diff --git a/docs/apis-tools/typescript/api-reference/fp/functions/classifyDomainError.md b/docs/apis-tools/typescript/api-reference/fp/functions/classifyDomainError.md index 35face5c52b..98ff961d857 100644 --- a/docs/apis-tools/typescript/api-reference/fp/functions/classifyDomainError.md +++ b/docs/apis-tools/typescript/api-reference/fp/functions/classifyDomainError.md @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang function classifyDomainError(err): DomainErrorTag; ``` -Defined in: [fp-ts.ts:42](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L42) +Defined in: [fp-ts.ts:42](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L42) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/fp/functions/eventuallyTE.md b/docs/apis-tools/typescript/api-reference/fp/functions/eventuallyTE.md index 9bee8e66be5..bf6c319d2fd 100644 --- a/docs/apis-tools/typescript/api-reference/fp/functions/eventuallyTE.md +++ b/docs/apis-tools/typescript/api-reference/fp/functions/eventuallyTE.md @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang function eventuallyTE(thunk, predicate, opts): TaskEither; ``` -Defined in: [fp-ts.ts:177](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L177) +Defined in: [fp-ts.ts:177](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L177) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/fp/functions/foldDomainError.md b/docs/apis-tools/typescript/api-reference/fp/functions/foldDomainError.md index 0122c068b61..3fb8cba1c42 100644 --- a/docs/apis-tools/typescript/api-reference/fp/functions/foldDomainError.md +++ b/docs/apis-tools/typescript/api-reference/fp/functions/foldDomainError.md @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang function foldDomainError(handlers): (err) => A; ``` -Defined in: [fp-ts.ts:51](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L51) +Defined in: [fp-ts.ts:51](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L51) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/fp/functions/retryTE.md b/docs/apis-tools/typescript/api-reference/fp/functions/retryTE.md index 261a39c6a04..c11ede4efec 100644 --- a/docs/apis-tools/typescript/api-reference/fp/functions/retryTE.md +++ b/docs/apis-tools/typescript/api-reference/fp/functions/retryTE.md @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang function retryTE(task, opts): TaskEither; ``` -Defined in: [fp-ts.ts:128](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L128) +Defined in: [fp-ts.ts:128](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L128) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/fp/functions/withTimeoutTE.md b/docs/apis-tools/typescript/api-reference/fp/functions/withTimeoutTE.md index d5a0661bb78..7c34a5c3324 100644 --- a/docs/apis-tools/typescript/api-reference/fp/functions/withTimeoutTE.md +++ b/docs/apis-tools/typescript/api-reference/fp/functions/withTimeoutTE.md @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang function withTimeoutTE(task, ms, onTimeout?): TaskEither; ``` -Defined in: [fp-ts.ts:155](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L155) +Defined in: [fp-ts.ts:155](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L155) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainError.md b/docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainError.md index 65ce8d462d1..26d11e7e041 100644 --- a/docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainError.md +++ b/docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainError.md @@ -19,4 +19,4 @@ type DomainError = | Error; ``` -Defined in: [fp-ts.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L24) +Defined in: [fp-ts.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L24) diff --git a/docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainErrorTag.md b/docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainErrorTag.md index e9d349e26b3..846e58903c2 100644 --- a/docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainErrorTag.md +++ b/docs/apis-tools/typescript/api-reference/fp/type-aliases/DomainErrorTag.md @@ -15,4 +15,4 @@ The Functional Programming API is a **technical preview**. Its surface may chang type DomainErrorTag = "validation" | "timeout" | "http" | "generic"; ``` -Defined in: [fp-ts.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L40) +Defined in: [fp-ts.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L40) diff --git a/docs/apis-tools/typescript/api-reference/fp/type-aliases/FnKeys.md b/docs/apis-tools/typescript/api-reference/fp/type-aliases/FnKeys.md index 3c6316774be..081ee275987 100644 --- a/docs/apis-tools/typescript/api-reference/fp/type-aliases/FnKeys.md +++ b/docs/apis-tools/typescript/api-reference/fp/type-aliases/FnKeys.md @@ -17,7 +17,7 @@ type FnKeys = { }[keyof C]; ``` -Defined in: [fp-ts.ts:72](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L72) +Defined in: [fp-ts.ts:72](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L72) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/fp/type-aliases/Fpify.md b/docs/apis-tools/typescript/api-reference/fp/type-aliases/Fpify.md index e72b17b2839..9cca4598661 100644 --- a/docs/apis-tools/typescript/api-reference/fp/type-aliases/Fpify.md +++ b/docs/apis-tools/typescript/api-reference/fp/type-aliases/Fpify.md @@ -19,7 +19,7 @@ type Fpify = { } & object & { [K in Exclude>]: C[K] }; ``` -Defined in: [fp-ts.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L73) +Defined in: [fp-ts.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L73) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/fp/type-aliases/HttpError.md b/docs/apis-tools/typescript/api-reference/fp/type-aliases/HttpError.md index 8428897ce44..c9e4111a1b8 100644 --- a/docs/apis-tools/typescript/api-reference/fp/type-aliases/HttpError.md +++ b/docs/apis-tools/typescript/api-reference/fp/type-aliases/HttpError.md @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang type HttpError = object & Record; ``` -Defined in: [fp-ts.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L20) +Defined in: [fp-ts.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L20) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/fp/type-aliases/Left.md b/docs/apis-tools/typescript/api-reference/fp/type-aliases/Left.md index 87747334ebb..bc58fbd362b 100644 --- a/docs/apis-tools/typescript/api-reference/fp/type-aliases/Left.md +++ b/docs/apis-tools/typescript/api-reference/fp/type-aliases/Left.md @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang type Left = object; ``` -Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L9) +Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L9) ## Type Parameters @@ -31,7 +31,7 @@ Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js _tag: "Left"; ``` -Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L9) +Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L9) --- @@ -41,4 +41,4 @@ Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js left: E; ``` -Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L9) +Defined in: [fp-ts.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L9) diff --git a/docs/apis-tools/typescript/api-reference/fp/type-aliases/Right.md b/docs/apis-tools/typescript/api-reference/fp/type-aliases/Right.md index 8fd34b4342c..3b053881f24 100644 --- a/docs/apis-tools/typescript/api-reference/fp/type-aliases/Right.md +++ b/docs/apis-tools/typescript/api-reference/fp/type-aliases/Right.md @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang type Right = object; ``` -Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L10) +Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L10) ## Type Parameters @@ -31,7 +31,7 @@ Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-j _tag: "Right"; ``` -Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L10) +Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L10) --- @@ -41,4 +41,4 @@ Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-j right: A; ``` -Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L10) +Defined in: [fp-ts.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L10) diff --git a/docs/apis-tools/typescript/api-reference/fp/type-aliases/TaskEither.md b/docs/apis-tools/typescript/api-reference/fp/type-aliases/TaskEither.md index b89e5fa88f0..6f63d5c492e 100644 --- a/docs/apis-tools/typescript/api-reference/fp/type-aliases/TaskEither.md +++ b/docs/apis-tools/typescript/api-reference/fp/type-aliases/TaskEither.md @@ -15,7 +15,7 @@ The Functional Programming API is a **technical preview**. Its surface may chang type TaskEither = () => Promise>; ``` -Defined in: [fp-ts.ts:12](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L12) +Defined in: [fp-ts.ts:12](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L12) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/index.md b/docs/apis-tools/typescript/api-reference/index.md index 771dc1a7306..e1433cd021f 100644 --- a/docs/apis-tools/typescript/api-reference/index.md +++ b/docs/apis-tools/typescript/api-reference/index.md @@ -8,6 +8,8 @@ mdx: # Camunda 8 Orchestration Cluster TypeScript SDK + + Type‑safe, promise‑based client for the Camunda 8 Orchestration Cluster REST API. ## Highlights @@ -21,7 +23,8 @@ Type‑safe, promise‑based client for the Camunda 8 Orchestration Cluster REST - Eventual consistency helper for polling endpoints - Immutable, deep‑frozen configuration accessible through a factory‑created client instance - Automatic body-level tenantId defaulting: if a request body supports an optional tenantId and you omit it, the SDK fills it from CAMUNDA_DEFAULT_TENANT_ID (path params are never auto-filled) -- Automatic transient HTTP retry (429, 503, network) with exponential backoff + full jitter (configurable via CAMUNDA_SDK_HTTP_RETRY\*). Non-retryable 500s fail fast. Pluggable strategy surface (default uses p-retry when available, internal fallback otherwise). +- Automatic transient HTTP retry (429, 503, network) with exponential backoff + full jitter (configurable via CAMUNDA_SDK_HTTP_RETRY\*). Non-retryable 500s fail fast. +- Per-method retry override: disable or customize retry policy on any individual API call without changing global settings ## Install @@ -36,27 +39,31 @@ Runtime support: For older Node versions supply a fetch ponyfill AND a `File` shim (or upgrade). For legacy browsers, add a fetch polyfill (e.g. `whatwg-fetch`). -## Versioning +### Versioning + +This SDK has a different release cadence from the Camunda server. Features and fixes land in the SDK during a server release. -This SDK does **not** follow traditional semver. The **major.minor** version tracks the Camunda server version, so you can easily match the SDK to your deployment target (e.g. SDK `8.9.x` targets Camunda `8.9`). +The major version of the SDK signals a 1:1 type coherence with the server API for a Camunda minor release. -**Patch releases** contain fixes, features, and occasionally **breaking type changes**. A breaking type change typically means an upstream API definition fix that corrects the shape of a request or response model — your code may stop type-checking even though it worked before. +SDK version `n.y.z` -> server version `8.n`, so the type surface of SDK version 9.y.z matches the API surface of Camunda 8.9. -When this happens, we signal it in the [CHANGELOG](https://github.com/camunda/orchestration-cluster-api-js/releases). +Using a later SDK version, for example: SDK version 10.y.z with Camunda 8.9, means that the SDK contains additive surfaces that are not guaranteed at runtime, and the compiler cannot warn of unsupported operations. -**Recommended approach:** +Using an earlier SDK version, for example: SDK version 9.y.z with Camunda 8.10, results in slightly degraded compiler reasoning: exhaustiveness checks cannot be guaranteed by the compiler for any extended surfaces (principally, enums with added members). -- **Ride the latest** — accept that types may shift and update your code when it happens. This keeps you on the most accurate API surface. -- **Pin and review** — pin to a specific patch version in `package.json` and review the [CHANGELOG](https://github.com/camunda/orchestration-cluster-api-js/releases) before upgrading: +In the vast majority of use-cases, this will not be an issue; but you should be aware that using the matching SDK major version for the server minor version provides the strongest compiler guarantees about runtime reliability. - ```json - "@camunda8/orchestration-cluster-api": "8.9.3" - ``` +**Recommended approach**: + +- Check the [CHANGELOG](https://github.com/camunda/orchestration-cluster-api-js/releases). +- As a sanity check during server version upgrade, rebuild applications with the matching SDK major version to identify any affected runtime surfaces. ## Quick Start (Zero‑Config – Recommended) Keep configuration out of application code. Let the factory read `CAMUNDA_*` variables from the environment (12‑factor style). This makes rotation, secret management, and environment promotion safer & simpler. + + ```ts import createCamundaClient from "@camunda8/orchestration-cluster-api"; @@ -97,6 +104,8 @@ CAMUNDA_SDK_HTTP_RETRY_MAX_DELAY_MS=2000 # optional: cap (ms) Use only when you must supply or mutate configuration dynamically (e.g. multi‑tenant routing, tests, ephemeral preview environments) or in the browser. Keys mirror their `CAMUNDA_*` env names. + + ```ts const camunda = createCamundaClient({ config: { @@ -112,6 +121,8 @@ const camunda = createCamundaClient({ Inject a custom `fetch` to add tracing, mock responses, instrumentation, circuit breakers, etc. + + ```ts const camunda = createCamundaClient({ fetch: (input, init) => { @@ -157,15 +168,63 @@ Behavior: - `strict` - fail on type mismatch or missing required fields - `fanatical` - fail on type mismatch, missing required fields, or unknown additional fields +## Per-Method Retry Override + +Every API method accepts an optional trailing `options` parameter that lets you override or disable the global retry policy for that single call. + +### Disable Retry for a Single Call + + + +```ts +// This call will not retry on transient errors +await camunda.completeJob({ jobKey }, { retry: false }); +``` + +### Override Specific Retry Settings + +Pass a partial `HttpRetryPolicy` to override individual fields. Unspecified fields inherit from the global configuration. + + + +```ts +// More aggressive retry for this operation only +await camunda.createProcessInstance( + { processDefinitionId: ProcessDefinitionId.assumeExists("payment-process") }, + { retry: { maxAttempts: 8, maxDelayMs: 5000 } } +); + +// Minimal retry: single retry with short backoff +await camunda.getTopology({ retry: { maxAttempts: 2, baseDelayMs: 50 } }); +``` + +### How It Works + +| `options.retry` value | Behavior | +| --------------------- | -------------------------------------------------------------------- | +| omitted / `undefined` | Uses global policy (`CAMUNDA_SDK_HTTP_RETRY_*` env vars) | +| `false` | Disables retry entirely (single attempt, no backoff) | +| `{ maxAttempts: 5 }` | Merges with global policy — only the specified fields are overridden | + +The `HttpRetryPolicy` fields available for override: + +| Field | Type | Description | +| ------------- | -------- | --------------------------------------- | +| `maxAttempts` | `number` | Total attempts (initial + retries) | +| `baseDelayMs` | `number` | Base delay for exponential backoff (ms) | +| `maxDelayMs` | `number` | Maximum delay cap (ms) | + ## Advanced HTTP Retry: Cockatiel Adapter (Optional) -The SDK includes built‑in transient HTTP retry (429, 503, network errors) using a p‑retry based engine plus a fallback implementation. For advanced resilience patterns (circuit breakers, timeouts, custom classification, combining policies) you can integrate [cockatiel](https://github.com/connor4312/cockatiel). +For advanced resilience patterns beyond per-method overrides — circuit breakers, timeouts, custom classification, combining policies — you can integrate [cockatiel](https://github.com/connor4312/cockatiel). + +> **Tip:** For most use cases, per-method retry override (above) is sufficient. Reach for Cockatiel when you need circuit breaking, hedging, or bulkhead controls. ### When To Use Cockatiel -- You need different retry policies per operation (e.g. idempotent GET vs mutating POST) - You want circuit breaking, hedging, timeout, or bulkhead controls - You want to add custom classification (e.g. retry certain 5xx only on safe verbs) +- You need to compose multiple resilience policies together ### Disable Built‑In HTTP Retries @@ -313,7 +372,7 @@ const policy = retry(classify, { - Keep SDK retries disabled to prevent duplicate layers. - SDK synthesizes `Error` objects with a `status` for retry-significant HTTP responses (429, 503, 500), enabling classification. - You can tag errors (e.g. assign `err.__opVerb`) in a wrapper if verb-level logic is needed. -- Future improvement: an official `retryStrategy` injection hook—current approach is non-invasive. +- For per-operation retry customization without external dependencies, use the built-in [per-method retry override](#per-method-retry-override) instead. > Combine cockatiel retry with a circuit breaker, timeout, or bulkhead policy for more robust behavior in partial outages. @@ -415,12 +474,29 @@ Factors use integer percentages to avoid floating point drift in env parsing; th If you have concrete tuning needs, open an issue describing workload patterns (operation mix, baseline concurrency, observed broker limits) to help prioritize which knobs to surface. +### What Should I Set? + +If you're unsure about your workload shape, **don't set anything**. The default BALANCED profile activates automatically and outperforms no-gating (LEGACY) in most scenarios — on raw throughput alone, not just error reduction. + +Benchmark results against a single-node local cluster with multiple independent clients (no shared state between them): + +| Scenario | BALANCED | LEGACY (no gating) | +| ----------------------------- | --------------- | ------------------ | +| Single-client (1K processes) | **80.1 ops/s** | 67.8 ops/s | +| Single-client sustained (10K) | **119.6 ops/s** | 87.8 ops/s | +| Multi-client 3+2 spike | **86.3 ops/s** | 48.0 ops/s | +| Stress 8 clients ×1000 | 76.3 ops/s | **106.4 ops/s** | + +BALANCED wins 3 of 4 on pure throughput. The only scenario where LEGACY is faster is extreme overload (800 concurrent requests against a single broker) — and in that case LEGACY accumulates 44,505 errors vs BALANCED's 15,527. The default just works. + ## Job Workers (Polling API) The SDK provides a lightweight polling job worker for service task job types using `createJobWorker`. It activates jobs in batches (respecting a concurrency limit), validates variables (optional), and offers action helpers on each job. ### Minimal Example + + ```ts import createCamundaClient from "@camunda8/orchestration-cluster-api"; import { z } from "zod"; @@ -434,7 +510,7 @@ const Output = z.object({ processed: z.boolean() }); const worker = client.createJobWorker({ jobType: "process-order", maxParallelJobs: 10, - timeoutMs: 15_000, // long‑poll timeout (server side requestTimeout) + jobTimeoutMs: 15_000, // long‑poll timeout (server side requestTimeout) pollIntervalMs: 100, // delay between polls when no jobs / at capacity // Optional: only fetch specific variables during activation fetchVariables: ["orderId"], @@ -442,9 +518,11 @@ const worker = client.createJobWorker({ outputSchema: Output, // validates variables passed to complete(...) validateSchemas: true, // set false for max throughput (skip Zod) autoStart: true, // default true; start polling immediately + startupJitterMaxSeconds: 5, // random delay up to 5s before first poll (default 0) jobHandler: (job) => { // Access typed variables const vars = job.variables; // inferred from Input schema + console.log(`Processing order: ${vars.orderId}`); // Do work... return job.complete({ variables: { processed: true } }); }, @@ -464,6 +542,8 @@ TypeScript inference: - When you provide `inputSchema`, the type of `fetchVariables` is constrained to the keys of the inferred `variables` type from that schema. Example: + + ```ts const Input = z.object({ orderId: z.string(), amount: z.number() }); client.createJobWorker({ @@ -541,6 +621,8 @@ If `validateSchemas` is true: Use `await worker.stopGracefully({ waitUpToMs?, checkIntervalMs? })` to drain without force‑cancelling the current activation request. + + ```ts // Attempt graceful drain for up to 8 seconds const { remainingJobs, timedOut } = await worker.stopGracefully({ @@ -566,12 +648,33 @@ Activation cancellations during stop are logged at debug (`activation.cancelled` You can register multiple workers on a single client instance—one per job type is typical. The client exposes `client.getWorkers()` for inspection and `client.stopAllWorkers()` for coordinated shutdown. +### Startup Jitter + +When deploying multiple application instances simultaneously (e.g. a rolling restart or scale-up), all workers start polling at the same time and can saturate the server with activation requests. Set `startupJitterMaxSeconds` to spread out the initial poll across a random window: + + + +```ts +client.createJobWorker({ + jobType: "process-order", + maxParallelJobs: 10, + jobTimeoutMs: 30_000, + startupJitterMaxSeconds: 5, // each instance delays 0–5s before first poll + jobHandler: async (job) => job.complete(), +}); +``` + +A value of `0` (the default) means no delay. + ### Receipt Type (Unique Symbol) Action methods return a unique symbol (not a string) to avoid accidental misuse and allow internal metrics. If you store the receipt, annotate its type as `JobActionReceipt` to preserve uniqueness: + + ```ts -import { JobActionReceipt } from "@camunda8/orchestration-cluster-api"; +import type { JobActionReceipt } from "@camunda8/orchestration-cluster-api"; + const receipt: JobActionReceipt = await job.complete({ variables: { processed: true }, }); @@ -617,6 +720,115 @@ Call `client.getBackpressureState()` to obtain: } ``` +### Threaded Job Workers (Node.js Only) + +For CPU-intensive job handlers, `createThreadedJobWorker` offloads handler execution to a pool of Node.js `worker_threads`. Polling and I/O remain on the main event loop, while handler logic runs in parallel threads — dramatically improving throughput when the handler does CPU-bound work (JSON processing, validation, transformation, cryptography). + +#### When to use + +- Your handler spends significant time on CPU work (not just waiting for HTTP responses) +- You observe that a single-threaded worker saturates one CPU core while throughput plateaus +- You need to process more jobs per second without deploying additional instances + +If your handler is mostly I/O-bound (HTTP calls, database queries), the standard `createJobWorker` is sufficient. + +#### Handler module + +The handler must be a **separate file** (not an inline function) that exports a default async function: + +```ts +// my-handler.ts (or my-handler.js) +import type { ThreadedJobHandler } from "@camunda8/orchestration-cluster-api"; + +const handler: ThreadedJobHandler = async (job, client) => { + const { orderId } = job.variables; + // CPU-intensive work here... + const result = heavyComputation(orderId); + return job.complete({ result }); +}; +export default handler; +``` + +Typing your handler as `ThreadedJobHandler` gives full intellisense for `job` (variables, action methods like `complete()`, `fail()`, `error()`) and `client` (every `CamundaClient` API method). + +The handler receives two arguments: + +1. **`job`** — a proxy with the same shape as a regular job worker job (`variables`, `customHeaders`, `jobKey`, plus action methods: `complete()`, `fail()`, `error()`, `cancelWorkflow()`, `ignore()`) +2. **`client`** — a proxy to the `CamundaClient` on the main thread. You can call any SDK method (e.g. `client.publishMessage(...)`, `client.createProcessInstance(...)`) and it will be forwarded to the main thread and executed there. + +#### Minimal example + + + +```ts +import createCamundaClient from "@camunda8/orchestration-cluster-api"; +import path from "node:path"; +import { fileURLToPath } from "node:url"; + +const client = createCamundaClient(); + +const worker = client.createThreadedJobWorker({ + jobType: "cpu-heavy-task", + handlerModule: path.join( + path.dirname(fileURLToPath(import.meta.url)), + "my-handler.js" + ), + maxParallelJobs: 32, + jobTimeoutMs: 30_000, +}); +``` + +#### Configuration + +`createThreadedJobWorker` accepts all the same options as `createJobWorker` (except `jobHandler`), plus: + +| Option | Type | Default | Description | +| ---------------- | -------- | --------------------------- | ---------------------------------------------------------------- | +| `handlerModule` | `string` | (required) | Path to handler module (absolute or relative to `process.cwd()`) | +| `threadPoolSize` | `number` | `os.availableParallelism()` | Number of worker threads in the pool | + +Other familiar options: `jobType`, `maxParallelJobs`, `jobTimeoutMs`, `pollIntervalMs`, `pollTimeoutMs`, `fetchVariables`, `inputSchema`, `outputSchema`, `customHeadersSchema`, `validateSchemas`, `autoStart`, `startupJitterMaxSeconds`, `workerName`. + +#### Lifecycle + +Threaded workers integrate with the same lifecycle as regular workers: + +```ts +// Returned by getWorkers() +const allWorkers = client.getWorkers(); + +// Stopped by stopAllWorkers() +client.stopAllWorkers(); + +// Graceful shutdown (waits for in-flight jobs to finish) +const { timedOut, remainingJobs } = await worker.stopGracefully({ + waitUpToMs: 10_000, +}); +``` + +#### Pool stats + +```ts +worker.poolSize; // number of threads +worker.busyThreads; // threads currently processing a job +worker.activeJobs; // total jobs dispatched but not yet completed +``` + +#### How it works + +1. The main thread polls `activateJobs` using the same mechanism as `createJobWorker` +2. Activated jobs are serialized and dispatched to an idle thread via `MessageChannel` +3. The thread loads the handler module (lazy, on first job), creates a proxy for `job` action methods and `client` API calls +4. Action methods (`job.complete()`, `job.fail()`, etc.) and client calls are forwarded back to the main thread over the `MessagePort` and executed there +5. The result is relayed back, and the thread is marked idle for the next job + +#### Constraints + +- **Node.js only**: `worker_threads` is not available in browsers or Deno +- **Handler must be a file module**: Inline functions cannot be transferred to threads +- **Job variables must be JSON-serializable**: Functions and class instances on the job are stripped during transfer +- **Client calls are async round-trips**: Each `client.xyz()` call crosses a thread boundary, adding a small amount of latency per call + --- ## Authentication @@ -703,11 +915,13 @@ If both cert & key are available an https.Agent is attached to all outbound call Import branded key helpers directly: + + ```ts import { ProcessDefinitionKey, ProcessInstanceKey, -} from "@camunda8/orchestration-cluster"; +} from "@camunda8/orchestration-cluster-api"; const defKey = ProcessDefinitionKey.assumeExists("2251799813686749"); // @ts-expect-error – cannot assign def key to instance key @@ -720,10 +934,13 @@ They are zero‑cost runtime strings with compile‑time separation. All methods return a `CancelablePromise`: + + ```ts -const p = camunda.searchProcessInstances({ - filter: { processDefinitionKey: defKey }, -}); +const p = camunda.searchProcessInstances( + { filter: { processDefinitionKey: defKey } }, + { consistency: { waitUpToMs: 0 } } +); setTimeout(() => p.cancel(), 100); // best‑effort cancel try { await p; // resolves if not cancelled @@ -744,6 +961,16 @@ Notes: @experimental - this feature is not guaranteed to be tested or stable. +> **Peer dependency:** `fp-ts` is an optional peer dependency. If you use real `fp-ts` functions +> (e.g. `pipe`, `TE.match`) alongside this subpath, install it separately: +> +> ```sh +> npm install fp-ts +> ``` +> +> The `/fp` subpath works without `fp-ts` installed — it exposes structurally-compatible +> `Either`/`TaskEither` shapes that interoperate with `fp-ts` but do not require it at runtime. + The main entry stays minimal. To opt in to a TaskEither-style facade & helper combinators import from the dedicated subpath: ```ts @@ -821,17 +1048,23 @@ Use this to understand convergence speed and data shape evolution during tests o ### Example + + ```ts -const jobs = await camunda.searchJobs({ - filter: { type: "payment" }, - consistency: { - waitUpToMs: 5000, - pollIntervalMs: 200, - trace: true, - predicate: (r) => - Array.isArray(r.items) && r.items.some((j) => j.state === "CREATED"), +const jobs = await camunda.searchJobs( + { + filter: { type: "payment" }, }, -}); + { + consistency: { + waitUpToMs: 5000, + pollIntervalMs: 200, + trace: true, + predicate: (r) => + Array.isArray(r.items) && r.items.some((j) => j.state === "CREATED"), + }, + } +); ``` On timeout an `EventualConsistencyTimeoutError` includes diagnostic fields: `{ attempts, elapsedMs, lastStatus, lastResponse, operationId }`. @@ -840,6 +1073,8 @@ On timeout an `EventualConsistencyTimeoutError` includes diagnostic fields: `{ a Per‑client logger; no global singleton. The level defaults from `CAMUNDA_SDK_LOG_LEVEL` (default `error`). + + ```ts const client = createCamundaClient({ log: { @@ -981,9 +1216,13 @@ May throw: All SDK-thrown operational errors normalize to a discriminated union (`SdkError`) when they originate from HTTP, network, auth, or validation layers. Use the guard `isSdkError` to narrow inside a catch: + + ```ts -import { createCamundaClient } from "@camunda8/orchestration-cluster-api"; -import { isSdkError } from "@camunda8/orchestration-cluster-api/dist/runtime/errors"; +import { + createCamundaClient, + isSdkError, +} from "@camunda8/orchestration-cluster-api"; const client = createCamundaClient(); @@ -1030,16 +1269,18 @@ _Note that this feature is experimental and subject to change._ If you prefer FP‑style explicit error handling instead of exceptions, use the result client wrapper: + + ```ts import { createCamundaResultClient, isOk, -} from "@camunda8/orchestration-cluster"; +} from "@camunda8/orchestration-cluster-api"; const camundaR = createCamundaResultClient(); const res = await camundaR.createDeployment({ resources: [file] }); if (isOk(res)) { - console.log("Deployment key", res.value.deployments[0].deploymentKey); + console.log("Deployment key", res.value.deploymentKey); } else { console.error("Deployment failed", res.error); } @@ -1118,6 +1359,8 @@ The deployment endpoint requires each resource to have a filename (extension use ### Browser + + ```ts const bpmnXml = `...`; const file = new File([bpmnXml], "order-process.bpmn", { @@ -1139,6 +1382,8 @@ await camunda.createDeployment({ resources: [file] }); Use the built-in helper `deployResourcesFromFiles(...)` to read local files and create `File` objects automatically. It returns the enriched `ExtendedDeploymentResult` (adds typed arrays: `processes`, `decisions`, `decisionRequirements`, `forms`, `resources`). + + ```ts const result = await camunda.deployResourcesFromFiles([ "./bpmn/order-process.bpmn", @@ -1193,6 +1438,8 @@ Empty arrays are rejected. Always use correct extensions so the server can class Create isolated clients per test file: + + ```ts const client = createCamundaClient({ config: { @@ -1204,6 +1451,8 @@ const client = createCamundaClient({ Inject a mock fetch: + + ```ts const client = createCamundaClient({ fetch: async (input, init) => diff --git a/docs/apis-tools/typescript/api-reference/index/classes/CamundaClient.md b/docs/apis-tools/typescript/api-reference/index/classes/CamundaClient.md index 701b66ca82a..7df3546e122 100644 --- a/docs/apis-tools/typescript/api-reference/index/classes/CamundaClient.md +++ b/docs/apis-tools/typescript/api-reference/index/classes/CamundaClient.md @@ -7,7 +7,7 @@ mdx: # Class: CamundaClient -Defined in: [gen/CamundaClient.ts:1186](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1186) +Defined in: [gen/CamundaClient.ts:1183](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1183) ## Constructors @@ -17,7 +17,7 @@ Defined in: [gen/CamundaClient.ts:1186](https://github.com/camunda/orchestration new CamundaClient(opts): CamundaClient; ``` -Defined in: [gen/CamundaClient.ts:1212](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1212) +Defined in: [gen/CamundaClient.ts:1212](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1212) #### Parameters @@ -39,7 +39,7 @@ Defined in: [gen/CamundaClient.ts:1212](https://github.com/camunda/orchestration get config(): Readonly; ``` -Defined in: [gen/CamundaClient.ts:1330](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1330) +Defined in: [gen/CamundaClient.ts:1334](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1334) ##### Returns @@ -53,7 +53,7 @@ Defined in: [gen/CamundaClient.ts:1330](https://github.com/camunda/orchestration _getSupportLogger(): SupportLogger; ``` -Defined in: [gen/CamundaClient.ts:1459](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1459) +Defined in: [gen/CamundaClient.ts:1465](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1465) Internal accessor for support logger (no public API commitment yet). @@ -69,7 +69,7 @@ Internal accessor for support logger (no public API commitment yet). _invokeWithRetry(op, opts): Promise; ``` -Defined in: [gen/CamundaClient.ts:1492](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1492) +Defined in: [gen/CamundaClient.ts:1504](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1504) Internal invocation helper to apply global backpressure gating + retry + normalization @@ -99,6 +99,11 @@ Internal invocation helper to apply global backpressure gating + retry + normali `string` +###### retryOverride? + +\| `false` +\| `Partial`\<[`HttpRetryPolicy`](../interfaces/HttpRetryPolicy.md)\> + #### Returns `Promise`\<`T`\> @@ -108,10 +113,10 @@ Internal invocation helper to apply global backpressure gating + retry + normali ### activateAdHocSubProcessActivities() ```ts -activateAdHocSubProcessActivities(input): CancelablePromise; +activateAdHocSubProcessActivities(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:1578](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1578) +Defined in: [gen/CamundaClient.ts:1611](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1611) Activate activities within an ad-hoc sub-process @@ -127,10 +132,30 @@ provided adHocSubProcessInstanceKey. [`activateAdHocSubProcessActivitiesInput`](../type-aliases/activateAdHocSubProcessActivitiesInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function activateAdHocSubProcessActivitiesExample() { + const camunda = createCamundaClient(); + + const adHocSubProcessInstanceKey = + ElementInstanceKey.assumeExists("2251799813685249"); + + await camunda.activateAdHocSubProcessActivities({ + adHocSubProcessInstanceKey, + elements: [{ elementId: ElementId.assumeExists("task-a") }], + }); +} +``` + #### Operation Id activateAdHocSubProcessActivities @@ -144,12 +169,12 @@ Ad-hoc sub-process ### activateJobs() ```ts -activateJobs(input): CancelablePromise<{ +activateJobs(input, options?): CancelablePromise<{ jobs: EnrichedActivatedJob[]; }>; ``` -Defined in: [gen/CamundaClient.ts:1641](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1641) +Defined in: [gen/CamundaClient.ts:1676](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1676) Activate jobs @@ -163,6 +188,10 @@ Iterate through all known partitions and activate jobs up to the requested maxim [`JobActivationRequest`](../type-aliases/JobActivationRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ @@ -203,10 +232,10 @@ Job ### assignClientToGroup() ```ts -assignClientToGroup(input): CancelablePromise; +assignClientToGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:1702](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1702) +Defined in: [gen/CamundaClient.ts:1741](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1741) Assign a client to a group @@ -221,10 +250,27 @@ Members of the group inherit the group authorizations, roles, and tenant assignm [`assignClientToGroupInput`](../type-aliases/assignClientToGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignClientToGroupExample() { + const camunda = createCamundaClient(); + + await camunda.assignClientToGroup({ + groupId: "engineering-team", + clientId: "my-service-account", + }); +} +``` + #### Operation Id assignClientToGroup @@ -238,10 +284,10 @@ Group ### assignClientToTenant() ```ts -assignClientToTenant(input): CancelablePromise; +assignClientToTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:1762](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1762) +Defined in: [gen/CamundaClient.ts:1805](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1805) Assign a client to a tenant @@ -256,10 +302,27 @@ The client can then access tenant data and perform authorized actions. [`assignClientToTenantInput`](../type-aliases/assignClientToTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignClientToTenantExample() { + const camunda = createCamundaClient(); + + await camunda.assignClientToTenant({ + tenantId: TenantId.assumeExists("customer-service"), + clientId: "my-service-account", + }); +} +``` + #### Operation Id assignClientToTenant @@ -273,10 +336,10 @@ Tenant ### assignGroupToTenant() ```ts -assignGroupToTenant(input): CancelablePromise; +assignGroupToTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:1822](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1822) +Defined in: [gen/CamundaClient.ts:1869](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1869) Assign a group to a tenant @@ -291,10 +354,27 @@ Group members (users, clients) can then access tenant data and perform authorize [`assignGroupToTenantInput`](../type-aliases/assignGroupToTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignGroupToTenantExample() { + const camunda = createCamundaClient(); + + await camunda.assignGroupToTenant({ + tenantId: TenantId.assumeExists("customer-service"), + groupId: "engineering-team", + }); +} +``` + #### Operation Id assignGroupToTenant @@ -308,10 +388,10 @@ Tenant ### assignMappingRuleToGroup() ```ts -assignMappingRuleToGroup(input): CancelablePromise; +assignMappingRuleToGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:1880](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1880) +Defined in: [gen/CamundaClient.ts:1931](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1931) Assign a mapping rule to a group @@ -325,10 +405,27 @@ Assigns a mapping rule to a group. [`assignMappingRuleToGroupInput`](../type-aliases/assignMappingRuleToGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignMappingRuleToGroupExample() { + const camunda = createCamundaClient(); + + await camunda.assignMappingRuleToGroup({ + groupId: "engineering-team", + mappingRuleId: "rule-123", + }); +} +``` + #### Operation Id assignMappingRuleToGroup @@ -342,10 +439,10 @@ Group ### assignMappingRuleToTenant() ```ts -assignMappingRuleToTenant(input): CancelablePromise; +assignMappingRuleToTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:1938](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1938) +Defined in: [gen/CamundaClient.ts:1993](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1993) Assign a mapping rule to a tenant @@ -359,10 +456,27 @@ Assign a single mapping rule to a specified tenant. [`assignMappingRuleToTenantInput`](../type-aliases/assignMappingRuleToTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignMappingRuleToTenantExample() { + const camunda = createCamundaClient(); + + await camunda.assignMappingRuleToTenant({ + tenantId: TenantId.assumeExists("customer-service"), + mappingRuleId: "rule-123", + }); +} +``` + #### Operation Id assignMappingRuleToTenant @@ -376,10 +490,10 @@ Tenant ### assignRoleToClient() ```ts -assignRoleToClient(input): CancelablePromise; +assignRoleToClient(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:1996](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1996) +Defined in: [gen/CamundaClient.ts:2055](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2055) Assign a role to a client @@ -393,10 +507,27 @@ Assigns the specified role to the client. The client will inherit the authorizat [`assignRoleToClientInput`](../type-aliases/assignRoleToClientInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignRoleToClientExample() { + const camunda = createCamundaClient(); + + await camunda.assignRoleToClient({ + roleId: "process-admin", + clientId: "my-service-account", + }); +} +``` + #### Operation Id assignRoleToClient @@ -410,10 +541,10 @@ Role ### assignRoleToGroup() ```ts -assignRoleToGroup(input): CancelablePromise; +assignRoleToGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2054](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2054) +Defined in: [gen/CamundaClient.ts:2117](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2117) Assign a role to a group @@ -427,10 +558,27 @@ Assigns the specified role to the group. Every member of the group (user or clie [`assignRoleToGroupInput`](../type-aliases/assignRoleToGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignRoleToGroupExample() { + const camunda = createCamundaClient(); + + await camunda.assignRoleToGroup({ + roleId: "process-admin", + groupId: "engineering-team", + }); +} +``` + #### Operation Id assignRoleToGroup @@ -444,10 +592,10 @@ Role ### assignRoleToMappingRule() ```ts -assignRoleToMappingRule(input): CancelablePromise; +assignRoleToMappingRule(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2112](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2112) +Defined in: [gen/CamundaClient.ts:2179](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2179) Assign a role to a mapping rule @@ -461,10 +609,27 @@ Assigns a role to a mapping rule. [`assignRoleToMappingRuleInput`](../type-aliases/assignRoleToMappingRuleInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignRoleToMappingRuleExample() { + const camunda = createCamundaClient(); + + await camunda.assignRoleToMappingRule({ + roleId: "process-admin", + mappingRuleId: "rule-123", + }); +} +``` + #### Operation Id assignRoleToMappingRule @@ -478,10 +643,10 @@ Role ### assignRoleToTenant() ```ts -assignRoleToTenant(input): CancelablePromise; +assignRoleToTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2172](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2172) +Defined in: [gen/CamundaClient.ts:2243](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2243) Assign a role to a tenant @@ -496,10 +661,27 @@ Users, Clients or Groups, that have the role assigned, will get access to the te [`assignRoleToTenantInput`](../type-aliases/assignRoleToTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignRoleToTenantExample() { + const camunda = createCamundaClient(); + + await camunda.assignRoleToTenant({ + tenantId: TenantId.assumeExists("customer-service"), + roleId: "process-admin", + }); +} +``` + #### Operation Id assignRoleToTenant @@ -513,10 +695,10 @@ Tenant ### assignRoleToUser() ```ts -assignRoleToUser(input): CancelablePromise; +assignRoleToUser(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2230](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2230) +Defined in: [gen/CamundaClient.ts:2305](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2305) Assign a role to a user @@ -530,10 +712,27 @@ Assigns the specified role to the user. The user will inherit the authorizations [`assignRoleToUserInput`](../type-aliases/assignRoleToUserInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignRoleToUserExample() { + const camunda = createCamundaClient(); + + await camunda.assignRoleToUser({ + roleId: "process-admin", + username: Username.assumeExists("alice"), + }); +} +``` + #### Operation Id assignRoleToUser @@ -547,14 +746,14 @@ Role ### assignUserTask() ```ts -assignUserTask(input): CancelablePromise; +assignUserTask(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2290](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2290) +Defined in: [gen/CamundaClient.ts:2368](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2368) Assign user task -Assigns a user task with the given key to the given assignee. +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. - @@ -564,6 +763,10 @@ Assigns a user task with the given key to the given assignee. [`assignUserTaskInput`](../type-aliases/assignUserTaskInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> @@ -597,10 +800,10 @@ User task ### assignUserToGroup() ```ts -assignUserToGroup(input): CancelablePromise; +assignUserToGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2352](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2352) +Defined in: [gen/CamundaClient.ts:2434](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2434) Assign a user to a group @@ -615,10 +818,27 @@ Group members inherit the group authorizations, roles, and tenant assignments. [`assignUserToGroupInput`](../type-aliases/assignUserToGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignUserToGroupExample() { + const camunda = createCamundaClient(); + + await camunda.assignUserToGroup({ + groupId: "engineering-team", + username: Username.assumeExists("alice"), + }); +} +``` + #### Operation Id assignUserToGroup @@ -632,10 +852,10 @@ Group ### assignUserToTenant() ```ts -assignUserToTenant(input): CancelablePromise; +assignUserToTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2410](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2410) +Defined in: [gen/CamundaClient.ts:2496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2496) Assign a user to a tenant @@ -649,10 +869,27 @@ Assign a single user to a specified tenant. The user can then access tenant data [`assignUserToTenantInput`](../type-aliases/assignUserToTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function assignUserToTenantExample() { + const camunda = createCamundaClient(); + + await camunda.assignUserToTenant({ + tenantId: TenantId.assumeExists("customer-service"), + username: Username.assumeExists("alice"), + }); +} +``` + #### Operation Id assignUserToTenant @@ -666,10 +903,10 @@ Tenant ### broadcastSignal() ```ts -broadcastSignal(input): CancelablePromise; +broadcastSignal(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2470](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2470) +Defined in: [gen/CamundaClient.ts:2558](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2558) Broadcast signal @@ -683,6 +920,10 @@ Broadcasts a signal. [`SignalBroadcastRequest`](../type-aliases/SignalBroadcastRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SignalBroadcastResult`](../type-aliases/SignalBroadcastResult.md)\> @@ -717,10 +958,10 @@ Signal ### cancelBatchOperation() ```ts -cancelBatchOperation(input, consistencyManagement): CancelablePromise; +cancelBatchOperation(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2535](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2535) +Defined in: [gen/CamundaClient.ts:2626](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2626) Cancel Batch operation @@ -737,14 +978,26 @@ This is done asynchronously, the progress can be tracked using the batch operati [`BatchOperationKey`](../type-aliases/BatchOperationKey.md) -##### consistencyManagement +##### options? -[`cancelBatchOperationConsistency`](../type-aliases/cancelBatchOperationConsistency.md) +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function cancelBatchOperationExample() { + const camunda = createCamundaClient(); + + const batchOperationKey = BatchOperationKey.assumeExists("2251799813685249"); + + await camunda.cancelBatchOperation({ batchOperationKey }); +} +``` + #### Operation Id cancelBatchOperation @@ -753,23 +1006,19 @@ cancelBatchOperation Batch operation -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### cancelProcessInstance() ```ts -cancelProcessInstance(input): CancelablePromise; +cancelProcessInstance(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2601](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2601) +Defined in: [gen/CamundaClient.ts:2691](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2691) 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. +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. - @@ -779,6 +1028,10 @@ Cancels a running process instance. As a cancellation includes more than just th `object` & `object` +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> @@ -814,10 +1067,10 @@ Process instance ### cancelProcessInstancesBatchOperation() ```ts -cancelProcessInstancesBatchOperation(input, consistencyManagement): CancelablePromise; +cancelProcessInstancesBatchOperation(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2666](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2666) +Defined in: [gen/CamundaClient.ts:2759](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2759) Cancel process instances (batch) @@ -832,23 +1085,32 @@ This is done asynchronously, the progress can be tracked using the batchOperatio ##### input -###### filter +[`ProcessInstanceCancellationBatchOperationRequest`](../type-aliases/ProcessInstanceCancellationBatchOperationRequest.md) -[`ProcessInstanceFilter`](../type-aliases/ProcessInstanceFilter.md) +##### options? -The process instance filter. +[`OperationOptions`](../interfaces/OperationOptions.md) -###### operationReference? +#### Returns -`number` +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> -##### consistencyManagement +#### Example -[`cancelProcessInstancesBatchOperationConsistency`](../type-aliases/cancelProcessInstancesBatchOperationConsistency.md) +```ts +async function cancelProcessInstancesBatchOperationExample() { + const camunda = createCamundaClient(); -#### Returns + const result = await camunda.cancelProcessInstancesBatchOperation({ + filter: { + processDefinitionKey: + ProcessDefinitionKey.assumeExists("2251799813685249"), + }, + }); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> + console.log(`Batch operation key: ${result.batchOperationKey}`); +} +``` #### Operation Id @@ -858,10 +1120,6 @@ cancelProcessInstancesBatchOperation Process instance -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### clearAuthCache() @@ -870,7 +1128,7 @@ eventual - this endpoint is backed by data that is eventually consistent with th clearAuthCache(opts?): void; ``` -Defined in: [gen/CamundaClient.ts:1438](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1438) +Defined in: [gen/CamundaClient.ts:1444](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1444) #### Parameters @@ -893,10 +1151,10 @@ Defined in: [gen/CamundaClient.ts:1438](https://github.com/camunda/orchestration ### completeJob() ```ts -completeJob(input): CancelablePromise; +completeJob(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2731](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2731) +Defined in: [gen/CamundaClient.ts:2822](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2822) Complete job @@ -910,6 +1168,10 @@ Complete a job with the given payload, which allows completing the associated se [`completeJobInput`](../type-aliases/completeJobInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> @@ -945,14 +1207,14 @@ Job ### completeUserTask() ```ts -completeUserTask(input): CancelablePromise; +completeUserTask(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2793](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2793) +Defined in: [gen/CamundaClient.ts:2887](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2887) Complete user task -Completes a user task with the given key. +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. - @@ -962,6 +1224,10 @@ Completes a user task with the given key. [`completeUserTaskInput`](../type-aliases/completeUserTaskInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> @@ -1000,7 +1266,7 @@ User task configure(next): void; ``` -Defined in: [gen/CamundaClient.ts:1342](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1342) +Defined in: [gen/CamundaClient.ts:1346](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1346) #### Parameters @@ -1017,10 +1283,10 @@ Defined in: [gen/CamundaClient.ts:1342](https://github.com/camunda/orchestration ### correlateMessage() ```ts -correlateMessage(input): CancelablePromise; +correlateMessage(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2859](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2859) +Defined in: [gen/CamundaClient.ts:2955](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L2955) Correlate message @@ -1037,6 +1303,10 @@ Use the publish message endpoint to send messages that can be buffered. [`MessageCorrelationRequest`](../type-aliases/MessageCorrelationRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`MessageCorrelationResult`](../type-aliases/MessageCorrelationResult.md)\> @@ -1073,10 +1343,10 @@ Message ### createAdminUser() ```ts -createAdminUser(input, consistencyManagement): CancelablePromise; +createAdminUser(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2922](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2922) +Defined in: [gen/CamundaClient.ts:3021](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3021) Create admin user @@ -1090,14 +1360,31 @@ Creates a new user and assigns the admin role to it. This endpoint is only usabl [`UserRequest`](../type-aliases/UserRequest.md) -##### consistencyManagement +##### options? -[`createAdminUserConsistency`](../type-aliases/createAdminUserConsistency.md) +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`UserCreateResult`](../type-aliases/UserCreateResult.md)\> +#### Example + +```ts +async function createAdminUserExample() { + const camunda = createCamundaClient(); + + const result = await camunda.createAdminUser({ + username: Username.assumeExists("admin"), + name: "Admin User", + email: "admin@example.com", + password: "admin-password-123", + }); + + console.log(`Created admin user: ${result.username}`); +} +``` + #### Operation Id createAdminUser @@ -1106,19 +1393,15 @@ createAdminUser Setup -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### createAuthorization() ```ts -createAuthorization(input): CancelablePromise; +createAuthorization(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:2984](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L2984) +Defined in: [gen/CamundaClient.ts:3083](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3083) Create authorization @@ -1132,10 +1415,32 @@ Create the authorization. [`AuthorizationIdBasedRequest`](../type-aliases/AuthorizationIdBasedRequest.md) | [`AuthorizationPropertyBasedRequest`](../type-aliases/AuthorizationPropertyBasedRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`AuthorizationCreateResult`](../type-aliases/AuthorizationCreateResult.md)\> +#### Example + +```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}`); +} +``` + #### Operation Id createAuthorization @@ -1149,10 +1454,10 @@ Authorization ### createDeployment() ```ts -createDeployment(input): CancelablePromise; +createDeployment(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3047](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3047) +Defined in: [gen/CamundaClient.ts:3148](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3148) Deploy resources @@ -1167,6 +1472,10 @@ This is an atomic call, i.e. either all resources are deployed or none of them a [`createDeploymentInput`](../type-aliases/createDeploymentInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ExtendedDeploymentResult`](../interfaces/ExtendedDeploymentResult.md)\> @@ -1209,10 +1518,10 @@ Resource ### createDocument() ```ts -createDocument(input): CancelablePromise; +createDocument(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3127](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3127) +Defined in: [gen/CamundaClient.ts:3230](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3230) Upload document @@ -1228,6 +1537,10 @@ Note that this is currently supported for document stores of type: AWS, GCP, in- [`createDocumentInput`](../type-aliases/createDocumentInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DocumentReference`](../type-aliases/DocumentReference.md)\> @@ -1245,10 +1558,10 @@ Document ### createDocumentLink() ```ts -createDocumentLink(input): CancelablePromise; +createDocumentLink(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3190) +Defined in: [gen/CamundaClient.ts:3297](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3297) Create document link @@ -1264,15 +1577,36 @@ Note that this is currently supported for document stores of type: AWS, GCP [`createDocumentLinkInput`](../type-aliases/createDocumentLinkInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DocumentLink`](../type-aliases/DocumentLink.md)\> -#### Operation Id +#### Example -createDocumentLink +```ts +async function createDocumentLinkExample() { + const camunda = createCamundaClient(); -#### Tags + const documentId = DocumentId.assumeExists("doc-123"); + + const link = await camunda.createDocumentLink({ + documentId, + timeToLive: 3600000, + }); + + console.log(`Document link: ${link.url}`); +} +``` + +#### Operation Id + +createDocumentLink + +#### Tags Document @@ -1281,10 +1615,10 @@ Document ### createDocuments() ```ts -createDocuments(input): CancelablePromise; +createDocuments(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3267](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3267) +Defined in: [gen/CamundaClient.ts:3376](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3376) Upload multiple documents @@ -1312,6 +1646,10 @@ Note that this is currently supported for document stores of type: AWS, GCP, in- [`createDocumentsInput`](../type-aliases/createDocumentsInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DocumentCreationBatchResponse`](../type-aliases/DocumentCreationBatchResponse.md)\> @@ -1329,15 +1667,19 @@ Document ### createElementInstanceVariables() ```ts -createElementInstanceVariables(input): CancelablePromise; +createElementInstanceVariables(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3329](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3329) +Defined in: [gen/CamundaClient.ts:3446](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3446) 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. - @@ -1347,10 +1689,30 @@ Specify the element instance in the `elementInstanceKey` parameter. [`createElementInstanceVariablesInput`](../type-aliases/createElementInstanceVariablesInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function createElementInstanceVariablesExample() { + const camunda = createCamundaClient(); + + const elementInstanceKey = + ElementInstanceKey.assumeExists("2251799813685249"); + + await camunda.createElementInstanceVariables({ + elementInstanceKey, + variables: { orderId: "ORD-12345", status: "processing" }, + }); +} +``` + #### Operation Id createElementInstanceVariables @@ -1364,10 +1726,10 @@ Element instance ### createGlobalClusterVariable() ```ts -createGlobalClusterVariable(input): CancelablePromise; +createGlobalClusterVariable(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3389](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3389) +Defined in: [gen/CamundaClient.ts:3510](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3510) Create a global-scoped cluster variable @@ -1381,10 +1743,29 @@ Create a global-scoped cluster variable. [`CreateClusterVariableRequest`](../type-aliases/CreateClusterVariableRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ClusterVariableResult`](../type-aliases/ClusterVariableResult.md)\> +#### Example + +```ts +async function createGlobalClusterVariableExample() { + const camunda = createCamundaClient(); + + const result = await camunda.createGlobalClusterVariable({ + name: "feature-flags", + value: { darkMode: true }, + }); + + console.log(`Created: ${result.name}`); +} +``` + #### Operation Id createGlobalClusterVariable @@ -1395,13 +1776,67 @@ Cluster Variable --- +### createGlobalTaskListener() + +```ts +createGlobalTaskListener(input, options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:3572](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3572) + +Create global user task listener + +Create a new global user task listener. + +- + +#### Parameters + +##### input + +[`CreateGlobalTaskListenerRequest`](../type-aliases/CreateGlobalTaskListenerRequest.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GlobalTaskListenerResult`](../type-aliases/GlobalTaskListenerResult.md)\> + +#### Example + +```ts +async function createGlobalTaskListenerExample() { + const camunda = createCamundaClient(); + + const result = await camunda.createGlobalTaskListener({ + id: GlobalListenerId.assumeExists("audit-log-listener"), + eventTypes: ["completing"], + type: "audit-log-listener", + }); + + console.log(`Created listener: ${result.id}`); +} +``` + +#### Operation Id + +createGlobalTaskListener + +#### Tags + +Global listener + +--- + ### createGroup() ```ts -createGroup(input): CancelablePromise; +createGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3447](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3447) +Defined in: [gen/CamundaClient.ts:3634](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3634) Create group @@ -1415,10 +1850,29 @@ Create a new group. [`GroupCreateRequest`](../type-aliases/GroupCreateRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GroupCreateResult`](../type-aliases/GroupCreateResult.md)\> +#### Example + +```ts +async function createGroupExample() { + const camunda = createCamundaClient(); + + const result = await camunda.createGroup({ + groupId: "engineering-team", + name: "Engineering Team", + }); + + console.log(`Created group: ${result.groupId}`); +} +``` + #### Operation Id createGroup @@ -1435,7 +1889,7 @@ Group createJobWorker(cfg): JobWorker; ``` -Defined in: [gen/CamundaClient.ts:12362](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L12362) +Defined in: [gen/CamundaClient.ts:13694](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13694) Create a job worker that activates and processes jobs of the given type. @@ -1517,10 +1971,10 @@ async function jobWorkerWithErrorHandlingExample() { ### createMappingRule() ```ts -createMappingRule(input): CancelablePromise; +createMappingRule(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3506](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3506) +Defined in: [gen/CamundaClient.ts:3697](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3697) Create mapping rule @@ -1534,10 +1988,31 @@ Create a new mapping rule [`MappingRuleCreateRequest`](../type-aliases/MappingRuleCreateRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`MappingRuleCreateUpdateResult`](../type-aliases/MappingRuleCreateUpdateResult.md)\> +#### Example + +```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}`); +} +``` + #### Operation Id createMappingRule @@ -1551,10 +2026,10 @@ Mapping rule ### createProcessInstance() ```ts -createProcessInstance(input): CancelablePromise; +createProcessInstance(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3574](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3574) +Defined in: [gen/CamundaClient.ts:3767](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3767) Create process instance @@ -1571,191 +2046,11 @@ when awaitCompletion is enabled. ##### input -\{ -`awaitCompletion?`: `boolean`; -`fetchVariables?`: `string`[]; -`operationReference?`: `number`; -`processDefinitionId`: [`ProcessDefinitionId`](../type-aliases/ProcessDefinitionId.md); -`processDefinitionVersion?`: `number`; -`requestTimeout?`: `number`; -`runtimeInstructions?`: [`ProcessInstanceCreationRuntimeInstruction`](../type-aliases/ProcessInstanceCreationRuntimeInstruction.md)[]; -`startInstructions?`: [`ProcessInstanceCreationStartInstruction`](../type-aliases/ProcessInstanceCreationStartInstruction.md)[]; -`tags?`: [`TagSet`](../type-aliases/TagSet.md); -`tenantId?`: [`TenantId`](../type-aliases/TenantId.md); -`variables?`: \{ -\[`key`: `string`\]: `unknown`; -\}; -\} - -###### awaitCompletion? - -`boolean` - -Wait for the process instance to complete. If the process instance completion does -not occur within the requestTimeout, the request will be closed. This can lead to a 504 -response status. Disabled by default. - -###### fetchVariables? - -`string`[] - -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. - -###### operationReference? - -`number` - -###### processDefinitionId - -[`ProcessDefinitionId`](../type-aliases/ProcessDefinitionId.md) - -The BPMN process id of the process definition to start an instance of. - -###### processDefinitionVersion? - -`number` - -The version of the process. By default, the latest version of the process is used. - -###### requestTimeout? - -`number` - -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. - -###### runtimeInstructions? - -[`ProcessInstanceCreationRuntimeInstruction`](../type-aliases/ProcessInstanceCreationRuntimeInstruction.md)[] - -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. - -###### startInstructions? - -[`ProcessInstanceCreationStartInstruction`](../type-aliases/ProcessInstanceCreationStartInstruction.md)[] - -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. - -###### tags? - -[`TagSet`](../type-aliases/TagSet.md) - -###### tenantId? - -[`TenantId`](../type-aliases/TenantId.md) - -The tenant id of the process definition. - -###### variables? - -\{ -\[`key`: `string`\]: `unknown`; -\} - -JSON object that will instantiate the variables for the root variable scope -of the process instance. - -| - -\{ -`awaitCompletion?`: `boolean`; -`fetchVariables?`: `string`[]; -`operationReference?`: `number`; -`processDefinitionKey`: [`ProcessDefinitionKey`](../type-aliases/ProcessDefinitionKey.md); -`processDefinitionVersion?`: `number`; -`requestTimeout?`: `number`; -`runtimeInstructions?`: [`ProcessInstanceCreationRuntimeInstruction`](../type-aliases/ProcessInstanceCreationRuntimeInstruction.md)[]; -`startInstructions?`: [`ProcessInstanceCreationStartInstruction`](../type-aliases/ProcessInstanceCreationStartInstruction.md)[]; -`tags?`: [`TagSet`](../type-aliases/TagSet.md); -`tenantId?`: [`TenantId`](../type-aliases/TenantId.md); -`variables?`: \{ -\[`key`: `string`\]: `unknown`; -\}; -\} - -###### awaitCompletion? - -`boolean` - -Wait for the process instance to complete. If the process instance completion does -not occur within the requestTimeout, the request will be closed. This can lead to a 504 -response status. Disabled by default. - -###### fetchVariables? - -`string`[] - -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. - -###### operationReference? - -`number` - -###### processDefinitionKey - -[`ProcessDefinitionKey`](../type-aliases/ProcessDefinitionKey.md) - -The unique key identifying the process definition, for example, returned for a process in the -deploy resources endpoint. - -###### processDefinitionVersion? - -`number` - -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. - -###### requestTimeout? +[`ProcessInstanceCreationInstructionByKey`](../type-aliases/ProcessInstanceCreationInstructionByKey.md) | [`ProcessInstanceCreationInstructionById`](../type-aliases/ProcessInstanceCreationInstructionById.md) -`number` - -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. - -###### runtimeInstructions? - -[`ProcessInstanceCreationRuntimeInstruction`](../type-aliases/ProcessInstanceCreationRuntimeInstruction.md)[] - -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. - -###### startInstructions? - -[`ProcessInstanceCreationStartInstruction`](../type-aliases/ProcessInstanceCreationStartInstruction.md)[] - -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. - -###### tags? - -[`TagSet`](../type-aliases/TagSet.md) - -###### tenantId? - -[`TenantId`](../type-aliases/TenantId.md) - -The tenant id of the process definition. - -###### variables? - -\{ -\[`key`: `string`\]: `unknown`; -\} +##### options? -JSON object that will instantiate the variables for the root variable scope -of the process instance. +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns @@ -1812,10 +2107,10 @@ Process instance ### createRole() ```ts -createRole(input): CancelablePromise; +createRole(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3636](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3636) +Defined in: [gen/CamundaClient.ts:3833](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3833) Create role @@ -1829,10 +2124,29 @@ Create a new role. [`RoleCreateRequest`](../type-aliases/RoleCreateRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`RoleCreateResult`](../type-aliases/RoleCreateResult.md)\> +#### Example + +```ts +async function createRoleExample() { + const camunda = createCamundaClient(); + + const result = await camunda.createRole({ + roleId: "process-admin", + name: "Process Admin", + }); + + console.log(`Created role: ${result.roleId}`); +} +``` + #### Operation Id createRole @@ -1846,10 +2160,10 @@ Role ### createTenant() ```ts -createTenant(input): CancelablePromise; +createTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3694](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3694) +Defined in: [gen/CamundaClient.ts:3895](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3895) Create tenant @@ -1863,10 +2177,29 @@ Creates a new tenant. [`TenantCreateRequest`](../type-aliases/TenantCreateRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantCreateResult`](../type-aliases/TenantCreateResult.md)\> +#### Example + +```ts +async function createTenantExample() { + const camunda = createCamundaClient(); + + const result = await camunda.createTenant({ + tenantId: TenantId.assumeExists("customer-service"), + name: "Customer Service", + }); + + console.log(`Created tenant: ${result.tenantId}`); +} +``` + #### Operation Id createTenant @@ -1880,10 +2213,10 @@ Tenant ### createTenantClusterVariable() ```ts -createTenantClusterVariable(input): CancelablePromise; +createTenantClusterVariable(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3752](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3752) +Defined in: [gen/CamundaClient.ts:3957](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L3957) Create a tenant-scoped cluster variable @@ -1897,10 +2230,30 @@ Create a new cluster variable for the given tenant. [`createTenantClusterVariableInput`](../type-aliases/createTenantClusterVariableInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ClusterVariableResult`](../type-aliases/ClusterVariableResult.md)\> +#### Example + +```ts +async function createTenantClusterVariableExample() { + const camunda = createCamundaClient(); + + const result = await camunda.createTenantClusterVariable({ + tenantId: TenantId.assumeExists("customer-service"), + name: "config", + value: { region: "us-east-1" }, + }); + + console.log(`Created: ${result.name}`); +} +``` + #### Operation Id createTenantClusterVariable @@ -1911,59 +2264,71 @@ Cluster Variable --- -### createUser() +### createThreadedJobWorker() ```ts -createUser(input, consistencyManagement): CancelablePromise; +createThreadedJobWorker(cfg): ThreadedJobWorker; ``` -Defined in: [gen/CamundaClient.ts:3813](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3813) +Defined in: [gen/CamundaClient.ts:13723](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13723) -Create user +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`. -Create a new user. +This keeps the main event loop free for polling and I/O, dramatically improving +throughput for CPU-bound job handlers. -- +#### Type Parameters -#### Parameters +##### In -##### input +`In` _extends_ `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> = `any` -[`UserRequest`](../type-aliases/UserRequest.md) +##### Out -##### consistencyManagement +`Out` _extends_ `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> = `any` -[`createUserConsistency`](../type-aliases/createUserConsistency.md) +##### Headers -#### Returns +`Headers` _extends_ `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\> = `any` -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`UserCreateResult`](../type-aliases/UserCreateResult.md)\> +#### Parameters -#### Operation Id +##### cfg -createUser +[`ThreadedJobWorkerConfig`](../interfaces/ThreadedJobWorkerConfig.md)\<`In`, `Out`, `Headers`\> -#### Tags +Threaded worker configuration -User +#### Returns -#### Consistency +[`ThreadedJobWorker`](../interfaces/ThreadedJobWorker.md) -eventual - this endpoint is backed by data that is eventually consistent with the system state. +#### Example + +```ts +const worker = client.createThreadedJobWorker({ + jobType: "cpu-heavy-task", + handlerModule: "./my-handler.js", + maxParallelJobs: 32, + jobTimeoutMs: 30000, +}); +``` --- -### deleteAuthorization() +### createUser() ```ts -deleteAuthorization(input): CancelablePromise; +createUser(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3875](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3875) +Defined in: [gen/CamundaClient.ts:4021](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4021) -Delete authorization +Create user -Deletes the authorization with the given key. +Create a new user. - @@ -1971,33 +2336,54 @@ Deletes the authorization with the given key. ##### input -[`deleteAuthorizationInput`](../type-aliases/deleteAuthorizationInput.md) +[`UserRequest`](../type-aliases/UserRequest.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`UserCreateResult`](../type-aliases/UserCreateResult.md)\> + +#### Example + +```ts +async function createUserExample() { + const camunda = createCamundaClient(); + + const result = await camunda.createUser({ + username: Username.assumeExists("alice"), + name: "Alice Smith", + email: "alice@example.com", + password: "secure-password-123", + }); + + console.log(`Created user: ${result.username}`); +} +``` #### Operation Id -deleteAuthorization +createUser #### Tags -Authorization +User --- -### deleteDecisionInstance() +### deleteAuthorization() ```ts -deleteDecisionInstance(input, consistencyManagement): CancelablePromise; +deleteAuthorization(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:3934](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L3934) +Defined in: [gen/CamundaClient.ts:4083](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4083) -Delete decision instance +Delete authorization -Delete all associated decision evaluations based on provided key. +Deletes the authorization with the given key. - @@ -2005,42 +2391,49 @@ Delete all associated decision evaluations based on provided key. ##### input -`object` & `object` +[`deleteAuthorizationInput`](../type-aliases/deleteAuthorizationInput.md) -##### consistencyManagement +##### options? -[`deleteDecisionInstanceConsistency`](../type-aliases/deleteDecisionInstanceConsistency.md) +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> -#### Operation Id +#### Example -deleteDecisionInstance +```ts +async function deleteAuthorizationExample() { + const camunda = createCamundaClient(); -#### Tags + const authorizationKey = AuthorizationKey.assumeExists("2251799813685249"); -Decision instance + await camunda.deleteAuthorization({ authorizationKey }); +} +``` -#### Consistency +#### Operation Id -eventual - this endpoint is backed by data that is eventually consistent with the system state. +deleteAuthorization + +#### Tags + +Authorization --- -### deleteDecisionInstancesBatchOperation() +### deleteDecisionInstance() ```ts -deleteDecisionInstancesBatchOperation(input, consistencyManagement): CancelablePromise; +deleteDecisionInstance(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4001](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4001) +Defined in: [gen/CamundaClient.ts:4145](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4145) -Delete decision instances (batch) +Delete decision instance -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}). +Delete all associated decision evaluations based on provided key. - @@ -2048,162 +2441,155 @@ This is done asynchronously, the progress can be tracked using the batchOperatio ##### input -###### filter - -\{ -`decisionDefinitionId?`: [`DecisionDefinitionId`](../type-aliases/DecisionDefinitionId.md); -`decisionDefinitionKey?`: [`DecisionDefinitionKeyFilterProperty`](../type-aliases/DecisionDefinitionKeyFilterProperty.md); -`decisionDefinitionName?`: `string`; -`decisionDefinitionType?`: [`DecisionDefinitionTypeEnum`](../type-aliases/DecisionDefinitionTypeEnum.md); -`decisionDefinitionVersion?`: `number`; -`decisionEvaluationInstanceKey?`: [`DecisionEvaluationInstanceKeyFilterProperty`](../type-aliases/DecisionEvaluationInstanceKeyFilterProperty.md); -`decisionEvaluationKey?`: [`DecisionEvaluationKey`](../type-aliases/DecisionEvaluationKey.md); -`decisionRequirementsKey?`: [`DecisionRequirementsKeyFilterProperty`](../type-aliases/DecisionRequirementsKeyFilterProperty.md); -`elementInstanceKey?`: [`ElementInstanceKeyFilterProperty`](../type-aliases/ElementInstanceKeyFilterProperty.md); -`evaluationDate?`: [`DateTimeFilterProperty`](../type-aliases/DateTimeFilterProperty.md); -`evaluationFailure?`: `string`; -`processDefinitionKey?`: [`ProcessDefinitionKey`](../type-aliases/ProcessDefinitionKey.md); -`processInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`rootDecisionDefinitionKey?`: [`DecisionDefinitionKeyFilterProperty`](../type-aliases/DecisionDefinitionKeyFilterProperty.md); -`state?`: [`DecisionInstanceStateFilterProperty`](../type-aliases/DecisionInstanceStateFilterProperty.md); -`tenantId?`: [`TenantId`](../type-aliases/TenantId.md); -\} - -Decision instance search filter. +`object` & `object` -###### filter.decisionDefinitionId? +##### options? -[`DecisionDefinitionId`](../type-aliases/DecisionDefinitionId.md) +[`OperationOptions`](../interfaces/OperationOptions.md) -The ID of the DMN decision. +#### Returns -###### filter.decisionDefinitionKey? +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> -[`DecisionDefinitionKeyFilterProperty`](../type-aliases/DecisionDefinitionKeyFilterProperty.md) +#### Example -The key of the decision. +```ts +async function deleteDecisionInstanceExample() { + const camunda = createCamundaClient(); -###### filter.decisionDefinitionName? + const decisionEvaluationKey = + DecisionEvaluationKey.assumeExists("2251799813685249"); -`string` + await camunda.deleteDecisionInstance({ decisionEvaluationKey }); +} +``` -The name of the DMN decision. +#### Operation Id -###### filter.decisionDefinitionType? +deleteDecisionInstance -[`DecisionDefinitionTypeEnum`](../type-aliases/DecisionDefinitionTypeEnum.md) +#### Tags -###### filter.decisionDefinitionVersion? +Decision instance -`number` +--- -The version of the decision. +### deleteDecisionInstancesBatchOperation() -###### filter.decisionEvaluationInstanceKey? +```ts +deleteDecisionInstancesBatchOperation(input, options?): CancelablePromise; +``` -[`DecisionEvaluationInstanceKeyFilterProperty`](../type-aliases/DecisionEvaluationInstanceKeyFilterProperty.md) +Defined in: [gen/CamundaClient.ts:4211](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4211) -The key of the decision evaluation instance. +Delete decision instances (batch) -###### filter.decisionEvaluationKey? +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}). -[`DecisionEvaluationKey`](../type-aliases/DecisionEvaluationKey.md) +- -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. +#### Parameters -###### filter.decisionRequirementsKey? +##### input -[`DecisionRequirementsKeyFilterProperty`](../type-aliases/DecisionRequirementsKeyFilterProperty.md) +[`DecisionInstanceDeletionBatchOperationRequest`](../type-aliases/DecisionInstanceDeletionBatchOperationRequest.md) -The key of the decision requirements definition. +##### options? -###### filter.elementInstanceKey? +[`OperationOptions`](../interfaces/OperationOptions.md) -[`ElementInstanceKeyFilterProperty`](../type-aliases/ElementInstanceKeyFilterProperty.md) +#### Returns -The key of the element instance this decision instance is linked to. +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> -###### filter.evaluationDate? +#### Example -[`DateTimeFilterProperty`](../type-aliases/DateTimeFilterProperty.md) +```ts +async function deleteDecisionInstancesBatchOperationExample() { + const camunda = createCamundaClient(); -The evaluation date of the decision instance. + const result = await camunda.deleteDecisionInstancesBatchOperation({ + filter: {}, + }); -###### filter.evaluationFailure? + console.log(`Batch operation key: ${result.batchOperationKey}`); +} +``` -`string` +#### Operation Id -The evaluation failure of the decision instance. +deleteDecisionInstancesBatchOperation -###### filter.processDefinitionKey? +#### Tags -[`ProcessDefinitionKey`](../type-aliases/ProcessDefinitionKey.md) +Decision instance -The key of the process definition. +--- -###### filter.processInstanceKey? +### deleteDocument() -[`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md) +```ts +deleteDocument(input, options?): CancelablePromise; +``` -The key of the process instance. +Defined in: [gen/CamundaClient.ts:4276](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4276) -###### filter.rootDecisionDefinitionKey? +Delete document -[`DecisionDefinitionKeyFilterProperty`](../type-aliases/DecisionDefinitionKeyFilterProperty.md) +Delete a document from the Camunda 8 cluster. -The key of the root decision definition. +Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) -###### filter.state? +- -[`DecisionInstanceStateFilterProperty`](../type-aliases/DecisionInstanceStateFilterProperty.md) +#### Parameters -The state of the decision instance. +##### input -###### filter.tenantId? +[`deleteDocumentInput`](../type-aliases/deleteDocumentInput.md) -[`TenantId`](../type-aliases/TenantId.md) +##### options? -The tenant ID of the decision instance. +[`OperationOptions`](../interfaces/OperationOptions.md) -###### operationReference? +#### Returns -`number` +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> -##### consistencyManagement +#### Example -[`deleteDecisionInstancesBatchOperationConsistency`](../type-aliases/deleteDecisionInstancesBatchOperationConsistency.md) +```ts +async function deleteDocumentExample() { + const camunda = createCamundaClient(); -#### Returns + const documentId = DocumentId.assumeExists("doc-123"); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> + await camunda.deleteDocument({ documentId }); +} +``` #### Operation Id -deleteDecisionInstancesBatchOperation +deleteDocument #### Tags -Decision instance - -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. +Document --- -### deleteDocument() +### deleteGlobalClusterVariable() ```ts -deleteDocument(input): CancelablePromise; +deleteGlobalClusterVariable(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4066](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4066) - -Delete document +Defined in: [gen/CamundaClient.ts:4340](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4340) -Delete a document from the Camunda 8 cluster. +Delete a global-scoped cluster variable -Note that this is currently supported for document stores of type: AWS, GCP, in-memory (non-production), local (non-production) +Delete a global-scoped cluster variable. - @@ -2211,33 +2597,47 @@ Note that this is currently supported for document stores of type: AWS, GCP, in- ##### input -[`deleteDocumentInput`](../type-aliases/deleteDocumentInput.md) +[`deleteGlobalClusterVariableInput`](../type-aliases/deleteGlobalClusterVariableInput.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function deleteGlobalClusterVariableExample() { + const camunda = createCamundaClient(); + + await camunda.deleteGlobalClusterVariable({ name: "feature-flags" }); +} +``` + #### Operation Id -deleteDocument +deleteGlobalClusterVariable #### Tags -Document +Cluster Variable --- -### deleteGlobalClusterVariable() +### deleteGlobalTaskListener() ```ts -deleteGlobalClusterVariable(input): CancelablePromise; +deleteGlobalTaskListener(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4126](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4126) +Defined in: [gen/CamundaClient.ts:4402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4402) -Delete a global-scoped cluster variable +Delete global user task listener -Delete a global-scoped cluster variable. +Deletes a global user task listener. - @@ -2245,29 +2645,45 @@ Delete a global-scoped cluster variable. ##### input -[`deleteGlobalClusterVariableInput`](../type-aliases/deleteGlobalClusterVariableInput.md) +[`deleteGlobalTaskListenerInput`](../type-aliases/deleteGlobalTaskListenerInput.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function deleteGlobalTaskListenerExample() { + const camunda = createCamundaClient(); + + await camunda.deleteGlobalTaskListener({ + id: GlobalListenerId.assumeExists("listener-123"), + }); +} +``` + #### Operation Id -deleteGlobalClusterVariable +deleteGlobalTaskListener #### Tags -Cluster Variable +Global listener --- ### deleteGroup() ```ts -deleteGroup(input): CancelablePromise; +deleteGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4184](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4184) +Defined in: [gen/CamundaClient.ts:4464](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4464) Delete group @@ -2281,10 +2697,24 @@ Deletes the group with the given ID. [`deleteGroupInput`](../type-aliases/deleteGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function deleteGroupExample() { + const camunda = createCamundaClient(); + + await camunda.deleteGroup({ groupId: "engineering-team" }); +} +``` + #### Operation Id deleteGroup @@ -2298,10 +2728,10 @@ Group ### deleteMappingRule() ```ts -deleteMappingRule(input): CancelablePromise; +deleteMappingRule(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4243](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4243) +Defined in: [gen/CamundaClient.ts:4527](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4527) Delete a mapping rule @@ -2315,10 +2745,24 @@ Deletes the mapping rule with the given ID. [`deleteMappingRuleInput`](../type-aliases/deleteMappingRuleInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function deleteMappingRuleExample() { + const camunda = createCamundaClient(); + + await camunda.deleteMappingRule({ mappingRuleId: "ldap-group-mapping" }); +} +``` + #### Operation Id deleteMappingRule @@ -2332,10 +2776,10 @@ Mapping rule ### deleteProcessInstance() ```ts -deleteProcessInstance(input, consistencyManagement): CancelablePromise; +deleteProcessInstance(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4302](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4302) +Defined in: [gen/CamundaClient.ts:4589](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4589) Delete process instance @@ -2349,14 +2793,27 @@ Deletes a process instance. Only instances that are completed or terminated can `object` & `object` -##### consistencyManagement +##### options? -[`deleteProcessInstanceConsistency`](../type-aliases/deleteProcessInstanceConsistency.md) +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function deleteProcessInstanceExample() { + const camunda = createCamundaClient(); + + const processInstanceKey = + ProcessInstanceKey.assumeExists("2251799813685249"); + + await camunda.deleteProcessInstance({ processInstanceKey }); +} +``` + #### Operation Id deleteProcessInstance @@ -2365,19 +2822,15 @@ deleteProcessInstance Process instance -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### deleteProcessInstancesBatchOperation() ```ts -deleteProcessInstancesBatchOperation(input, consistencyManagement): CancelablePromise; +deleteProcessInstancesBatchOperation(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4370](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4370) +Defined in: [gen/CamundaClient.ts:4656](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4656) Delete process instances (batch) @@ -2391,23 +2844,32 @@ This is done asynchronously, the progress can be tracked using the batchOperatio ##### input -###### filter +[`ProcessInstanceDeletionBatchOperationRequest`](../type-aliases/ProcessInstanceDeletionBatchOperationRequest.md) -[`ProcessInstanceFilter`](../type-aliases/ProcessInstanceFilter.md) +##### options? -The process instance filter. +[`OperationOptions`](../interfaces/OperationOptions.md) -###### operationReference? +#### Returns -`number` +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> -##### consistencyManagement +#### Example -[`deleteProcessInstancesBatchOperationConsistency`](../type-aliases/deleteProcessInstancesBatchOperationConsistency.md) +```ts +async function deleteProcessInstancesBatchOperationExample() { + const camunda = createCamundaClient(); -#### Returns + const result = await camunda.deleteProcessInstancesBatchOperation({ + filter: { + processDefinitionKey: + ProcessDefinitionKey.assumeExists("2251799813685249"), + }, + }); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> + console.log(`Batch operation key: ${result.batchOperationKey}`); +} +``` #### Operation Id @@ -2417,19 +2879,15 @@ deleteProcessInstancesBatchOperation Process instance -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### deleteResource() ```ts -deleteResource(input): CancelablePromise; +deleteResource(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4446](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4446) +Defined in: [gen/CamundaClient.ts:4730](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4730) Delete resource @@ -2455,6 +2913,10 @@ will be deleted. `object` & `object` +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DeleteResourceResponse`](../type-aliases/DeleteResourceResponse.md)\> @@ -2487,10 +2949,10 @@ Resource ### deleteRole() ```ts -deleteRole(input): CancelablePromise; +deleteRole(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4506](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4506) +Defined in: [gen/CamundaClient.ts:4794](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4794) Delete role @@ -2504,10 +2966,24 @@ Deletes the role with the given ID. [`deleteRoleInput`](../type-aliases/deleteRoleInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function deleteRoleExample() { + const camunda = createCamundaClient(); + + await camunda.deleteRole({ roleId: "process-admin" }); +} +``` + #### Operation Id deleteRole @@ -2521,10 +2997,10 @@ Role ### deleteTenant() ```ts -deleteTenant(input): CancelablePromise; +deleteTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4564](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4564) +Defined in: [gen/CamundaClient.ts:4856](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4856) Delete tenant @@ -2538,10 +3014,26 @@ Deletes an existing tenant. [`deleteTenantInput`](../type-aliases/deleteTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function deleteTenantExample() { + const camunda = createCamundaClient(); + + const tenantId = TenantId.assumeExists("customer-service"); + + await camunda.deleteTenant({ tenantId }); +} +``` + #### Operation Id deleteTenant @@ -2555,10 +3047,10 @@ Tenant ### deleteTenantClusterVariable() ```ts -deleteTenantClusterVariable(input): CancelablePromise; +deleteTenantClusterVariable(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4622) +Defined in: [gen/CamundaClient.ts:4918](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4918) Delete a tenant-scoped cluster variable @@ -2572,13 +3064,30 @@ Delete a tenant-scoped cluster variable. [`deleteTenantClusterVariableInput`](../type-aliases/deleteTenantClusterVariableInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> -#### Operation Id - -deleteTenantClusterVariable +#### Example + +```ts +async function deleteTenantClusterVariableExample() { + const camunda = createCamundaClient(); + + await camunda.deleteTenantClusterVariable({ + tenantId: TenantId.assumeExists("customer-service"), + name: "config", + }); +} +``` + +#### Operation Id + +deleteTenantClusterVariable #### Tags @@ -2589,10 +3098,10 @@ Cluster Variable ### deleteUser() ```ts -deleteUser(input, consistencyManagement): CancelablePromise; +deleteUser(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4681](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4681) +Defined in: [gen/CamundaClient.ts:4980](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L4980) Delete user @@ -2606,14 +3115,26 @@ Deletes a user. [`deleteUserInput`](../type-aliases/deleteUserInput.md) -##### consistencyManagement +##### options? -[`deleteUserConsistency`](../type-aliases/deleteUserConsistency.md) +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function deleteUserExample() { + const camunda = createCamundaClient(); + + const username = Username.assumeExists("alice"); + + await camunda.deleteUser({ username }); +} +``` + #### Operation Id deleteUser @@ -2622,10 +3143,6 @@ deleteUser User -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### deployResourcesFromFiles() @@ -2634,7 +3151,7 @@ eventual - this endpoint is backed by data that is eventually consistent with th deployResourcesFromFiles(resourceFilenames, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:12378](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L12378) +Defined in: [gen/CamundaClient.ts:13740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13740) Node-only convenience: deploy resources from local filesystem paths. @@ -2668,7 +3185,7 @@ ExtendedDeploymentResult emitSupportLogPreamble(): void; ``` -Defined in: [gen/CamundaClient.ts:1468](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1468) +Defined in: [gen/CamundaClient.ts:1474](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1474) Emit the standard support log preamble & redacted configuration to the current support logger. Safe to call multiple times; subsequent calls are ignored (idempotent). @@ -2683,10 +3200,10 @@ Useful when a custom supportLogger was injected and you still want the canonical ### evaluateConditionals() ```ts -evaluateConditionals(input): CancelablePromise; +evaluateConditionals(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4746](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4746) +Defined in: [gen/CamundaClient.ts:5045](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5045) Evaluate root level conditional start events @@ -2702,10 +3219,29 @@ Multiple root-level conditional start events of the same process definition can [`ConditionalEvaluationInstruction`](../type-aliases/ConditionalEvaluationInstruction.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`EvaluateConditionalResult`](../type-aliases/EvaluateConditionalResult.md)\> +#### Example + +```ts +async function evaluateConditionalsExample() { + const camunda = createCamundaClient(); + + const result = await camunda.evaluateConditionals({ + variables: { orderReady: true }, + tenantId: TenantId.assumeExists("customer-service"), + }); + + console.log(`Evaluated conditionals: ${JSON.stringify(result)}`); +} +``` + #### Operation Id evaluateConditionals @@ -2719,10 +3255,10 @@ Conditional ### evaluateDecision() ```ts -evaluateDecision(input): CancelablePromise; +evaluateDecision(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4816](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4816) +Defined in: [gen/CamundaClient.ts:5117](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5117) Evaluate decision @@ -2739,6 +3275,10 @@ version of the decision is used. [`DecisionEvaluationById`](../type-aliases/DecisionEvaluationById.md) | [`DecisionEvaluationByKey`](../type-aliases/DecisionEvaluationByKey.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`EvaluateDecisionResult`](../type-aliases/EvaluateDecisionResult.md)\> @@ -2796,10 +3336,10 @@ Decision definition ### evaluateExpression() ```ts -evaluateExpression(input): CancelablePromise; +evaluateExpression(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4878](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4878) +Defined in: [gen/CamundaClient.ts:5183](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5183) Evaluate an expression @@ -2813,10 +3353,29 @@ Evaluates a FEEL expression and returns the result. Supports references to tenan [`ExpressionEvaluationRequest`](../type-aliases/ExpressionEvaluationRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ExpressionEvaluationResult`](../type-aliases/ExpressionEvaluationResult.md)\> +#### Example + +```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}`); +} +``` + #### Operation Id evaluateExpression @@ -2830,10 +3389,10 @@ Expression ### failJob() ```ts -failJob(input): CancelablePromise; +failJob(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:4943](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L4943) +Defined in: [gen/CamundaClient.ts:5250](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5250) Fail job @@ -2847,6 +3406,10 @@ Mark the job as failed. [`failJobInput`](../type-aliases/failJobInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> @@ -2884,7 +3447,7 @@ Job forceAuthRefresh(): Promise; ``` -Defined in: [gen/CamundaClient.ts:1435](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1435) +Defined in: [gen/CamundaClient.ts:1441](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1441) #### Returns @@ -2895,42 +3458,13 @@ Defined in: [gen/CamundaClient.ts:1435](https://github.com/camunda/orchestration ### getAuditLog() ```ts -getAuditLog(input, consistencyManagement): CancelablePromise<{ - actorId?: string; - actorType?: AuditLogActorTypeEnum; - annotation?: string; - auditLogKey?: AuditLogKey; - batchOperationKey?: BatchOperationKey; - batchOperationType?: BatchOperationTypeEnum; - category?: AuditLogCategoryEnum; - decisionDefinitionId?: DecisionDefinitionId; - decisionDefinitionKey?: DecisionDefinitionKey; - decisionEvaluationKey?: DecisionEvaluationKey; - decisionRequirementsId?: string; - decisionRequirementsKey?: DecisionRequirementsKey; - deploymentKey?: DeploymentKey; - elementInstanceKey?: ElementInstanceKey; - entityDescription?: string; - entityKey?: AuditLogEntityKey; - entityType?: AuditLogEntityTypeEnum; - formKey?: FormKey; - jobKey?: JobKey; - operationType?: AuditLogOperationTypeEnum; - processDefinitionId?: ProcessDefinitionId; - processDefinitionKey?: ProcessDefinitionKey; - processInstanceKey?: ProcessInstanceKey; - relatedEntityKey?: AuditLogEntityKey; - relatedEntityType?: AuditLogEntityTypeEnum; - resourceKey?: ResourceKey; - result?: AuditLogResultEnum; - rootProcessInstanceKey?: ProcessInstanceKey; - tenantId?: TenantId; - timestamp?: string; - userTaskKey?: UserTaskKey; -}>; +getAuditLog( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5004](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5004) +Defined in: [gen/CamundaClient.ts:5315](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5315) Get audit log @@ -2948,41 +3482,31 @@ Get an audit log entry by auditLogKey. [`getAuditLogConsistency`](../type-aliases/getAuditLogConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`actorId?`: `string`; -`actorType?`: [`AuditLogActorTypeEnum`](../type-aliases/AuditLogActorTypeEnum.md); -`annotation?`: `string`; -`auditLogKey?`: [`AuditLogKey`](../type-aliases/AuditLogKey.md); -`batchOperationKey?`: [`BatchOperationKey`](../type-aliases/BatchOperationKey.md); -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); -`category?`: [`AuditLogCategoryEnum`](../type-aliases/AuditLogCategoryEnum.md); -`decisionDefinitionId?`: [`DecisionDefinitionId`](../type-aliases/DecisionDefinitionId.md); -`decisionDefinitionKey?`: [`DecisionDefinitionKey`](../type-aliases/DecisionDefinitionKey.md); -`decisionEvaluationKey?`: [`DecisionEvaluationKey`](../type-aliases/DecisionEvaluationKey.md); -`decisionRequirementsId?`: `string`; -`decisionRequirementsKey?`: [`DecisionRequirementsKey`](../type-aliases/DecisionRequirementsKey.md); -`deploymentKey?`: [`DeploymentKey`](../type-aliases/DeploymentKey.md); -`elementInstanceKey?`: [`ElementInstanceKey`](../type-aliases/ElementInstanceKey.md); -`entityDescription?`: `string`; -`entityKey?`: [`AuditLogEntityKey`](../type-aliases/AuditLogEntityKey.md); -`entityType?`: [`AuditLogEntityTypeEnum`](../type-aliases/AuditLogEntityTypeEnum.md); -`formKey?`: [`FormKey`](../type-aliases/FormKey.md); -`jobKey?`: [`JobKey`](../type-aliases/JobKey.md); -`operationType?`: [`AuditLogOperationTypeEnum`](../type-aliases/AuditLogOperationTypeEnum.md); -`processDefinitionId?`: [`ProcessDefinitionId`](../type-aliases/ProcessDefinitionId.md); -`processDefinitionKey?`: [`ProcessDefinitionKey`](../type-aliases/ProcessDefinitionKey.md); -`processInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`relatedEntityKey?`: [`AuditLogEntityKey`](../type-aliases/AuditLogEntityKey.md); -`relatedEntityType?`: [`AuditLogEntityTypeEnum`](../type-aliases/AuditLogEntityTypeEnum.md); -`resourceKey?`: [`ResourceKey`](../type-aliases/ResourceKey.md); -`result?`: [`AuditLogResultEnum`](../type-aliases/AuditLogResultEnum.md); -`rootProcessInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`tenantId?`: [`TenantId`](../type-aliases/TenantId.md); -`timestamp?`: `string`; -`userTaskKey?`: [`UserTaskKey`](../type-aliases/UserTaskKey.md); -\}\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`AuditLogResult`](../type-aliases/AuditLogResult.md)\> + +#### Example + +```ts +async function getAuditLogExample() { + const camunda = createCamundaClient(); + + const { AuditLogKey } = await import("@camunda8/orchestration-cluster-api"); + const auditLogKey = AuditLogKey.assumeExists("2251799813685249"); + + const log = await camunda.getAuditLog( + { auditLogKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Audit log: ${log.operationType}`); +} +``` #### Operation Id @@ -3001,10 +3525,10 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getAuthentication() ```ts -getAuthentication(): CancelablePromise; +getAuthentication(options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5066](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5066) +Defined in: [gen/CamundaClient.ts:5381](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5381) Get current user @@ -3012,10 +3536,28 @@ Retrieves the current authenticated user. - +#### Parameters + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`CamundaUserResult`](../type-aliases/CamundaUserResult.md)\> +#### Example + +```ts +async function getAuthenticationExample() { + const camunda = createCamundaClient(); + + const user = await camunda.getAuthentication(); + + console.log(`Authenticated as: ${user.username}`); +} +``` + #### Operation Id getAuthentication @@ -3032,7 +3574,7 @@ Authentication getAuthHeaders(): Promise>; ``` -Defined in: [gen/CamundaClient.ts:1432](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1432) +Defined in: [gen/CamundaClient.ts:1438](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1438) #### Returns @@ -3043,10 +3585,13 @@ Defined in: [gen/CamundaClient.ts:1432](https://github.com/camunda/orchestration ### getAuthorization() ```ts -getAuthorization(input, consistencyManagement): CancelablePromise; +getAuthorization( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5116](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5116) +Defined in: [gen/CamundaClient.ts:5434](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5434) Get authorization @@ -3064,10 +3609,31 @@ Get authorization by the given key. [`getAuthorizationConsistency`](../type-aliases/getAuthorizationConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`AuthorizationResult`](../type-aliases/AuthorizationResult.md)\> +#### Example + +```ts +async function getAuthorizationExample() { + const camunda = createCamundaClient(); + + const authorizationKey = AuthorizationKey.assumeExists("2251799813685249"); + + const authorization = await camunda.getAuthorization( + { authorizationKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Owner: ${authorization.ownerId} (${authorization.ownerType})`); +} +``` + #### Operation Id getAuthorization @@ -3087,6 +3653,7 @@ eventual - this endpoint is backed by data that is eventually consistent with th ```ts getBackpressureState(): | { + backoffMs: number; consecutive: number; permitsCurrent: number; permitsMax: number | null; @@ -3102,13 +3669,14 @@ getBackpressureState(): }; ``` -Defined in: [gen/CamundaClient.ts:1537](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1537) +Defined in: [gen/CamundaClient.ts:1556](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1556) Public accessor for current backpressure adaptive limiter state (stable) #### Returns \| \{ +`backoffMs`: `number`; `consecutive`: `number`; `permitsCurrent`: `number`; `permitsMax`: `number` \| `null`; @@ -3128,10 +3696,13 @@ Public accessor for current backpressure adaptive limiter state (stable) ### getBatchOperation() ```ts -getBatchOperation(input, consistencyManagement): CancelablePromise; +getBatchOperation( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5179](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5179) +Defined in: [gen/CamundaClient.ts:5501](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5501) Get batch operation @@ -3149,10 +3720,31 @@ Get batch operation by key. [`getBatchOperationConsistency`](../type-aliases/getBatchOperationConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationResponse`](../type-aliases/BatchOperationResponse.md)\> +#### Example + +```ts +async function getBatchOperationExample() { + const camunda = createCamundaClient(); + + const batchOperationKey = BatchOperationKey.assumeExists("2251799813685249"); + + const batch = await camunda.getBatchOperation( + { batchOperationKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Batch: ${batch.batchOperationType} (${batch.state})`); +} +``` + #### Operation Id getBatchOperation @@ -3173,7 +3765,7 @@ eventual - this endpoint is backed by data that is eventually consistent with th getConfig(): Readonly; ``` -Defined in: [gen/CamundaClient.ts:1337](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1337) +Defined in: [gen/CamundaClient.ts:1341](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1341) Read-only snapshot of current hydrated configuration (do not mutate directly). Use configure(...) to apply changes. @@ -3187,10 +3779,13 @@ Use configure(...) to apply changes. ### getDecisionDefinition() ```ts -getDecisionDefinition(input, consistencyManagement): CancelablePromise; +getDecisionDefinition( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5244](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5244) +Defined in: [gen/CamundaClient.ts:5568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5568) Get decision definition @@ -3208,6 +3803,10 @@ Returns a decision definition by key. [`getDecisionDefinitionConsistency`](../type-aliases/getDecisionDefinitionConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DecisionDefinitionResult`](../type-aliases/DecisionDefinitionResult.md)\> @@ -3248,10 +3847,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getDecisionDefinitionXml() ```ts -getDecisionDefinitionXml(input, consistencyManagement): CancelablePromise; +getDecisionDefinitionXml( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5307](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5307) +Defined in: [gen/CamundaClient.ts:5633](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5633) Get decision definition XML @@ -3269,6 +3871,10 @@ Returns decision definition as XML. [`getDecisionDefinitionXmlConsistency`](../type-aliases/getDecisionDefinitionXmlConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`string`\> @@ -3290,10 +3896,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getDecisionInstance() ```ts -getDecisionInstance(input, consistencyManagement): CancelablePromise; +getDecisionInstance( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5370](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5370) +Defined in: [gen/CamundaClient.ts:5700](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5700) Get decision instance @@ -3311,9 +3920,31 @@ Returns a decision instance. [`getDecisionInstanceConsistency`](../type-aliases/getDecisionInstanceConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`object` & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DecisionInstanceGetQueryResult`](../type-aliases/DecisionInstanceGetQueryResult.md)\> + +#### Example + +```ts +async function getDecisionInstanceExample() { + const camunda = createCamundaClient(); + + const decisionEvaluationInstanceKey = + DecisionEvaluationInstanceKey.assumeExists("2251799813685249"); + + const instance = await camunda.getDecisionInstance( + { decisionEvaluationInstanceKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Decision: ${instance.decisionDefinitionId}`); +} +``` #### Operation Id @@ -3332,10 +3963,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getDecisionRequirements() ```ts -getDecisionRequirements(input, consistencyManagement): CancelablePromise; +getDecisionRequirements( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5433](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5433) +Defined in: [gen/CamundaClient.ts:5767](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5767) Get decision requirements @@ -3353,10 +3987,32 @@ Returns Decision Requirements as JSON. [`getDecisionRequirementsConsistency`](../type-aliases/getDecisionRequirementsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DecisionRequirementsResult`](../type-aliases/DecisionRequirementsResult.md)\> +#### Example + +```ts +async function getDecisionRequirementsExample() { + const camunda = createCamundaClient(); + + const decisionRequirementsKey = + DecisionRequirementsKey.assumeExists("2251799813685249"); + + const requirements = await camunda.getDecisionRequirements( + { decisionRequirementsKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Requirements: ${requirements.decisionRequirementsId}`); +} +``` + #### Operation Id getDecisionRequirements @@ -3374,10 +4030,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getDecisionRequirementsXml() ```ts -getDecisionRequirementsXml(input, consistencyManagement): CancelablePromise; +getDecisionRequirementsXml( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5496](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5496) +Defined in: [gen/CamundaClient.ts:5832](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5832) Get decision requirements XML @@ -3395,6 +4054,10 @@ Returns decision requirements as XML. [`getDecisionRequirementsXmlConsistency`](../type-aliases/getDecisionRequirementsXmlConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`string`\> @@ -3416,10 +4079,10 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getDocument() ```ts -getDocument(input): CancelablePromise; +getDocument(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5561](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5561) +Defined in: [gen/CamundaClient.ts:5899](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5899) Download document @@ -3435,6 +4098,10 @@ Note that this is currently supported for document stores of type: AWS, GCP, in- [`getDocumentInput`](../type-aliases/getDocumentInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`Blob`\> @@ -3452,51 +4119,13 @@ Document ### getElementInstance() ```ts -getElementInstance(input, consistencyManagement): CancelablePromise<{ - elementId: ElementId; - elementInstanceKey: ElementInstanceKey; - elementName: string; - endDate?: string; - hasIncident: boolean; - incidentKey?: IncidentKey; - processDefinitionId: ProcessDefinitionId; - processDefinitionKey: ProcessDefinitionKey; - processInstanceKey: ProcessInstanceKey; - rootProcessInstanceKey?: ProcessInstanceKey; - startDate: string; - state: ElementInstanceStateEnum; - tenantId: TenantId; - type: | "USER_TASK" - | "UNKNOWN" - | "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" - | "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"; -}>; +getElementInstance( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5622) +Defined in: [gen/CamundaClient.ts:5964](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L5964) Get element instance @@ -3514,50 +4143,31 @@ Returns element instance as JSON. [`getElementInstanceConsistency`](../type-aliases/getElementInstanceConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`elementId`: [`ElementId`](../type-aliases/ElementId.md); -`elementInstanceKey`: [`ElementInstanceKey`](../type-aliases/ElementInstanceKey.md); -`elementName`: `string`; -`endDate?`: `string`; -`hasIncident`: `boolean`; -`incidentKey?`: [`IncidentKey`](../type-aliases/IncidentKey.md); -`processDefinitionId`: [`ProcessDefinitionId`](../type-aliases/ProcessDefinitionId.md); -`processDefinitionKey`: [`ProcessDefinitionKey`](../type-aliases/ProcessDefinitionKey.md); -`processInstanceKey`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`rootProcessInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`startDate`: `string`; -`state`: [`ElementInstanceStateEnum`](../type-aliases/ElementInstanceStateEnum.md); -`tenantId`: [`TenantId`](../type-aliases/TenantId.md); -`type`: \| `"USER_TASK"` -\| `"UNKNOWN"` -\| `"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"` -\| `"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"`; -\}\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ElementInstanceResult`](../type-aliases/ElementInstanceResult.md)\> + +#### Example + +```ts +async function getElementInstanceExample() { + const camunda = createCamundaClient(); + + const elementInstanceKey = + ElementInstanceKey.assumeExists("2251799813685249"); + + const element = await camunda.getElementInstance( + { elementInstanceKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Element: ${element.elementId} (${element.type})`); +} +``` #### Operation Id @@ -3579,7 +4189,7 @@ eventual - this endpoint is backed by data that is eventually consistent with th getErrorMode(): "result" | "throw"; ``` -Defined in: [gen/CamundaClient.ts:1454](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1454) +Defined in: [gen/CamundaClient.ts:1460](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1460) Internal accessor (read-only) for eventual consistency error mode. @@ -3592,10 +4202,13 @@ Internal accessor (read-only) for eventual consistency error mode. ### getGlobalClusterVariable() ```ts -getGlobalClusterVariable(input, consistencyManagement): CancelablePromise; +getGlobalClusterVariable( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5685](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5685) +Defined in: [gen/CamundaClient.ts:6031](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6031) Get a global-scoped cluster variable @@ -3613,10 +4226,29 @@ Get a global-scoped cluster variable. [`getGlobalClusterVariableConsistency`](../type-aliases/getGlobalClusterVariableConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ClusterVariableResult`](../type-aliases/ClusterVariableResult.md)\> +#### Example + +```ts +async function getGlobalClusterVariableExample() { + const camunda = createCamundaClient(); + + const variable = await camunda.getGlobalClusterVariable( + { name: "feature-flags" }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`${variable.name} = ${variable.value}`); +} +``` + #### Operation Id getGlobalClusterVariable @@ -3634,10 +4266,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getGlobalJobStatistics() ```ts -getGlobalJobStatistics(input, consistencyManagement): CancelablePromise; +getGlobalJobStatistics( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5749](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5749) +Defined in: [gen/CamundaClient.ts:6099](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6099) Global job statistics @@ -3655,10 +4290,32 @@ Returns global aggregated counts for jobs. Optionally filter by the creation tim [`getGlobalJobStatisticsConsistency`](../type-aliases/getGlobalJobStatisticsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GlobalJobStatisticsQueryResult`](../type-aliases/GlobalJobStatisticsQueryResult.md)\> +#### Example + +```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)}`); +} +``` + #### Operation Id getGlobalJobStatistics @@ -3673,13 +4330,80 @@ eventual - this endpoint is backed by data that is eventually consistent with th --- +### getGlobalTaskListener() + +```ts +getGlobalTaskListener( + input, + consistencyManagement, +options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:6166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6166) + +Get global user task listener + +Get a global user task listener by its id. + +- + +#### Parameters + +##### input + +[`getGlobalTaskListenerInput`](../type-aliases/getGlobalTaskListenerInput.md) + +##### consistencyManagement + +[`getGlobalTaskListenerConsistency`](../type-aliases/getGlobalTaskListenerConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GlobalTaskListenerResult`](../type-aliases/GlobalTaskListenerResult.md)\> + +#### Example + +```ts +async function getGlobalTaskListenerExample() { + const camunda = createCamundaClient(); + + const listener = await camunda.getGlobalTaskListener( + { id: GlobalListenerId.assumeExists("listener-123") }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Listener: ${listener.type} (${listener.eventTypes})`); +} +``` + +#### Operation Id + +getGlobalTaskListener + +#### Tags + +Global listener + +#### Consistency + +eventual - this endpoint is backed by data that is eventually consistent with the system state. + +--- + ### getGroup() ```ts -getGroup(input, consistencyManagement): CancelablePromise; +getGroup( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5812](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5812) +Defined in: [gen/CamundaClient.ts:6233](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6233) Get group @@ -3697,10 +4421,29 @@ Get a group by its ID. [`getGroupConsistency`](../type-aliases/getGroupConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GroupResult`](../type-aliases/GroupResult.md)\> +#### Example + +```ts +async function getGroupExample() { + const camunda = createCamundaClient(); + + const group = await camunda.getGroup( + { groupId: "engineering-team" }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Group: ${group.name}`); +} +``` + #### Operation Id getGroup @@ -3718,24 +4461,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getIncident() ```ts -getIncident(input, consistencyManagement): CancelablePromise<{ - creationTime?: string; - elementId?: ElementId; - elementInstanceKey?: ElementInstanceKey; - errorMessage?: string; - errorType?: IncidentErrorTypeEnum; - incidentKey?: IncidentKey; - jobKey?: JobKey; - processDefinitionId?: ProcessDefinitionId; - processDefinitionKey?: ProcessDefinitionKey; - processInstanceKey?: ProcessInstanceKey; - rootProcessInstanceKey?: ProcessInstanceKey; - state?: IncidentStateEnum; - tenantId?: TenantId; -}>; +getIncident( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5878](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5878) +Defined in: [gen/CamundaClient.ts:6301](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6301) Get incident @@ -3747,56 +4479,330 @@ Returns incident as JSON. ##### input -[`getIncidentInput`](../type-aliases/getIncidentInput.md) +[`getIncidentInput`](../type-aliases/getIncidentInput.md) + +##### consistencyManagement + +[`getIncidentConsistency`](../type-aliases/getIncidentConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`IncidentResult`](../type-aliases/IncidentResult.md)\> + +#### Example + +```ts +async function getIncidentExample() { + const camunda = createCamundaClient(); + + const incidentKey = IncidentKey.assumeExists("2251799813685249"); + + const incident = await camunda.getIncident( + { incidentKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Type: ${incident.errorType}`); + console.log(`State: ${incident.state}`); + console.log(`Message: ${incident.errorMessage}`); +} +``` + +#### Operation Id + +getIncident + +#### Tags + +Incident + +#### Consistency + +eventual - this endpoint is backed by data that is eventually consistent with the system state. + +--- + +### getJobErrorStatistics() + +```ts +getJobErrorStatistics( + input, + consistencyManagement, +options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:6369](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6369) + +Get error metrics for a job type + +Returns aggregated metrics per error for the given jobType. + +- + +#### Parameters + +##### input + +[`JobErrorStatisticsQuery`](../type-aliases/JobErrorStatisticsQuery.md) + +##### consistencyManagement + +[`getJobErrorStatisticsConsistency`](../type-aliases/getJobErrorStatisticsConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`JobErrorStatisticsQueryResult`](../type-aliases/JobErrorStatisticsQueryResult.md)\> + +#### Example + +```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}`); + } +} +``` + +#### Operation Id + +getJobErrorStatistics + +#### Tags + +Job + +#### Consistency + +eventual - this endpoint is backed by data that is eventually consistent with the system state. + +--- + +### getJobTimeSeriesStatistics() + +```ts +getJobTimeSeriesStatistics( + input, + consistencyManagement, +options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:6439](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6439) + +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. + +- + +#### Parameters + +##### input + +[`JobTimeSeriesStatisticsQuery`](../type-aliases/JobTimeSeriesStatisticsQuery.md) + +##### consistencyManagement + +[`getJobTimeSeriesStatisticsConsistency`](../type-aliases/getJobTimeSeriesStatisticsConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`JobTimeSeriesStatisticsQueryResult`](../type-aliases/JobTimeSeriesStatisticsQueryResult.md)\> + +#### Example + +```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}`); + } +} +``` + +#### Operation Id + +getJobTimeSeriesStatistics + +#### Tags + +Job + +#### Consistency + +eventual - this endpoint is backed by data that is eventually consistent with the system state. + +--- + +### getJobTypeStatistics() + +```ts +getJobTypeStatistics( + input, + consistencyManagement, +options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:6507](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6507) + +Get job statistics by type + +Get statistics about jobs, grouped by job type. + +- + +#### Parameters + +##### input + +[`JobTypeStatisticsQuery`](../type-aliases/JobTypeStatisticsQuery.md) + +##### consistencyManagement + +[`getJobTypeStatisticsConsistency`](../type-aliases/getJobTypeStatisticsConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`JobTypeStatisticsQueryResult`](../type-aliases/JobTypeStatisticsQueryResult.md)\> + +#### Example + +```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}`); + } +} +``` + +#### Operation Id + +getJobTypeStatistics + +#### Tags + +Job + +#### Consistency + +eventual - this endpoint is backed by data that is eventually consistent with the system state. + +--- + +### getJobWorkerStatistics() + +```ts +getJobWorkerStatistics( + input, + consistencyManagement, +options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:6575](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6575) + +Get job statistics by worker + +Get statistics about jobs, grouped by worker, for a given job type. + +- + +#### Parameters + +##### input + +[`JobWorkerStatisticsQuery`](../type-aliases/JobWorkerStatisticsQuery.md) ##### consistencyManagement -[`getIncidentConsistency`](../type-aliases/getIncidentConsistency.md) +[`getJobWorkerStatisticsConsistency`](../type-aliases/getJobWorkerStatisticsConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`creationTime?`: `string`; -`elementId?`: [`ElementId`](../type-aliases/ElementId.md); -`elementInstanceKey?`: [`ElementInstanceKey`](../type-aliases/ElementInstanceKey.md); -`errorMessage?`: `string`; -`errorType?`: [`IncidentErrorTypeEnum`](../type-aliases/IncidentErrorTypeEnum.md); -`incidentKey?`: [`IncidentKey`](../type-aliases/IncidentKey.md); -`jobKey?`: [`JobKey`](../type-aliases/JobKey.md); -`processDefinitionId?`: [`ProcessDefinitionId`](../type-aliases/ProcessDefinitionId.md); -`processDefinitionKey?`: [`ProcessDefinitionKey`](../type-aliases/ProcessDefinitionKey.md); -`processInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`rootProcessInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`state?`: [`IncidentStateEnum`](../type-aliases/IncidentStateEnum.md); -`tenantId?`: [`TenantId`](../type-aliases/TenantId.md); -\}\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`JobWorkerStatisticsQueryResult`](../type-aliases/JobWorkerStatisticsQueryResult.md)\> #### Example ```ts -async function getIncidentExample() { +async function getJobWorkerStatisticsExample() { const camunda = createCamundaClient(); - const incidentKey = IncidentKey.assumeExists("2251799813685249"); - - const incident = await camunda.getIncident( - { incidentKey }, + const result = await camunda.getJobWorkerStatistics( + { + filter: { + from: "2025-01-01T00:00:00Z", + to: "2025-12-31T23:59:59Z", + jobType: "payment-processing", + }, + }, { consistency: { waitUpToMs: 5000 } } ); - console.log(`Type: ${incident.errorType}`); - console.log(`State: ${incident.state}`); - console.log(`Message: ${incident.errorMessage}`); + for (const stat of result.items ?? []) { + console.log(`Worker: ${stat.worker}, completed: ${stat.completed.count}`); + } } ``` #### Operation Id -getIncident +getJobWorkerStatistics #### Tags -Incident +Job #### Consistency @@ -3807,10 +4813,10 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getLicense() ```ts -getLicense(): CancelablePromise; +getLicense(options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5940](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5940) +Defined in: [gen/CamundaClient.ts:6641](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6641) Get license status @@ -3818,10 +4824,28 @@ Obtains the status of the current Camunda license. - +#### Parameters + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`LicenseResponse`](../type-aliases/LicenseResponse.md)\> +#### Example + +```ts +async function getLicenseExample() { + const camunda = createCamundaClient(); + + const license = await camunda.getLicense(); + + console.log(`License type: ${license.validLicense}`); +} +``` + #### Operation Id getLicense @@ -3835,10 +4859,13 @@ License ### getMappingRule() ```ts -getMappingRule(input, consistencyManagement): CancelablePromise; +getMappingRule( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:5991](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L5991) +Defined in: [gen/CamundaClient.ts:6695](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6695) Get a mapping rule @@ -3856,10 +4883,29 @@ Gets the mapping rule with the given ID. [`getMappingRuleConsistency`](../type-aliases/getMappingRuleConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`MappingRuleResult`](../type-aliases/MappingRuleResult.md)\> +#### Example + +```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})`); +} +``` + #### Operation Id getMappingRule @@ -3877,10 +4923,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessDefinition() ```ts -getProcessDefinition(input, consistencyManagement): CancelablePromise; +getProcessDefinition( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6054](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6054) +Defined in: [gen/CamundaClient.ts:6762](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6762) Get process definition @@ -3898,10 +4947,34 @@ Returns process definition as JSON. [`getProcessDefinitionConsistency`](../type-aliases/getProcessDefinitionConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessDefinitionResult`](../type-aliases/ProcessDefinitionResult.md)\> +#### Example + +```ts +async function getProcessDefinitionExample() { + const camunda = createCamundaClient(); + + const processDefinitionKey = + ProcessDefinitionKey.assumeExists("2251799813685249"); + + const definition = await camunda.getProcessDefinition( + { processDefinitionKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log( + `Process: ${definition.processDefinitionId} v${definition.version}` + ); +} +``` + #### Operation Id getProcessDefinition @@ -3919,10 +4992,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessDefinitionInstanceStatistics() ```ts -getProcessDefinitionInstanceStatistics(input, consistencyManagement): CancelablePromise; +getProcessDefinitionInstanceStatistics( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6118](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6118) +Defined in: [gen/CamundaClient.ts:6830](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6830) Get process instance statistics @@ -3934,24 +5010,39 @@ Get statistics about process instances, grouped by process definition and tenant ##### input -###### page? - -[`OffsetPagination`](../type-aliases/OffsetPagination.md) - -###### sort? - -`object`[] - -Sort field criteria. +[`ProcessDefinitionInstanceStatisticsQuery`](../type-aliases/ProcessDefinitionInstanceStatisticsQuery.md) ##### consistencyManagement [`getProcessDefinitionInstanceStatisticsConsistency`](../type-aliases/getProcessDefinitionInstanceStatisticsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessDefinitionInstanceStatisticsQueryResult`](../type-aliases/ProcessDefinitionInstanceStatisticsQueryResult.md)\> +#### Example + +```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` + ); + } +} +``` + #### Operation Id getProcessDefinitionInstanceStatistics @@ -3969,10 +5060,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessDefinitionInstanceVersionStatistics() ```ts -getProcessDefinitionInstanceVersionStatistics(input, consistencyManagement): CancelablePromise; +getProcessDefinitionInstanceVersionStatistics( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6183](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6183) +Defined in: [gen/CamundaClient.ts:6899](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6899) Get process instance statistics by version @@ -3985,31 +5079,42 @@ The process definition ID must be provided as a required field in the request bo ##### input -###### filter - -[`ProcessDefinitionInstanceVersionStatisticsFilter`](../type-aliases/ProcessDefinitionInstanceVersionStatisticsFilter.md) - -The process definition instance version statistics search filters. +[`ProcessDefinitionInstanceVersionStatisticsQuery`](../type-aliases/ProcessDefinitionInstanceVersionStatisticsQuery.md) -###### page? +##### consistencyManagement -[`OffsetPagination`](../type-aliases/OffsetPagination.md) +[`getProcessDefinitionInstanceVersionStatisticsConsistency`](../type-aliases/getProcessDefinitionInstanceVersionStatisticsConsistency.md) -Pagination criteria. +##### options? -###### sort? +[`OperationOptions`](../interfaces/OperationOptions.md) -`object`[] +#### Returns -Sort field criteria. +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessDefinitionInstanceVersionStatisticsQueryResult`](../type-aliases/ProcessDefinitionInstanceVersionStatisticsQueryResult.md)\> -##### consistencyManagement +#### Example -[`getProcessDefinitionInstanceVersionStatisticsConsistency`](../type-aliases/getProcessDefinitionInstanceVersionStatisticsConsistency.md) +```ts +async function getProcessDefinitionInstanceVersionStatisticsExample() { + const camunda = createCamundaClient(); -#### Returns + const result = await camunda.getProcessDefinitionInstanceVersionStatistics( + { + filter: { + processDefinitionId: ProcessDefinitionId.assumeExists("order-process"), + }, + }, + { consistency: { waitUpToMs: 5000 } } + ); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessDefinitionInstanceVersionStatisticsQueryResult`](../type-aliases/ProcessDefinitionInstanceVersionStatisticsQueryResult.md)\> + for (const stat of result.items ?? []) { + console.log( + `Version ${stat.processDefinitionVersion}: ${stat.activeInstancesWithoutIncidentCount} active` + ); + } +} +``` #### Operation Id @@ -4028,10 +5133,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessDefinitionMessageSubscriptionStatistics() ```ts -getProcessDefinitionMessageSubscriptionStatistics(input, consistencyManagement): CancelablePromise; +getProcessDefinitionMessageSubscriptionStatistics( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6247](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6247) +Defined in: [gen/CamundaClient.ts:6967](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L6967) Get message subscription statistics @@ -4043,101 +5151,39 @@ Get message subscription statistics, grouped by process definition. ##### input -###### filter? - -\{ -`correlationKey?`: [`StringFilterProperty`](../type-aliases/StringFilterProperty.md); -`elementId?`: [`StringFilterProperty`](../type-aliases/StringFilterProperty.md); -`elementInstanceKey?`: [`ElementInstanceKeyFilterProperty`](../type-aliases/ElementInstanceKeyFilterProperty.md); -`lastUpdatedDate?`: [`DateTimeFilterProperty`](../type-aliases/DateTimeFilterProperty.md); -`messageName?`: [`StringFilterProperty`](../type-aliases/StringFilterProperty.md); -`messageSubscriptionKey?`: [`MessageSubscriptionKeyFilterProperty`](../type-aliases/MessageSubscriptionKeyFilterProperty.md); -`messageSubscriptionState?`: [`MessageSubscriptionStateFilterProperty`](../type-aliases/MessageSubscriptionStateFilterProperty.md); -`processDefinitionId?`: [`StringFilterProperty`](../type-aliases/StringFilterProperty.md); -`processDefinitionKey?`: [`ProcessDefinitionKeyFilterProperty`](../type-aliases/ProcessDefinitionKeyFilterProperty.md); -`processInstanceKey?`: [`ProcessInstanceKeyFilterProperty`](../type-aliases/ProcessInstanceKeyFilterProperty.md); -`tenantId?`: [`StringFilterProperty`](../type-aliases/StringFilterProperty.md); -\} - -Message subscription search filter. - -###### filter.correlationKey? - -[`StringFilterProperty`](../type-aliases/StringFilterProperty.md) - -The correlation key of the message subscription. - -###### filter.elementId? - -[`StringFilterProperty`](../type-aliases/StringFilterProperty.md) - -The element ID associated with this message subscription. - -###### filter.elementInstanceKey? - -[`ElementInstanceKeyFilterProperty`](../type-aliases/ElementInstanceKeyFilterProperty.md) - -The element instance key associated with this message subscription. +[`ProcessDefinitionMessageSubscriptionStatisticsQuery`](../type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQuery.md) -###### filter.lastUpdatedDate? - -[`DateTimeFilterProperty`](../type-aliases/DateTimeFilterProperty.md) - -The last updated date of the message subscription. - -###### filter.messageName? - -[`StringFilterProperty`](../type-aliases/StringFilterProperty.md) - -The name of the message associated with the message subscription. - -###### filter.messageSubscriptionKey? - -[`MessageSubscriptionKeyFilterProperty`](../type-aliases/MessageSubscriptionKeyFilterProperty.md) - -The message subscription key associated with this message subscription. - -###### filter.messageSubscriptionState? - -[`MessageSubscriptionStateFilterProperty`](../type-aliases/MessageSubscriptionStateFilterProperty.md) - -The message subscription state. - -###### filter.processDefinitionId? - -[`StringFilterProperty`](../type-aliases/StringFilterProperty.md) - -The process definition ID associated with this message subscription. - -###### filter.processDefinitionKey? - -[`ProcessDefinitionKeyFilterProperty`](../type-aliases/ProcessDefinitionKeyFilterProperty.md) - -The process definition key associated with this correlated message subscription. This only works for data created with 8.9 and later. - -###### filter.processInstanceKey? - -[`ProcessInstanceKeyFilterProperty`](../type-aliases/ProcessInstanceKeyFilterProperty.md) - -The process instance key associated with this message subscription. +##### consistencyManagement -###### filter.tenantId? +[`getProcessDefinitionMessageSubscriptionStatisticsConsistency`](../type-aliases/getProcessDefinitionMessageSubscriptionStatisticsConsistency.md) -[`StringFilterProperty`](../type-aliases/StringFilterProperty.md) +##### options? -The unique external tenant ID. +[`OperationOptions`](../interfaces/OperationOptions.md) -###### page? +#### Returns -[`CursorForwardPagination`](../type-aliases/CursorForwardPagination.md) +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessDefinitionMessageSubscriptionStatisticsQueryResult`](../type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQueryResult.md)\> -##### consistencyManagement +#### Example -[`getProcessDefinitionMessageSubscriptionStatisticsConsistency`](../type-aliases/getProcessDefinitionMessageSubscriptionStatisticsConsistency.md) +```ts +async function getProcessDefinitionMessageSubscriptionStatisticsExample() { + const camunda = createCamundaClient(); -#### Returns + const result = + await camunda.getProcessDefinitionMessageSubscriptionStatistics( + {}, + { consistency: { waitUpToMs: 5000 } } + ); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessDefinitionMessageSubscriptionStatisticsQueryResult`](../type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQueryResult.md)\> + for (const stat of result.items ?? []) { + console.log( + `Definition ${stat.processDefinitionId}: ${stat.activeSubscriptions} subscriptions` + ); + } +} +``` #### Operation Id @@ -4156,10 +5202,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessDefinitionStatistics() ```ts -getProcessDefinitionStatistics(input, consistencyManagement): CancelablePromise; +getProcessDefinitionStatistics( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6310](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6310) +Defined in: [gen/CamundaClient.ts:7034](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7034) Get process definition statistics @@ -4177,10 +5226,34 @@ Get statistics about elements in currently running process instances by process [`getProcessDefinitionStatisticsConsistency`](../type-aliases/getProcessDefinitionStatisticsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessDefinitionElementStatisticsQueryResult`](../type-aliases/ProcessDefinitionElementStatisticsQueryResult.md)\> +#### Example + +```ts +async function getProcessDefinitionStatisticsExample() { + const camunda = createCamundaClient(); + + const processDefinitionKey = + ProcessDefinitionKey.assumeExists("2251799813685249"); + + const result = await camunda.getProcessDefinitionStatistics( + { processDefinitionKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const stat of result.items ?? []) { + console.log(`Element ${stat.elementId}: active=${stat.active}`); + } +} +``` + #### Operation Id getProcessDefinitionStatistics @@ -4198,10 +5271,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessDefinitionXml() ```ts -getProcessDefinitionXml(input, consistencyManagement): CancelablePromise; +getProcessDefinitionXml( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6375](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6375) +Defined in: [gen/CamundaClient.ts:7101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7101) Get process definition XML @@ -4219,6 +5295,10 @@ Returns process definition as XML. [`getProcessDefinitionXmlConsistency`](../type-aliases/getProcessDefinitionXmlConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`string`\> @@ -4240,26 +5320,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessInstance() ```ts -getProcessInstance(input, consistencyManagement): CancelablePromise<{ - endDate?: string; - hasIncident: boolean; - parentElementInstanceKey?: ElementInstanceKey; - parentProcessInstanceKey?: ProcessInstanceKey; - processDefinitionId: ProcessDefinitionId; - processDefinitionKey: ProcessDefinitionKey; - processDefinitionName: string; - processDefinitionVersion: number; - processDefinitionVersionTag?: string; - processInstanceKey: ProcessInstanceKey; - rootProcessInstanceKey?: ProcessInstanceKey; - startDate: string; - state: ProcessInstanceStateEnum; - tags?: TagSet; - tenantId: TenantId; -}>; +getProcessInstance( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6440](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6440) +Defined in: [gen/CamundaClient.ts:7168](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7168) Get process instance @@ -4277,25 +5344,13 @@ Get the process instance by the process instance key. [`getProcessInstanceConsistency`](../type-aliases/getProcessInstanceConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`endDate?`: `string`; -`hasIncident`: `boolean`; -`parentElementInstanceKey?`: [`ElementInstanceKey`](../type-aliases/ElementInstanceKey.md); -`parentProcessInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`processDefinitionId`: [`ProcessDefinitionId`](../type-aliases/ProcessDefinitionId.md); -`processDefinitionKey`: [`ProcessDefinitionKey`](../type-aliases/ProcessDefinitionKey.md); -`processDefinitionName`: `string`; -`processDefinitionVersion`: `number`; -`processDefinitionVersionTag?`: `string`; -`processInstanceKey`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`rootProcessInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`startDate`: `string`; -`state`: [`ProcessInstanceStateEnum`](../type-aliases/ProcessInstanceStateEnum.md); -`tags?`: [`TagSet`](../type-aliases/TagSet.md); -`tenantId`: [`TenantId`](../type-aliases/TenantId.md); -\}\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessInstanceResult`](../type-aliases/ProcessInstanceResult.md)\> #### Example @@ -4333,10 +5388,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessInstanceCallHierarchy() ```ts -getProcessInstanceCallHierarchy(input, consistencyManagement): CancelablePromise; +getProcessInstanceCallHierarchy( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6503](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6503) +Defined in: [gen/CamundaClient.ts:7235](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7235) Get call hierarchy @@ -4354,10 +5412,32 @@ Returns the call hierarchy for a given process instance, showing its ancestry up [`getProcessInstanceCallHierarchyConsistency`](../type-aliases/getProcessInstanceCallHierarchyConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessInstanceCallHierarchyEntry`](../type-aliases/ProcessInstanceCallHierarchyEntry.md)[]\> +#### Example + +```ts +async function getProcessInstanceCallHierarchyExample() { + const camunda = createCamundaClient(); + + const processInstanceKey = + ProcessInstanceKey.assumeExists("2251799813685249"); + + const result = await camunda.getProcessInstanceCallHierarchy( + { processInstanceKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Call hierarchy entries: ${result.length}`); +} +``` + #### Operation Id getProcessInstanceCallHierarchy @@ -4375,12 +5455,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessInstanceSequenceFlows() ```ts -getProcessInstanceSequenceFlows(input, consistencyManagement): CancelablePromise<{ - items?: object[]; -}>; +getProcessInstanceSequenceFlows( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6566](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6566) +Defined in: [gen/CamundaClient.ts:7302](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7302) Get sequence flows @@ -4398,11 +5479,33 @@ Get sequence flows taken by the process instance. [`getProcessInstanceSequenceFlowsConsistency`](../type-aliases/getProcessInstanceSequenceFlowsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; -\}\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessInstanceSequenceFlowsQueryResult`](../type-aliases/ProcessInstanceSequenceFlowsQueryResult.md)\> + +#### Example + +```ts +async function getProcessInstanceSequenceFlowsExample() { + const camunda = createCamundaClient(); + + const processInstanceKey = + ProcessInstanceKey.assumeExists("2251799813685249"); + + const result = await camunda.getProcessInstanceSequenceFlows( + { processInstanceKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const flow of result.items ?? []) { + console.log(`Sequence flow: ${flow.sequenceFlowId}`); + } +} +``` #### Operation Id @@ -4421,10 +5524,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessInstanceStatistics() ```ts -getProcessInstanceStatistics(input, consistencyManagement): CancelablePromise; +getProcessInstanceStatistics( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6629](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6629) +Defined in: [gen/CamundaClient.ts:7369](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7369) Get element instance statistics @@ -4442,10 +5548,34 @@ Get statistics about elements by the process instance key. [`getProcessInstanceStatisticsConsistency`](../type-aliases/getProcessInstanceStatisticsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessInstanceElementStatisticsQueryResult`](../type-aliases/ProcessInstanceElementStatisticsQueryResult.md)\> +#### Example + +```ts +async function getProcessInstanceStatisticsExample() { + const camunda = createCamundaClient(); + + const processInstanceKey = + ProcessInstanceKey.assumeExists("2251799813685249"); + + const result = await camunda.getProcessInstanceStatistics( + { processInstanceKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const stat of result.items ?? []) { + console.log(`Element ${stat.elementId}: active=${stat.active}`); + } +} +``` + #### Operation Id getProcessInstanceStatistics @@ -4463,10 +5593,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessInstanceStatisticsByDefinition() ```ts -getProcessInstanceStatisticsByDefinition(input, consistencyManagement): CancelablePromise; +getProcessInstanceStatisticsByDefinition( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6695](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6695) +Defined in: [gen/CamundaClient.ts:7439](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7439) Get process instance statistics by definition @@ -4484,12 +5617,39 @@ provided as a filter in the request body. ##### consistencyManagement -[`getProcessInstanceStatisticsByDefinitionConsistency`](../type-aliases/getProcessInstanceStatisticsByDefinitionConsistency.md) +[`getProcessInstanceStatisticsByDefinitionConsistency`](../type-aliases/getProcessInstanceStatisticsByDefinitionConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`IncidentProcessInstanceStatisticsByDefinitionQueryResult`](../type-aliases/IncidentProcessInstanceStatisticsByDefinitionQueryResult.md)\> +#### Example + +```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` + ); + } +} +``` + #### Operation Id getProcessInstanceStatisticsByDefinition @@ -4507,10 +5667,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getProcessInstanceStatisticsByError() ```ts -getProcessInstanceStatisticsByError(input, consistencyManagement): CancelablePromise; +getProcessInstanceStatisticsByError( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6760](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6760) +Defined in: [gen/CamundaClient.ts:7508](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7508) Get process instance statistics by error @@ -4529,10 +5692,33 @@ grouped by incident error hash code. [`getProcessInstanceStatisticsByErrorConsistency`](../type-aliases/getProcessInstanceStatisticsByErrorConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`IncidentProcessInstanceStatisticsByErrorQueryResult`](../type-aliases/IncidentProcessInstanceStatisticsByErrorQueryResult.md)\> +#### Example + +```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}` + ); + } +} +``` + #### Operation Id getProcessInstanceStatisticsByError @@ -4550,10 +5736,10 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getResource() ```ts -getResource(input): CancelablePromise; +getResource(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6826](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6826) +Defined in: [gen/CamundaClient.ts:7578](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7578) Get resource @@ -4570,10 +5756,28 @@ Currently, this endpoint only supports RPA resources. [`getResourceInput`](../type-aliases/getResourceInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ResourceResult`](../type-aliases/ResourceResult.md)\> +#### Example + +```ts +async function getResourceExample() { + const camunda = createCamundaClient(); + + const resource = await camunda.getResource({ + resourceKey: ProcessDefinitionKey.assumeExists("2251799813685249"), + }); + + console.log(`Resource: ${resource.resourceName} (${resource.resourceId})`); +} +``` + #### Operation Id getResource @@ -4587,10 +5791,10 @@ Resource ### getResourceContent() ```ts -getResourceContent(input): CancelablePromise; +getResourceContent(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6888](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6888) +Defined in: [gen/CamundaClient.ts:7644](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7644) Get resource content @@ -4607,9 +5811,27 @@ Currently, this endpoint only supports RPA resources. [`getResourceContentInput`](../type-aliases/getResourceContentInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`Blob`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`string`\> + +#### Example + +```ts +async function getResourceContentExample() { + const camunda = createCamundaClient(); + + const content = await camunda.getResourceContent({ + resourceKey: ProcessDefinitionKey.assumeExists("2251799813685249"), + }); + + console.log(`Content retrieved (type: ${typeof content})`); +} +``` #### Operation Id @@ -4624,10 +5846,13 @@ Resource ### getRole() ```ts -getRole(input, consistencyManagement): CancelablePromise; +getRole( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:6947](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L6947) +Defined in: [gen/CamundaClient.ts:7707](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7707) Get role @@ -4645,10 +5870,29 @@ Get a role by its ID. [`getRoleConsistency`](../type-aliases/getRoleConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`RoleResult`](../type-aliases/RoleResult.md)\> +#### Example + +```ts +async function getRoleExample() { + const camunda = createCamundaClient(); + + const role = await camunda.getRole( + { roleId: "process-admin" }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Role: ${role.name}`); +} +``` + #### Operation Id getRole @@ -4666,20 +5910,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getStartProcessForm() ```ts -getStartProcessForm(input, consistencyManagement): CancelablePromise< - | void - | { - formId?: FormId; - formKey?: FormKey; - schema?: { - [key: string]: unknown; - }; - tenantId?: TenantId; - version?: number; -}>; +getStartProcessForm( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7012](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7012) +Defined in: [gen/CamundaClient.ts:7776](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7776) Get process start form @@ -4698,19 +5935,33 @@ Note that this endpoint will only return linked forms. This endpoint does not su [`getStartProcessFormConsistency`](../type-aliases/getStartProcessFormConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\< -\| `void` -\| \{ -`formId?`: [`FormId`](../type-aliases/FormId.md); -`formKey?`: [`FormKey`](../type-aliases/FormKey.md); -`schema?`: \{ -\[`key`: `string`\]: `unknown`; -\}; -`tenantId?`: [`TenantId`](../type-aliases/TenantId.md); -`version?`: `number`; -\}\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void` \| [`FormResult`](../type-aliases/FormResult.md)\> + +#### Example + +```ts +async function getStartProcessFormExample() { + const camunda = createCamundaClient(); + + const processDefinitionKey = + ProcessDefinitionKey.assumeExists("2251799813685249"); + + const form = await camunda.getStartProcessForm( + { processDefinitionKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + if (form) { + console.log(`Form key: ${form.formKey}`); + } +} +``` #### Operation Id @@ -4729,10 +5980,10 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getStatus() ```ts -getStatus(): CancelablePromise; +getStatus(options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7074](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7074) +Defined in: [gen/CamundaClient.ts:7842](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7842) Get cluster status @@ -4740,10 +5991,28 @@ Checks the health status of the cluster by verifying if there's at least one par - +#### Parameters + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function getStatusExample() { + const camunda = createCamundaClient(); + + await camunda.getStatus(); + + console.log("Cluster is healthy"); +} +``` + #### Operation Id getStatus @@ -4754,13 +6023,66 @@ Cluster --- +### getSystemConfiguration() + +```ts +getSystemConfiguration(options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:7899](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7899) + +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. + +- + +#### Parameters + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SystemConfigurationResponse`](../type-aliases/SystemConfigurationResponse.md)\> + +#### Example + +```ts +async function getSystemConfigurationExample() { + const camunda = createCamundaClient(); + + const config = await camunda.getSystemConfiguration(); + + console.log(`Configuration loaded: ${JSON.stringify(config)}`); +} +``` + +#### Operation Id + +getSystemConfiguration + +#### Tags + +System + +--- + ### getTenant() ```ts -getTenant(input, consistencyManagement): CancelablePromise; +getTenant( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7124](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7124) +Defined in: [gen/CamundaClient.ts:7952](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L7952) Get tenant @@ -4778,10 +6100,31 @@ Retrieves a single tenant by tenant ID. [`getTenantConsistency`](../type-aliases/getTenantConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantResult`](../type-aliases/TenantResult.md)\> +#### Example + +```ts +async function getTenantExample() { + const camunda = createCamundaClient(); + + const tenantId = TenantId.assumeExists("customer-service"); + + const tenant = await camunda.getTenant( + { tenantId }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Tenant: ${tenant.name}`); +} +``` + #### Operation Id getTenant @@ -4799,10 +6142,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getTenantClusterVariable() ```ts -getTenantClusterVariable(input, consistencyManagement): CancelablePromise; +getTenantClusterVariable( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7187](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7187) +Defined in: [gen/CamundaClient.ts:8019](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8019) Get a tenant-scoped cluster variable @@ -4820,10 +6166,32 @@ Get a tenant-scoped cluster variable. [`getTenantClusterVariableConsistency`](../type-aliases/getTenantClusterVariableConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ClusterVariableResult`](../type-aliases/ClusterVariableResult.md)\> +#### Example + +```ts +async function getTenantClusterVariableExample() { + const camunda = createCamundaClient(); + + const variable = await camunda.getTenantClusterVariable( + { + tenantId: TenantId.assumeExists("customer-service"), + name: "config", + }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`${variable.name} = ${variable.value}`); +} +``` + #### Operation Id getTenantClusterVariable @@ -4841,10 +6209,10 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getTopology() ```ts -getTopology(): CancelablePromise; +getTopology(options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7251](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7251) +Defined in: [gen/CamundaClient.ts:8085](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8085) Get cluster topology @@ -4852,6 +6220,12 @@ Obtains the current topology of the cluster the gateway is part of. - +#### Parameters + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TopologyResponse`](../type-aliases/TopologyResponse.md)\> @@ -4885,10 +6259,13 @@ Cluster ### getUsageMetrics() ```ts -getUsageMetrics(input, consistencyManagement): CancelablePromise; +getUsageMetrics( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7301](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7301) +Defined in: [gen/CamundaClient.ts:8138](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8138) Get usage metrics @@ -4906,10 +6283,32 @@ Retrieve the usage metrics based on given criteria. [`getUsageMetricsConsistency`](../type-aliases/getUsageMetricsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`UsageMetricsResponse`](../type-aliases/UsageMetricsResponse.md)\> +#### Example + +```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)}`); +} +``` + #### Operation Id getUsageMetrics @@ -4927,10 +6326,17 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getUser() ```ts -getUser(input, consistencyManagement): CancelablePromise; +getUser( + input, + consistencyManagement, + options?): CancelablePromise<{ + email: string | null; + name: string | null; + username: Username; +}>; ``` -Defined in: [gen/CamundaClient.ts:7364](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7364) +Defined in: [gen/CamundaClient.ts:8205](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8205) Get user @@ -4948,9 +6354,34 @@ Get a user by its username. [`getUserConsistency`](../type-aliases/getUserConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`UserResult`](../type-aliases/UserResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`email`: `string` \| `null`; +`name`: `string` \| `null`; +`username`: [`Username`](../type-aliases/Username.md); +\}\> + +#### Example + +```ts +async function getUserExample() { + const camunda = createCamundaClient(); + + const username = Username.assumeExists("alice"); + + const user = await camunda.getUser( + { username }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`User: ${user.name} (${user.email})`); +} +``` #### Operation Id @@ -4969,37 +6400,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getUserTask() ```ts -getUserTask(input, consistencyManagement): CancelablePromise<{ - assignee?: string; - candidateGroups?: string[]; - candidateUsers?: string[]; - completionDate?: string; - creationDate?: string; - customHeaders?: { - [key: string]: string; - }; - dueDate?: string; - elementId?: ElementId; - elementInstanceKey?: ElementInstanceKey; - externalFormReference?: string; - followUpDate?: string; - formKey?: FormKey; - name?: string; - priority?: number; - processDefinitionId?: ProcessDefinitionId; - processDefinitionKey?: ProcessDefinitionKey; - processDefinitionVersion?: number; - processInstanceKey?: ProcessInstanceKey; - processName?: string; - rootProcessInstanceKey?: ProcessInstanceKey; - state?: UserTaskStateEnum; - tags?: TagSet; - tenantId?: TenantId; - userTaskKey?: UserTaskKey; -}>; +getUserTask( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7427](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7427) +Defined in: [gen/CamundaClient.ts:8272](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8272) Get user task @@ -5017,36 +6424,31 @@ Get the user task by the user task key. [`getUserTaskConsistency`](../type-aliases/getUserTaskConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`assignee?`: `string`; -`candidateGroups?`: `string`[]; -`candidateUsers?`: `string`[]; -`completionDate?`: `string`; -`creationDate?`: `string`; -`customHeaders?`: \{ -\[`key`: `string`\]: `string`; -\}; -`dueDate?`: `string`; -`elementId?`: [`ElementId`](../type-aliases/ElementId.md); -`elementInstanceKey?`: [`ElementInstanceKey`](../type-aliases/ElementInstanceKey.md); -`externalFormReference?`: `string`; -`followUpDate?`: `string`; -`formKey?`: [`FormKey`](../type-aliases/FormKey.md); -`name?`: `string`; -`priority?`: `number`; -`processDefinitionId?`: [`ProcessDefinitionId`](../type-aliases/ProcessDefinitionId.md); -`processDefinitionKey?`: [`ProcessDefinitionKey`](../type-aliases/ProcessDefinitionKey.md); -`processDefinitionVersion?`: `number`; -`processInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`processName?`: `string`; -`rootProcessInstanceKey?`: [`ProcessInstanceKey`](../type-aliases/ProcessInstanceKey.md); -`state?`: [`UserTaskStateEnum`](../type-aliases/UserTaskStateEnum.md); -`tags?`: [`TagSet`](../type-aliases/TagSet.md); -`tenantId?`: [`TenantId`](../type-aliases/TenantId.md); -`userTaskKey?`: [`UserTaskKey`](../type-aliases/UserTaskKey.md); -\}\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`UserTaskResult`](../type-aliases/UserTaskResult.md)\> + +#### Example + +```ts +async function getUserTaskExample() { + const camunda = createCamundaClient(); + + const { UserTaskKey } = await import("@camunda8/orchestration-cluster-api"); + const userTaskKey = UserTaskKey.assumeExists("2251799813685249"); + + const task = await camunda.getUserTask( + { userTaskKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`Task: ${task.name} (${task.state})`); +} +``` #### Operation Id @@ -5065,20 +6467,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getUserTaskForm() ```ts -getUserTaskForm(input, consistencyManagement): CancelablePromise< - | void - | { - formId?: FormId; - formKey?: FormKey; - schema?: { - [key: string]: unknown; - }; - tenantId?: TenantId; - version?: number; -}>; +getUserTaskForm( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7492](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7492) +Defined in: [gen/CamundaClient.ts:8341](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8341) Get user task form @@ -5097,19 +6492,33 @@ Note that this endpoint will only return linked forms. This endpoint does not su [`getUserTaskFormConsistency`](../type-aliases/getUserTaskFormConsistency.md) -#### Returns +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void` \| [`FormResult`](../type-aliases/FormResult.md)\> + +#### Example + +```ts +async function getUserTaskFormExample() { + const camunda = createCamundaClient(); + + const { UserTaskKey } = await import("@camunda8/orchestration-cluster-api"); + const userTaskKey = UserTaskKey.assumeExists("2251799813685249"); + + const form = await camunda.getUserTaskForm( + { userTaskKey }, + { consistency: { waitUpToMs: 5000 } } + ); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\< -\| `void` -\| \{ -`formId?`: [`FormId`](../type-aliases/FormId.md); -`formKey?`: [`FormKey`](../type-aliases/FormKey.md); -`schema?`: \{ -\[`key`: `string`\]: `unknown`; -\}; -`tenantId?`: [`TenantId`](../type-aliases/TenantId.md); -`version?`: `number`; -\}\> + if (form) { + console.log(`Form key: ${form.formKey}`); + } +} +``` #### Operation Id @@ -5128,14 +6537,21 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### getVariable() ```ts -getVariable(input, consistencyManagement): CancelablePromise; +getVariable( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7555](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7555) +Defined in: [gen/CamundaClient.ts:8412](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8412) Get variable -Get the variable by the variable key. +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. - @@ -5149,9 +6565,30 @@ Get the variable by the variable key. [`getVariableConsistency`](../type-aliases/getVariableConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`object` & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`VariableResult`](../type-aliases/VariableResult.md)\> + +#### Example + +```ts +async function getVariableExample() { + const camunda = createCamundaClient(); + + const variableKey = VariableKey.assumeExists("2251799813685249"); + + const variable = await camunda.getVariable( + { variableKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + console.log(`${variable.name} = ${variable.value}`); +} +``` #### Operation Id @@ -5173,7 +6610,7 @@ eventual - this endpoint is backed by data that is eventually consistent with th getWorkers(): any[]; ``` -Defined in: [gen/CamundaClient.ts:1552](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1552) +Defined in: [gen/CamundaClient.ts:1571](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1571) Return a read-only snapshot of currently registered job workers. @@ -5189,7 +6626,7 @@ Return a read-only snapshot of currently registered job workers. logger(scope?): Logger; ``` -Defined in: [gen/CamundaClient.ts:1449](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1449) +Defined in: [gen/CamundaClient.ts:1455](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1455) Access a scoped logger (internal & future user emission). @@ -5208,10 +6645,10 @@ Access a scoped logger (internal & future user emission). ### migrateProcessInstance() ```ts -migrateProcessInstance(input): CancelablePromise; +migrateProcessInstance(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7624](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7624) +Defined in: [gen/CamundaClient.ts:8485](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8485) Migrate process instance @@ -5231,10 +6668,37 @@ latest process improvements. [`migrateProcessInstanceInput`](../type-aliases/migrateProcessInstanceInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function migrateProcessInstanceExample() { + const camunda = createCamundaClient(); + + const processInstanceKey = + ProcessInstanceKey.assumeExists("2251799813685249"); + + await camunda.migrateProcessInstance({ + processInstanceKey, + targetProcessDefinitionKey: + ProcessDefinitionKey.assumeExists("2251799813685250"), + mappingInstructions: [ + { + sourceElementId: ElementId.assumeExists("task-a"), + targetElementId: ElementId.assumeExists("task-b"), + }, + ], + }); +} +``` + #### Operation Id migrateProcessInstance @@ -5248,10 +6712,10 @@ Process instance ### migrateProcessInstancesBatchOperation() ```ts -migrateProcessInstancesBatchOperation(input, consistencyManagement): CancelablePromise; +migrateProcessInstancesBatchOperation(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7689](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7689) +Defined in: [gen/CamundaClient.ts:8553](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8553) Migrate process instances (batch) @@ -5266,29 +6730,42 @@ This is done asynchronously, the progress can be tracked using the batchOperatio ##### input -###### filter +[`ProcessInstanceMigrationBatchOperationRequest`](../type-aliases/ProcessInstanceMigrationBatchOperationRequest.md) -[`ProcessInstanceFilter`](../type-aliases/ProcessInstanceFilter.md) - -The process instance filter. - -###### migrationPlan - -[`ProcessInstanceMigrationBatchOperationPlan`](../type-aliases/ProcessInstanceMigrationBatchOperationPlan.md) +##### options? -The migration plan. +[`OperationOptions`](../interfaces/OperationOptions.md) -###### operationReference? +#### Returns -`number` +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> -##### consistencyManagement +#### Example -[`migrateProcessInstancesBatchOperationConsistency`](../type-aliases/migrateProcessInstancesBatchOperationConsistency.md) +```ts +async function migrateProcessInstancesBatchOperationExample() { + const camunda = createCamundaClient(); -#### Returns + const result = await camunda.migrateProcessInstancesBatchOperation({ + filter: { + processDefinitionKey: + ProcessDefinitionKey.assumeExists("2251799813685249"), + }, + migrationPlan: { + targetProcessDefinitionKey: + ProcessDefinitionKey.assumeExists("2251799813685250"), + mappingInstructions: [ + { + sourceElementId: ElementId.assumeExists("task-a"), + targetElementId: ElementId.assumeExists("task-b"), + }, + ], + }, + }); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> + console.log(`Batch operation key: ${result.batchOperationKey}`); +} +``` #### Operation Id @@ -5298,19 +6775,15 @@ migrateProcessInstancesBatchOperation Process instance -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### modifyProcessInstance() ```ts -modifyProcessInstance(input): CancelablePromise; +modifyProcessInstance(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7757](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7757) +Defined in: [gen/CamundaClient.ts:8621](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8621) Modify process instance @@ -5329,10 +6802,35 @@ For example, because an external system is not available or doesn't respond as e [`modifyProcessInstanceInput`](../type-aliases/modifyProcessInstanceInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function modifyProcessInstanceExample() { + const camunda = createCamundaClient(); + + const processInstanceKey = + ProcessInstanceKey.assumeExists("2251799813685249"); + + await camunda.modifyProcessInstance({ + processInstanceKey, + activateInstructions: [{ elementId: ElementId.assumeExists("task-a") }], + terminateInstructions: [ + { + elementInstanceKey: ElementInstanceKey.assumeExists("2251799813685260"), + }, + ], + }); +} +``` + #### Operation Id modifyProcessInstance @@ -5346,10 +6844,10 @@ Process instance ### modifyProcessInstancesBatchOperation() ```ts -modifyProcessInstancesBatchOperation(input, consistencyManagement): CancelablePromise; +modifyProcessInstancesBatchOperation(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7824](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7824) +Defined in: [gen/CamundaClient.ts:8691](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8691) Modify process instances (batch) @@ -5366,29 +6864,38 @@ This is done asynchronously, the progress can be tracked using the batchOperatio ##### input -###### filter - -[`ProcessInstanceFilter`](../type-aliases/ProcessInstanceFilter.md) - -The process instance filter. - -###### moveInstructions +[`ProcessInstanceModificationBatchOperationRequest`](../type-aliases/ProcessInstanceModificationBatchOperationRequest.md) -[`ProcessInstanceModificationMoveBatchOperationInstruction`](../type-aliases/ProcessInstanceModificationMoveBatchOperationInstruction.md)[] +##### options? -Instructions for moving tokens between elements. +[`OperationOptions`](../interfaces/OperationOptions.md) -###### operationReference? +#### Returns -`number` +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> -##### consistencyManagement +#### Example -[`modifyProcessInstancesBatchOperationConsistency`](../type-aliases/modifyProcessInstancesBatchOperationConsistency.md) +```ts +async function modifyProcessInstancesBatchOperationExample() { + const camunda = createCamundaClient(); -#### Returns + const result = await camunda.modifyProcessInstancesBatchOperation({ + filter: { + processDefinitionKey: + ProcessDefinitionKey.assumeExists("2251799813685249"), + }, + moveInstructions: [ + { + sourceElementId: ElementId.assumeExists("task-a"), + targetElementId: ElementId.assumeExists("task-b"), + }, + ], + }); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> + console.log(`Batch operation key: ${result.batchOperationKey}`); +} +``` #### Operation Id @@ -5398,10 +6905,6 @@ modifyProcessInstancesBatchOperation Process instance -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### onAuthHeaders() @@ -5410,7 +6913,7 @@ eventual - this endpoint is backed by data that is eventually consistent with th onAuthHeaders(h): void; ``` -Defined in: [gen/CamundaClient.ts:1441](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1441) +Defined in: [gen/CamundaClient.ts:1447](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1447) #### Parameters @@ -5429,10 +6932,10 @@ Defined in: [gen/CamundaClient.ts:1441](https://github.com/camunda/orchestration ### pinClock() ```ts -pinClock(input): CancelablePromise; +pinClock(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7892](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7892) +Defined in: [gen/CamundaClient.ts:8759](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8759) Pin internal clock (alpha) @@ -5451,10 +6954,28 @@ in future releases. [`ClockPinRequest`](../type-aliases/ClockPinRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function pinClockExample() { + const camunda = createCamundaClient(); + + await camunda.pinClock({ + timestamp: 1735689599000, + }); + + console.log("Clock pinned"); +} +``` + #### Operation Id pinClock @@ -5468,13 +6989,10 @@ Clock ### publishMessage() ```ts -publishMessage(input): CancelablePromise<{ - messageKey?: MessageKey; - tenantId?: TenantId; -}>; +publishMessage(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:7957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L7957) +Defined in: [gen/CamundaClient.ts:8826](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8826) Publish message @@ -5492,12 +7010,13 @@ Use the message correlation endpoint for such use cases. [`MessagePublicationRequest`](../type-aliases/MessagePublicationRequest.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`messageKey?`: [`MessageKey`](../type-aliases/MessageKey.md); -`tenantId?`: [`TenantId`](../type-aliases/TenantId.md); -\}\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`MessagePublicationResult`](../type-aliases/MessagePublicationResult.md)\> #### Example @@ -5529,10 +7048,10 @@ Message ### resetClock() ```ts -resetClock(): CancelablePromise; +resetClock(options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8025) +Defined in: [gen/CamundaClient.ts:8898](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8898) Reset internal clock (alpha) @@ -5545,10 +7064,28 @@ in future releases. - +#### Parameters + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function resetClockExample() { + const camunda = createCamundaClient(); + + await camunda.resetClock(); + + console.log("Clock reset"); +} +``` + #### Operation Id resetClock @@ -5562,10 +7099,10 @@ Clock ### resolveIncident() ```ts -resolveIncident(input): CancelablePromise; +resolveIncident(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8078](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8078) +Defined in: [gen/CamundaClient.ts:8952](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L8952) Resolve incident @@ -5580,6 +7117,10 @@ to reset the job's retries, followed by this call. [`resolveIncidentInput`](../type-aliases/resolveIncidentInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> @@ -5609,10 +7150,10 @@ Incident ### resolveIncidentsBatchOperation() ```ts -resolveIncidentsBatchOperation(input, consistencyManagement): CancelablePromise; +resolveIncidentsBatchOperation(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8143](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8143) +Defined in: [gen/CamundaClient.ts:9020](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9020) Resolve related incidents (batch) @@ -5627,23 +7168,32 @@ This is done asynchronously, the progress can be tracked using the batchOperatio ##### input -###### filter +[`ProcessInstanceIncidentResolutionBatchOperationRequest`](../type-aliases/ProcessInstanceIncidentResolutionBatchOperationRequest.md) -[`ProcessInstanceFilter`](../type-aliases/ProcessInstanceFilter.md) +##### options? -The process instance filter. +[`OperationOptions`](../interfaces/OperationOptions.md) -###### operationReference? +#### Returns -`number` +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> -##### consistencyManagement +#### Example -[`resolveIncidentsBatchOperationConsistency`](../type-aliases/resolveIncidentsBatchOperationConsistency.md) +```ts +async function resolveIncidentsBatchOperationExample() { + const camunda = createCamundaClient(); -#### Returns + const result = await camunda.resolveIncidentsBatchOperation({ + filter: { + processDefinitionKey: + ProcessDefinitionKey.assumeExists("2251799813685249"), + }, + }); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> + console.log(`Batch operation key: ${result.batchOperationKey}`); +} +``` #### Operation Id @@ -5653,19 +7203,15 @@ resolveIncidentsBatchOperation Process instance -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### resolveProcessInstanceIncidents() ```ts -resolveProcessInstanceIncidents(input, consistencyManagement): CancelablePromise; +resolveProcessInstanceIncidents(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8206](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8206) +Defined in: [gen/CamundaClient.ts:9082](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9082) Resolve related incidents @@ -5679,14 +7225,31 @@ Creates a batch operation to resolve multiple incidents of a process instance. [`resolveProcessInstanceIncidentsInput`](../type-aliases/resolveProcessInstanceIncidentsInput.md) -##### consistencyManagement +##### options? -[`resolveProcessInstanceIncidentsConsistency`](../type-aliases/resolveProcessInstanceIncidentsConsistency.md) +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationCreatedResult`](../type-aliases/BatchOperationCreatedResult.md)\> +#### Example + +```ts +async function resolveProcessInstanceIncidentsExample() { + const camunda = createCamundaClient(); + + const processInstanceKey = + ProcessInstanceKey.assumeExists("2251799813685249"); + + const result = await camunda.resolveProcessInstanceIncidents({ + processInstanceKey, + }); + + console.log(`Batch operation key: ${result.batchOperationKey}`); +} +``` + #### Operation Id resolveProcessInstanceIncidents @@ -5695,19 +7258,15 @@ resolveProcessInstanceIncidents Process instance -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### resumeBatchOperation() ```ts -resumeBatchOperation(input, consistencyManagement): CancelablePromise; +resumeBatchOperation(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8271](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8271) +Defined in: [gen/CamundaClient.ts:9146](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9146) Resume Batch operation @@ -5724,14 +7283,26 @@ This is done asynchronously, the progress can be tracked using the batch operati [`BatchOperationKey`](../type-aliases/BatchOperationKey.md) -##### consistencyManagement +##### options? -[`resumeBatchOperationConsistency`](../type-aliases/resumeBatchOperationConsistency.md) +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function resumeBatchOperationExample() { + const camunda = createCamundaClient(); + + const batchOperationKey = BatchOperationKey.assumeExists("2251799813685249"); + + await camunda.resumeBatchOperation({ batchOperationKey }); +} +``` + #### Operation Id resumeBatchOperation @@ -5740,19 +7311,18 @@ resumeBatchOperation Batch operation -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### searchAuditLogs() ```ts -searchAuditLogs(input, consistencyManagement): CancelablePromise; +searchAuditLogs( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8336](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8336) +Defined in: [gen/CamundaClient.ts:9211](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9211) Search audit logs @@ -5770,9 +7340,32 @@ Search for audit logs based on given criteria. [`searchAuditLogsConsistency`](../type-aliases/searchAuditLogsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`AuditLogSearchQueryResult`](../type-aliases/AuditLogSearchQueryResult.md)\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -5791,10 +7384,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchAuthorizations() ```ts -searchAuthorizations(input, consistencyManagement): CancelablePromise; +searchAuthorizations( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8399](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8399) +Defined in: [gen/CamundaClient.ts:9278](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9278) Search authorizations @@ -5812,10 +7408,36 @@ Search for authorizations based on given criteria. [`searchAuthorizationsConsistency`](../type-aliases/searchAuthorizationsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`AuthorizationSearchResult`](../type-aliases/AuthorizationSearchResult.md)\> +#### Example + +```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}` + ); + } +} +``` + #### Operation Id searchAuthorizations @@ -5833,10 +7455,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchBatchOperationItems() ```ts -searchBatchOperationItems(input, consistencyManagement): CancelablePromise; +searchBatchOperationItems( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8462](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8462) +Defined in: [gen/CamundaClient.ts:9345](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9345) Search batch operation items @@ -5848,15 +7473,38 @@ Search for batch operation items based on given criteria. ##### input -[`SearchQueryRequest`](../type-aliases/SearchQueryRequest.md) & `object` +[`BatchOperationItemSearchQuery`](../type-aliases/BatchOperationItemSearchQuery.md) ##### consistencyManagement [`searchBatchOperationItemsConsistency`](../type-aliases/searchBatchOperationItemsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationItemSearchQueryResult`](../type-aliases/BatchOperationItemSearchQueryResult.md)\> + +#### Example + +```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})`); + } +} +``` #### Operation Id @@ -5875,10 +7523,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchBatchOperations() ```ts -searchBatchOperations(input, consistencyManagement): CancelablePromise; +searchBatchOperations( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8525](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8525) +Defined in: [gen/CamundaClient.ts:9412](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9412) Search batch operations @@ -5890,15 +7541,40 @@ Search for batch operations based on given criteria. ##### input -[`SearchQueryRequest`](../type-aliases/SearchQueryRequest.md) & `object` +[`BatchOperationSearchQuery`](../type-aliases/BatchOperationSearchQuery.md) ##### consistencyManagement [`searchBatchOperationsConsistency`](../type-aliases/searchBatchOperationsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationSearchQueryResult`](../type-aliases/BatchOperationSearchQueryResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`BatchOperationSearchQueryResult`](../type-aliases/BatchOperationSearchQueryResult.md)\> + +#### Example + +```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})` + ); + } +} +``` #### Operation Id @@ -5917,10 +7593,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchClientsForGroup() ```ts -searchClientsForGroup(input, consistencyManagement): CancelablePromise; +searchClientsForGroup( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8588](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8588) +Defined in: [gen/CamundaClient.ts:9479](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9479) Search group clients @@ -5938,9 +7617,30 @@ Search clients assigned to a group. [`searchClientsForGroupConsistency`](../type-aliases/searchClientsForGroupConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantClientSearchResult`](../type-aliases/TenantClientSearchResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -5959,10 +7659,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchClientsForRole() ```ts -searchClientsForRole(input, consistencyManagement): CancelablePromise; +searchClientsForRole( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8653](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8653) +Defined in: [gen/CamundaClient.ts:9548](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9548) Search role clients @@ -5980,9 +7683,30 @@ Search clients with assigned role. [`searchClientsForRoleConsistency`](../type-aliases/searchClientsForRoleConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantClientSearchResult`](../type-aliases/TenantClientSearchResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -6001,10 +7725,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchClientsForTenant() ```ts -searchClientsForTenant(input, consistencyManagement): CancelablePromise; +searchClientsForTenant( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8718](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8718) +Defined in: [gen/CamundaClient.ts:9617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9617) Search clients for tenant @@ -6022,9 +7749,30 @@ Retrieves a filtered and sorted list of clients for a specified tenant. [`searchClientsForTenantConsistency`](../type-aliases/searchClientsForTenantConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantClientSearchResult`](../type-aliases/TenantClientSearchResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```ts +async function searchClientsForTenantExample() { + const camunda = createCamundaClient(); + + const result = await camunda.searchClientsForTenant( + { tenantId: TenantId.assumeExists("customer-service") }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const client of result.items ?? []) { + console.log(`Client: ${client.clientId}`); + } +} +``` #### Operation Id @@ -6043,10 +7791,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchClusterVariables() ```ts -searchClusterVariables(input, consistencyManagement): CancelablePromise; +searchClusterVariables( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8781](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8781) +Defined in: [gen/CamundaClient.ts:9684](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9684) Search for cluster variables based on given criteria. By default, long variable values in the response are truncated. @@ -6062,9 +7813,32 @@ Search for cluster variables based on given criteria. By default, long variable [`searchClusterVariablesConsistency`](../type-aliases/searchClusterVariablesConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ClusterVariableSearchQueryResult`](../type-aliases/ClusterVariableSearchQueryResult.md)\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -6083,10 +7857,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchCorrelatedMessageSubscriptions() ```ts -searchCorrelatedMessageSubscriptions(input, consistencyManagement): CancelablePromise; +searchCorrelatedMessageSubscriptions( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8846](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8846) +Defined in: [gen/CamundaClient.ts:9753](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9753) Search correlated message subscriptions @@ -6104,9 +7881,32 @@ Search correlated message subscriptions based on given criteria. [`searchCorrelatedMessageSubscriptionsConsistency`](../type-aliases/searchCorrelatedMessageSubscriptionsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`CorrelatedMessageSubscriptionSearchQueryResult`](../type-aliases/CorrelatedMessageSubscriptionSearchQueryResult.md)\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -6125,10 +7925,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchDecisionDefinitions() ```ts -searchDecisionDefinitions(input, consistencyManagement): CancelablePromise; +searchDecisionDefinitions( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8911](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8911) +Defined in: [gen/CamundaClient.ts:9820](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9820) Search decision definitions @@ -6146,6 +7949,10 @@ Search for decision definitions based on given criteria. [`searchDecisionDefinitionsConsistency`](../type-aliases/searchDecisionDefinitionsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DecisionDefinitionSearchQueryResult`](../type-aliases/DecisionDefinitionSearchQueryResult.md)\> @@ -6190,10 +7997,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchDecisionInstances() ```ts -searchDecisionInstances(input, consistencyManagement): CancelablePromise; +searchDecisionInstances( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:8974](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L8974) +Defined in: [gen/CamundaClient.ts:9887](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9887) Search decision instances @@ -6205,15 +8015,40 @@ Search for decision instances based on given criteria. ##### input -[`SearchQueryRequest`](../type-aliases/SearchQueryRequest.md) & `object` +[`DecisionInstanceSearchQuery`](../type-aliases/DecisionInstanceSearchQuery.md) ##### consistencyManagement [`searchDecisionInstancesConsistency`](../type-aliases/searchDecisionInstancesConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DecisionInstanceSearchQueryResult`](../type-aliases/DecisionInstanceSearchQueryResult.md)\> + +#### Example + +```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}` + ); + } +} +``` #### Operation Id @@ -6232,10 +8067,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchDecisionRequirements() ```ts -searchDecisionRequirements(input, consistencyManagement): CancelablePromise; +searchDecisionRequirements( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9037](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9037) +Defined in: [gen/CamundaClient.ts:9954](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L9954) Search decision requirements @@ -6253,10 +8091,35 @@ Search for decision requirements based on given criteria. [`searchDecisionRequirementsConsistency`](../type-aliases/searchDecisionRequirementsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`DecisionRequirementsSearchQueryResult`](../type-aliases/DecisionRequirementsSearchQueryResult.md)\> +#### Example + +```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}` + ); + } +} +``` + #### Operation Id searchDecisionRequirements @@ -6274,10 +8137,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchElementInstanceIncidents() ```ts -searchElementInstanceIncidents(input, consistencyManagement): CancelablePromise; +searchElementInstanceIncidents( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9107](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9107) +Defined in: [gen/CamundaClient.ts:10028](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10028) Search for incidents of a specific element instance @@ -6301,9 +8167,33 @@ to the root element itself. [`searchElementInstanceIncidentsConsistency`](../type-aliases/searchElementInstanceIncidentsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`IncidentSearchQueryResult`](../type-aliases/IncidentSearchQueryResult.md)\> + +#### Example + +```ts +async function searchElementInstanceIncidentsExample() { + const camunda = createCamundaClient(); + + const elementInstanceKey = + ElementInstanceKey.assumeExists("2251799813685249"); + + const result = await camunda.searchElementInstanceIncidents( + { elementInstanceKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const incident of result.items ?? []) { + console.log(`Incident: ${incident.errorType}`); + } +} +``` #### Operation Id @@ -6322,10 +8212,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchElementInstances() ```ts -searchElementInstances(input, consistencyManagement): CancelablePromise; +searchElementInstances( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9172](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9172) +Defined in: [gen/CamundaClient.ts:10097](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10097) Search element instances @@ -6343,9 +8236,35 @@ Search for element instances based on given criteria. [`searchElementInstancesConsistency`](../type-aliases/searchElementInstancesConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ElementInstanceSearchQueryResult`](../type-aliases/ElementInstanceSearchQueryResult.md)\> + +#### Example + +```ts +async function searchElementInstancesExample() { + const camunda = createCamundaClient(); + + const result = await camunda.searchElementInstances( + { + filter: { + processInstanceKey: ProcessInstanceKey.assumeExists("2251799813685249"), + }, + page: { limit: 10 }, + }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const element of result.items ?? []) { + console.log(`${element.elementId}: ${element.type} (${element.state})`); + } +} +``` #### Operation Id @@ -6361,13 +8280,84 @@ eventual - this endpoint is backed by data that is eventually consistent with th --- +### searchGlobalTaskListeners() + +```ts +searchGlobalTaskListeners( + input, + consistencyManagement, +options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:10164](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10164) + +Search global user task listeners + +Search for global user task listeners based on given criteria. + +- + +#### Parameters + +##### input + +[`GlobalTaskListenerSearchQueryRequest`](../type-aliases/GlobalTaskListenerSearchQueryRequest.md) + +##### consistencyManagement + +[`searchGlobalTaskListenersConsistency`](../type-aliases/searchGlobalTaskListenersConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GlobalTaskListenerSearchQueryResult`](../type-aliases/GlobalTaskListenerSearchQueryResult.md)\> + +#### Example + +```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})`); + } +} +``` + +#### Operation Id + +searchGlobalTaskListeners + +#### Tags + +Global listener + +#### Consistency + +eventual - this endpoint is backed by data that is eventually consistent with the system state. + +--- + ### searchGroupIdsForTenant() ```ts -searchGroupIdsForTenant(input, consistencyManagement): CancelablePromise; +searchGroupIdsForTenant( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9235](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9235) +Defined in: [gen/CamundaClient.ts:10231](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10231) Search groups for tenant @@ -6385,10 +8375,31 @@ Retrieves a filtered and sorted list of groups for a specified tenant. [`searchGroupIdsForTenantConsistency`](../type-aliases/searchGroupIdsForTenantConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantGroupSearchResult`](../type-aliases/TenantGroupSearchResult.md)\> +#### Example + +```ts +async function searchGroupIdsForTenantExample() { + const camunda = createCamundaClient(); + + const result = await camunda.searchGroupIdsForTenant( + { tenantId: TenantId.assumeExists("customer-service") }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const group of result.items ?? []) { + console.log(`Group: ${group.groupId}`); + } +} +``` + #### Operation Id searchGroupIdsForTenant @@ -6406,10 +8417,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchGroups() ```ts -searchGroups(input, consistencyManagement): CancelablePromise; +searchGroups( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9300](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9300) +Defined in: [gen/CamundaClient.ts:10300](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10300) Search groups @@ -6427,9 +8441,32 @@ Search for groups based on given criteria. [`searchGroupsConsistency`](../type-aliases/searchGroupsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GroupSearchQueryResult`](../type-aliases/GroupSearchQueryResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GroupSearchQueryResult`](../type-aliases/GroupSearchQueryResult.md)\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -6448,10 +8485,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchGroupsForRole() ```ts -searchGroupsForRole(input, consistencyManagement): CancelablePromise; +searchGroupsForRole( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9363](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9363) +Defined in: [gen/CamundaClient.ts:10367](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10367) Search role groups @@ -6469,10 +8509,31 @@ Search groups with assigned role. [`searchGroupsForRoleConsistency`](../type-aliases/searchGroupsForRoleConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`RoleGroupSearchResult`](../type-aliases/RoleGroupSearchResult.md)\> +#### Example + +```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}`); + } +} +``` + #### Operation Id searchGroupsForRole @@ -6490,10 +8551,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchIncidents() ```ts -searchIncidents(input, consistencyManagement): CancelablePromise; +searchIncidents( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9431](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9431) +Defined in: [gen/CamundaClient.ts:10437](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10437) Search incidents @@ -6511,9 +8575,13 @@ Search for incidents based on given criteria. [`searchIncidentsConsistency`](../type-aliases/searchIncidentsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`IncidentSearchQueryResult`](../type-aliases/IncidentSearchQueryResult.md)\> #### Example @@ -6556,10 +8624,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchJobs() ```ts -searchJobs(input, consistencyManagement): CancelablePromise; +searchJobs( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9494](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9494) +Defined in: [gen/CamundaClient.ts:10504](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10504) Search jobs @@ -6577,9 +8648,33 @@ Search for jobs based on given criteria. [`searchJobsConsistency`](../type-aliases/searchJobsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`JobSearchQueryResult`](../type-aliases/JobSearchQueryResult.md)\> + +#### Example + +```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})`); + } +} +``` #### Operation Id @@ -6598,10 +8693,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchMappingRule() ```ts -searchMappingRule(input, consistencyManagement): CancelablePromise; +searchMappingRule( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9558](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9558) +Defined in: [gen/CamundaClient.ts:10572](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10572) Search mapping rules @@ -6619,9 +8717,32 @@ Search for mapping rules based on given criteria. [`searchMappingRuleConsistency`](../type-aliases/searchMappingRuleConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`MappingRuleSearchQueryResult`](../type-aliases/MappingRuleSearchQueryResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -6640,10 +8761,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchMappingRulesForGroup() ```ts -searchMappingRulesForGroup(input, consistencyManagement): CancelablePromise; +searchMappingRulesForGroup( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9621](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9621) +Defined in: [gen/CamundaClient.ts:10639](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10639) Search group mapping rules @@ -6661,9 +8785,30 @@ Search mapping rules assigned to a group. [`searchMappingRulesForGroupConsistency`](../type-aliases/searchMappingRulesForGroupConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -6682,10 +8827,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchMappingRulesForRole() ```ts -searchMappingRulesForRole(input, consistencyManagement): CancelablePromise; +searchMappingRulesForRole( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9686](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9686) +Defined in: [gen/CamundaClient.ts:10708](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10708) Search role mapping rules @@ -6703,9 +8851,30 @@ Search mapping rules with assigned role. [`searchMappingRulesForRoleConsistency`](../type-aliases/searchMappingRulesForRoleConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -6724,10 +8893,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchMappingRulesForTenant() ```ts -searchMappingRulesForTenant(input, consistencyManagement): CancelablePromise; +searchMappingRulesForTenant( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9751](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9751) +Defined in: [gen/CamundaClient.ts:10777](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10777) Search mapping rules for tenant @@ -6745,9 +8917,30 @@ Retrieves a filtered and sorted list of MappingRules for a specified tenant. [`searchMappingRulesForTenantConsistency`](../type-aliases/searchMappingRulesForTenantConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```ts +async function searchMappingRulesForTenantExample() { + const camunda = createCamundaClient(); + + const result = await camunda.searchMappingRulesForTenant( + { tenantId: TenantId.assumeExists("customer-service") }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const rule of result.items ?? []) { + console.log(`Mapping rule: ${rule.name}`); + } +} +``` #### Operation Id @@ -6766,10 +8959,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchMessageSubscriptions() ```ts -searchMessageSubscriptions(input, consistencyManagement): CancelablePromise; +searchMessageSubscriptions( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9816](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9816) +Defined in: [gen/CamundaClient.ts:10846](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10846) Search message subscriptions @@ -6781,15 +8977,38 @@ Search for message subscriptions based on given criteria. ##### input -[`SearchQueryRequest`](../type-aliases/SearchQueryRequest.md) & `object` +[`MessageSubscriptionSearchQuery`](../type-aliases/MessageSubscriptionSearchQuery.md) ##### consistencyManagement [`searchMessageSubscriptionsConsistency`](../type-aliases/searchMessageSubscriptionsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`MessageSubscriptionSearchQueryResult`](../type-aliases/MessageSubscriptionSearchQueryResult.md)\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -6808,10 +9027,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchProcessDefinitions() ```ts -searchProcessDefinitions(input, consistencyManagement): CancelablePromise; +searchProcessDefinitions( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9879](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9879) +Defined in: [gen/CamundaClient.ts:10913](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10913) Search process definitions @@ -6823,16 +9045,41 @@ Search for process definitions based on given criteria. ##### input -[`SearchQueryRequest`](../type-aliases/SearchQueryRequest.md) & `object` +[`ProcessDefinitionSearchQuery`](../type-aliases/ProcessDefinitionSearchQuery.md) ##### consistencyManagement [`searchProcessDefinitionsConsistency`](../type-aliases/searchProcessDefinitionsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessDefinitionSearchQueryResult`](../type-aliases/ProcessDefinitionSearchQueryResult.md)\> +#### Example + +```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}` + ); + } +} +``` + #### Operation Id searchProcessDefinitions @@ -6850,10 +9097,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchProcessInstanceIncidents() ```ts -searchProcessInstanceIncidents(input, consistencyManagement): CancelablePromise; +searchProcessInstanceIncidents( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:9948](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L9948) +Defined in: [gen/CamundaClient.ts:10986](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L10986) Search related incidents @@ -6876,9 +9126,35 @@ subprocesses or called processes under the root instance while excluding inciden [`searchProcessInstanceIncidentsConsistency`](../type-aliases/searchProcessInstanceIncidentsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`IncidentSearchQueryResult`](../type-aliases/IncidentSearchQueryResult.md)\> + +#### Example + +```ts +async function searchProcessInstanceIncidentsExample() { + const camunda = createCamundaClient(); + + const processInstanceKey = + ProcessInstanceKey.assumeExists("2251799813685249"); + + const result = await camunda.searchProcessInstanceIncidents( + { + processInstanceKey, + }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const incident of result.items ?? []) { + console.log(`Incident: ${incident.errorType} - ${incident.errorMessage}`); + } +} +``` #### Operation Id @@ -6897,10 +9173,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchProcessInstances() ```ts -searchProcessInstances(input, consistencyManagement): CancelablePromise; +searchProcessInstances( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10015](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10015) +Defined in: [gen/CamundaClient.ts:11055](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11055) Search process instances @@ -6912,15 +9191,19 @@ Search for process instances based on given criteria. ##### input -[`SearchQueryRequest`](../type-aliases/SearchQueryRequest.md) & `object` +[`ProcessInstanceSearchQuery`](../type-aliases/ProcessInstanceSearchQuery.md) ##### consistencyManagement [`searchProcessInstancesConsistency`](../type-aliases/searchProcessInstancesConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ProcessInstanceSearchQueryResult`](../type-aliases/ProcessInstanceSearchQueryResult.md)\> #### Example @@ -6963,10 +9246,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchRoles() ```ts -searchRoles(input, consistencyManagement): CancelablePromise; +searchRoles( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10078](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10078) +Defined in: [gen/CamundaClient.ts:11122](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11122) Search roles @@ -6984,10 +9270,33 @@ Search for roles based on given criteria. [`searchRolesConsistency`](../type-aliases/searchRolesConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`RoleSearchQueryResult`](../type-aliases/RoleSearchQueryResult.md)\> +#### Example + +```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}`); + } +} +``` + #### Operation Id searchRoles @@ -7005,10 +9314,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchRolesForGroup() ```ts -searchRolesForGroup(input, consistencyManagement): CancelablePromise; +searchRolesForGroup( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10141](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10141) +Defined in: [gen/CamundaClient.ts:11189](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11189) Search group roles @@ -7026,9 +9338,30 @@ Search roles assigned to a group. [`searchRolesForGroupConsistency`](../type-aliases/searchRolesForGroupConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -7047,10 +9380,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchRolesForTenant() ```ts -searchRolesForTenant(input, consistencyManagement): CancelablePromise; +searchRolesForTenant( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10206](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10206) +Defined in: [gen/CamundaClient.ts:11258](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11258) Search roles for tenant @@ -7068,9 +9404,30 @@ Retrieves a filtered and sorted list of roles for a specified tenant. [`searchRolesForTenantConsistency`](../type-aliases/searchRolesForTenantConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```ts +async function searchRolesForTenantExample() { + const camunda = createCamundaClient(); + + const result = await camunda.searchRolesForTenant( + { tenantId: TenantId.assumeExists("customer-service") }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const role of result.items ?? []) { + console.log(`Role: ${role.name}`); + } +} +``` #### Operation Id @@ -7089,10 +9446,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchTenants() ```ts -searchTenants(input, consistencyManagement): CancelablePromise; +searchTenants( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10271](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10271) +Defined in: [gen/CamundaClient.ts:11327](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11327) Search tenants @@ -7104,16 +9464,39 @@ Retrieves a filtered and sorted list of tenants. ##### input -[`SearchQueryRequest`](../type-aliases/SearchQueryRequest.md) & `object` +[`TenantSearchQueryRequest`](../type-aliases/TenantSearchQueryRequest.md) ##### consistencyManagement [`searchTenantsConsistency`](../type-aliases/searchTenantsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantSearchQueryResult`](../type-aliases/TenantSearchQueryResult.md)\> +#### Example + +```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}`); + } +} +``` + #### Operation Id searchTenants @@ -7131,10 +9514,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchUsers() ```ts -searchUsers(input, consistencyManagement): CancelablePromise; +searchUsers( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10334](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10334) +Defined in: [gen/CamundaClient.ts:11394](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11394) Search users @@ -7146,15 +9532,39 @@ Search for users based on given criteria. ##### input -[`SearchQueryRequest`](../type-aliases/SearchQueryRequest.md) & `object` +[`UserSearchQueryRequest`](../type-aliases/UserSearchQueryRequest.md) + +##### consistencyManagement + +[`searchUsersConsistency`](../type-aliases/searchUsersConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> -##### consistencyManagement +#### Example -[`searchUsersConsistency`](../type-aliases/searchUsersConsistency.md) +```ts +async function searchUsersExample() { + const camunda = createCamundaClient(); -#### Returns + const result = await camunda.searchUsers( + { + filter: {}, + page: { limit: 10 }, + }, + { consistency: { waitUpToMs: 5000 } } + ); -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`UserSearchResult`](../type-aliases/UserSearchResult.md)\> + for (const user of result.items ?? []) { + console.log(`${user.username}: ${user.name}`); + } +} +``` #### Operation Id @@ -7173,10 +9583,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchUsersForGroup() ```ts -searchUsersForGroup(input, consistencyManagement): CancelablePromise; +searchUsersForGroup( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10397](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10397) +Defined in: [gen/CamundaClient.ts:11461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11461) Search group users @@ -7194,9 +9607,30 @@ Search users assigned to a group. [`searchUsersForGroupConsistency`](../type-aliases/searchUsersForGroupConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantUserSearchResult`](../type-aliases/TenantUserSearchResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -7215,10 +9649,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchUsersForRole() ```ts -searchUsersForRole(input, consistencyManagement): CancelablePromise; +searchUsersForRole( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10462](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10462) +Defined in: [gen/CamundaClient.ts:11530](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11530) Search role users @@ -7236,9 +9673,30 @@ Search users with assigned role. [`searchUsersForRoleConsistency`](../type-aliases/searchUsersForRoleConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantUserSearchResult`](../type-aliases/TenantUserSearchResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```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}`); + } +} +``` #### Operation Id @@ -7257,10 +9715,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchUsersForTenant() ```ts -searchUsersForTenant(input, consistencyManagement): CancelablePromise; +searchUsersForTenant( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10527](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10527) +Defined in: [gen/CamundaClient.ts:11599](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11599) Search users for tenant @@ -7278,9 +9739,30 @@ Retrieves a filtered and sorted list of users for a specified tenant. [`searchUsersForTenantConsistency`](../type-aliases/searchUsersForTenantConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantUserSearchResult`](../type-aliases/TenantUserSearchResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> + +#### Example + +```ts +async function searchUsersForTenantExample() { + const camunda = createCamundaClient(); + + const result = await camunda.searchUsersForTenant( + { tenantId: TenantId.assumeExists("customer-service") }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const user of result.items ?? []) { + console.log(`Tenant member: ${user.username}`); + } +} +``` #### Operation Id @@ -7299,10 +9781,13 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchUserTaskAuditLogs() ```ts -searchUserTaskAuditLogs(input, consistencyManagement): CancelablePromise; +searchUserTaskAuditLogs( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10592](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10592) +Defined in: [gen/CamundaClient.ts:11668](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11668) Search user task audit logs @@ -7320,9 +9805,33 @@ Search for user task audit logs based on given criteria. [`searchUserTaskAuditLogsConsistency`](../type-aliases/searchUserTaskAuditLogsConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`AuditLogSearchQueryResult`](../type-aliases/AuditLogSearchQueryResult.md)\> + +#### Example + +```ts +async function searchUserTaskAuditLogsExample() { + const camunda = createCamundaClient(); + + const { UserTaskKey } = await import("@camunda8/orchestration-cluster-api"); + const userTaskKey = UserTaskKey.assumeExists("2251799813685249"); + + const result = await camunda.searchUserTaskAuditLogs( + { userTaskKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const log of result.items ?? []) { + console.log(`Audit: ${log.operationType} at ${log.timestamp}`); + } +} +``` #### Operation Id @@ -7338,13 +9847,70 @@ eventual - this endpoint is backed by data that is eventually consistent with th --- +### searchUserTaskEffectiveVariables() + +```ts +searchUserTaskEffectiveVariables( + input, + consistencyManagement, +options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:11741](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11741) + +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. + +- + +#### Parameters + +##### input + +[`searchUserTaskEffectiveVariablesInput`](../type-aliases/searchUserTaskEffectiveVariablesInput.md) + +##### consistencyManagement + +[`searchUserTaskEffectiveVariablesConsistency`](../type-aliases/searchUserTaskEffectiveVariablesConsistency.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`VariableSearchQueryResult`](../type-aliases/VariableSearchQueryResult.md)\> + +#### Operation Id + +searchUserTaskEffectiveVariables + +#### Tags + +User task + +#### Consistency + +eventual - this endpoint is backed by data that is eventually consistent with the system state. + +--- + ### searchUserTasks() ```ts -searchUserTasks(input, consistencyManagement): CancelablePromise; +searchUserTasks( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10659](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10659) +Defined in: [gen/CamundaClient.ts:11812](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11812) Search user tasks @@ -7356,15 +9922,19 @@ Search for user tasks based on given criteria. ##### input -[`SearchQueryRequest`](../type-aliases/SearchQueryRequest.md) & `object` +[`UserTaskSearchQuery`](../type-aliases/UserTaskSearchQuery.md) ##### consistencyManagement [`searchUserTasksConsistency`](../type-aliases/searchUserTasksConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`UserTaskSearchQueryResult`](../type-aliases/UserTaskSearchQueryResult.md)\> #### Example @@ -7404,14 +9974,23 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchUserTaskVariables() ```ts -searchUserTaskVariables(input, consistencyManagement): CancelablePromise; +searchUserTaskVariables( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10722](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10722) +Defined in: [gen/CamundaClient.ts:11886](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11886) Search user task variables -Search for user task variables based on given criteria. By default, long variable values in the response are truncated. +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. - @@ -7425,9 +10004,33 @@ Search for user task variables based on given criteria. By default, long variabl [`searchUserTaskVariablesConsistency`](../type-aliases/searchUserTaskVariablesConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`VariableSearchQueryResult`](../type-aliases/VariableSearchQueryResult.md)\> + +#### Example + +```ts +async function searchUserTaskVariablesExample() { + const camunda = createCamundaClient(); + + const { UserTaskKey } = await import("@camunda8/orchestration-cluster-api"); + const userTaskKey = UserTaskKey.assumeExists("2251799813685249"); + + const result = await camunda.searchUserTaskVariables( + { userTaskKey }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const variable of result.items ?? []) { + console.log(`${variable.name} = ${variable.value}`); + } +} +``` #### Operation Id @@ -7446,14 +10049,25 @@ eventual - this endpoint is backed by data that is eventually consistent with th ### searchVariables() ```ts -searchVariables(input, consistencyManagement): CancelablePromise; +searchVariables( + input, + consistencyManagement, +options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10789](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10789) +Defined in: [gen/CamundaClient.ts:11965](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L11965) Search variables -Search for process and local variables based on given criteria. By default, long variable values in the response are truncated. +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. - @@ -7467,9 +10081,35 @@ Search for process and local variables based on given criteria. By default, long [`searchVariablesConsistency`](../type-aliases/searchVariablesConsistency.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`SearchQueryResponse`](../type-aliases/SearchQueryResponse.md) & `object`\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`VariableSearchQueryResult`](../type-aliases/VariableSearchQueryResult.md)\> + +#### Example + +```ts +async function searchVariablesExample() { + const camunda = createCamundaClient(); + + const result = await camunda.searchVariables( + { + filter: { + processInstanceKey: ProcessInstanceKey.assumeExists("2251799813685249"), + }, + page: { limit: 10 }, + }, + { consistency: { waitUpToMs: 5000 } } + ); + + for (const variable of result.items ?? []) { + console.log(`${variable.name} = ${variable.value}`); + } +} +``` #### Operation Id @@ -7491,9 +10131,9 @@ eventual - this endpoint is backed by data that is eventually consistent with th stopAllWorkers(): void; ``` -Defined in: [gen/CamundaClient.ts:1556](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1556) +Defined in: [gen/CamundaClient.ts:1575](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1575) -Stop all registered job workers (best-effort). +Stop all registered job workers (best-effort) and terminate the shared thread pool. #### Returns @@ -7504,10 +10144,10 @@ Stop all registered job workers (best-effort). ### suspendBatchOperation() ```ts -suspendBatchOperation(input, consistencyManagement): CancelablePromise; +suspendBatchOperation(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10856](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10856) +Defined in: [gen/CamundaClient.ts:12035](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12035) Suspend Batch operation @@ -7524,14 +10164,26 @@ This is done asynchronously, the progress can be tracked using the batch operati [`BatchOperationKey`](../type-aliases/BatchOperationKey.md) -##### consistencyManagement +##### options? -[`suspendBatchOperationConsistency`](../type-aliases/suspendBatchOperationConsistency.md) +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function suspendBatchOperationExample() { + const camunda = createCamundaClient(); + + const batchOperationKey = BatchOperationKey.assumeExists("2251799813685249"); + + await camunda.suspendBatchOperation({ batchOperationKey }); +} +``` + #### Operation Id suspendBatchOperation @@ -7540,19 +10192,15 @@ suspendBatchOperation Batch operation -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### throwJobError() ```ts -throwJobError(input): CancelablePromise; +throwJobError(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10921](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10921) +Defined in: [gen/CamundaClient.ts:12100](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12100) Throw error for job @@ -7566,10 +10214,30 @@ Reports a business error (i.e. non-technical) that occurs while processing a job [`throwJobErrorInput`](../type-aliases/throwJobErrorInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function throwJobErrorExample() { + const camunda = createCamundaClient(); + + const jobKey = JobKey.assumeExists("2251799813685249"); + + await camunda.throwJobError({ + jobKey, + errorCode: "PAYMENT_FAILED", + errorMessage: "Payment provider returned error", + }); +} +``` + #### Operation Id throwJobError @@ -7583,10 +10251,10 @@ Job ### unassignClientFromGroup() ```ts -unassignClientFromGroup(input): CancelablePromise; +unassignClientFromGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:10983](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L10983) +Defined in: [gen/CamundaClient.ts:12166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12166) Unassign a client from a group @@ -7601,10 +10269,27 @@ The client is removed as a group member, with associated authorizations, roles, [`unassignClientFromGroupInput`](../type-aliases/unassignClientFromGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignClientFromGroupExample() { + const camunda = createCamundaClient(); + + await camunda.unassignClientFromGroup({ + groupId: "engineering-team", + clientId: "my-service-account", + }); +} +``` + #### Operation Id unassignClientFromGroup @@ -7618,10 +10303,10 @@ Group ### unassignClientFromTenant() ```ts -unassignClientFromTenant(input): CancelablePromise; +unassignClientFromTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11043](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11043) +Defined in: [gen/CamundaClient.ts:12230](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12230) Unassign a client from a tenant @@ -7636,10 +10321,27 @@ The client can no longer access tenant data. [`unassignClientFromTenantInput`](../type-aliases/unassignClientFromTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignClientFromTenantExample() { + const camunda = createCamundaClient(); + + await camunda.unassignClientFromTenant({ + tenantId: TenantId.assumeExists("customer-service"), + clientId: "my-service-account", + }); +} +``` + #### Operation Id unassignClientFromTenant @@ -7653,10 +10355,10 @@ Tenant ### unassignGroupFromTenant() ```ts -unassignGroupFromTenant(input): CancelablePromise; +unassignGroupFromTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11103) +Defined in: [gen/CamundaClient.ts:12294](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12294) Unassign a group from a tenant @@ -7671,10 +10373,27 @@ Members of the group (users, clients) will no longer have access to the tenant's [`unassignGroupFromTenantInput`](../type-aliases/unassignGroupFromTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignGroupFromTenantExample() { + const camunda = createCamundaClient(); + + await camunda.unassignGroupFromTenant({ + tenantId: TenantId.assumeExists("customer-service"), + groupId: "engineering-team", + }); +} +``` + #### Operation Id unassignGroupFromTenant @@ -7688,10 +10407,10 @@ Tenant ### unassignMappingRuleFromGroup() ```ts -unassignMappingRuleFromGroup(input): CancelablePromise; +unassignMappingRuleFromGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11161](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11161) +Defined in: [gen/CamundaClient.ts:12356](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12356) Unassign a mapping rule from a group @@ -7705,10 +10424,27 @@ Unassigns a mapping rule from a group. [`unassignMappingRuleFromGroupInput`](../type-aliases/unassignMappingRuleFromGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignMappingRuleFromGroupExample() { + const camunda = createCamundaClient(); + + await camunda.unassignMappingRuleFromGroup({ + groupId: "engineering-team", + mappingRuleId: "rule-123", + }); +} +``` + #### Operation Id unassignMappingRuleFromGroup @@ -7722,10 +10458,10 @@ Group ### unassignMappingRuleFromTenant() ```ts -unassignMappingRuleFromTenant(input): CancelablePromise; +unassignMappingRuleFromTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11219](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11219) +Defined in: [gen/CamundaClient.ts:12418](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12418) Unassign a mapping rule from a tenant @@ -7739,10 +10475,27 @@ Unassigns a single mapping rule from a specified tenant without deleting the rul [`unassignMappingRuleFromTenantInput`](../type-aliases/unassignMappingRuleFromTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignMappingRuleFromTenantExample() { + const camunda = createCamundaClient(); + + await camunda.unassignMappingRuleFromTenant({ + tenantId: TenantId.assumeExists("customer-service"), + mappingRuleId: "rule-123", + }); +} +``` + #### Operation Id unassignMappingRuleFromTenant @@ -7756,10 +10509,10 @@ Tenant ### unassignRoleFromClient() ```ts -unassignRoleFromClient(input): CancelablePromise; +unassignRoleFromClient(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11277](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11277) +Defined in: [gen/CamundaClient.ts:12480](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12480) Unassign a role from a client @@ -7773,10 +10526,27 @@ Unassigns the specified role from the client. The client will no longer inherit [`unassignRoleFromClientInput`](../type-aliases/unassignRoleFromClientInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignRoleFromClientExample() { + const camunda = createCamundaClient(); + + await camunda.unassignRoleFromClient({ + roleId: "process-admin", + clientId: "my-service-account", + }); +} +``` + #### Operation Id unassignRoleFromClient @@ -7790,10 +10560,10 @@ Role ### unassignRoleFromGroup() ```ts -unassignRoleFromGroup(input): CancelablePromise; +unassignRoleFromGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11335](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11335) +Defined in: [gen/CamundaClient.ts:12542](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12542) Unassign a role from a group @@ -7807,10 +10577,27 @@ Unassigns the specified role from the group. All group members (user or client) [`unassignRoleFromGroupInput`](../type-aliases/unassignRoleFromGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignRoleFromGroupExample() { + const camunda = createCamundaClient(); + + await camunda.unassignRoleFromGroup({ + roleId: "process-admin", + groupId: "engineering-team", + }); +} +``` + #### Operation Id unassignRoleFromGroup @@ -7824,10 +10611,10 @@ Role ### unassignRoleFromMappingRule() ```ts -unassignRoleFromMappingRule(input): CancelablePromise; +unassignRoleFromMappingRule(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11393](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11393) +Defined in: [gen/CamundaClient.ts:12604](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12604) Unassign a role from a mapping rule @@ -7841,10 +10628,27 @@ Unassigns a role from a mapping rule. [`unassignRoleFromMappingRuleInput`](../type-aliases/unassignRoleFromMappingRuleInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignRoleFromMappingRuleExample() { + const camunda = createCamundaClient(); + + await camunda.unassignRoleFromMappingRule({ + roleId: "process-admin", + mappingRuleId: "rule-123", + }); +} +``` + #### Operation Id unassignRoleFromMappingRule @@ -7858,10 +10662,10 @@ Role ### unassignRoleFromTenant() ```ts -unassignRoleFromTenant(input): CancelablePromise; +unassignRoleFromTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11454](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11454) +Defined in: [gen/CamundaClient.ts:12669](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12669) Unassign a role from a tenant @@ -7877,10 +10681,27 @@ tenant's data - unless they are assigned directly to the tenant. [`unassignRoleFromTenantInput`](../type-aliases/unassignRoleFromTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignRoleFromTenantExample() { + const camunda = createCamundaClient(); + + await camunda.unassignRoleFromTenant({ + tenantId: TenantId.assumeExists("customer-service"), + roleId: "process-admin", + }); +} +``` + #### Operation Id unassignRoleFromTenant @@ -7894,10 +10715,10 @@ Tenant ### unassignRoleFromUser() ```ts -unassignRoleFromUser(input): CancelablePromise; +unassignRoleFromUser(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11512](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11512) +Defined in: [gen/CamundaClient.ts:12731](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12731) Unassign a role from a user @@ -7911,10 +10732,27 @@ Unassigns a role from a user. The user will no longer inherit the authorizations [`unassignRoleFromUserInput`](../type-aliases/unassignRoleFromUserInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignRoleFromUserExample() { + const camunda = createCamundaClient(); + + await camunda.unassignRoleFromUser({ + roleId: "process-admin", + username: Username.assumeExists("alice"), + }); +} +``` + #### Operation Id unassignRoleFromUser @@ -7928,10 +10766,10 @@ Role ### unassignUserFromGroup() ```ts -unassignUserFromGroup(input): CancelablePromise; +unassignUserFromGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11572](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11572) +Defined in: [gen/CamundaClient.ts:12795](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12795) Unassign a user from a group @@ -7946,10 +10784,27 @@ The user is removed as a group member, with associated authorizations, roles, an [`unassignUserFromGroupInput`](../type-aliases/unassignUserFromGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignUserFromGroupExample() { + const camunda = createCamundaClient(); + + await camunda.unassignUserFromGroup({ + groupId: "engineering-team", + username: Username.assumeExists("alice"), + }); +} +``` + #### Operation Id unassignUserFromGroup @@ -7963,10 +10818,10 @@ Group ### unassignUserFromTenant() ```ts -unassignUserFromTenant(input): CancelablePromise; +unassignUserFromTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11632](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11632) +Defined in: [gen/CamundaClient.ts:12859](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12859) Unassign a user from a tenant @@ -7981,10 +10836,27 @@ The user can no longer access tenant data. [`unassignUserFromTenantInput`](../type-aliases/unassignUserFromTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function unassignUserFromTenantExample() { + const camunda = createCamundaClient(); + + await camunda.unassignUserFromTenant({ + tenantId: TenantId.assumeExists("customer-service"), + username: Username.assumeExists("alice"), + }); +} +``` + #### Operation Id unassignUserFromTenant @@ -7998,14 +10870,14 @@ Tenant ### unassignUserTask() ```ts -unassignUserTask(input): CancelablePromise; +unassignUserTask(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11692](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11692) +Defined in: [gen/CamundaClient.ts:12922](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12922) Unassign user task -Removes the assignee of a task with the given key. +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. - @@ -8015,6 +10887,10 @@ Removes the assignee of a task with the given key. [`unassignUserTaskInput`](../type-aliases/unassignUserTaskInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> @@ -8044,10 +10920,10 @@ User task ### updateAuthorization() ```ts -updateAuthorization(input): CancelablePromise; +updateAuthorization(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11750](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11750) +Defined in: [gen/CamundaClient.ts:12984](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L12984) Update authorization @@ -8061,10 +10937,37 @@ Update the authorization with the given key. [`updateAuthorizationInput`](../type-aliases/updateAuthorizationInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function updateAuthorizationExample() { + const camunda = createCamundaClient(); + + const authorizationKey = AuthorizationKey.assumeExists("2251799813685249"); + + 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", + ], + }); +} +``` + #### Operation Id updateAuthorization @@ -8078,10 +10981,10 @@ Authorization ### updateGlobalClusterVariable() ```ts -updateGlobalClusterVariable(input): CancelablePromise; +updateGlobalClusterVariable(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11812](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11812) +Defined in: [gen/CamundaClient.ts:13050](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13050) Update a global-scoped cluster variable @@ -8096,10 +10999,27 @@ The variable must exist, otherwise a 404 error is returned. [`updateGlobalClusterVariableInput`](../type-aliases/updateGlobalClusterVariableInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ClusterVariableResult`](../type-aliases/ClusterVariableResult.md)\> +#### Example + +```ts +async function updateGlobalClusterVariableExample() { + const camunda = createCamundaClient(); + + await camunda.updateGlobalClusterVariable({ + name: "feature-flags", + value: { darkMode: false }, + }); +} +``` + #### Operation Id updateGlobalClusterVariable @@ -8110,13 +11030,65 @@ Cluster Variable --- +### updateGlobalTaskListener() + +```ts +updateGlobalTaskListener(input, options?): CancelablePromise; +``` + +Defined in: [gen/CamundaClient.ts:13114](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13114) + +Update global user task listener + +Updates a global user task listener. + +- + +#### Parameters + +##### input + +[`updateGlobalTaskListenerInput`](../type-aliases/updateGlobalTaskListenerInput.md) + +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GlobalTaskListenerResult`](../type-aliases/GlobalTaskListenerResult.md)\> + +#### Example + +```ts +async function updateGlobalTaskListenerExample() { + const camunda = createCamundaClient(); + + await camunda.updateGlobalTaskListener({ + id: GlobalListenerId.assumeExists("listener-123"), + eventTypes: ["completing"], + type: "updated-audit-listener", + }); +} +``` + +#### Operation Id + +updateGlobalTaskListener + +#### Tags + +Global listener + +--- + ### updateGroup() ```ts -updateGroup(input): CancelablePromise; +updateGroup(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11872](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11872) +Defined in: [gen/CamundaClient.ts:13178](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13178) Update group @@ -8130,10 +11102,27 @@ Update a group with the given ID. [`updateGroupInput`](../type-aliases/updateGroupInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`GroupUpdateResult`](../type-aliases/GroupUpdateResult.md)\> +#### Example + +```ts +async function updateGroupExample() { + const camunda = createCamundaClient(); + + await camunda.updateGroup({ + groupId: "engineering-team", + name: "Engineering Team", + }); +} +``` + #### Operation Id updateGroup @@ -8147,10 +11136,10 @@ Group ### updateJob() ```ts -updateJob(input): CancelablePromise; +updateJob(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11932](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11932) +Defined in: [gen/CamundaClient.ts:13242](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13242) Update job @@ -8164,10 +11153,29 @@ Update a job with the given key. [`updateJobInput`](../type-aliases/updateJobInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function updateJobExample() { + const camunda = createCamundaClient(); + + const jobKey = JobKey.assumeExists("2251799813685249"); + + await camunda.updateJob({ + jobKey, + changeset: { retries: 5, timeout: 60000 }, + }); +} +``` + #### Operation Id updateJob @@ -8181,10 +11189,10 @@ Job ### updateMappingRule() ```ts -updateMappingRule(input): CancelablePromise; +updateMappingRule(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:11993](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L11993) +Defined in: [gen/CamundaClient.ts:13307](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13307) Update mapping rule @@ -8198,10 +11206,29 @@ Update a mapping rule. [`updateMappingRuleInput`](../type-aliases/updateMappingRuleInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`MappingRuleCreateUpdateResult`](../type-aliases/MappingRuleCreateUpdateResult.md)\> +#### Example + +```ts +async function updateMappingRuleExample() { + const camunda = createCamundaClient(); + + await camunda.updateMappingRule({ + mappingRuleId: "ldap-group-mapping", + name: "LDAP Group Mapping", + claimName: "groups", + claimValue: "engineering-team", + }); +} +``` + #### Operation Id updateMappingRule @@ -8215,10 +11242,10 @@ Mapping rule ### updateRole() ```ts -updateRole(input): CancelablePromise; +updateRole(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:12053](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L12053) +Defined in: [gen/CamundaClient.ts:13371](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13371) Update role @@ -8232,10 +11259,27 @@ Update a role with the given ID. [`updateRoleInput`](../type-aliases/updateRoleInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`RoleUpdateResult`](../type-aliases/RoleUpdateResult.md)\> +#### Example + +```ts +async function updateRoleExample() { + const camunda = createCamundaClient(); + + await camunda.updateRole({ + roleId: "process-admin", + name: "Process Administrator", + }); +} +``` + #### Operation Id updateRole @@ -8249,10 +11293,10 @@ Role ### updateTenant() ```ts -updateTenant(input): CancelablePromise; +updateTenant(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:12113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L12113) +Defined in: [gen/CamundaClient.ts:13435](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13435) Update tenant @@ -8266,10 +11310,29 @@ Updates an existing tenant. [`updateTenantInput`](../type-aliases/updateTenantInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`TenantUpdateResult`](../type-aliases/TenantUpdateResult.md)\> +#### Example + +```ts +async function updateTenantExample() { + const camunda = createCamundaClient(); + + const tenantId = TenantId.assumeExists("customer-service"); + + await camunda.updateTenant({ + tenantId, + name: "Customer Service Team", + }); +} +``` + #### Operation Id updateTenant @@ -8283,10 +11346,10 @@ Tenant ### updateTenantClusterVariable() ```ts -updateTenantClusterVariable(input): CancelablePromise; +updateTenantClusterVariable(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:12175](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L12175) +Defined in: [gen/CamundaClient.ts:13501](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13501) Update a tenant-scoped cluster variable @@ -8301,10 +11364,28 @@ The variable must exist, otherwise a 404 error is returned. [`updateTenantClusterVariableInput`](../type-aliases/updateTenantClusterVariableInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`ClusterVariableResult`](../type-aliases/ClusterVariableResult.md)\> +#### Example + +```ts +async function updateTenantClusterVariableExample() { + const camunda = createCamundaClient(); + + await camunda.updateTenantClusterVariable({ + tenantId: TenantId.assumeExists("customer-service"), + name: "config", + value: { region: "eu-west-1" }, + }); +} +``` + #### Operation Id updateTenantClusterVariable @@ -8318,10 +11399,14 @@ Cluster Variable ### updateUser() ```ts -updateUser(input, consistencyManagement): CancelablePromise; +updateUser(input, options?): CancelablePromise<{ + email: string | null; + name: string | null; + username: Username; +}>; ``` -Defined in: [gen/CamundaClient.ts:12236](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L12236) +Defined in: [gen/CamundaClient.ts:13565](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13565) Update user @@ -8335,13 +11420,33 @@ Updates a user. [`updateUserInput`](../type-aliases/updateUserInput.md) -##### consistencyManagement +##### options? -[`updateUserConsistency`](../type-aliases/updateUserConsistency.md) +[`OperationOptions`](../interfaces/OperationOptions.md) #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<[`UserResult`](../type-aliases/UserResult.md)\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`email`: `string` \| `null`; +`name`: `string` \| `null`; +`username`: [`Username`](../type-aliases/Username.md); +\}\> + +#### Example + +```ts +async function updateUserExample() { + const camunda = createCamundaClient(); + + const username = Username.assumeExists("alice"); + + await camunda.updateUser({ + username, + name: "Alice Jones", + email: "alice.jones@example.com", + }); +} +``` #### Operation Id @@ -8351,23 +11456,19 @@ updateUser User -#### Consistency - -eventual - this endpoint is backed by data that is eventually consistent with the system state. - --- ### updateUserTask() ```ts -updateUserTask(input): CancelablePromise; +updateUserTask(input, options?): CancelablePromise; ``` -Defined in: [gen/CamundaClient.ts:12300](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L12300) +Defined in: [gen/CamundaClient.ts:13630](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L13630) Update user task -Update a user task with the given key. +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. - @@ -8377,10 +11478,34 @@ Update a user task with the given key. [`updateUserTaskInput`](../type-aliases/updateUserTaskInput.md) +##### options? + +[`OperationOptions`](../interfaces/OperationOptions.md) + #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +#### Example + +```ts +async function updateUserTaskExample() { + const camunda = createCamundaClient(); + + const { UserTaskKey } = await import("@camunda8/orchestration-cluster-api"); + const userTaskKey = UserTaskKey.assumeExists("2251799813685249"); + + await camunda.updateUserTask({ + userTaskKey, + changeset: { + candidateUsers: ["alice", "bob"], + dueDate: "2025-12-31T23:59:59Z", + priority: 80, + }, + }); +} +``` + #### Operation Id updateUserTask @@ -8397,7 +11522,7 @@ User task withCorrelation(id, fn): Promise; ``` -Defined in: [gen/CamundaClient.ts:1477](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1477) +Defined in: [gen/CamundaClient.ts:1483](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1483) #### Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/classes/CamundaValidationError.md b/docs/apis-tools/typescript/api-reference/index/classes/CamundaValidationError.md index e27ee45e67d..420c0e4b834 100644 --- a/docs/apis-tools/typescript/api-reference/index/classes/CamundaValidationError.md +++ b/docs/apis-tools/typescript/api-reference/index/classes/CamundaValidationError.md @@ -7,7 +7,7 @@ mdx: # Class: CamundaValidationError -Defined in: [runtime/errors.ts:138](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L138) +Defined in: [runtime/errors.ts:138](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L138) ## Extends @@ -21,7 +21,7 @@ Defined in: [runtime/errors.ts:138](https://github.com/camunda/orchestration-clu new CamundaValidationError(params): CamundaValidationError; ``` -Defined in: [runtime/errors.ts:143](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L143) +Defined in: [runtime/errors.ts:143](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L143) #### Parameters @@ -65,7 +65,7 @@ Error.constructor; issues: string[]; ``` -Defined in: [runtime/errors.ts:142](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L142) +Defined in: [runtime/errors.ts:142](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L142) --- @@ -75,7 +75,7 @@ Defined in: [runtime/errors.ts:142](https://github.com/camunda/orchestration-clu optional operationId: string; ``` -Defined in: [runtime/errors.ts:140](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L140) +Defined in: [runtime/errors.ts:140](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L140) --- @@ -85,7 +85,7 @@ Defined in: [runtime/errors.ts:140](https://github.com/camunda/orchestration-clu side: "request" | "response"; ``` -Defined in: [runtime/errors.ts:139](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L139) +Defined in: [runtime/errors.ts:139](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L139) --- @@ -95,4 +95,4 @@ Defined in: [runtime/errors.ts:139](https://github.com/camunda/orchestration-clu summary: string; ``` -Defined in: [runtime/errors.ts:141](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L141) +Defined in: [runtime/errors.ts:141](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L141) diff --git a/docs/apis-tools/typescript/api-reference/index/classes/CancelError.md b/docs/apis-tools/typescript/api-reference/index/classes/CancelError.md index 7c5d6e5971d..dbe2ecc03a4 100644 --- a/docs/apis-tools/typescript/api-reference/index/classes/CancelError.md +++ b/docs/apis-tools/typescript/api-reference/index/classes/CancelError.md @@ -7,7 +7,7 @@ mdx: # Class: CancelError -Defined in: [gen/CamundaClient.ts:1111](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1111) +Defined in: [gen/CamundaClient.ts:1108](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1108) ## Extends @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1111](https://github.com/camunda/orchestration new CancelError(): CancelError; ``` -Defined in: [gen/CamundaClient.ts:1112](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1112) +Defined in: [gen/CamundaClient.ts:1109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1109) #### Returns diff --git a/docs/apis-tools/typescript/api-reference/index/classes/EventualConsistencyTimeoutError.md b/docs/apis-tools/typescript/api-reference/index/classes/EventualConsistencyTimeoutError.md index d94905c7e53..39fb6d60bb9 100644 --- a/docs/apis-tools/typescript/api-reference/index/classes/EventualConsistencyTimeoutError.md +++ b/docs/apis-tools/typescript/api-reference/index/classes/EventualConsistencyTimeoutError.md @@ -7,7 +7,7 @@ mdx: # Class: EventualConsistencyTimeoutError -Defined in: [runtime/errors.ts:159](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L159) +Defined in: [runtime/errors.ts:159](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L159) ## Extends @@ -21,7 +21,7 @@ Defined in: [runtime/errors.ts:159](https://github.com/camunda/orchestration-clu new EventualConsistencyTimeoutError(params): EventualConsistencyTimeoutError; ``` -Defined in: [runtime/errors.ts:166](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L166) +Defined in: [runtime/errors.ts:166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L166) #### Parameters @@ -69,7 +69,7 @@ Error.constructor; attempts: number; ``` -Defined in: [runtime/errors.ts:161](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L161) +Defined in: [runtime/errors.ts:161](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L161) --- @@ -79,7 +79,7 @@ Defined in: [runtime/errors.ts:161](https://github.com/camunda/orchestration-clu code: string = "CAMUNDA_SDK_EVENTUAL_TIMEOUT"; ``` -Defined in: [runtime/errors.ts:160](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L160) +Defined in: [runtime/errors.ts:160](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L160) --- @@ -89,7 +89,7 @@ Defined in: [runtime/errors.ts:160](https://github.com/camunda/orchestration-clu elapsedMs: number; ``` -Defined in: [runtime/errors.ts:162](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L162) +Defined in: [runtime/errors.ts:162](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L162) --- @@ -99,7 +99,7 @@ Defined in: [runtime/errors.ts:162](https://github.com/camunda/orchestration-clu optional lastResponseSnippet: string; ``` -Defined in: [runtime/errors.ts:164](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L164) +Defined in: [runtime/errors.ts:164](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L164) --- @@ -109,7 +109,7 @@ Defined in: [runtime/errors.ts:164](https://github.com/camunda/orchestration-clu optional lastStatus: number; ``` -Defined in: [runtime/errors.ts:163](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L163) +Defined in: [runtime/errors.ts:163](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L163) --- @@ -119,4 +119,4 @@ Defined in: [runtime/errors.ts:163](https://github.com/camunda/orchestration-clu optional operationId: string; ``` -Defined in: [runtime/errors.ts:165](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/errors.ts#L165) +Defined in: [runtime/errors.ts:165](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L165) diff --git a/docs/apis-tools/typescript/api-reference/index/functions/assertConstraint.md b/docs/apis-tools/typescript/api-reference/index/functions/assertConstraint.md index 7fd07e67c59..117e66ea969 100644 --- a/docs/apis-tools/typescript/api-reference/index/functions/assertConstraint.md +++ b/docs/apis-tools/typescript/api-reference/index/functions/assertConstraint.md @@ -11,7 +11,7 @@ mdx: function assertConstraint(value, label, c): void; ``` -Defined in: [gen/types.gen.ts:17755](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17755) +Defined in: [gen/types.gen.ts:16631](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16631) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/functions/createCamundaClient.md b/docs/apis-tools/typescript/api-reference/index/functions/createCamundaClient.md index 132ac7fd78b..6af925cd9ae 100644 --- a/docs/apis-tools/typescript/api-reference/index/functions/createCamundaClient.md +++ b/docs/apis-tools/typescript/api-reference/index/functions/createCamundaClient.md @@ -11,7 +11,7 @@ mdx: function createCamundaClient(options?): CamundaClient; ``` -Defined in: [gen/CamundaClient.ts:1182](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1182) +Defined in: [gen/CamundaClient.ts:1179](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1179) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/functions/createCamundaClientLoose.md b/docs/apis-tools/typescript/api-reference/index/functions/createCamundaClientLoose.md index 851727f1e50..1e40109fce8 100644 --- a/docs/apis-tools/typescript/api-reference/index/functions/createCamundaClientLoose.md +++ b/docs/apis-tools/typescript/api-reference/index/functions/createCamundaClientLoose.md @@ -11,7 +11,7 @@ mdx: function createCamundaClientLoose(...args): object; ``` -Defined in: [loose.ts:43](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/loose.ts#L43) +Defined in: [loose.ts:43](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/loose.ts#L43) Create a client where all branded key types are widened to string. Use when integrating with external systems or when dynamic string keys are common and brand friction is unwanted. @@ -99,12 +99,24 @@ enabled: boolean; floor: number; ``` +#### config.backpressure.healthyRecoveryMultiplier + +```ts +healthyRecoveryMultiplier: number; +``` + #### config.backpressure.initialMax ```ts initialMax: number; ``` +#### config.backpressure.maxWaiters + +```ts +maxWaiters: number; +``` + #### config.backpressure.observeOnly ```ts @@ -147,6 +159,12 @@ severeThreshold: number; softFactor: number; ``` +#### config.backpressure.unlimitedAfterHealthyMs + +```ts +unlimitedAfterHealthyMs: number; +``` + #### config.defaultTenantId ```ts @@ -439,7 +457,7 @@ activateAdHocSubProcessActivities(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -457,7 +475,7 @@ activateJobs(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -475,7 +493,7 @@ assignClientToGroup(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -491,7 +509,7 @@ assignClientToTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -507,7 +525,7 @@ assignGroupToTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -523,7 +541,7 @@ assignMappingRuleToGroup(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -539,7 +557,7 @@ assignMappingRuleToTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -555,7 +573,7 @@ assignRoleToClient(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -571,7 +589,7 @@ assignRoleToGroup(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -587,7 +605,7 @@ assignRoleToMappingRule(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -603,7 +621,7 @@ assignRoleToTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -619,7 +637,7 @@ assignRoleToUser(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -635,7 +653,7 @@ assignUserTask(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -651,7 +669,7 @@ assignUserToGroup(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -667,7 +685,7 @@ assignUserToTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -686,7 +704,7 @@ broadcastSignal(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -721,7 +739,7 @@ cancelProcessInstance(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -731,11 +749,8 @@ cancelProcessInstance(...a): CancelablePromise; ```ts cancelProcessInstancesBatchOperation(...a): CancelablePromise<{ - batchOperationKey?: { - [key: number]: string; - __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; + batchOperationKey: string; + batchOperationType: BatchOperationTypeEnum; }>; ``` @@ -748,11 +763,8 @@ cancelProcessInstancesBatchOperation(...a): CancelablePromise<{ #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`batchOperationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); +`batchOperationKey`: `string`; +`batchOperationType`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); \}\> ### clearAuthCache() @@ -781,7 +793,7 @@ completeJob(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -797,7 +809,7 @@ completeUserTask(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -823,18 +835,9 @@ configure(...a): void; ```ts correlateMessage(...a): CancelablePromise<{ - messageKey?: { - [key: number]: string; - __brand: "MessageKey"; - }; - processInstanceKey?: { - [key: number]: string; - __brand: "ProcessInstanceKey"; - }; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; + messageKey: string; + processInstanceKey: string; + tenantId: string; }>; ``` @@ -842,35 +845,23 @@ correlateMessage(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`messageKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"MessageKey"`; -\}; -`processInstanceKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ProcessInstanceKey"`; -\}; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; +`messageKey`: `string`; +`processInstanceKey`: `string`; +`tenantId`: `string`; \}\> ### createAdminUser() ```ts createAdminUser(...a): CancelablePromise<{ - email?: string; - name?: string; - username?: { - [key: number]: string; - __brand: "Username"; - }; + email: string | null; + name: string | null; + username: string; }>; ``` @@ -883,22 +874,16 @@ createAdminUser(...a): CancelablePromise<{ #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`email?`: `string`; -`name?`: `string`; -`username?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"Username"`; -\}; +`email`: `string` \| `null`; +`name`: `string` \| `null`; +`username`: `string`; \}\> ### createAuthorization() ```ts createAuthorization(...a): CancelablePromise<{ - authorizationKey?: { - [key: number]: string; - __brand: "AuthorizationKey"; - }; + authorizationKey: string; }>; ``` @@ -920,15 +905,12 @@ createAuthorization(...a): CancelablePromise<{ `permissionTypes`: [`PermissionTypeEnum`](../type-aliases/PermissionTypeEnum.md)[]; `resourcePropertyName`: `string`; `resourceType`: [`ResourceTypeEnum`](../type-aliases/ResourceTypeEnum.md); -\}\] +\}, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`authorizationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"AuthorizationKey"`; -\}; +`authorizationKey`: `string`; \}\> ### createDeployment() @@ -950,7 +932,7 @@ createDeployment(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -969,30 +951,29 @@ createDeployment(...a): CancelablePromise<{ ```ts createDocument(...a): CancelablePromise<{ - camunda.document.type?: "camunda"; - contentHash?: string; - documentId?: { - [key: number]: string; - __brand: "DocumentId"; - }; - metadata?: { - contentType?: string; - customProperties?: { + camunda.document.type: "camunda"; + contentHash: string | null; + documentId: string; + metadata: { + contentType: string; + customProperties: { [key: string]: unknown; }; - expiresAt?: string; - fileName?: string; - processDefinitionId?: { + expiresAt: string | null; + fileName: string; + processDefinitionId: | { [key: number]: string; __brand: "ProcessDefinitionId"; - }; - processInstanceKey?: { + } + | null; + processInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; - size?: number; + } + | null; + size: number; }; - storeId?: string; + storeId: string; }>; ``` @@ -1000,43 +981,42 @@ createDocument(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`camunda.document.type?`: `"camunda"`; -`contentHash?`: `string`; -`documentId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DocumentId"`; -\}; -`metadata?`: \{ -`contentType?`: `string`; -`customProperties?`: \{ +`camunda.document.type`: `"camunda"`; +`contentHash`: `string` \| `null`; +`documentId`: `string`; +`metadata`: \{ +`contentType`: `string`; +`customProperties`: \{ \[`key`: `string`\]: `unknown`; \}; -`expiresAt?`: `string`; -`fileName?`: `string`; -`processDefinitionId?`: \{ +`expiresAt`: `string` \| `null`; +`fileName`: `string`; +`processDefinitionId`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessDefinitionId"`; -\}; -`processInstanceKey?`: \{ +\} +\| `null`; +`processInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; +\} +\| `null`; +`size`: `number`; \}; -`size?`: `number`; -\}; -`storeId?`: `string`; +`storeId`: `string`; \}\> ### createDocumentLink() ```ts createDocumentLink(...a): CancelablePromise<{ - expiresAt?: string; - url?: string; + expiresAt: string; + url: string; }>; ``` @@ -1044,21 +1024,21 @@ createDocumentLink(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`expiresAt?`: `string`; -`url?`: `string`; +`expiresAt`: `string`; +`url`: `string`; \}\> ### createDocuments() ```ts createDocuments(...a): CancelablePromise<{ - createdDocuments?: object[]; - failedDocuments?: object[]; + createdDocuments: object[]; + failedDocuments: object[]; }>; ``` @@ -1066,13 +1046,13 @@ createDocuments(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`createdDocuments?`: `object`[]; -`failedDocuments?`: `object`[]; +`createdDocuments`: `object`[]; +`failedDocuments`: `object`[]; \}\> ### createElementInstanceVariables() @@ -1085,7 +1065,7 @@ createElementInstanceVariables(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -1097,8 +1077,8 @@ createElementInstanceVariables(...a): CancelablePromise; createGlobalClusterVariable(...a): CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; - tenantId?: string; - value?: string; + tenantId: string | null; + value: string; }>; ``` @@ -1106,24 +1086,56 @@ createGlobalClusterVariable(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `name`: `string`; `scope`: [`ClusterVariableScopeEnum`](../type-aliases/ClusterVariableScopeEnum.md); -`tenantId?`: `string`; -`value?`: `string`; +`tenantId`: `string` \| `null`; +`value`: `string`; +\}\> + +### createGlobalTaskListener() + +```ts +createGlobalTaskListener(...a): CancelablePromise<{ + afterNonGlobal?: boolean; + eventTypes: GlobalTaskListenerEventTypeEnum[]; + id: string; + priority?: number; + retries?: number; + source: GlobalListenerSourceEnum; + type?: string; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`afterNonGlobal?`: `boolean`; +`eventTypes`: [`GlobalTaskListenerEventTypeEnum`](../type-aliases/GlobalTaskListenerEventTypeEnum.md)[]; +`id`: `string`; +`priority?`: `number`; +`retries?`: `number`; +`source`: [`GlobalListenerSourceEnum`](../type-aliases/GlobalListenerSourceEnum.md); +`type?`: `string`; \}\> ### createGroup() ```ts createGroup(...a): CancelablePromise<{ - description?: string; - groupId?: string; - name?: string; + description: string | null; + groupId: string; + name: string; }>; ``` @@ -1131,14 +1143,14 @@ createGroup(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`description?`: `string`; -`groupId?`: `string`; -`name?`: `string`; +`description`: `string` \| `null`; +`groupId`: `string`; +`name`: `string`; \}\> ### createJobWorker() @@ -1233,10 +1245,10 @@ stopGracefully(...a): Promise<{ ```ts createMappingRule(...a): CancelablePromise<{ - claimName?: string; - claimValue?: string; - mappingRuleId?: string; - name?: string; + claimName: string; + claimValue: string; + mappingRuleId: string; + name: string; }>; ``` @@ -1244,26 +1256,31 @@ createMappingRule(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`claimName?`: `string`; -`claimValue?`: `string`; -`mappingRuleId?`: `string`; -`name?`: `string`; +`claimName`: `string`; +`claimValue`: `string`; +`mappingRuleId`: `string`; +`name`: `string`; \}\> ### createProcessInstance() ```ts createProcessInstance(...a): CancelablePromise<{ + businessId: | { + [key: number]: string; + __brand: "BusinessId"; + } + | null; processDefinitionId: string; processDefinitionKey: string; processDefinitionVersion: number; processInstanceKey: string; - tags?: string[]; + tags: string[]; tenantId: string; variables: { [key: string]: unknown; @@ -1278,9 +1295,13 @@ createProcessInstance(...a): CancelablePromise<{ ...\[ \| \{ `awaitCompletion?`: `boolean`; +`businessId?`: \{ +\[`key`: `number`\]: `string`; +`__brand`: `"BusinessId"`; +\}; `fetchVariables?`: `string`[]; `operationReference?`: `number`; -`processDefinitionId`: `string`; +`processDefinitionKey`: `string`; `processDefinitionVersion?`: `number`; `requestTimeout?`: `number`; `runtimeInstructions?`: `object`[]; @@ -1296,9 +1317,13 @@ createProcessInstance(...a): CancelablePromise<{ \} \| \{ `awaitCompletion?`: `boolean`; +`businessId?`: \{ +\[`key`: `number`\]: `string`; +`__brand`: `"BusinessId"`; +\}; `fetchVariables?`: `string`[]; `operationReference?`: `number`; -`processDefinitionKey`: `string`; +`processDefinitionId`: `string`; `processDefinitionVersion?`: `number`; `requestTimeout?`: `number`; `runtimeInstructions?`: `object`[]; @@ -1311,16 +1336,21 @@ createProcessInstance(...a): CancelablePromise<{ `variables?`: \{ \[`key`: `string`\]: `unknown`; \}; -\}\] +\}, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`businessId`: \| \{ +\[`key`: `number`\]: `string`; +`__brand`: `"BusinessId"`; +\} +\| `null`; `processDefinitionId`: `string`; `processDefinitionKey`: `string`; `processDefinitionVersion`: `number`; `processInstanceKey`: `string`; -`tags?`: `string`[]; +`tags`: `string`[]; `tenantId`: `string`; `variables`: \{ \[`key`: `string`\]: `unknown`; @@ -1331,9 +1361,9 @@ createProcessInstance(...a): CancelablePromise<{ ```ts createRole(...a): CancelablePromise<{ - description?: string; - name?: string; - roleId?: string; + description: string | null; + name: string; + roleId: string; }>; ``` @@ -1341,26 +1371,23 @@ createRole(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`description?`: `string`; -`name?`: `string`; -`roleId?`: `string`; +`description`: `string` \| `null`; +`name`: `string`; +`roleId`: `string`; \}\> ### createTenant() ```ts createTenant(...a): CancelablePromise<{ - description?: string; - name?: string; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; + description: string | null; + name: string; + tenantId: string; }>; ``` @@ -1368,17 +1395,14 @@ createTenant(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`description?`: `string`; -`name?`: `string`; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; +`description`: `string` \| `null`; +`name`: `string`; +`tenantId`: `string`; \}\> ### createTenantClusterVariable() @@ -1387,8 +1411,8 @@ createTenant(...a): CancelablePromise<{ createTenantClusterVariable(...a): CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; - tenantId?: string; - value?: string; + tenantId: string | null; + value: string; }>; ``` @@ -1396,122 +1420,216 @@ createTenantClusterVariable(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `name`: `string`; `scope`: [`ClusterVariableScopeEnum`](../type-aliases/ClusterVariableScopeEnum.md); -`tenantId?`: `string`; -`value?`: `string`; +`tenantId`: `string` \| `null`; +`value`: `string`; \}\> -### createUser() +### createThreadedJobWorker() ```ts -createUser(...a): CancelablePromise<{ - email?: string; - name?: string; - username?: { - [key: number]: string; - __brand: "Username"; - }; -}>; +createThreadedJobWorker(...a): object; ``` #### Parameters ##### a -...\[`object`, `object`\] +...\[`object`\] #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`email?`: `string`; -`name?`: `string`; -`username?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"Username"`; -\}; -\}\> +`object` -### deleteAuthorization() +##### activeJobs ```ts -deleteAuthorization(...a): CancelablePromise; +activeJobs: number; ``` -#### Parameters - -##### a +##### busyThreads -...\[`object`\] +```ts +busyThreads: number; +``` -#### Returns +##### name -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +```ts +name: string; +``` -### deleteDecisionInstance() +##### poolSize ```ts -deleteDecisionInstance(...a): CancelablePromise; +poolSize: number; ``` -#### Parameters - -##### a +##### ready -...\[`object`, `object`\] +```ts +ready: Promise; +``` -#### Returns +##### stopped -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +```ts +stopped: boolean; +``` -### deleteDecisionInstancesBatchOperation() +##### start() ```ts -deleteDecisionInstancesBatchOperation(...a): CancelablePromise<{ - batchOperationKey?: { - [key: number]: string; - __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; -}>; +start(...a): void; ``` -#### Parameters +###### Parameters -##### a +###### a -...\[`object`, `object`\] +...\[\] -#### Returns +###### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`batchOperationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); -\}\> +`void` -### deleteDocument() +##### stop() ```ts -deleteDocument(...a): CancelablePromise; +stop(...a): void; ``` -#### Parameters +###### Parameters -##### a +###### a -...\[`object`\] +...\[\] -#### Returns +###### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> +`void` + +##### stopGracefully() + +```ts +stopGracefully(...a): Promise<{ + remainingJobs: number; + timedOut: boolean; +}>; +``` + +###### Parameters + +###### a + +...\[`object`\] + +###### Returns + +`Promise`\<\{ +`remainingJobs`: `number`; +`timedOut`: `boolean`; +\}\> + +### createUser() + +```ts +createUser(...a): CancelablePromise<{ + email: string | null; + name: string | null; + username: string; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`email`: `string` \| `null`; +`name`: `string` \| `null`; +`username`: `string`; +\}\> + +### deleteAuthorization() + +```ts +deleteAuthorization(...a): CancelablePromise; +``` + +#### Parameters + +##### a + +...\[`object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> + +### deleteDecisionInstance() + +```ts +deleteDecisionInstance(...a): CancelablePromise; +``` + +#### Parameters + +##### a + +...\[`object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> + +### deleteDecisionInstancesBatchOperation() + +```ts +deleteDecisionInstancesBatchOperation(...a): CancelablePromise<{ + batchOperationKey: string; + batchOperationType: BatchOperationTypeEnum; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`batchOperationKey`: `string`; +`batchOperationType`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); +\}\> + +### deleteDocument() + +```ts +deleteDocument(...a): CancelablePromise; +``` + +#### Parameters + +##### a + +...\[`object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> ### deleteGlobalClusterVariable() @@ -1523,7 +1641,23 @@ deleteGlobalClusterVariable(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> + +### deleteGlobalTaskListener() + +```ts +deleteGlobalTaskListener(...a): CancelablePromise; +``` + +#### Parameters + +##### a + +...\[`object`, `object`\] #### Returns @@ -1539,7 +1673,7 @@ deleteGroup(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -1555,7 +1689,7 @@ deleteMappingRule(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -1581,11 +1715,8 @@ deleteProcessInstance(...a): CancelablePromise; ```ts deleteProcessInstancesBatchOperation(...a): CancelablePromise<{ - batchOperationKey?: { - [key: number]: string; - __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; + batchOperationKey: string; + batchOperationType: BatchOperationTypeEnum; }>; ``` @@ -1598,24 +1729,19 @@ deleteProcessInstancesBatchOperation(...a): CancelablePromise<{ #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`batchOperationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); +`batchOperationKey`: `string`; +`batchOperationType`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); \}\> ### deleteResource() ```ts deleteResource(...a): CancelablePromise<{ - batchOperation?: { - batchOperationKey?: { - [key: number]: string; - __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; - }; + batchOperation: | { + batchOperationKey: string; + batchOperationType: BatchOperationTypeEnum; + } + | null; resourceKey: string; }>; ``` @@ -1624,18 +1750,16 @@ deleteResource(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`batchOperation?`: \{ -`batchOperationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); -\}; +`batchOperation`: \| \{ +`batchOperationKey`: `string`; +`batchOperationType`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); +\} +\| `null`; `resourceKey`: `string`; \}\> @@ -1649,7 +1773,7 @@ deleteRole(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -1665,7 +1789,7 @@ deleteTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -1681,7 +1805,7 @@ deleteTenantClusterVariable(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -1767,7 +1891,7 @@ evaluateConditionals(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -1786,15 +1910,16 @@ evaluateDecision(...a): CancelablePromise<{ decisionDefinitionName: string; decisionDefinitionVersion: number; decisionEvaluationKey: string; - decisionInstanceKey?: { - [key: number]: string; - __brand: "DecisionInstanceKey"; - }; + decisionInstanceKey: string; decisionRequirementsId: string; decisionRequirementsKey: string; evaluatedDecisions: object[]; - failedDecisionDefinitionId: string; - failureMessage: string; + failedDecisionDefinitionId: | { + [key: number]: string; + __brand: "DecisionDefinitionId"; + } + | null; + failureMessage: string | null; output: string; tenantId: string; }>; @@ -1824,7 +1949,7 @@ evaluateDecision(...a): CancelablePromise<{ `variables?`: \{ \[`key`: `string`\]: `unknown`; \}; -\}\] +\}, `object`\] #### Returns @@ -1834,15 +1959,16 @@ evaluateDecision(...a): CancelablePromise<{ `decisionDefinitionName`: `string`; `decisionDefinitionVersion`: `number`; `decisionEvaluationKey`: `string`; -`decisionInstanceKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionInstanceKey"`; -\}; +`decisionInstanceKey`: `string`; `decisionRequirementsId`: `string`; `decisionRequirementsKey`: `string`; `evaluatedDecisions`: `object`[]; -`failedDecisionDefinitionId`: `string`; -`failureMessage`: `string`; +`failedDecisionDefinitionId`: \| \{ +\[`key`: `number`\]: `string`; +`__brand`: `"DecisionDefinitionId"`; +\} +\| `null`; +`failureMessage`: `string` \| `null`; `output`: `string`; `tenantId`: `string`; \}\> @@ -1853,7 +1979,7 @@ evaluateDecision(...a): CancelablePromise<{ evaluateExpression(...a): CancelablePromise<{ expression: string; result: unknown; - warnings: string[]; + warnings: object[]; }>; ``` @@ -1861,14 +1987,14 @@ evaluateExpression(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `expression`: `string`; `result`: `unknown`; -`warnings`: `string`[]; +`warnings`: `object`[]; \}\> ### failJob() @@ -1881,7 +2007,7 @@ failJob(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -1907,77 +2033,87 @@ forceAuthRefresh(...a): Promise; ```ts getAuditLog(...a): CancelablePromise<{ - actorId?: string; - actorType?: AuditLogActorTypeEnum; - annotation?: string; - auditLogKey?: { - [key: number]: string; - __brand: "AuditLogKey"; - }; - batchOperationKey?: { + actorId: string | null; + actorType: | AuditLogActorTypeEnum + | null; + agentElementId: string | null; + auditLogKey: string; + batchOperationKey: | { [key: number]: string; __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; - category?: AuditLogCategoryEnum; - decisionDefinitionId?: { + } + | null; + batchOperationType: | BatchOperationTypeEnum + | null; + category: AuditLogCategoryEnum; + decisionDefinitionId: | { [key: number]: string; __brand: "DecisionDefinitionId"; - }; - decisionDefinitionKey?: { + } + | null; + decisionDefinitionKey: | { [key: number]: string; __brand: "DecisionDefinitionKey"; - }; - decisionEvaluationKey?: { + } + | null; + decisionEvaluationKey: | { [key: number]: string; __brand: "DecisionEvaluationKey"; - }; - decisionRequirementsId?: string; - decisionRequirementsKey?: { + } + | null; + decisionRequirementsId: string | null; + decisionRequirementsKey: | { [key: number]: string; __brand: "DecisionRequirementsKey"; - }; - deploymentKey?: { + } + | null; + deploymentKey: | { [key: number]: string; __brand: "DeploymentKey"; - }; - elementInstanceKey?: { + } + | null; + elementInstanceKey: | { [key: number]: string; __brand: "ElementInstanceKey"; - }; - entityDescription?: string; - entityKey?: { - [key: number]: string; - __brand: "AuditLogEntityKey"; - }; - entityType?: AuditLogEntityTypeEnum; - formKey?: { + } + | null; + entityDescription: string | null; + entityKey: string; + entityType: AuditLogEntityTypeEnum; + formKey: | { [key: number]: string; __brand: "FormKey"; - }; - jobKey?: { + } + | null; + jobKey: | { [key: number]: string; __brand: "JobKey"; - }; - operationType?: AuditLogOperationTypeEnum; - processDefinitionId?: { + } + | null; + operationType: AuditLogOperationTypeEnum; + processDefinitionId: | { [key: number]: string; __brand: "ProcessDefinitionId"; - }; - processDefinitionKey?: { + } + | null; + processDefinitionKey: | { [key: number]: string; __brand: "ProcessDefinitionKey"; - }; - processInstanceKey?: { + } + | null; + processInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; - relatedEntityKey?: { + } + | null; + relatedEntityKey: | { [key: number]: string; __brand: "AuditLogEntityKey"; - }; - relatedEntityType?: AuditLogEntityTypeEnum; - resourceKey?: | { + } + | null; + relatedEntityType: | AuditLogEntityTypeEnum + | null; + resourceKey: | { [key: number]: string; __brand: "FormKey"; } @@ -1992,21 +2128,25 @@ getAuditLog(...a): CancelablePromise<{ | { [key: number]: string; __brand: "DecisionDefinitionKey"; - }; - result?: AuditLogResultEnum; - rootProcessInstanceKey?: { + } + | null; + result: AuditLogResultEnum; + rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; - tenantId?: { + } + | null; + tenantId: | { [key: number]: string; __brand: "TenantId"; - }; - timestamp?: string; - userTaskKey?: { + } + | null; + timestamp: string; + userTaskKey: | { [key: number]: string; __brand: "UserTaskKey"; - }; + } + | null; }>; ``` @@ -2014,82 +2154,92 @@ getAuditLog(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`actorId?`: `string`; -`actorType?`: [`AuditLogActorTypeEnum`](../type-aliases/AuditLogActorTypeEnum.md); -`annotation?`: `string`; -`auditLogKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"AuditLogKey"`; -\}; -`batchOperationKey?`: \{ +`actorId`: `string` \| `null`; +`actorType`: \| [`AuditLogActorTypeEnum`](../type-aliases/AuditLogActorTypeEnum.md) +\| `null`; +`agentElementId`: `string` \| `null`; +`auditLogKey`: `string`; +`batchOperationKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); -`category?`: [`AuditLogCategoryEnum`](../type-aliases/AuditLogCategoryEnum.md); -`decisionDefinitionId?`: \{ +\} +\| `null`; +`batchOperationType`: \| [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md) +\| `null`; +`category`: [`AuditLogCategoryEnum`](../type-aliases/AuditLogCategoryEnum.md); +`decisionDefinitionId`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"DecisionDefinitionId"`; -\}; -`decisionDefinitionKey?`: \{ +\} +\| `null`; +`decisionDefinitionKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"DecisionDefinitionKey"`; -\}; -`decisionEvaluationKey?`: \{ +\} +\| `null`; +`decisionEvaluationKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"DecisionEvaluationKey"`; -\}; -`decisionRequirementsId?`: `string`; -`decisionRequirementsKey?`: \{ +\} +\| `null`; +`decisionRequirementsId`: `string` \| `null`; +`decisionRequirementsKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"DecisionRequirementsKey"`; -\}; -`deploymentKey?`: \{ +\} +\| `null`; +`deploymentKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"DeploymentKey"`; -\}; -`elementInstanceKey?`: \{ +\} +\| `null`; +`elementInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ElementInstanceKey"`; -\}; -`entityDescription?`: `string`; -`entityKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"AuditLogEntityKey"`; -\}; -`entityType?`: [`AuditLogEntityTypeEnum`](../type-aliases/AuditLogEntityTypeEnum.md); -`formKey?`: \{ +\} +\| `null`; +`entityDescription`: `string` \| `null`; +`entityKey`: `string`; +`entityType`: [`AuditLogEntityTypeEnum`](../type-aliases/AuditLogEntityTypeEnum.md); +`formKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"FormKey"`; -\}; -`jobKey?`: \{ +\} +\| `null`; +`jobKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"JobKey"`; -\}; -`operationType?`: [`AuditLogOperationTypeEnum`](../type-aliases/AuditLogOperationTypeEnum.md); -`processDefinitionId?`: \{ +\} +\| `null`; +`operationType`: [`AuditLogOperationTypeEnum`](../type-aliases/AuditLogOperationTypeEnum.md); +`processDefinitionId`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessDefinitionId"`; -\}; -`processDefinitionKey?`: \{ +\} +\| `null`; +`processDefinitionKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessDefinitionKey"`; -\}; -`processInstanceKey?`: \{ +\} +\| `null`; +`processInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; -\}; -`relatedEntityKey?`: \{ +\} +\| `null`; +`relatedEntityKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"AuditLogEntityKey"`; -\}; -`relatedEntityType?`: [`AuditLogEntityTypeEnum`](../type-aliases/AuditLogEntityTypeEnum.md); -`resourceKey?`: \| \{ +\} +\| `null`; +`relatedEntityType`: \| [`AuditLogEntityTypeEnum`](../type-aliases/AuditLogEntityTypeEnum.md) +\| `null`; +`resourceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"FormKey"`; \} @@ -2104,39 +2254,43 @@ getAuditLog(...a): CancelablePromise<{ \| \{ \[`key`: `number`\]: `string`; `__brand`: `"DecisionDefinitionKey"`; -\}; -`result?`: [`AuditLogResultEnum`](../type-aliases/AuditLogResultEnum.md); -`rootProcessInstanceKey?`: \{ +\} +\| `null`; +`result`: [`AuditLogResultEnum`](../type-aliases/AuditLogResultEnum.md); +`rootProcessInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; -\}; -`tenantId?`: \{ +\} +\| `null`; +`tenantId`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"TenantId"`; -\}; -`timestamp?`: `string`; -`userTaskKey?`: \{ +\} +\| `null`; +`timestamp`: `string`; +`userTaskKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"UserTaskKey"`; -\}; +\} +\| `null`; \}\> ### getAuthentication() ```ts getAuthentication(...a): CancelablePromise<{ - authorizedComponents?: string[]; + authorizedComponents: string[]; c8Links: { [key: string]: string; }; canLogout: boolean; - displayName?: string | null; - email?: string | null; + displayName: string | null; + email: string | null; groups: string[]; roles: string[]; - salesPlanType: string; + salesPlanType: string | null; tenants: object[]; - username?: | { + username: | { [key: number]: string; __brand: "Username"; } @@ -2148,23 +2302,23 @@ getAuthentication(...a): CancelablePromise<{ ##### a -...\[\] +...\[`object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`authorizedComponents?`: `string`[]; +`authorizedComponents`: `string`[]; `c8Links`: \{ \[`key`: `string`\]: `string`; \}; `canLogout`: `boolean`; -`displayName?`: `string` \| `null`; -`email?`: `string` \| `null`; +`displayName`: `string` \| `null`; +`email`: `string` \| `null`; `groups`: `string`[]; `roles`: `string`[]; -`salesPlanType`: `string`; +`salesPlanType`: `string` \| `null`; `tenants`: `object`[]; -`username?`: \| \{ +`username`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"Username"`; \} @@ -2195,16 +2349,13 @@ getAuthHeaders(...a): Promise<{ ```ts getAuthorization(...a): CancelablePromise<{ - authorizationKey?: { - [key: number]: string; - __brand: "AuthorizationKey"; - }; - ownerId?: string; - ownerType?: OwnerTypeEnum; - permissionTypes?: PermissionTypeEnum[]; - resourceId?: string; - resourcePropertyName?: string; - resourceType?: ResourceTypeEnum; + authorizationKey: string; + ownerId: string; + ownerType: OwnerTypeEnum; + permissionTypes: PermissionTypeEnum[]; + resourceId: string | null; + resourcePropertyName: string | null; + resourceType: ResourceTypeEnum; }>; ``` @@ -2212,21 +2363,18 @@ getAuthorization(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`authorizationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"AuthorizationKey"`; -\}; -`ownerId?`: `string`; -`ownerType?`: [`OwnerTypeEnum`](../type-aliases/OwnerTypeEnum.md); -`permissionTypes?`: [`PermissionTypeEnum`](../type-aliases/PermissionTypeEnum.md)[]; -`resourceId?`: `string`; -`resourcePropertyName?`: `string`; -`resourceType?`: [`ResourceTypeEnum`](../type-aliases/ResourceTypeEnum.md); +`authorizationKey`: `string`; +`ownerId`: `string`; +`ownerType`: [`OwnerTypeEnum`](../type-aliases/OwnerTypeEnum.md); +`permissionTypes`: [`PermissionTypeEnum`](../type-aliases/PermissionTypeEnum.md)[]; +`resourceId`: `string` \| `null`; +`resourcePropertyName`: `string` \| `null`; +`resourceType`: [`ResourceTypeEnum`](../type-aliases/ResourceTypeEnum.md); \}\> ### getBackpressureState() @@ -2234,6 +2382,7 @@ getAuthorization(...a): CancelablePromise<{ ```ts getBackpressureState(...a): | { + backoffMs: number; consecutive: number; permitsCurrent: number; permitsMax: number | null; @@ -2258,6 +2407,7 @@ getBackpressureState(...a): #### Returns \| \{ +`backoffMs`: `number`; `consecutive`: `number`; `permitsCurrent`: `number`; `permitsMax`: `number` \| `null`; @@ -2276,20 +2426,18 @@ getBackpressureState(...a): ```ts getBatchOperation(...a): CancelablePromise<{ - actorId?: string; - actorType?: AuditLogActorTypeEnum; - batchOperationKey?: { - [key: number]: string; - __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; - endDate?: string; - errors?: object[]; - operationsCompletedCount?: number; - operationsFailedCount?: number; - operationsTotalCount?: number; - startDate?: string; - state?: BatchOperationStateEnum; + actorId: string | null; + actorType: | AuditLogActorTypeEnum + | null; + batchOperationKey: string; + batchOperationType: BatchOperationTypeEnum; + endDate: string | null; + errors: object[]; + operationsCompletedCount: number; + operationsFailedCount: number; + operationsTotalCount: number; + startDate: string | null; + state: BatchOperationStateEnum; }>; ``` @@ -2297,25 +2445,23 @@ getBatchOperation(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`actorId?`: `string`; -`actorType?`: [`AuditLogActorTypeEnum`](../type-aliases/AuditLogActorTypeEnum.md); -`batchOperationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); -`endDate?`: `string`; -`errors?`: `object`[]; -`operationsCompletedCount?`: `number`; -`operationsFailedCount?`: `number`; -`operationsTotalCount?`: `number`; -`startDate?`: `string`; -`state?`: [`BatchOperationStateEnum`](../type-aliases/BatchOperationStateEnum.md); +`actorId`: `string` \| `null`; +`actorType`: \| [`AuditLogActorTypeEnum`](../type-aliases/AuditLogActorTypeEnum.md) +\| `null`; +`batchOperationKey`: `string`; +`batchOperationType`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); +`endDate`: `string` \| `null`; +`errors`: `object`[]; +`operationsCompletedCount`: `number`; +`operationsFailedCount`: `number`; +`operationsTotalCount`: `number`; +`startDate`: `string` \| `null`; +`state`: [`BatchOperationStateEnum`](../type-aliases/BatchOperationStateEnum.md); \}\> ### getConfig() @@ -2400,12 +2546,24 @@ enabled: boolean; floor: number; ``` +###### backpressure.healthyRecoveryMultiplier + +```ts +healthyRecoveryMultiplier: number; +``` + ###### backpressure.initialMax ```ts initialMax: number; ``` +###### backpressure.maxWaiters + +```ts +maxWaiters: number; +``` + ###### backpressure.observeOnly ```ts @@ -2448,6 +2606,12 @@ severeThreshold: number; softFactor: number; ``` +###### backpressure.unlimitedAfterHealthyMs + +```ts +unlimitedAfterHealthyMs: number; +``` + ##### defaultTenantId ```ts @@ -2686,27 +2850,15 @@ res: ValidationMode; ```ts getDecisionDefinition(...a): CancelablePromise<{ - decisionDefinitionId?: { - [key: number]: string; - __brand: "DecisionDefinitionId"; - }; - decisionDefinitionKey?: { - [key: number]: string; - __brand: "DecisionDefinitionKey"; - }; - decisionRequirementsId?: string; - decisionRequirementsKey?: { - [key: number]: string; - __brand: "DecisionRequirementsKey"; - }; - decisionRequirementsName?: string; - decisionRequirementsVersion?: number; - name?: string; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; - version?: number; + decisionDefinitionId: string; + decisionDefinitionKey: string; + decisionRequirementsId: string; + decisionRequirementsKey: string; + decisionRequirementsName: string; + decisionRequirementsVersion: number; + name: string; + tenantId: string; + version: number; }>; ``` @@ -2714,32 +2866,20 @@ getDecisionDefinition(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`decisionDefinitionId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionDefinitionId"`; -\}; -`decisionDefinitionKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionDefinitionKey"`; -\}; -`decisionRequirementsId?`: `string`; -`decisionRequirementsKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionRequirementsKey"`; -\}; -`decisionRequirementsName?`: `string`; -`decisionRequirementsVersion?`: `number`; -`name?`: `string`; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; -`version?`: `number`; +`decisionDefinitionId`: `string`; +`decisionDefinitionKey`: `string`; +`decisionRequirementsId`: `string`; +`decisionRequirementsKey`: `string`; +`decisionRequirementsName`: `string`; +`decisionRequirementsVersion`: `number`; +`name`: `string`; +`tenantId`: `string`; +`version`: `number`; \}\> ### getDecisionDefinitionXml() @@ -2752,7 +2892,7 @@ getDecisionDefinitionXml(...a): CancelablePromise; ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns @@ -2762,55 +2902,41 @@ getDecisionDefinitionXml(...a): CancelablePromise; ```ts getDecisionInstance(...a): CancelablePromise<{ - decisionDefinitionId?: { - [key: number]: string; - __brand: "DecisionDefinitionId"; - }; - decisionDefinitionKey?: { - [key: number]: string; - __brand: "DecisionDefinitionKey"; - }; - decisionDefinitionName?: string; - decisionDefinitionType?: DecisionDefinitionTypeEnum; - decisionDefinitionVersion?: number; - decisionEvaluationInstanceKey?: { - [key: number]: string; - __brand: "DecisionEvaluationInstanceKey"; - }; - decisionEvaluationKey?: { - [key: number]: string; - __brand: "DecisionEvaluationKey"; - }; - elementInstanceKey?: { + decisionDefinitionId: string; + decisionDefinitionKey: string; + decisionDefinitionName: string; + decisionDefinitionType: DecisionDefinitionTypeEnum; + decisionDefinitionVersion: number; + decisionEvaluationInstanceKey: string; + decisionEvaluationKey: string; + elementInstanceKey: | { [key: number]: string; __brand: "ElementInstanceKey"; - }; - evaluatedInputs?: object[]; - evaluationDate?: string; - evaluationFailure?: string; - matchedRules?: object[]; - processDefinitionKey?: { + } + | null; + evaluatedInputs: object[]; + evaluationDate: string; + evaluationFailure: string | null; + matchedRules: object[]; + processDefinitionKey: | { [key: number]: string; __brand: "ProcessDefinitionKey"; - }; - processInstanceKey?: { + } + | null; + processInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; - result?: string; - rootDecisionDefinitionKey?: { - [key: number]: string; - __brand: "DecisionDefinitionKey"; - }; - rootProcessInstanceKey?: { + } + | null; + result: string; + rootDecisionDefinitionKey: string; + rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; - state?: DecisionInstanceStateEnum; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; + } + | null; + state: DecisionInstanceStateEnum; + tenantId: string; }>; ``` @@ -2818,78 +2944,58 @@ getDecisionInstance(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`decisionDefinitionId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionDefinitionId"`; -\}; -`decisionDefinitionKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionDefinitionKey"`; -\}; -`decisionDefinitionName?`: `string`; -`decisionDefinitionType?`: [`DecisionDefinitionTypeEnum`](../type-aliases/DecisionDefinitionTypeEnum.md); -`decisionDefinitionVersion?`: `number`; -`decisionEvaluationInstanceKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionEvaluationInstanceKey"`; -\}; -`decisionEvaluationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionEvaluationKey"`; -\}; -`elementInstanceKey?`: \{ +`decisionDefinitionId`: `string`; +`decisionDefinitionKey`: `string`; +`decisionDefinitionName`: `string`; +`decisionDefinitionType`: [`DecisionDefinitionTypeEnum`](../type-aliases/DecisionDefinitionTypeEnum.md); +`decisionDefinitionVersion`: `number`; +`decisionEvaluationInstanceKey`: `string`; +`decisionEvaluationKey`: `string`; +`elementInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ElementInstanceKey"`; -\}; -`evaluatedInputs?`: `object`[]; -`evaluationDate?`: `string`; -`evaluationFailure?`: `string`; -`matchedRules?`: `object`[]; -`processDefinitionKey?`: \{ +\} +\| `null`; +`evaluatedInputs`: `object`[]; +`evaluationDate`: `string`; +`evaluationFailure`: `string` \| `null`; +`matchedRules`: `object`[]; +`processDefinitionKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessDefinitionKey"`; -\}; -`processInstanceKey?`: \{ +\} +\| `null`; +`processInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; -\}; -`result?`: `string`; -`rootDecisionDefinitionKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionDefinitionKey"`; -\}; -`rootProcessInstanceKey?`: \{ +\} +\| `null`; +`result`: `string`; +`rootDecisionDefinitionKey`: `string`; +`rootProcessInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; -\}; -`state?`: [`DecisionInstanceStateEnum`](../type-aliases/DecisionInstanceStateEnum.md); -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; +\} +\| `null`; +`state`: [`DecisionInstanceStateEnum`](../type-aliases/DecisionInstanceStateEnum.md); +`tenantId`: `string`; \}\> ### getDecisionRequirements() ```ts getDecisionRequirements(...a): CancelablePromise<{ - decisionRequirementsId?: string; - decisionRequirementsKey?: { - [key: number]: string; - __brand: "DecisionRequirementsKey"; - }; - decisionRequirementsName?: string; - resourceName?: string; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; - version?: number; + decisionRequirementsId: string; + decisionRequirementsKey: string; + decisionRequirementsName: string; + resourceName: string; + tenantId: string; + version: number; }>; ``` @@ -2897,23 +3003,17 @@ getDecisionRequirements(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`decisionRequirementsId?`: `string`; -`decisionRequirementsKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionRequirementsKey"`; -\}; -`decisionRequirementsName?`: `string`; -`resourceName?`: `string`; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; -`version?`: `number`; +`decisionRequirementsId`: `string`; +`decisionRequirementsKey`: `string`; +`decisionRequirementsName`: `string`; +`resourceName`: `string`; +`tenantId`: `string`; +`version`: `number`; \}\> ### getDecisionRequirementsXml() @@ -2926,7 +3026,7 @@ getDecisionRequirementsXml(...a): CancelablePromise; ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns @@ -2943,7 +3043,7 @@ getDocument(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -2957,19 +3057,21 @@ getElementInstance(...a): CancelablePromise<{ elementId: string; elementInstanceKey: string; elementName: string; - endDate?: string; + endDate: string | null; hasIncident: boolean; - incidentKey?: { + incidentKey: | { [key: number]: string; __brand: "IncidentKey"; - }; + } + | null; processDefinitionId: string; processDefinitionKey: string; processInstanceKey: string; - rootProcessInstanceKey?: { + rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; + } + | null; startDate: string; state: ElementInstanceStateEnum; tenantId: string; @@ -3007,7 +3109,7 @@ getElementInstance(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns @@ -3015,19 +3117,21 @@ getElementInstance(...a): CancelablePromise<{ `elementId`: `string`; `elementInstanceKey`: `string`; `elementName`: `string`; -`endDate?`: `string`; +`endDate`: `string` \| `null`; `hasIncident`: `boolean`; -`incidentKey?`: \{ +`incidentKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"IncidentKey"`; -\}; +\} +\| `null`; `processDefinitionId`: `string`; `processDefinitionKey`: `string`; `processInstanceKey`: `string`; -`rootProcessInstanceKey?`: \{ +`rootProcessInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; -\}; +\} +\| `null`; `startDate`: `string`; `state`: [`ElementInstanceStateEnum`](../type-aliases/ElementInstanceStateEnum.md); `tenantId`: `string`; @@ -3082,8 +3186,8 @@ getErrorMode(...a): "result" | "throw"; getGlobalClusterVariable(...a): CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; - tenantId?: string; - value?: string; + tenantId: string | null; + value: string; }>; ``` @@ -3091,15 +3195,15 @@ getGlobalClusterVariable(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `name`: `string`; `scope`: [`ClusterVariableScopeEnum`](../type-aliases/ClusterVariableScopeEnum.md); -`tenantId?`: `string`; -`value?`: `string`; +`tenantId`: `string` \| `null`; +`value`: `string`; \}\> ### getGlobalJobStatistics() @@ -3108,15 +3212,15 @@ getGlobalClusterVariable(...a): CancelablePromise<{ getGlobalJobStatistics(...a): CancelablePromise<{ completed: { count: number; - lastUpdatedAt: string; + lastUpdatedAt: string | null; }; created: { count: number; - lastUpdatedAt: string; + lastUpdatedAt: string | null; }; failed: { count: number; - lastUpdatedAt: string; + lastUpdatedAt: string | null; }; isIncomplete: boolean; }>; @@ -3126,33 +3230,65 @@ getGlobalJobStatistics(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `completed`: \{ `count`: `number`; -`lastUpdatedAt`: `string`; +`lastUpdatedAt`: `string` \| `null`; \}; `created`: \{ `count`: `number`; -`lastUpdatedAt`: `string`; +`lastUpdatedAt`: `string` \| `null`; \}; `failed`: \{ `count`: `number`; -`lastUpdatedAt`: `string`; +`lastUpdatedAt`: `string` \| `null`; \}; `isIncomplete`: `boolean`; \}\> +### getGlobalTaskListener() + +```ts +getGlobalTaskListener(...a): CancelablePromise<{ + afterNonGlobal?: boolean; + eventTypes: GlobalTaskListenerEventTypeEnum[]; + id: string; + priority?: number; + retries?: number; + source: GlobalListenerSourceEnum; + type?: string; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`afterNonGlobal?`: `boolean`; +`eventTypes`: [`GlobalTaskListenerEventTypeEnum`](../type-aliases/GlobalTaskListenerEventTypeEnum.md)[]; +`id`: `string`; +`priority?`: `number`; +`retries?`: `number`; +`source`: [`GlobalListenerSourceEnum`](../type-aliases/GlobalListenerSourceEnum.md); +`type?`: `string`; +\}\> + ### getGroup() ```ts getGroup(...a): CancelablePromise<{ - description?: string; - groupId?: string; - name?: string; + description: string | null; + groupId: string; + name: string; }>; ``` @@ -3160,60 +3296,41 @@ getGroup(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`description?`: `string`; -`groupId?`: `string`; -`name?`: `string`; +`description`: `string` \| `null`; +`groupId`: `string`; +`name`: `string`; \}\> ### getIncident() ```ts getIncident(...a): CancelablePromise<{ - creationTime?: string; - elementId?: { - [key: number]: string; - __brand: "ElementId"; - }; - elementInstanceKey?: { - [key: number]: string; - __brand: "ElementInstanceKey"; - }; - errorMessage?: string; - errorType?: IncidentErrorTypeEnum; - incidentKey?: { - [key: number]: string; - __brand: "IncidentKey"; - }; - jobKey?: { + creationTime: string; + elementId: string; + elementInstanceKey: string; + errorMessage: string; + errorType: IncidentErrorTypeEnum; + incidentKey: string; + jobKey: | { [key: number]: string; __brand: "JobKey"; - }; - processDefinitionId?: { - [key: number]: string; - __brand: "ProcessDefinitionId"; - }; - processDefinitionKey?: { - [key: number]: string; - __brand: "ProcessDefinitionKey"; - }; - processInstanceKey?: { - [key: number]: string; - __brand: "ProcessInstanceKey"; - }; - rootProcessInstanceKey?: { + } + | null; + processDefinitionId: string; + processDefinitionKey: string; + processInstanceKey: string; + rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; - state?: IncidentStateEnum; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; + } + | null; + state: IncidentStateEnum; + tenantId: string; }>; ``` @@ -3221,50 +3338,223 @@ getIncident(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`creationTime?`: `string`; -`elementId?`: \{ +`creationTime`: `string`; +`elementId`: `string`; +`elementInstanceKey`: `string`; +`errorMessage`: `string`; +`errorType`: [`IncidentErrorTypeEnum`](../type-aliases/IncidentErrorTypeEnum.md); +`incidentKey`: `string`; +`jobKey`: \| \{ \[`key`: `number`\]: `string`; -`__brand`: `"ElementId"`; -\}; -`elementInstanceKey?`: \{ +`__brand`: `"JobKey"`; +\} +\| `null`; +`processDefinitionId`: `string`; +`processDefinitionKey`: `string`; +`processInstanceKey`: `string`; +`rootProcessInstanceKey`: \| \{ \[`key`: `number`\]: `string`; -`__brand`: `"ElementInstanceKey"`; -\}; -`errorMessage?`: `string`; -`errorType?`: [`IncidentErrorTypeEnum`](../type-aliases/IncidentErrorTypeEnum.md); -`incidentKey?`: \{ +`__brand`: `"ProcessInstanceKey"`; +\} +\| `null`; +`state`: [`IncidentStateEnum`](../type-aliases/IncidentStateEnum.md); +`tenantId`: `string`; +\}\> + +### getJobErrorStatistics() + +```ts +getJobErrorStatistics(...a): CancelablePromise<{ + items: object[]; + page: { + endCursor: | { + [key: number]: string; + __brand: "EndCursor"; + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { + [key: number]: string; + __brand: "StartCursor"; + } + | null; + totalItems: number; + }; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; +`page`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; -`__brand`: `"IncidentKey"`; -\}; -`jobKey?`: \{ +`__brand`: `"EndCursor"`; +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; -`__brand`: `"JobKey"`; +`__brand`: `"StartCursor"`; +\} +\| `null`; +`totalItems`: `number`; \}; -`processDefinitionId?`: \{ +\}\> + +### getJobTimeSeriesStatistics() + +```ts +getJobTimeSeriesStatistics(...a): CancelablePromise<{ + items: object[]; + page: { + endCursor: | { + [key: number]: string; + __brand: "EndCursor"; + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { + [key: number]: string; + __brand: "StartCursor"; + } + | null; + totalItems: number; + }; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; +`page`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; -`__brand`: `"ProcessDefinitionId"`; -\}; -`processDefinitionKey?`: \{ +`__brand`: `"EndCursor"`; +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; -`__brand`: `"ProcessDefinitionKey"`; +`__brand`: `"StartCursor"`; +\} +\| `null`; +`totalItems`: `number`; \}; -`processInstanceKey?`: \{ +\}\> + +### getJobTypeStatistics() + +```ts +getJobTypeStatistics(...a): CancelablePromise<{ + items: object[]; + page: { + endCursor: | { + [key: number]: string; + __brand: "EndCursor"; + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { + [key: number]: string; + __brand: "StartCursor"; + } + | null; + totalItems: number; + }; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; +`page`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; -`__brand`: `"ProcessInstanceKey"`; +`__brand`: `"EndCursor"`; +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ +\[`key`: `number`\]: `string`; +`__brand`: `"StartCursor"`; +\} +\| `null`; +`totalItems`: `number`; \}; -`rootProcessInstanceKey?`: \{ +\}\> + +### getJobWorkerStatistics() + +```ts +getJobWorkerStatistics(...a): CancelablePromise<{ + items: object[]; + page: { + endCursor: | { + [key: number]: string; + __brand: "EndCursor"; + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { + [key: number]: string; + __brand: "StartCursor"; + } + | null; + totalItems: number; + }; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; +`page`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; -`__brand`: `"ProcessInstanceKey"`; -\}; -`state?`: [`IncidentStateEnum`](../type-aliases/IncidentStateEnum.md); -`tenantId?`: \{ +`__brand`: `"EndCursor"`; +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; +`__brand`: `"StartCursor"`; +\} +\| `null`; +`totalItems`: `number`; \}; \}\> @@ -3272,7 +3562,7 @@ getIncident(...a): CancelablePromise<{ ```ts getLicense(...a): CancelablePromise<{ - expiresAt?: string | null; + expiresAt: string | null; isCommercial: boolean; licenseType: string; validLicense: boolean; @@ -3283,12 +3573,12 @@ getLicense(...a): CancelablePromise<{ ##### a -...\[\] +...\[`object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`expiresAt?`: `string` \| `null`; +`expiresAt`: `string` \| `null`; `isCommercial`: `boolean`; `licenseType`: `string`; `validLicense`: `boolean`; @@ -3298,10 +3588,10 @@ getLicense(...a): CancelablePromise<{ ```ts getMappingRule(...a): CancelablePromise<{ - claimName?: string; - claimValue?: string; - mappingRuleId?: string; - name?: string; + claimName: string; + claimValue: string; + mappingRuleId: string; + name: string; }>; ``` @@ -3309,38 +3599,29 @@ getMappingRule(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`claimName?`: `string`; -`claimValue?`: `string`; -`mappingRuleId?`: `string`; -`name?`: `string`; +`claimName`: `string`; +`claimValue`: `string`; +`mappingRuleId`: `string`; +`name`: `string`; \}\> ### getProcessDefinition() ```ts getProcessDefinition(...a): CancelablePromise<{ - hasStartForm?: boolean; - name?: string; - processDefinitionId?: { - [key: number]: string; - __brand: "ProcessDefinitionId"; - }; - processDefinitionKey?: { - [key: number]: string; - __brand: "ProcessDefinitionKey"; - }; - resourceName?: string; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; - version?: number; - versionTag?: string; + hasStartForm: boolean; + name: string | null; + processDefinitionId: string; + processDefinitionKey: string; + resourceName: string; + tenantId: string; + version: number; + versionTag: string | null; }>; ``` @@ -3348,45 +3629,38 @@ getProcessDefinition(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`hasStartForm?`: `boolean`; -`name?`: `string`; -`processDefinitionId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ProcessDefinitionId"`; -\}; -`processDefinitionKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ProcessDefinitionKey"`; -\}; -`resourceName?`: `string`; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; -`version?`: `number`; -`versionTag?`: `string`; +`hasStartForm`: `boolean`; +`name`: `string` \| `null`; +`processDefinitionId`: `string`; +`processDefinitionKey`: `string`; +`resourceName`: `string`; +`tenantId`: `string`; +`version`: `number`; +`versionTag`: `string` \| `null`; \}\> ### getProcessDefinitionInstanceStatistics() ```ts getProcessDefinitionInstanceStatistics(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -3396,22 +3670,24 @@ getProcessDefinitionInstanceStatistics(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -3420,17 +3696,19 @@ getProcessDefinitionInstanceStatistics(...a): CancelablePromise<{ ```ts getProcessDefinitionInstanceVersionStatistics(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -3440,22 +3718,24 @@ getProcessDefinitionInstanceVersionStatistics(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -3464,17 +3744,19 @@ getProcessDefinitionInstanceVersionStatistics(...a): CancelablePromise<{ ```ts getProcessDefinitionMessageSubscriptionStatistics(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -3484,22 +3766,24 @@ getProcessDefinitionMessageSubscriptionStatistics(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -3508,7 +3792,7 @@ getProcessDefinitionMessageSubscriptionStatistics(...a): CancelablePromise<{ ```ts getProcessDefinitionStatistics(...a): CancelablePromise<{ - items?: object[]; + items: object[]; }>; ``` @@ -3516,12 +3800,12 @@ getProcessDefinitionStatistics(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; \}\> ### getProcessDefinitionXml() @@ -3534,7 +3818,7 @@ getProcessDefinitionXml(...a): CancelablePromise; ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns @@ -3544,29 +3828,37 @@ getProcessDefinitionXml(...a): CancelablePromise; ```ts getProcessInstance(...a): CancelablePromise<{ - endDate?: string; + businessId: | { + [key: number]: string; + __brand: "BusinessId"; + } + | null; + endDate: string | null; hasIncident: boolean; - parentElementInstanceKey?: { + parentElementInstanceKey: | { [key: number]: string; __brand: "ElementInstanceKey"; - }; - parentProcessInstanceKey?: { + } + | null; + parentProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; + } + | null; processDefinitionId: string; processDefinitionKey: string; - processDefinitionName: string; + processDefinitionName: string | null; processDefinitionVersion: number; - processDefinitionVersionTag?: string; + processDefinitionVersionTag: string | null; processInstanceKey: string; - rootProcessInstanceKey?: { + rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; + } + | null; startDate: string; state: ProcessInstanceStateEnum; - tags?: string[]; + tags: string[]; tenantId: string; }>; ``` @@ -3575,34 +3867,42 @@ getProcessInstance(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`endDate?`: `string`; +`businessId`: \| \{ +\[`key`: `number`\]: `string`; +`__brand`: `"BusinessId"`; +\} +\| `null`; +`endDate`: `string` \| `null`; `hasIncident`: `boolean`; -`parentElementInstanceKey?`: \{ +`parentElementInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ElementInstanceKey"`; -\}; -`parentProcessInstanceKey?`: \{ +\} +\| `null`; +`parentProcessInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; -\}; +\} +\| `null`; `processDefinitionId`: `string`; `processDefinitionKey`: `string`; -`processDefinitionName`: `string`; +`processDefinitionName`: `string` \| `null`; `processDefinitionVersion`: `number`; -`processDefinitionVersionTag?`: `string`; +`processDefinitionVersionTag`: `string` \| `null`; `processInstanceKey`: `string`; -`rootProcessInstanceKey?`: \{ +`rootProcessInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; -\}; +\} +\| `null`; `startDate`: `string`; `state`: [`ProcessInstanceStateEnum`](../type-aliases/ProcessInstanceStateEnum.md); -`tags?`: `string`[]; +`tags`: `string`[]; `tenantId`: `string`; \}\> @@ -3616,7 +3916,7 @@ getProcessInstanceCallHierarchy(...a): CancelablePromise; ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns @@ -3626,7 +3926,7 @@ getProcessInstanceCallHierarchy(...a): CancelablePromise; ```ts getProcessInstanceSequenceFlows(...a): CancelablePromise<{ - items?: object[]; + items: object[]; }>; ``` @@ -3634,19 +3934,19 @@ getProcessInstanceSequenceFlows(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; \}\> ### getProcessInstanceStatistics() ```ts getProcessInstanceStatistics(...a): CancelablePromise<{ - items?: object[]; + items: object[]; }>; ``` @@ -3654,29 +3954,31 @@ getProcessInstanceStatistics(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; \}\> ### getProcessInstanceStatisticsByDefinition() ```ts getProcessInstanceStatisticsByDefinition(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -3686,22 +3988,24 @@ getProcessInstanceStatisticsByDefinition(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -3710,17 +4014,19 @@ getProcessInstanceStatisticsByDefinition(...a): CancelablePromise<{ ```ts getProcessInstanceStatisticsByError(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -3730,22 +4036,24 @@ getProcessInstanceStatisticsByError(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -3754,30 +4062,12 @@ getProcessInstanceStatisticsByError(...a): CancelablePromise<{ ```ts getResource(...a): CancelablePromise<{ - resourceId?: string; - resourceKey?: | { - [key: number]: string; - __brand: "FormKey"; - } - | { - [key: number]: string; - __brand: "ProcessDefinitionKey"; - } - | { - [key: number]: string; - __brand: "DecisionRequirementsKey"; - } - | { - [key: number]: string; - __brand: "DecisionDefinitionKey"; - }; - resourceName?: string; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; - version?: number; - versionTag?: string; + resourceId: string; + resourceKey: string; + resourceName: string; + tenantId: string; + version: number; + versionTag: string | null; }>; ``` @@ -3785,62 +4075,42 @@ getResource(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`resourceId?`: `string`; -`resourceKey?`: \| \{ -\[`key`: `number`\]: `string`; -`__brand`: `"FormKey"`; -\} -\| \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ProcessDefinitionKey"`; -\} -\| \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionRequirementsKey"`; -\} -\| \{ -\[`key`: `number`\]: `string`; -`__brand`: `"DecisionDefinitionKey"`; -\}; -`resourceName?`: `string`; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; -`version?`: `number`; -`versionTag?`: `string`; +`resourceId`: `string`; +`resourceKey`: `string`; +`resourceName`: `string`; +`tenantId`: `string`; +`version`: `number`; +`versionTag`: `string` \| `null`; \}\> ### getResourceContent() ```ts -getResourceContent(...a): CancelablePromise<{ -}>; +getResourceContent(...a): CancelablePromise; ``` #### Parameters ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns -[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -\}\> +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<`string`\> ### getRole() ```ts getRole(...a): CancelablePromise<{ - description?: string; - name?: string; - roleId?: string; + description: string | null; + name: string; + roleId: string; }>; ``` @@ -3848,14 +4118,14 @@ getRole(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`description?`: `string`; -`name?`: `string`; -`roleId?`: `string`; +`description`: `string` \| `null`; +`name`: `string`; +`roleId`: `string`; \}\> ### getStartProcessForm() @@ -3864,22 +4134,11 @@ getRole(...a): CancelablePromise<{ getStartProcessForm(...a): CancelablePromise< | void | { - formId?: { - [key: number]: string; - __brand: "FormId"; - }; - formKey?: { - [key: number]: string; - __brand: "FormKey"; - }; - schema?: { - [key: string]: unknown; - }; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; - version?: number; + formId: string; + formKey: string; + schema: string; + tenantId: string; + version: number; }>; ``` @@ -3887,29 +4146,18 @@ getStartProcessForm(...a): CancelablePromise< ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\< \| `void` \| \{ -`formId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"FormId"`; -\}; -`formKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"FormKey"`; -\}; -`schema?`: \{ -\[`key`: `string`\]: `unknown`; -\}; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; -`version?`: `number`; +`formId`: `string`; +`formKey`: `string`; +`schema`: `string`; +`tenantId`: `string`; +`version`: `number`; \}\> ### getStatus() @@ -3922,21 +4170,23 @@ getStatus(...a): CancelablePromise; ##### a -...\[\] +...\[`object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<`void`\> -### getTenant() +### getSystemConfiguration() ```ts -getTenant(...a): CancelablePromise<{ - description?: string; - name?: string; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; +getSystemConfiguration(...a): CancelablePromise<{ + jobMetrics: { + enabled: boolean; + exportInterval: string; + maxJobTypeLength: number; + maxTenantIdLength: number; + maxUniqueKeys: number; + maxWorkerNameLength: number; }; }>; ``` @@ -3945,27 +4195,53 @@ getTenant(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`description?`: `string`; -`name?`: `string`; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; +`jobMetrics`: \{ +`enabled`: `boolean`; +`exportInterval`: `string`; +`maxJobTypeLength`: `number`; +`maxTenantIdLength`: `number`; +`maxUniqueKeys`: `number`; +`maxWorkerNameLength`: `number`; \}; \}\> +### getTenant() + +```ts +getTenant(...a): CancelablePromise<{ + description: string | null; + name: string; + tenantId: string; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`description`: `string` \| `null`; +`name`: `string`; +`tenantId`: `string`; +\}\> + ### getTenantClusterVariable() ```ts getTenantClusterVariable(...a): CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; - tenantId?: string; - value?: string; + tenantId: string | null; + value: string; }>; ``` @@ -3973,15 +4249,15 @@ getTenantClusterVariable(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `name`: `string`; `scope`: [`ClusterVariableScopeEnum`](../type-aliases/ClusterVariableScopeEnum.md); -`tenantId?`: `string`; -`value?`: `string`; +`tenantId`: `string` \| `null`; +`value`: `string`; \}\> ### getTopology() @@ -3989,7 +4265,7 @@ getTenantClusterVariable(...a): CancelablePromise<{ ```ts getTopology(...a): CancelablePromise<{ brokers: object[]; - clusterId?: string | null; + clusterId: string | null; clusterSize: number; gatewayVersion: string; lastCompletedChangeId: string; @@ -4002,13 +4278,13 @@ getTopology(...a): CancelablePromise<{ ##### a -...\[\] +...\[`object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `brokers`: `object`[]; -`clusterId?`: `string` \| `null`; +`clusterId`: `string` \| `null`; `clusterSize`: `number`; `gatewayVersion`: `string`; `lastCompletedChangeId`: `string`; @@ -4020,11 +4296,11 @@ getTopology(...a): CancelablePromise<{ ```ts getUsageMetrics(...a): CancelablePromise<{ - activeTenants?: number; - assignees?: number; - decisionInstances?: number; - processInstances?: number; - tenants?: { + activeTenants: number; + assignees: number; + decisionInstances: number; + processInstances: number; + tenants: { [key: string]: object; }; }>; @@ -4034,16 +4310,16 @@ getUsageMetrics(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`activeTenants?`: `number`; -`assignees?`: `number`; -`decisionInstances?`: `number`; -`processInstances?`: `number`; -`tenants?`: \{ +`activeTenants`: `number`; +`assignees`: `number`; +`decisionInstances`: `number`; +`processInstances`: `number`; +`tenants`: \{ \[`key`: `string`\]: `object`; \}; \}\> @@ -4052,12 +4328,9 @@ getUsageMetrics(...a): CancelablePromise<{ ```ts getUser(...a): CancelablePromise<{ - email?: string; - name?: string; - username?: { - [key: number]: string; - __brand: "Username"; - }; + email: string | null; + name: string | null; + username: string; }>; ``` @@ -4065,76 +4338,54 @@ getUser(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`email?`: `string`; -`name?`: `string`; -`username?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"Username"`; -\}; +`email`: `string` \| `null`; +`name`: `string` \| `null`; +`username`: `string`; \}\> ### getUserTask() ```ts getUserTask(...a): CancelablePromise<{ - assignee?: string; - candidateGroups?: string[]; - candidateUsers?: string[]; - completionDate?: string; - creationDate?: string; - customHeaders?: { + assignee: string | null; + candidateGroups: string[]; + candidateUsers: string[]; + completionDate: string | null; + creationDate: string; + customHeaders: { [key: string]: string; }; - dueDate?: string; - elementId?: { - [key: number]: string; - __brand: "ElementId"; - }; - elementInstanceKey?: { - [key: number]: string; - __brand: "ElementInstanceKey"; - }; - externalFormReference?: string; - followUpDate?: string; - formKey?: { + dueDate: string | null; + elementId: string; + elementInstanceKey: string; + externalFormReference: string | null; + followUpDate: string | null; + formKey: | { [key: number]: string; __brand: "FormKey"; - }; - name?: string; - priority?: number; - processDefinitionId?: { - [key: number]: string; - __brand: "ProcessDefinitionId"; - }; - processDefinitionKey?: { - [key: number]: string; - __brand: "ProcessDefinitionKey"; - }; - processDefinitionVersion?: number; - processInstanceKey?: { - [key: number]: string; - __brand: "ProcessInstanceKey"; - }; - processName?: string; - rootProcessInstanceKey?: { + } + | null; + name: string | null; + priority: number; + processDefinitionId: string; + processDefinitionKey: string; + processDefinitionVersion: number; + processInstanceKey: string; + processName: string | null; + rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; - state?: UserTaskStateEnum; - tags?: string[]; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; - userTaskKey?: { - [key: number]: string; - __brand: "UserTaskKey"; - }; + } + | null; + state: UserTaskStateEnum; + tags: string[]; + tenantId: string; + userTaskKey: string; }>; ``` @@ -4142,64 +4393,45 @@ getUserTask(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`assignee?`: `string`; -`candidateGroups?`: `string`[]; -`candidateUsers?`: `string`[]; -`completionDate?`: `string`; -`creationDate?`: `string`; -`customHeaders?`: \{ +`assignee`: `string` \| `null`; +`candidateGroups`: `string`[]; +`candidateUsers`: `string`[]; +`completionDate`: `string` \| `null`; +`creationDate`: `string`; +`customHeaders`: \{ \[`key`: `string`\]: `string`; \}; -`dueDate?`: `string`; -`elementId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ElementId"`; -\}; -`elementInstanceKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ElementInstanceKey"`; -\}; -`externalFormReference?`: `string`; -`followUpDate?`: `string`; -`formKey?`: \{ +`dueDate`: `string` \| `null`; +`elementId`: `string`; +`elementInstanceKey`: `string`; +`externalFormReference`: `string` \| `null`; +`followUpDate`: `string` \| `null`; +`formKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"FormKey"`; -\}; -`name?`: `string`; -`priority?`: `number`; -`processDefinitionId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ProcessDefinitionId"`; -\}; -`processDefinitionKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ProcessDefinitionKey"`; -\}; -`processDefinitionVersion?`: `number`; -`processInstanceKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ProcessInstanceKey"`; -\}; -`processName?`: `string`; -`rootProcessInstanceKey?`: \{ +\} +\| `null`; +`name`: `string` \| `null`; +`priority`: `number`; +`processDefinitionId`: `string`; +`processDefinitionKey`: `string`; +`processDefinitionVersion`: `number`; +`processInstanceKey`: `string`; +`processName`: `string` \| `null`; +`rootProcessInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; -\}; -`state?`: [`UserTaskStateEnum`](../type-aliases/UserTaskStateEnum.md); -`tags?`: `string`[]; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; -`userTaskKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"UserTaskKey"`; -\}; +\} +\| `null`; +`state`: [`UserTaskStateEnum`](../type-aliases/UserTaskStateEnum.md); +`tags`: `string`[]; +`tenantId`: `string`; +`userTaskKey`: `string`; \}\> ### getUserTaskForm() @@ -4208,22 +4440,11 @@ getUserTask(...a): CancelablePromise<{ getUserTaskForm(...a): CancelablePromise< | void | { - formId?: { - [key: number]: string; - __brand: "FormId"; - }; - formKey?: { - [key: number]: string; - __brand: "FormKey"; - }; - schema?: { - [key: string]: unknown; - }; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; - version?: number; + formId: string; + formKey: string; + schema: string; + tenantId: string; + version: number; }>; ``` @@ -4231,57 +4452,35 @@ getUserTaskForm(...a): CancelablePromise< ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\< \| `void` \| \{ -`formId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"FormId"`; -\}; -`formKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"FormKey"`; -\}; -`schema?`: \{ -\[`key`: `string`\]: `unknown`; -\}; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; -`version?`: `number`; +`formId`: `string`; +`formKey`: `string`; +`schema`: `string`; +`tenantId`: `string`; +`version`: `number`; \}\> ### getVariable() ```ts getVariable(...a): CancelablePromise<{ - name?: string; - processInstanceKey?: { - [key: number]: string; - __brand: "ProcessInstanceKey"; - }; - rootProcessInstanceKey?: { + name: string; + processInstanceKey: string; + rootProcessInstanceKey: | { [key: number]: string; __brand: "ProcessInstanceKey"; - }; - scopeKey?: { - [key: number]: string; - __brand: "ScopeKey"; - }; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; - value?: string; - variableKey?: { - [key: number]: string; - __brand: "VariableKey"; - }; + } + | null; + scopeKey: string; + tenantId: string; + value: string; + variableKey: string; }>; ``` @@ -4289,33 +4488,22 @@ getVariable(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`name?`: `string`; -`processInstanceKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ProcessInstanceKey"`; -\}; -`rootProcessInstanceKey?`: \{ +`name`: `string`; +`processInstanceKey`: `string`; +`rootProcessInstanceKey`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"ProcessInstanceKey"`; -\}; -`scopeKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"ScopeKey"`; -\}; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; -`value?`: `string`; -`variableKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"VariableKey"`; -\}; +\} +\| `null`; +`scopeKey`: `string`; +`tenantId`: `string`; +`value`: `string`; +`variableKey`: `string`; \}\> ### getWorkers() @@ -4536,7 +4724,7 @@ migrateProcessInstance(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -4546,11 +4734,8 @@ migrateProcessInstance(...a): CancelablePromise; ```ts migrateProcessInstancesBatchOperation(...a): CancelablePromise<{ - batchOperationKey?: { - [key: number]: string; - __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; + batchOperationKey: string; + batchOperationType: BatchOperationTypeEnum; }>; ``` @@ -4563,11 +4748,8 @@ migrateProcessInstancesBatchOperation(...a): CancelablePromise<{ #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`batchOperationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); +`batchOperationKey`: `string`; +`batchOperationType`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); \}\> ### modifyProcessInstance() @@ -4580,7 +4762,7 @@ modifyProcessInstance(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -4590,11 +4772,8 @@ modifyProcessInstance(...a): CancelablePromise; ```ts modifyProcessInstancesBatchOperation(...a): CancelablePromise<{ - batchOperationKey?: { - [key: number]: string; - __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; + batchOperationKey: string; + batchOperationType: BatchOperationTypeEnum; }>; ``` @@ -4607,11 +4786,8 @@ modifyProcessInstancesBatchOperation(...a): CancelablePromise<{ #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`batchOperationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); +`batchOperationKey`: `string`; +`batchOperationType`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); \}\> ### onAuthHeaders() @@ -4646,7 +4822,7 @@ pinClock(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -4656,14 +4832,8 @@ pinClock(...a): CancelablePromise; ```ts publishMessage(...a): CancelablePromise<{ - messageKey?: { - [key: number]: string; - __brand: "MessageKey"; - }; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; + messageKey: string; + tenantId: string; }>; ``` @@ -4671,19 +4841,13 @@ publishMessage(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`messageKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"MessageKey"`; -\}; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; +`messageKey`: `string`; +`tenantId`: `string`; \}\> ### resetClock() @@ -4696,7 +4860,7 @@ resetClock(...a): CancelablePromise; ##### a -...\[\] +...\[`object`\] #### Returns @@ -4712,7 +4876,7 @@ resolveIncident(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -4722,11 +4886,8 @@ resolveIncident(...a): CancelablePromise; ```ts resolveIncidentsBatchOperation(...a): CancelablePromise<{ - batchOperationKey?: { - [key: number]: string; - __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; + batchOperationKey: string; + batchOperationType: BatchOperationTypeEnum; }>; ``` @@ -4739,22 +4900,16 @@ resolveIncidentsBatchOperation(...a): CancelablePromise<{ #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`batchOperationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); +`batchOperationKey`: `string`; +`batchOperationType`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); \}\> ### resolveProcessInstanceIncidents() ```ts resolveProcessInstanceIncidents(...a): CancelablePromise<{ - batchOperationKey?: { - [key: number]: string; - __brand: "BatchOperationKey"; - }; - batchOperationType?: BatchOperationTypeEnum; + batchOperationKey: string; + batchOperationType: BatchOperationTypeEnum; }>; ``` @@ -4767,11 +4922,8 @@ resolveProcessInstanceIncidents(...a): CancelablePromise<{ #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`batchOperationKey?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"BatchOperationKey"`; -\}; -`batchOperationType?`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); +`batchOperationKey`: `string`; +`batchOperationType`: [`BatchOperationTypeEnum`](../type-aliases/BatchOperationTypeEnum.md); \}\> ### resumeBatchOperation() @@ -4794,17 +4946,19 @@ resumeBatchOperation(...a): CancelablePromise; ```ts searchAuditLogs(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -4814,22 +4968,24 @@ searchAuditLogs(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -4838,17 +4994,19 @@ searchAuditLogs(...a): CancelablePromise<{ ```ts searchAuthorizations(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -4858,22 +5016,24 @@ searchAuthorizations(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -4882,17 +5042,19 @@ searchAuthorizations(...a): CancelablePromise<{ ```ts searchBatchOperationItems(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -4902,22 +5064,24 @@ searchBatchOperationItems(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -4926,17 +5090,19 @@ searchBatchOperationItems(...a): CancelablePromise<{ ```ts searchBatchOperations(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -4946,22 +5112,24 @@ searchBatchOperations(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -4970,17 +5138,19 @@ searchBatchOperations(...a): CancelablePromise<{ ```ts searchClientsForGroup(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -4990,22 +5160,24 @@ searchClientsForGroup(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5014,17 +5186,19 @@ searchClientsForGroup(...a): CancelablePromise<{ ```ts searchClientsForRole(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5034,22 +5208,24 @@ searchClientsForRole(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5058,17 +5234,19 @@ searchClientsForRole(...a): CancelablePromise<{ ```ts searchClientsForTenant(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5078,22 +5256,24 @@ searchClientsForTenant(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5102,17 +5282,19 @@ searchClientsForTenant(...a): CancelablePromise<{ ```ts searchClusterVariables(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5122,22 +5304,24 @@ searchClusterVariables(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5146,17 +5330,19 @@ searchClusterVariables(...a): CancelablePromise<{ ```ts searchCorrelatedMessageSubscriptions(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5166,22 +5352,24 @@ searchCorrelatedMessageSubscriptions(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5190,17 +5378,19 @@ searchCorrelatedMessageSubscriptions(...a): CancelablePromise<{ ```ts searchDecisionDefinitions(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5210,22 +5400,24 @@ searchDecisionDefinitions(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5234,17 +5426,19 @@ searchDecisionDefinitions(...a): CancelablePromise<{ ```ts searchDecisionInstances(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5254,22 +5448,24 @@ searchDecisionInstances(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5278,17 +5474,19 @@ searchDecisionInstances(...a): CancelablePromise<{ ```ts searchDecisionRequirements(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5298,22 +5496,24 @@ searchDecisionRequirements(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5322,17 +5522,19 @@ searchDecisionRequirements(...a): CancelablePromise<{ ```ts searchElementInstanceIncidents(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5342,22 +5544,24 @@ searchElementInstanceIncidents(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5366,17 +5570,19 @@ searchElementInstanceIncidents(...a): CancelablePromise<{ ```ts searchElementInstances(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5386,22 +5592,72 @@ searchElementInstances(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; +\} +\| `null`; +`totalItems`: `number`; \}; +\}\> + +### searchGlobalTaskListeners() + +```ts +searchGlobalTaskListeners(...a): CancelablePromise<{ + items: object[]; + page: { + endCursor: | { + [key: number]: string; + __brand: "EndCursor"; + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { + [key: number]: string; + __brand: "StartCursor"; + } + | null; + totalItems: number; + }; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; +`page`: \{ +`endCursor`: \| \{ +\[`key`: `number`\]: `string`; +`__brand`: `"EndCursor"`; +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ +\[`key`: `number`\]: `string`; +`__brand`: `"StartCursor"`; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5410,17 +5666,19 @@ searchElementInstances(...a): CancelablePromise<{ ```ts searchGroupIdsForTenant(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5430,22 +5688,24 @@ searchGroupIdsForTenant(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5454,17 +5714,19 @@ searchGroupIdsForTenant(...a): CancelablePromise<{ ```ts searchGroups(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5474,22 +5736,24 @@ searchGroups(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5498,17 +5762,19 @@ searchGroups(...a): CancelablePromise<{ ```ts searchGroupsForRole(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5518,22 +5784,24 @@ searchGroupsForRole(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5542,17 +5810,19 @@ searchGroupsForRole(...a): CancelablePromise<{ ```ts searchIncidents(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5562,22 +5832,24 @@ searchIncidents(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5586,17 +5858,19 @@ searchIncidents(...a): CancelablePromise<{ ```ts searchJobs(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5606,22 +5880,24 @@ searchJobs(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5630,17 +5906,19 @@ searchJobs(...a): CancelablePromise<{ ```ts searchMappingRule(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5650,22 +5928,24 @@ searchMappingRule(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5674,16 +5954,19 @@ searchMappingRule(...a): CancelablePromise<{ ```ts searchMappingRulesForGroup(...a): CancelablePromise<{ + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5693,21 +5976,24 @@ searchMappingRulesForGroup(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5716,16 +6002,19 @@ searchMappingRulesForGroup(...a): CancelablePromise<{ ```ts searchMappingRulesForRole(...a): CancelablePromise<{ + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5735,21 +6024,24 @@ searchMappingRulesForRole(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5758,16 +6050,19 @@ searchMappingRulesForRole(...a): CancelablePromise<{ ```ts searchMappingRulesForTenant(...a): CancelablePromise<{ + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5777,21 +6072,24 @@ searchMappingRulesForTenant(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5800,17 +6098,19 @@ searchMappingRulesForTenant(...a): CancelablePromise<{ ```ts searchMessageSubscriptions(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5820,22 +6120,24 @@ searchMessageSubscriptions(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5844,17 +6146,19 @@ searchMessageSubscriptions(...a): CancelablePromise<{ ```ts searchProcessDefinitions(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5864,22 +6168,24 @@ searchProcessDefinitions(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5888,17 +6194,19 @@ searchProcessDefinitions(...a): CancelablePromise<{ ```ts searchProcessInstanceIncidents(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5908,22 +6216,24 @@ searchProcessInstanceIncidents(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5934,15 +6244,17 @@ searchProcessInstanceIncidents(...a): CancelablePromise<{ searchProcessInstances(...a): CancelablePromise<{ items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5952,22 +6264,24 @@ searchProcessInstances(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -5976,17 +6290,19 @@ searchProcessInstances(...a): CancelablePromise<{ ```ts searchRoles(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -5996,22 +6312,24 @@ searchRoles(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6020,16 +6338,19 @@ searchRoles(...a): CancelablePromise<{ ```ts searchRolesForGroup(...a): CancelablePromise<{ + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6039,21 +6360,24 @@ searchRolesForGroup(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6062,16 +6386,19 @@ searchRolesForGroup(...a): CancelablePromise<{ ```ts searchRolesForTenant(...a): CancelablePromise<{ + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6081,21 +6408,24 @@ searchRolesForTenant(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6104,17 +6434,19 @@ searchRolesForTenant(...a): CancelablePromise<{ ```ts searchTenants(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6124,22 +6456,24 @@ searchTenants(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6150,15 +6484,17 @@ searchTenants(...a): CancelablePromise<{ searchUsers(...a): CancelablePromise<{ items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6168,22 +6504,24 @@ searchUsers(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6192,17 +6530,19 @@ searchUsers(...a): CancelablePromise<{ ```ts searchUsersForGroup(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6212,22 +6552,24 @@ searchUsersForGroup(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6236,17 +6578,19 @@ searchUsersForGroup(...a): CancelablePromise<{ ```ts searchUsersForRole(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6256,22 +6600,24 @@ searchUsersForRole(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6280,17 +6626,19 @@ searchUsersForRole(...a): CancelablePromise<{ ```ts searchUsersForTenant(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6300,22 +6648,24 @@ searchUsersForTenant(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6324,17 +6674,19 @@ searchUsersForTenant(...a): CancelablePromise<{ ```ts searchUserTaskAuditLogs(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6344,22 +6696,72 @@ searchUserTaskAuditLogs(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; +\} +\| `null`; +`totalItems`: `number`; \}; +\}\> + +### searchUserTaskEffectiveVariables() + +```ts +searchUserTaskEffectiveVariables(...a): CancelablePromise<{ + items: object[]; + page: { + endCursor: | { + [key: number]: string; + __brand: "EndCursor"; + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { + [key: number]: string; + __brand: "StartCursor"; + } + | null; + totalItems: number; + }; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`items`: `object`[]; +`page`: \{ +`endCursor`: \| \{ +\[`key`: `number`\]: `string`; +`__brand`: `"EndCursor"`; +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ +\[`key`: `number`\]: `string`; +`__brand`: `"StartCursor"`; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6368,17 +6770,19 @@ searchUserTaskAuditLogs(...a): CancelablePromise<{ ```ts searchUserTasks(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6388,22 +6792,24 @@ searchUserTasks(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6412,17 +6818,19 @@ searchUserTasks(...a): CancelablePromise<{ ```ts searchUserTaskVariables(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6432,22 +6840,24 @@ searchUserTaskVariables(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6456,17 +6866,19 @@ searchUserTaskVariables(...a): CancelablePromise<{ ```ts searchVariables(...a): CancelablePromise<{ - items?: object[]; + items: object[]; page: { - endCursor?: { + endCursor: | { [key: number]: string; __brand: "EndCursor"; - }; - hasMoreTotalItems?: boolean; - startCursor?: { + } + | null; + hasMoreTotalItems: boolean; + startCursor: | { [key: number]: string; __brand: "StartCursor"; - }; + } + | null; totalItems: number; }; }>; @@ -6476,22 +6888,24 @@ searchVariables(...a): CancelablePromise<{ ##### a -...\[`object`, `object`\] +...\[`object`, `object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`items?`: `object`[]; +`items`: `object`[]; `page`: \{ -`endCursor?`: \{ +`endCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"EndCursor"`; -\}; -`hasMoreTotalItems?`: `boolean`; -`startCursor?`: \{ +\} +\| `null`; +`hasMoreTotalItems`: `boolean`; +`startCursor`: \| \{ \[`key`: `number`\]: `string`; `__brand`: `"StartCursor"`; -\}; +\} +\| `null`; `totalItems`: `number`; \}; \}\> @@ -6538,7 +6952,7 @@ throwJobError(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6554,7 +6968,7 @@ unassignClientFromGroup(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6570,7 +6984,7 @@ unassignClientFromTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6586,7 +7000,7 @@ unassignGroupFromTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6602,7 +7016,7 @@ unassignMappingRuleFromGroup(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6618,7 +7032,7 @@ unassignMappingRuleFromTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6634,7 +7048,7 @@ unassignRoleFromClient(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6650,7 +7064,7 @@ unassignRoleFromGroup(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6666,7 +7080,7 @@ unassignRoleFromMappingRule(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6682,7 +7096,7 @@ unassignRoleFromTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6698,7 +7112,7 @@ unassignRoleFromUser(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6714,7 +7128,7 @@ unassignUserFromGroup(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6730,7 +7144,7 @@ unassignUserFromTenant(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6746,7 +7160,7 @@ unassignUserTask(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6778,7 +7192,7 @@ updateAuthorization(...a): CancelablePromise; `permissionTypes`: [`PermissionTypeEnum`](../type-aliases/PermissionTypeEnum.md)[]; `resourcePropertyName`: `string`; `resourceType`: [`ResourceTypeEnum`](../type-aliases/ResourceTypeEnum.md); -\}\] +\}, `object`\] #### Returns @@ -6790,8 +7204,8 @@ updateAuthorization(...a): CancelablePromise; updateGlobalClusterVariable(...a): CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; - tenantId?: string; - value?: string; + tenantId: string | null; + value: string; }>; ``` @@ -6799,24 +7213,56 @@ updateGlobalClusterVariable(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `name`: `string`; `scope`: [`ClusterVariableScopeEnum`](../type-aliases/ClusterVariableScopeEnum.md); -`tenantId?`: `string`; -`value?`: `string`; +`tenantId`: `string` \| `null`; +`value`: `string`; +\}\> + +### updateGlobalTaskListener() + +```ts +updateGlobalTaskListener(...a): CancelablePromise<{ + afterNonGlobal?: boolean; + eventTypes: GlobalTaskListenerEventTypeEnum[]; + id: string; + priority?: number; + retries?: number; + source: GlobalListenerSourceEnum; + type?: string; +}>; +``` + +#### Parameters + +##### a + +...\[`object`, `object`\] + +#### Returns + +[`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ +`afterNonGlobal?`: `boolean`; +`eventTypes`: [`GlobalTaskListenerEventTypeEnum`](../type-aliases/GlobalTaskListenerEventTypeEnum.md)[]; +`id`: `string`; +`priority?`: `number`; +`retries?`: `number`; +`source`: [`GlobalListenerSourceEnum`](../type-aliases/GlobalListenerSourceEnum.md); +`type?`: `string`; \}\> ### updateGroup() ```ts updateGroup(...a): CancelablePromise<{ - description?: string; - groupId?: string; - name?: string; + description: string | null; + groupId: string; + name: string; }>; ``` @@ -6824,14 +7270,14 @@ updateGroup(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`description?`: `string`; -`groupId?`: `string`; -`name?`: `string`; +`description`: `string` \| `null`; +`groupId`: `string`; +`name`: `string`; \}\> ### updateJob() @@ -6844,7 +7290,7 @@ updateJob(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns @@ -6854,10 +7300,10 @@ updateJob(...a): CancelablePromise; ```ts updateMappingRule(...a): CancelablePromise<{ - claimName?: string; - claimValue?: string; - mappingRuleId?: string; - name?: string; + claimName: string; + claimValue: string; + mappingRuleId: string; + name: string; }>; ``` @@ -6865,24 +7311,24 @@ updateMappingRule(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`claimName?`: `string`; -`claimValue?`: `string`; -`mappingRuleId?`: `string`; -`name?`: `string`; +`claimName`: `string`; +`claimValue`: `string`; +`mappingRuleId`: `string`; +`name`: `string`; \}\> ### updateRole() ```ts updateRole(...a): CancelablePromise<{ - description?: string; - name?: string; - roleId?: string; + description: string | null; + name: string; + roleId: string; }>; ``` @@ -6890,26 +7336,23 @@ updateRole(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`description?`: `string`; -`name?`: `string`; -`roleId?`: `string`; +`description`: `string` \| `null`; +`name`: `string`; +`roleId`: `string`; \}\> ### updateTenant() ```ts updateTenant(...a): CancelablePromise<{ - description?: string; - name?: string; - tenantId?: { - [key: number]: string; - __brand: "TenantId"; - }; + description: string | null; + name: string; + tenantId: string; }>; ``` @@ -6917,17 +7360,14 @@ updateTenant(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`description?`: `string`; -`name?`: `string`; -`tenantId?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"TenantId"`; -\}; +`description`: `string` \| `null`; +`name`: `string`; +`tenantId`: `string`; \}\> ### updateTenantClusterVariable() @@ -6936,8 +7376,8 @@ updateTenant(...a): CancelablePromise<{ updateTenantClusterVariable(...a): CancelablePromise<{ name: string; scope: ClusterVariableScopeEnum; - tenantId?: string; - value?: string; + tenantId: string | null; + value: string; }>; ``` @@ -6945,27 +7385,24 @@ updateTenantClusterVariable(...a): CancelablePromise<{ ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ `name`: `string`; `scope`: [`ClusterVariableScopeEnum`](../type-aliases/ClusterVariableScopeEnum.md); -`tenantId?`: `string`; -`value?`: `string`; +`tenantId`: `string` \| `null`; +`value`: `string`; \}\> ### updateUser() ```ts updateUser(...a): CancelablePromise<{ - email?: string; - name?: string; - username?: { - [key: number]: string; - __brand: "Username"; - }; + email: string | null; + name: string | null; + username: string; }>; ``` @@ -6978,12 +7415,9 @@ updateUser(...a): CancelablePromise<{ #### Returns [`CancelablePromise`](../interfaces/CancelablePromise.md)\<\{ -`email?`: `string`; -`name?`: `string`; -`username?`: \{ -\[`key`: `number`\]: `string`; -`__brand`: `"Username"`; -\}; +`email`: `string` \| `null`; +`name`: `string` \| `null`; +`username`: `string`; \}\> ### updateUserTask() @@ -6996,7 +7430,7 @@ updateUserTask(...a): CancelablePromise; ##### a -...\[`object`\] +...\[`object`, `object`\] #### Returns diff --git a/docs/apis-tools/typescript/api-reference/index/functions/createCamundaFpClient.md b/docs/apis-tools/typescript/api-reference/index/functions/createCamundaFpClient.md index b60db6b70bc..2e5c7462222 100644 --- a/docs/apis-tools/typescript/api-reference/index/functions/createCamundaFpClient.md +++ b/docs/apis-tools/typescript/api-reference/index/functions/createCamundaFpClient.md @@ -11,7 +11,7 @@ mdx: function createCamundaFpClient(options?): CamundaFpClient; ``` -Defined in: [fp-ts.ts:91](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L91) +Defined in: [fp-ts.ts:91](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L91) **`Experimental`** diff --git a/docs/apis-tools/typescript/api-reference/index/functions/createCamundaResultClient.md b/docs/apis-tools/typescript/api-reference/index/functions/createCamundaResultClient.md index 675ac1a9660..6d191da78be 100644 --- a/docs/apis-tools/typescript/api-reference/index/functions/createCamundaResultClient.md +++ b/docs/apis-tools/typescript/api-reference/index/functions/createCamundaResultClient.md @@ -11,7 +11,7 @@ mdx: function createCamundaResultClient(options?): CamundaResultClient; ``` -Defined in: [resultClient.ts:19](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/resultClient.ts#L19) +Defined in: [resultClient.ts:19](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/resultClient.ts#L19) **`Experimental`** diff --git a/docs/apis-tools/typescript/api-reference/index/functions/isErr.md b/docs/apis-tools/typescript/api-reference/index/functions/isErr.md index 84c96b098ba..47de329a348 100644 --- a/docs/apis-tools/typescript/api-reference/index/functions/isErr.md +++ b/docs/apis-tools/typescript/api-reference/index/functions/isErr.md @@ -11,7 +11,7 @@ mdx: function isErr(r): r is { error: E; ok: false }; ``` -Defined in: [resultClient.ts:6](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/resultClient.ts#L6) +Defined in: [resultClient.ts:6](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/resultClient.ts#L6) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/functions/isLeft.md b/docs/apis-tools/typescript/api-reference/index/functions/isLeft.md index 7c391f1a7a1..8c6d634203f 100644 --- a/docs/apis-tools/typescript/api-reference/index/functions/isLeft.md +++ b/docs/apis-tools/typescript/api-reference/index/functions/isLeft.md @@ -11,7 +11,7 @@ mdx: function isLeft(e): e is Left; ``` -Defined in: [fp-ts.ts:16](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L16) +Defined in: [fp-ts.ts:16](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L16) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/functions/isOk.md b/docs/apis-tools/typescript/api-reference/index/functions/isOk.md index cb90f054d1b..0ecc6dab092 100644 --- a/docs/apis-tools/typescript/api-reference/index/functions/isOk.md +++ b/docs/apis-tools/typescript/api-reference/index/functions/isOk.md @@ -11,7 +11,7 @@ mdx: function isOk(r): r is { ok: true; value: T }; ``` -Defined in: [resultClient.ts:5](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/resultClient.ts#L5) +Defined in: [resultClient.ts:5](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/resultClient.ts#L5) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/functions/isRight.md b/docs/apis-tools/typescript/api-reference/index/functions/isRight.md index 7c4cb6733a8..e0bb16ccc4d 100644 --- a/docs/apis-tools/typescript/api-reference/index/functions/isRight.md +++ b/docs/apis-tools/typescript/api-reference/index/functions/isRight.md @@ -11,7 +11,7 @@ mdx: function isRight(e): e is Right; ``` -Defined in: [fp-ts.ts:17](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L17) +Defined in: [fp-ts.ts:17](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L17) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/functions/isSdkError.md b/docs/apis-tools/typescript/api-reference/index/functions/isSdkError.md new file mode 100644 index 00000000000..295d9386f7f --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/functions/isSdkError.md @@ -0,0 +1,24 @@ +--- +title: "Function: isSdkError()" +sidebar_label: "isSdkError()" +mdx: + format: md +--- + +# Function: isSdkError() + +```ts +function isSdkError(e): e is SdkError; +``` + +Defined in: [runtime/errors.ts:48](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L48) + +## Parameters + +### e + +`unknown` + +## Returns + +`e is SdkError` diff --git a/docs/apis-tools/typescript/api-reference/index/index.md b/docs/apis-tools/typescript/api-reference/index/index.md index c47e7aabae2..417f6828ce9 100644 --- a/docs/apis-tools/typescript/api-reference/index/index.md +++ b/docs/apis-tools/typescript/api-reference/index/index.md @@ -13,6 +13,7 @@ mdx: - [AuditLogKey](namespaces/AuditLogKey/index.md) - [AuthorizationKey](namespaces/AuthorizationKey/index.md) - [BatchOperationKey](namespaces/BatchOperationKey/index.md) +- [BusinessId](namespaces/BusinessId/index.md) - [ConditionalEvaluationKey](namespaces/ConditionalEvaluationKey/index.md) - [DecisionDefinitionId](namespaces/DecisionDefinitionId/index.md) - [DecisionDefinitionKey](namespaces/DecisionDefinitionKey/index.md) @@ -27,6 +28,7 @@ mdx: - [EndCursor](namespaces/EndCursor/index.md) - [FormId](namespaces/FormId/index.md) - [FormKey](namespaces/FormKey/index.md) +- [GlobalListenerId](namespaces/GlobalListenerId/index.md) - [IncidentKey](namespaces/IncidentKey/index.md) - [JobKey](namespaces/JobKey/index.md) - [MessageKey](namespaces/MessageKey/index.md) @@ -34,8 +36,6 @@ mdx: - [ProcessDefinitionId](namespaces/ProcessDefinitionId/index.md) - [ProcessDefinitionKey](namespaces/ProcessDefinitionKey/index.md) - [ProcessInstanceKey](namespaces/ProcessInstanceKey/index.md) -- [RootProcessInstanceKey](namespaces/RootProcessInstanceKey/index.md) -- [ScopeKey](namespaces/ScopeKey/index.md) - [SignalKey](namespaces/SignalKey/index.md) - [StartCursor](namespaces/StartCursor/index.md) - [Tag](namespaces/Tag/index.md) @@ -59,10 +59,15 @@ mdx: - [CreateLoggerOptions](interfaces/CreateLoggerOptions.md) - [EnrichedActivatedJob](interfaces/EnrichedActivatedJob.md) - [ExtendedDeploymentResult](interfaces/ExtendedDeploymentResult.md) +- [HttpRetryPolicy](interfaces/HttpRetryPolicy.md) - [JobWorker](interfaces/JobWorker.md) - [JobWorkerConfig](interfaces/JobWorkerConfig.md) +- [OperationOptions](interfaces/OperationOptions.md) - [SupportLogger](interfaces/SupportLogger.md) - [TelemetryHooks](interfaces/TelemetryHooks.md) +- [ThreadedJobWorker](interfaces/ThreadedJobWorker.md) +- [ThreadedJobWorkerConfig](interfaces/ThreadedJobWorkerConfig.md) +- [ThreadPool](interfaces/ThreadPool.md) ## Type Aliases @@ -100,6 +105,8 @@ mdx: - [AdvancedElementInstanceStateFilter](type-aliases/AdvancedElementInstanceStateFilter.md) - [AdvancedEntityTypeFilter](type-aliases/AdvancedEntityTypeFilter.md) - [AdvancedFormKeyFilter](type-aliases/AdvancedFormKeyFilter.md) +- [AdvancedGlobalListenerSourceFilter](type-aliases/AdvancedGlobalListenerSourceFilter.md) +- [AdvancedGlobalTaskListenerEventTypeFilter](type-aliases/AdvancedGlobalTaskListenerEventTypeFilter.md) - [AdvancedIncidentErrorTypeFilter](type-aliases/AdvancedIncidentErrorTypeFilter.md) - [AdvancedIncidentStateFilter](type-aliases/AdvancedIncidentStateFilter.md) - [AdvancedIntegerFilter](type-aliases/AdvancedIntegerFilter.md) @@ -262,12 +269,12 @@ mdx: - [BroadcastSignalResponse](type-aliases/BroadcastSignalResponse.md) - [BroadcastSignalResponses](type-aliases/BroadcastSignalResponses.md) - [BrokerInfo](type-aliases/BrokerInfo.md) +- [BusinessId](type-aliases/BusinessId.md) - [CamundaClientLoose](type-aliases/CamundaClientLoose.md) - [CamundaFpClient](type-aliases/CamundaFpClient.md) - [CamundaKey](type-aliases/CamundaKey.md) - [CamundaResultClient](type-aliases/CamundaResultClient.md) - [CamundaUserResult](type-aliases/CamundaUserResult.md) -- [cancelBatchOperationConsistency](type-aliases/cancelBatchOperationConsistency.md) - [CancelBatchOperationData](type-aliases/CancelBatchOperationData.md) - [CancelBatchOperationError](type-aliases/CancelBatchOperationError.md) - [CancelBatchOperationErrors](type-aliases/CancelBatchOperationErrors.md) @@ -281,7 +288,6 @@ mdx: - [CancelProcessInstanceRequest](type-aliases/CancelProcessInstanceRequest.md) - [CancelProcessInstanceResponse](type-aliases/CancelProcessInstanceResponse.md) - [CancelProcessInstanceResponses](type-aliases/CancelProcessInstanceResponses.md) -- [cancelProcessInstancesBatchOperationConsistency](type-aliases/cancelProcessInstancesBatchOperationConsistency.md) - [CancelProcessInstancesBatchOperationData](type-aliases/CancelProcessInstancesBatchOperationData.md) - [CancelProcessInstancesBatchOperationError](type-aliases/CancelProcessInstancesBatchOperationError.md) - [CancelProcessInstancesBatchOperationErrors](type-aliases/CancelProcessInstancesBatchOperationErrors.md) @@ -328,7 +334,6 @@ mdx: - [correlateMessageInput](type-aliases/correlateMessageInput.md) - [CorrelateMessageResponse](type-aliases/CorrelateMessageResponse.md) - [CorrelateMessageResponses](type-aliases/CorrelateMessageResponses.md) -- [createAdminUserConsistency](type-aliases/createAdminUserConsistency.md) - [CreateAdminUserData](type-aliases/CreateAdminUserData.md) - [CreateAdminUserError](type-aliases/CreateAdminUserError.md) - [CreateAdminUserErrors](type-aliases/CreateAdminUserErrors.md) @@ -378,6 +383,13 @@ mdx: - [createGlobalClusterVariableInput](type-aliases/createGlobalClusterVariableInput.md) - [CreateGlobalClusterVariableResponse](type-aliases/CreateGlobalClusterVariableResponse.md) - [CreateGlobalClusterVariableResponses](type-aliases/CreateGlobalClusterVariableResponses.md) +- [CreateGlobalTaskListenerData](type-aliases/CreateGlobalTaskListenerData.md) +- [CreateGlobalTaskListenerError](type-aliases/CreateGlobalTaskListenerError.md) +- [CreateGlobalTaskListenerErrors](type-aliases/CreateGlobalTaskListenerErrors.md) +- [createGlobalTaskListenerInput](type-aliases/createGlobalTaskListenerInput.md) +- [CreateGlobalTaskListenerRequest](type-aliases/CreateGlobalTaskListenerRequest.md) +- [CreateGlobalTaskListenerResponse](type-aliases/CreateGlobalTaskListenerResponse.md) +- [CreateGlobalTaskListenerResponses](type-aliases/CreateGlobalTaskListenerResponses.md) - [CreateGroupData](type-aliases/CreateGroupData.md) - [CreateGroupError](type-aliases/CreateGroupError.md) - [CreateGroupErrors](type-aliases/CreateGroupErrors.md) @@ -415,7 +427,6 @@ mdx: - [createTenantInput](type-aliases/createTenantInput.md) - [CreateTenantResponse](type-aliases/CreateTenantResponse.md) - [CreateTenantResponses](type-aliases/CreateTenantResponses.md) -- [createUserConsistency](type-aliases/createUserConsistency.md) - [CreateUserData](type-aliases/CreateUserData.md) - [CreateUserError](type-aliases/CreateUserError.md) - [CreateUserErrors](type-aliases/CreateUserErrors.md) @@ -469,7 +480,6 @@ mdx: - [deleteAuthorizationInput](type-aliases/deleteAuthorizationInput.md) - [DeleteAuthorizationResponse](type-aliases/DeleteAuthorizationResponse.md) - [DeleteAuthorizationResponses](type-aliases/DeleteAuthorizationResponses.md) -- [deleteDecisionInstanceConsistency](type-aliases/deleteDecisionInstanceConsistency.md) - [DeleteDecisionInstanceData](type-aliases/DeleteDecisionInstanceData.md) - [DeleteDecisionInstanceError](type-aliases/DeleteDecisionInstanceError.md) - [DeleteDecisionInstanceErrors](type-aliases/DeleteDecisionInstanceErrors.md) @@ -477,7 +487,6 @@ mdx: - [DeleteDecisionInstanceRequest](type-aliases/DeleteDecisionInstanceRequest.md) - [DeleteDecisionInstanceResponse](type-aliases/DeleteDecisionInstanceResponse.md) - [DeleteDecisionInstanceResponses](type-aliases/DeleteDecisionInstanceResponses.md) -- [deleteDecisionInstancesBatchOperationConsistency](type-aliases/deleteDecisionInstancesBatchOperationConsistency.md) - [DeleteDecisionInstancesBatchOperationData](type-aliases/DeleteDecisionInstancesBatchOperationData.md) - [DeleteDecisionInstancesBatchOperationError](type-aliases/DeleteDecisionInstancesBatchOperationError.md) - [DeleteDecisionInstancesBatchOperationErrors](type-aliases/DeleteDecisionInstancesBatchOperationErrors.md) @@ -496,6 +505,12 @@ mdx: - [deleteGlobalClusterVariableInput](type-aliases/deleteGlobalClusterVariableInput.md) - [DeleteGlobalClusterVariableResponse](type-aliases/DeleteGlobalClusterVariableResponse.md) - [DeleteGlobalClusterVariableResponses](type-aliases/DeleteGlobalClusterVariableResponses.md) +- [DeleteGlobalTaskListenerData](type-aliases/DeleteGlobalTaskListenerData.md) +- [DeleteGlobalTaskListenerError](type-aliases/DeleteGlobalTaskListenerError.md) +- [DeleteGlobalTaskListenerErrors](type-aliases/DeleteGlobalTaskListenerErrors.md) +- [deleteGlobalTaskListenerInput](type-aliases/deleteGlobalTaskListenerInput.md) +- [DeleteGlobalTaskListenerResponse](type-aliases/DeleteGlobalTaskListenerResponse.md) +- [DeleteGlobalTaskListenerResponses](type-aliases/DeleteGlobalTaskListenerResponses.md) - [DeleteGroupData](type-aliases/DeleteGroupData.md) - [DeleteGroupError](type-aliases/DeleteGroupError.md) - [DeleteGroupErrors](type-aliases/DeleteGroupErrors.md) @@ -508,7 +523,6 @@ mdx: - [deleteMappingRuleInput](type-aliases/deleteMappingRuleInput.md) - [DeleteMappingRuleResponse](type-aliases/DeleteMappingRuleResponse.md) - [DeleteMappingRuleResponses](type-aliases/DeleteMappingRuleResponses.md) -- [deleteProcessInstanceConsistency](type-aliases/deleteProcessInstanceConsistency.md) - [DeleteProcessInstanceData](type-aliases/DeleteProcessInstanceData.md) - [DeleteProcessInstanceError](type-aliases/DeleteProcessInstanceError.md) - [DeleteProcessInstanceErrors](type-aliases/DeleteProcessInstanceErrors.md) @@ -516,7 +530,6 @@ mdx: - [DeleteProcessInstanceRequest](type-aliases/DeleteProcessInstanceRequest.md) - [DeleteProcessInstanceResponse](type-aliases/DeleteProcessInstanceResponse.md) - [DeleteProcessInstanceResponses](type-aliases/DeleteProcessInstanceResponses.md) -- [deleteProcessInstancesBatchOperationConsistency](type-aliases/deleteProcessInstancesBatchOperationConsistency.md) - [DeleteProcessInstancesBatchOperationData](type-aliases/DeleteProcessInstancesBatchOperationData.md) - [DeleteProcessInstancesBatchOperationError](type-aliases/DeleteProcessInstancesBatchOperationError.md) - [DeleteProcessInstancesBatchOperationErrors](type-aliases/DeleteProcessInstancesBatchOperationErrors.md) @@ -549,7 +562,6 @@ mdx: - [deleteTenantInput](type-aliases/deleteTenantInput.md) - [DeleteTenantResponse](type-aliases/DeleteTenantResponse.md) - [DeleteTenantResponses](type-aliases/DeleteTenantResponses.md) -- [deleteUserConsistency](type-aliases/deleteUserConsistency.md) - [DeleteUserData](type-aliases/DeleteUserData.md) - [DeleteUserError](type-aliases/DeleteUserError.md) - [DeleteUserErrors](type-aliases/DeleteUserErrors.md) @@ -573,6 +585,7 @@ mdx: - [DocumentLink](type-aliases/DocumentLink.md) - [DocumentLinkRequest](type-aliases/DocumentLinkRequest.md) - [DocumentMetadata](type-aliases/DocumentMetadata.md) +- [DocumentMetadataResponse](type-aliases/DocumentMetadataResponse.md) - [DocumentReference](type-aliases/DocumentReference.md) - [Either](type-aliases/Either.md) - [ElementId](type-aliases/ElementId.md) @@ -615,6 +628,7 @@ mdx: - [EvaluateExpressionResponses](type-aliases/EvaluateExpressionResponses.md) - [ExpressionEvaluationRequest](type-aliases/ExpressionEvaluationRequest.md) - [ExpressionEvaluationResult](type-aliases/ExpressionEvaluationResult.md) +- [ExpressionEvaluationWarningItem](type-aliases/ExpressionEvaluationWarningItem.md) - [FailJobData](type-aliases/FailJobData.md) - [FailJobError](type-aliases/FailJobError.md) - [FailJobErrors](type-aliases/FailJobErrors.md) @@ -715,6 +729,13 @@ mdx: - [getGlobalJobStatisticsInput](type-aliases/getGlobalJobStatisticsInput.md) - [GetGlobalJobStatisticsResponse](type-aliases/GetGlobalJobStatisticsResponse.md) - [GetGlobalJobStatisticsResponses](type-aliases/GetGlobalJobStatisticsResponses.md) +- [getGlobalTaskListenerConsistency](type-aliases/getGlobalTaskListenerConsistency.md) +- [GetGlobalTaskListenerData](type-aliases/GetGlobalTaskListenerData.md) +- [GetGlobalTaskListenerError](type-aliases/GetGlobalTaskListenerError.md) +- [GetGlobalTaskListenerErrors](type-aliases/GetGlobalTaskListenerErrors.md) +- [getGlobalTaskListenerInput](type-aliases/getGlobalTaskListenerInput.md) +- [GetGlobalTaskListenerResponse](type-aliases/GetGlobalTaskListenerResponse.md) +- [GetGlobalTaskListenerResponses](type-aliases/GetGlobalTaskListenerResponses.md) - [getGroupConsistency](type-aliases/getGroupConsistency.md) - [GetGroupData](type-aliases/GetGroupData.md) - [GetGroupError](type-aliases/GetGroupError.md) @@ -729,6 +750,34 @@ mdx: - [getIncidentInput](type-aliases/getIncidentInput.md) - [GetIncidentResponse](type-aliases/GetIncidentResponse.md) - [GetIncidentResponses](type-aliases/GetIncidentResponses.md) +- [getJobErrorStatisticsConsistency](type-aliases/getJobErrorStatisticsConsistency.md) +- [GetJobErrorStatisticsData](type-aliases/GetJobErrorStatisticsData.md) +- [GetJobErrorStatisticsError](type-aliases/GetJobErrorStatisticsError.md) +- [GetJobErrorStatisticsErrors](type-aliases/GetJobErrorStatisticsErrors.md) +- [getJobErrorStatisticsInput](type-aliases/getJobErrorStatisticsInput.md) +- [GetJobErrorStatisticsResponse](type-aliases/GetJobErrorStatisticsResponse.md) +- [GetJobErrorStatisticsResponses](type-aliases/GetJobErrorStatisticsResponses.md) +- [getJobTimeSeriesStatisticsConsistency](type-aliases/getJobTimeSeriesStatisticsConsistency.md) +- [GetJobTimeSeriesStatisticsData](type-aliases/GetJobTimeSeriesStatisticsData.md) +- [GetJobTimeSeriesStatisticsError](type-aliases/GetJobTimeSeriesStatisticsError.md) +- [GetJobTimeSeriesStatisticsErrors](type-aliases/GetJobTimeSeriesStatisticsErrors.md) +- [getJobTimeSeriesStatisticsInput](type-aliases/getJobTimeSeriesStatisticsInput.md) +- [GetJobTimeSeriesStatisticsResponse](type-aliases/GetJobTimeSeriesStatisticsResponse.md) +- [GetJobTimeSeriesStatisticsResponses](type-aliases/GetJobTimeSeriesStatisticsResponses.md) +- [getJobTypeStatisticsConsistency](type-aliases/getJobTypeStatisticsConsistency.md) +- [GetJobTypeStatisticsData](type-aliases/GetJobTypeStatisticsData.md) +- [GetJobTypeStatisticsError](type-aliases/GetJobTypeStatisticsError.md) +- [GetJobTypeStatisticsErrors](type-aliases/GetJobTypeStatisticsErrors.md) +- [getJobTypeStatisticsInput](type-aliases/getJobTypeStatisticsInput.md) +- [GetJobTypeStatisticsResponse](type-aliases/GetJobTypeStatisticsResponse.md) +- [GetJobTypeStatisticsResponses](type-aliases/GetJobTypeStatisticsResponses.md) +- [getJobWorkerStatisticsConsistency](type-aliases/getJobWorkerStatisticsConsistency.md) +- [GetJobWorkerStatisticsData](type-aliases/GetJobWorkerStatisticsData.md) +- [GetJobWorkerStatisticsError](type-aliases/GetJobWorkerStatisticsError.md) +- [GetJobWorkerStatisticsErrors](type-aliases/GetJobWorkerStatisticsErrors.md) +- [getJobWorkerStatisticsInput](type-aliases/getJobWorkerStatisticsInput.md) +- [GetJobWorkerStatisticsResponse](type-aliases/GetJobWorkerStatisticsResponse.md) +- [GetJobWorkerStatisticsResponses](type-aliases/GetJobWorkerStatisticsResponses.md) - [GetLicenseData](type-aliases/GetLicenseData.md) - [GetLicenseError](type-aliases/GetLicenseError.md) - [GetLicenseErrors](type-aliases/GetLicenseErrors.md) @@ -857,6 +906,12 @@ mdx: - [getStatusInput](type-aliases/getStatusInput.md) - [GetStatusResponse](type-aliases/GetStatusResponse.md) - [GetStatusResponses](type-aliases/GetStatusResponses.md) +- [GetSystemConfigurationData](type-aliases/GetSystemConfigurationData.md) +- [GetSystemConfigurationError](type-aliases/GetSystemConfigurationError.md) +- [GetSystemConfigurationErrors](type-aliases/GetSystemConfigurationErrors.md) +- [getSystemConfigurationInput](type-aliases/getSystemConfigurationInput.md) +- [GetSystemConfigurationResponse](type-aliases/GetSystemConfigurationResponse.md) +- [GetSystemConfigurationResponses](type-aliases/GetSystemConfigurationResponses.md) - [getTenantClusterVariableConsistency](type-aliases/getTenantClusterVariableConsistency.md) - [GetTenantClusterVariableData](type-aliases/GetTenantClusterVariableData.md) - [GetTenantClusterVariableError](type-aliases/GetTenantClusterVariableError.md) @@ -913,6 +968,21 @@ mdx: - [GetVariableResponse](type-aliases/GetVariableResponse.md) - [GetVariableResponses](type-aliases/GetVariableResponses.md) - [GlobalJobStatisticsQueryResult](type-aliases/GlobalJobStatisticsQueryResult.md) +- [GlobalListenerBase](type-aliases/GlobalListenerBase.md) +- [GlobalListenerId](type-aliases/GlobalListenerId.md) +- [GlobalListenerSourceEnum](type-aliases/GlobalListenerSourceEnum.md) +- [GlobalListenerSourceExactMatch](type-aliases/GlobalListenerSourceExactMatch.md) +- [GlobalListenerSourceFilterProperty](type-aliases/GlobalListenerSourceFilterProperty.md) +- [GlobalTaskListenerBase](type-aliases/GlobalTaskListenerBase.md) +- [GlobalTaskListenerEventTypeEnum](type-aliases/GlobalTaskListenerEventTypeEnum.md) +- [GlobalTaskListenerEventTypeExactMatch](type-aliases/GlobalTaskListenerEventTypeExactMatch.md) +- [GlobalTaskListenerEventTypeFilterProperty](type-aliases/GlobalTaskListenerEventTypeFilterProperty.md) +- [GlobalTaskListenerEventTypes](type-aliases/GlobalTaskListenerEventTypes.md) +- [GlobalTaskListenerResult](type-aliases/GlobalTaskListenerResult.md) +- [GlobalTaskListenerSearchQueryFilterRequest](type-aliases/GlobalTaskListenerSearchQueryFilterRequest.md) +- [GlobalTaskListenerSearchQueryRequest](type-aliases/GlobalTaskListenerSearchQueryRequest.md) +- [GlobalTaskListenerSearchQueryResult](type-aliases/GlobalTaskListenerSearchQueryResult.md) +- [GlobalTaskListenerSearchQuerySortRequest](type-aliases/GlobalTaskListenerSearchQuerySortRequest.md) - [GroupClientResult](type-aliases/GroupClientResult.md) - [GroupClientSearchQueryRequest](type-aliases/GroupClientSearchQueryRequest.md) - [GroupClientSearchQuerySortRequest](type-aliases/GroupClientSearchQuerySortRequest.md) @@ -920,7 +990,9 @@ mdx: - [GroupCreateRequest](type-aliases/GroupCreateRequest.md) - [GroupCreateResult](type-aliases/GroupCreateResult.md) - [GroupFilter](type-aliases/GroupFilter.md) +- [GroupMappingRuleSearchResult](type-aliases/GroupMappingRuleSearchResult.md) - [GroupResult](type-aliases/GroupResult.md) +- [GroupRoleSearchResult](type-aliases/GroupRoleSearchResult.md) - [GroupSearchQueryRequest](type-aliases/GroupSearchQueryRequest.md) - [GroupSearchQueryResult](type-aliases/GroupSearchQueryResult.md) - [GroupSearchQuerySortRequest](type-aliases/GroupSearchQuerySortRequest.md) @@ -962,6 +1034,10 @@ mdx: - [JobChangeset](type-aliases/JobChangeset.md) - [JobCompletionRequest](type-aliases/JobCompletionRequest.md) - [JobErrorRequest](type-aliases/JobErrorRequest.md) +- [JobErrorStatisticsFilter](type-aliases/JobErrorStatisticsFilter.md) +- [JobErrorStatisticsItem](type-aliases/JobErrorStatisticsItem.md) +- [JobErrorStatisticsQuery](type-aliases/JobErrorStatisticsQuery.md) +- [JobErrorStatisticsQueryResult](type-aliases/JobErrorStatisticsQueryResult.md) - [JobFailRequest](type-aliases/JobFailRequest.md) - [JobFilter](type-aliases/JobFilter.md) - [JobKey](type-aliases/JobKey.md) @@ -973,6 +1049,7 @@ mdx: - [JobListenerEventTypeEnum](type-aliases/JobListenerEventTypeEnum.md) - [JobListenerEventTypeExactMatch](type-aliases/JobListenerEventTypeExactMatch.md) - [JobListenerEventTypeFilterProperty](type-aliases/JobListenerEventTypeFilterProperty.md) +- [JobMetricsConfigurationResponse](type-aliases/JobMetricsConfigurationResponse.md) - [JobResult](type-aliases/JobResult.md) - [JobResultActivateElement](type-aliases/JobResultActivateElement.md) - [JobResultAdHocSubProcess](type-aliases/JobResultAdHocSubProcess.md) @@ -985,7 +1062,19 @@ mdx: - [JobStateEnum](type-aliases/JobStateEnum.md) - [JobStateExactMatch](type-aliases/JobStateExactMatch.md) - [JobStateFilterProperty](type-aliases/JobStateFilterProperty.md) +- [JobTimeSeriesStatisticsFilter](type-aliases/JobTimeSeriesStatisticsFilter.md) +- [JobTimeSeriesStatisticsItem](type-aliases/JobTimeSeriesStatisticsItem.md) +- [JobTimeSeriesStatisticsQuery](type-aliases/JobTimeSeriesStatisticsQuery.md) +- [JobTimeSeriesStatisticsQueryResult](type-aliases/JobTimeSeriesStatisticsQueryResult.md) +- [JobTypeStatisticsFilter](type-aliases/JobTypeStatisticsFilter.md) +- [JobTypeStatisticsItem](type-aliases/JobTypeStatisticsItem.md) +- [JobTypeStatisticsQuery](type-aliases/JobTypeStatisticsQuery.md) +- [JobTypeStatisticsQueryResult](type-aliases/JobTypeStatisticsQueryResult.md) - [JobUpdateRequest](type-aliases/JobUpdateRequest.md) +- [JobWorkerStatisticsFilter](type-aliases/JobWorkerStatisticsFilter.md) +- [JobWorkerStatisticsItem](type-aliases/JobWorkerStatisticsItem.md) +- [JobWorkerStatisticsQuery](type-aliases/JobWorkerStatisticsQuery.md) +- [JobWorkerStatisticsQueryResult](type-aliases/JobWorkerStatisticsQueryResult.md) - [LicenseResponse](type-aliases/LicenseResponse.md) - [LikeFilter](type-aliases/LikeFilter.md) - [LimitPagination](type-aliases/LimitPagination.md) @@ -1026,7 +1115,6 @@ mdx: - [MigrateProcessInstanceMappingInstruction](type-aliases/MigrateProcessInstanceMappingInstruction.md) - [MigrateProcessInstanceResponse](type-aliases/MigrateProcessInstanceResponse.md) - [MigrateProcessInstanceResponses](type-aliases/MigrateProcessInstanceResponses.md) -- [migrateProcessInstancesBatchOperationConsistency](type-aliases/migrateProcessInstancesBatchOperationConsistency.md) - [MigrateProcessInstancesBatchOperationData](type-aliases/MigrateProcessInstancesBatchOperationData.md) - [MigrateProcessInstancesBatchOperationError](type-aliases/MigrateProcessInstancesBatchOperationError.md) - [MigrateProcessInstancesBatchOperationErrors](type-aliases/MigrateProcessInstancesBatchOperationErrors.md) @@ -1039,7 +1127,6 @@ mdx: - [modifyProcessInstanceInput](type-aliases/modifyProcessInstanceInput.md) - [ModifyProcessInstanceResponse](type-aliases/ModifyProcessInstanceResponse.md) - [ModifyProcessInstanceResponses](type-aliases/ModifyProcessInstanceResponses.md) -- [modifyProcessInstancesBatchOperationConsistency](type-aliases/modifyProcessInstancesBatchOperationConsistency.md) - [ModifyProcessInstancesBatchOperationData](type-aliases/ModifyProcessInstancesBatchOperationData.md) - [ModifyProcessInstancesBatchOperationError](type-aliases/ModifyProcessInstancesBatchOperationError.md) - [ModifyProcessInstancesBatchOperationErrors](type-aliases/ModifyProcessInstancesBatchOperationErrors.md) @@ -1141,14 +1228,12 @@ mdx: - [resolveIncidentInput](type-aliases/resolveIncidentInput.md) - [ResolveIncidentResponse](type-aliases/ResolveIncidentResponse.md) - [ResolveIncidentResponses](type-aliases/ResolveIncidentResponses.md) -- [resolveIncidentsBatchOperationConsistency](type-aliases/resolveIncidentsBatchOperationConsistency.md) - [ResolveIncidentsBatchOperationData](type-aliases/ResolveIncidentsBatchOperationData.md) - [ResolveIncidentsBatchOperationError](type-aliases/ResolveIncidentsBatchOperationError.md) - [ResolveIncidentsBatchOperationErrors](type-aliases/ResolveIncidentsBatchOperationErrors.md) - [resolveIncidentsBatchOperationInput](type-aliases/resolveIncidentsBatchOperationInput.md) - [ResolveIncidentsBatchOperationResponse](type-aliases/ResolveIncidentsBatchOperationResponse.md) - [ResolveIncidentsBatchOperationResponses](type-aliases/ResolveIncidentsBatchOperationResponses.md) -- [resolveProcessInstanceIncidentsConsistency](type-aliases/resolveProcessInstanceIncidentsConsistency.md) - [ResolveProcessInstanceIncidentsData](type-aliases/ResolveProcessInstanceIncidentsData.md) - [ResolveProcessInstanceIncidentsError](type-aliases/ResolveProcessInstanceIncidentsError.md) - [ResolveProcessInstanceIncidentsErrors](type-aliases/ResolveProcessInstanceIncidentsErrors.md) @@ -1161,7 +1246,6 @@ mdx: - [ResourceResult](type-aliases/ResourceResult.md) - [ResourceTypeEnum](type-aliases/ResourceTypeEnum.md) - [Result](type-aliases/Result.md) -- [resumeBatchOperationConsistency](type-aliases/resumeBatchOperationConsistency.md) - [ResumeBatchOperationData](type-aliases/ResumeBatchOperationData.md) - [ResumeBatchOperationError](type-aliases/ResumeBatchOperationError.md) - [ResumeBatchOperationErrors](type-aliases/ResumeBatchOperationErrors.md) @@ -1179,6 +1263,7 @@ mdx: - [RoleGroupSearchQueryRequest](type-aliases/RoleGroupSearchQueryRequest.md) - [RoleGroupSearchQuerySortRequest](type-aliases/RoleGroupSearchQuerySortRequest.md) - [RoleGroupSearchResult](type-aliases/RoleGroupSearchResult.md) +- [RoleMappingRuleSearchResult](type-aliases/RoleMappingRuleSearchResult.md) - [RoleResult](type-aliases/RoleResult.md) - [RoleSearchQueryRequest](type-aliases/RoleSearchQueryRequest.md) - [RoleSearchQueryResult](type-aliases/RoleSearchQueryResult.md) @@ -1189,10 +1274,10 @@ mdx: - [RoleUserSearchQueryRequest](type-aliases/RoleUserSearchQueryRequest.md) - [RoleUserSearchQuerySortRequest](type-aliases/RoleUserSearchQuerySortRequest.md) - [RoleUserSearchResult](type-aliases/RoleUserSearchResult.md) -- [RootProcessInstanceKey](type-aliases/RootProcessInstanceKey.md) - [ScopeKey](type-aliases/ScopeKey.md) - [ScopeKeyExactMatch](type-aliases/ScopeKeyExactMatch.md) - [ScopeKeyFilterProperty](type-aliases/ScopeKeyFilterProperty.md) +- [SdkError](type-aliases/SdkError.md) - [searchAuditLogsConsistency](type-aliases/searchAuditLogsConsistency.md) - [SearchAuditLogsData](type-aliases/SearchAuditLogsData.md) - [SearchAuditLogsError](type-aliases/SearchAuditLogsError.md) @@ -1289,6 +1374,13 @@ mdx: - [searchElementInstancesInput](type-aliases/searchElementInstancesInput.md) - [SearchElementInstancesResponse](type-aliases/SearchElementInstancesResponse.md) - [SearchElementInstancesResponses](type-aliases/SearchElementInstancesResponses.md) +- [searchGlobalTaskListenersConsistency](type-aliases/searchGlobalTaskListenersConsistency.md) +- [SearchGlobalTaskListenersData](type-aliases/SearchGlobalTaskListenersData.md) +- [SearchGlobalTaskListenersError](type-aliases/SearchGlobalTaskListenersError.md) +- [SearchGlobalTaskListenersErrors](type-aliases/SearchGlobalTaskListenersErrors.md) +- [searchGlobalTaskListenersInput](type-aliases/searchGlobalTaskListenersInput.md) +- [SearchGlobalTaskListenersResponse](type-aliases/SearchGlobalTaskListenersResponse.md) +- [SearchGlobalTaskListenersResponses](type-aliases/SearchGlobalTaskListenersResponses.md) - [searchGroupIdsForTenantConsistency](type-aliases/searchGroupIdsForTenantConsistency.md) - [SearchGroupIdsForTenantData](type-aliases/SearchGroupIdsForTenantData.md) - [searchGroupIdsForTenantInput](type-aliases/searchGroupIdsForTenantInput.md) @@ -1439,6 +1531,13 @@ mdx: - [searchUserTaskAuditLogsInput](type-aliases/searchUserTaskAuditLogsInput.md) - [SearchUserTaskAuditLogsResponse](type-aliases/SearchUserTaskAuditLogsResponse.md) - [SearchUserTaskAuditLogsResponses](type-aliases/SearchUserTaskAuditLogsResponses.md) +- [searchUserTaskEffectiveVariablesConsistency](type-aliases/searchUserTaskEffectiveVariablesConsistency.md) +- [SearchUserTaskEffectiveVariablesData](type-aliases/SearchUserTaskEffectiveVariablesData.md) +- [SearchUserTaskEffectiveVariablesError](type-aliases/SearchUserTaskEffectiveVariablesError.md) +- [SearchUserTaskEffectiveVariablesErrors](type-aliases/SearchUserTaskEffectiveVariablesErrors.md) +- [searchUserTaskEffectiveVariablesInput](type-aliases/searchUserTaskEffectiveVariablesInput.md) +- [SearchUserTaskEffectiveVariablesResponse](type-aliases/SearchUserTaskEffectiveVariablesResponse.md) +- [SearchUserTaskEffectiveVariablesResponses](type-aliases/SearchUserTaskEffectiveVariablesResponses.md) - [searchUserTasksConsistency](type-aliases/searchUserTasksConsistency.md) - [SearchUserTasksData](type-aliases/SearchUserTasksData.md) - [SearchUserTasksError](type-aliases/SearchUserTasksError.md) @@ -1471,13 +1570,13 @@ mdx: - [StartCursor](type-aliases/StartCursor.md) - [StatusMetric](type-aliases/StatusMetric.md) - [StringFilterProperty](type-aliases/StringFilterProperty.md) -- [suspendBatchOperationConsistency](type-aliases/suspendBatchOperationConsistency.md) - [SuspendBatchOperationData](type-aliases/SuspendBatchOperationData.md) - [SuspendBatchOperationError](type-aliases/SuspendBatchOperationError.md) - [SuspendBatchOperationErrors](type-aliases/SuspendBatchOperationErrors.md) - [suspendBatchOperationInput](type-aliases/suspendBatchOperationInput.md) - [SuspendBatchOperationResponse](type-aliases/SuspendBatchOperationResponse.md) - [SuspendBatchOperationResponses](type-aliases/SuspendBatchOperationResponses.md) +- [SystemConfigurationResponse](type-aliases/SystemConfigurationResponse.md) - [Tag](type-aliases/Tag.md) - [TagSet](type-aliases/TagSet.md) - [TenantClientResult](type-aliases/TenantClientResult.md) @@ -1493,7 +1592,9 @@ mdx: - [TenantGroupSearchQuerySortRequest](type-aliases/TenantGroupSearchQuerySortRequest.md) - [TenantGroupSearchResult](type-aliases/TenantGroupSearchResult.md) - [TenantId](type-aliases/TenantId.md) +- [TenantMappingRuleSearchResult](type-aliases/TenantMappingRuleSearchResult.md) - [TenantResult](type-aliases/TenantResult.md) +- [TenantRoleSearchResult](type-aliases/TenantRoleSearchResult.md) - [TenantSearchQueryRequest](type-aliases/TenantSearchQueryRequest.md) - [TenantSearchQueryResult](type-aliases/TenantSearchQueryResult.md) - [TenantSearchQuerySortRequest](type-aliases/TenantSearchQuerySortRequest.md) @@ -1503,6 +1604,8 @@ mdx: - [TenantUserSearchQueryRequest](type-aliases/TenantUserSearchQueryRequest.md) - [TenantUserSearchQuerySortRequest](type-aliases/TenantUserSearchQuerySortRequest.md) - [TenantUserSearchResult](type-aliases/TenantUserSearchResult.md) +- [ThreadedJob](type-aliases/ThreadedJob.md) +- [ThreadedJobHandler](type-aliases/ThreadedJobHandler.md) - [ThrowJobErrorData](type-aliases/ThrowJobErrorData.md) - [ThrowJobErrorError](type-aliases/ThrowJobErrorError.md) - [ThrowJobErrorErrors](type-aliases/ThrowJobErrorErrors.md) @@ -1601,6 +1704,13 @@ mdx: - [updateGlobalClusterVariableInput](type-aliases/updateGlobalClusterVariableInput.md) - [UpdateGlobalClusterVariableResponse](type-aliases/UpdateGlobalClusterVariableResponse.md) - [UpdateGlobalClusterVariableResponses](type-aliases/UpdateGlobalClusterVariableResponses.md) +- [UpdateGlobalTaskListenerData](type-aliases/UpdateGlobalTaskListenerData.md) +- [UpdateGlobalTaskListenerError](type-aliases/UpdateGlobalTaskListenerError.md) +- [UpdateGlobalTaskListenerErrors](type-aliases/UpdateGlobalTaskListenerErrors.md) +- [updateGlobalTaskListenerInput](type-aliases/updateGlobalTaskListenerInput.md) +- [UpdateGlobalTaskListenerRequest](type-aliases/UpdateGlobalTaskListenerRequest.md) +- [UpdateGlobalTaskListenerResponse](type-aliases/UpdateGlobalTaskListenerResponse.md) +- [UpdateGlobalTaskListenerResponses](type-aliases/UpdateGlobalTaskListenerResponses.md) - [UpdateGroupData](type-aliases/UpdateGroupData.md) - [UpdateGroupError](type-aliases/UpdateGroupError.md) - [UpdateGroupErrors](type-aliases/UpdateGroupErrors.md) @@ -1637,7 +1747,6 @@ mdx: - [updateTenantInput](type-aliases/updateTenantInput.md) - [UpdateTenantResponse](type-aliases/UpdateTenantResponse.md) - [UpdateTenantResponses](type-aliases/UpdateTenantResponses.md) -- [updateUserConsistency](type-aliases/updateUserConsistency.md) - [UpdateUserData](type-aliases/UpdateUserData.md) - [UpdateUserError](type-aliases/UpdateUserError.md) - [UpdateUserErrors](type-aliases/UpdateUserErrors.md) @@ -1664,6 +1773,7 @@ mdx: - [UserTaskAuditLogFilter](type-aliases/UserTaskAuditLogFilter.md) - [UserTaskAuditLogSearchQueryRequest](type-aliases/UserTaskAuditLogSearchQueryRequest.md) - [UserTaskCompletionRequest](type-aliases/UserTaskCompletionRequest.md) +- [UserTaskEffectiveVariableSearchQueryRequest](type-aliases/UserTaskEffectiveVariableSearchQueryRequest.md) - [UserTaskFilter](type-aliases/UserTaskFilter.md) - [UserTaskKey](type-aliases/UserTaskKey.md) - [UserTaskProperties](type-aliases/UserTaskProperties.md) @@ -1705,6 +1815,7 @@ mdx: - [isLeft](functions/isLeft.md) - [isOk](functions/isOk.md) - [isRight](functions/isRight.md) +- [isSdkError](functions/isSdkError.md) ## References diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/CamundaConfig.md b/docs/apis-tools/typescript/api-reference/index/interfaces/CamundaConfig.md index adfd17c4b0c..8a32a4863a4 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/CamundaConfig.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/CamundaConfig.md @@ -7,7 +7,7 @@ mdx: # Interface: CamundaConfig -Defined in: [runtime/unifiedConfiguration.ts:66](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L66) +Defined in: [runtime/unifiedConfiguration.ts:66](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L66) ## Properties @@ -17,7 +17,7 @@ Defined in: [runtime/unifiedConfiguration.ts:66](https://github.com/camunda/orch __raw: Record; ``` -Defined in: [runtime/unifiedConfiguration.ts:118](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L118) +Defined in: [runtime/unifiedConfiguration.ts:121](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L121) --- @@ -27,7 +27,7 @@ Defined in: [runtime/unifiedConfiguration.ts:118](https://github.com/camunda/orc auth: object; ``` -Defined in: [runtime/unifiedConfiguration.ts:94](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L94) +Defined in: [runtime/unifiedConfiguration.ts:97](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L97) #### basic? @@ -61,7 +61,7 @@ strategy: AuthStrategy; backpressure: object; ``` -Defined in: [runtime/unifiedConfiguration.ts:71](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L71) +Defined in: [runtime/unifiedConfiguration.ts:71](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L71) #### decayQuietMs @@ -81,12 +81,24 @@ enabled: boolean; floor: number; ``` +#### healthyRecoveryMultiplier + +```ts +healthyRecoveryMultiplier: number; +``` + #### initialMax ```ts initialMax: number; ``` +#### maxWaiters + +```ts +maxWaiters: number; +``` + #### observeOnly ```ts @@ -129,6 +141,12 @@ severeThreshold: number; softFactor: number; ``` +#### unlimitedAfterHealthyMs + +```ts +unlimitedAfterHealthyMs: number; +``` + --- ### defaultTenantId @@ -137,7 +155,7 @@ softFactor: number; defaultTenantId: string; ``` -Defined in: [runtime/unifiedConfiguration.ts:69](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L69) +Defined in: [runtime/unifiedConfiguration.ts:69](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L69) --- @@ -147,7 +165,7 @@ Defined in: [runtime/unifiedConfiguration.ts:69](https://github.com/camunda/orch optional eventual: object; ``` -Defined in: [runtime/unifiedConfiguration.ts:104](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L104) +Defined in: [runtime/unifiedConfiguration.ts:107](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L107) #### pollDefaultMs @@ -163,7 +181,7 @@ pollDefaultMs: number; httpRetry: object; ``` -Defined in: [runtime/unifiedConfiguration.ts:70](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L70) +Defined in: [runtime/unifiedConfiguration.ts:70](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L70) #### baseDelayMs @@ -191,7 +209,7 @@ maxDelayMs: number; logLevel: "trace" | "error" | "silent" | "warn" | "info" | "debug"; ``` -Defined in: [runtime/unifiedConfiguration.ts:103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L103) +Defined in: [runtime/unifiedConfiguration.ts:106](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L106) --- @@ -201,7 +219,7 @@ Defined in: [runtime/unifiedConfiguration.ts:103](https://github.com/camunda/orc optional mtls: object; ``` -Defined in: [runtime/unifiedConfiguration.ts:106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L106) +Defined in: [runtime/unifiedConfiguration.ts:109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L109) #### ca? @@ -253,7 +271,7 @@ optional keyPath: string; oauth: object; ``` -Defined in: [runtime/unifiedConfiguration.ts:84](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L84) +Defined in: [runtime/unifiedConfiguration.ts:87](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L87) #### cacheDir? @@ -323,7 +341,7 @@ timeoutMs: number; restAddress: string; ``` -Defined in: [runtime/unifiedConfiguration.ts:67](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L67) +Defined in: [runtime/unifiedConfiguration.ts:67](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L67) --- @@ -333,7 +351,7 @@ Defined in: [runtime/unifiedConfiguration.ts:67](https://github.com/camunda/orch optional supportLog: object; ``` -Defined in: [runtime/unifiedConfiguration.ts:116](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L116) +Defined in: [runtime/unifiedConfiguration.ts:119](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L119) #### enabled @@ -355,7 +373,7 @@ filePath: string; optional telemetry: object; ``` -Defined in: [runtime/unifiedConfiguration.ts:115](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L115) +Defined in: [runtime/unifiedConfiguration.ts:118](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L118) #### correlation @@ -377,7 +395,7 @@ log: boolean; tokenAudience: string; ``` -Defined in: [runtime/unifiedConfiguration.ts:68](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L68) +Defined in: [runtime/unifiedConfiguration.ts:68](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L68) --- @@ -387,7 +405,7 @@ Defined in: [runtime/unifiedConfiguration.ts:68](https://github.com/camunda/orch validation: object; ``` -Defined in: [runtime/unifiedConfiguration.ts:98](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L98) +Defined in: [runtime/unifiedConfiguration.ts:101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L101) #### raw diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/CamundaOptions.md b/docs/apis-tools/typescript/api-reference/index/interfaces/CamundaOptions.md index 22d6ffcd7ab..9059bd8b1b6 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/CamundaOptions.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/CamundaOptions.md @@ -7,7 +7,7 @@ mdx: # Interface: CamundaOptions -Defined in: [gen/CamundaClient.ts:1160](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1160) +Defined in: [gen/CamundaClient.ts:1157](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1157) ## Properties @@ -38,13 +38,16 @@ optional config: Partial<{ CAMUNDA_REST_ADDRESS: string; CAMUNDA_SDK_BACKPRESSURE_DECAY_QUIET_MS: number; CAMUNDA_SDK_BACKPRESSURE_FLOOR: number; + CAMUNDA_SDK_BACKPRESSURE_HEALTHY_RECOVERY_MULTIPLIER: number; CAMUNDA_SDK_BACKPRESSURE_INITIAL_MAX: number; + CAMUNDA_SDK_BACKPRESSURE_MAX_WAITERS: number; CAMUNDA_SDK_BACKPRESSURE_PROFILE: "BALANCED" | "CONSERVATIVE" | "AGGRESSIVE" | "LEGACY"; CAMUNDA_SDK_BACKPRESSURE_RECOVERY_INTERVAL_MS: number; CAMUNDA_SDK_BACKPRESSURE_RECOVERY_STEP: number; CAMUNDA_SDK_BACKPRESSURE_SEVERE_FACTOR: number; CAMUNDA_SDK_BACKPRESSURE_SEVERE_THRESHOLD: number; CAMUNDA_SDK_BACKPRESSURE_SOFT_FACTOR: number; + CAMUNDA_SDK_BACKPRESSURE_UNLIMITED_AFTER_HEALTHY_MS: number; CAMUNDA_SDK_EVENTUAL_POLL_DEFAULT_MS: number; CAMUNDA_SDK_HTTP_RETRY_BASE_DELAY_MS: number; CAMUNDA_SDK_HTTP_RETRY_MAX_ATTEMPTS: number; @@ -60,7 +63,7 @@ optional config: Partial<{ }>; ``` -Defined in: [gen/CamundaClient.ts:1162](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1162) +Defined in: [gen/CamundaClient.ts:1159](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1159) --- @@ -70,7 +73,7 @@ Defined in: [gen/CamundaClient.ts:1162](https://github.com/camunda/orchestration optional env: Record; ``` -Defined in: [gen/CamundaClient.ts:1166](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1166) +Defined in: [gen/CamundaClient.ts:1163](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1163) --- @@ -80,7 +83,7 @@ Defined in: [gen/CamundaClient.ts:1166](https://github.com/camunda/orchestration optional fetch: (input, init?) => Promise; ``` -Defined in: [gen/CamundaClient.ts:1164](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1164) +Defined in: [gen/CamundaClient.ts:1161](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1161) #### Parameters @@ -104,7 +107,7 @@ Defined in: [gen/CamundaClient.ts:1164](https://github.com/camunda/orchestration optional log: object; ``` -Defined in: [gen/CamundaClient.ts:1168](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1168) +Defined in: [gen/CamundaClient.ts:1165](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1165) #### level? @@ -126,7 +129,7 @@ optional transport: LogTransport; optional supportLogger: SupportLogger; ``` -Defined in: [gen/CamundaClient.ts:1179](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1179) +Defined in: [gen/CamundaClient.ts:1176](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1176) --- @@ -136,7 +139,7 @@ Defined in: [gen/CamundaClient.ts:1179](https://github.com/camunda/orchestration optional telemetry: object; ``` -Defined in: [gen/CamundaClient.ts:1170](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1170) +Defined in: [gen/CamundaClient.ts:1167](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1167) #### correlation? @@ -164,4 +167,4 @@ optional mirrorToLog: boolean; optional throwOnError: boolean; ``` -Defined in: [gen/CamundaClient.ts:1177](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1177) +Defined in: [gen/CamundaClient.ts:1174](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1174) diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/CancelablePromise.md b/docs/apis-tools/typescript/api-reference/index/interfaces/CancelablePromise.md index 85476bd5c87..bf78f22146b 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/CancelablePromise.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/CancelablePromise.md @@ -7,7 +7,7 @@ mdx: # Interface: CancelablePromise\ -Defined in: [gen/CamundaClient.ts:1117](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1117) +Defined in: [gen/CamundaClient.ts:1114](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1114) ## Extends @@ -27,7 +27,7 @@ Defined in: [gen/CamundaClient.ts:1117](https://github.com/camunda/orchestration cancel(): void; ``` -Defined in: [gen/CamundaClient.ts:1118](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1118) +Defined in: [gen/CamundaClient.ts:1115](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1115) #### Returns diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/CreateLoggerOptions.md b/docs/apis-tools/typescript/api-reference/index/interfaces/CreateLoggerOptions.md index e603cb1780c..c4635e9d61a 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/CreateLoggerOptions.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/CreateLoggerOptions.md @@ -7,7 +7,7 @@ mdx: # Interface: CreateLoggerOptions -Defined in: [runtime/logger.ts:38](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L38) +Defined in: [runtime/logger.ts:38](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L38) ## Properties @@ -17,7 +17,7 @@ Defined in: [runtime/logger.ts:38](https://github.com/camunda/orchestration-clus optional level: LogLevel; ``` -Defined in: [runtime/logger.ts:39](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L39) +Defined in: [runtime/logger.ts:39](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L39) --- @@ -27,7 +27,7 @@ Defined in: [runtime/logger.ts:39](https://github.com/camunda/orchestration-clus optional scope: string; ``` -Defined in: [runtime/logger.ts:41](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L41) +Defined in: [runtime/logger.ts:41](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L41) --- @@ -37,4 +37,4 @@ Defined in: [runtime/logger.ts:41](https://github.com/camunda/orchestration-clus optional transport: LogTransport; ``` -Defined in: [runtime/logger.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L40) +Defined in: [runtime/logger.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L40) diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/EnrichedActivatedJob.md b/docs/apis-tools/typescript/api-reference/index/interfaces/EnrichedActivatedJob.md index 04b626d6c28..4f714707439 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/EnrichedActivatedJob.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/EnrichedActivatedJob.md @@ -7,7 +7,7 @@ mdx: # Interface: EnrichedActivatedJob -Defined in: [runtime/jobActions.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L10) +Defined in: [runtime/jobActions.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L10) Enriched job type with convenience methods. @@ -23,7 +23,7 @@ Enriched job type with convenience methods. optional acknowledged: boolean; ``` -Defined in: [runtime/jobActions.ts:23](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L23) +Defined in: [runtime/jobActions.ts:23](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L23) Set true once any acknowledgement method is invoked. @@ -35,7 +35,7 @@ Set true once any acknowledgement method is invoked. customHeaders: object; ``` -Defined in: [gen/types.gen.ts:11720](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11720) +Defined in: [gen/types.gen.ts:4028](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4028) A set of custom headers defined during modelling; returned as a serialized JSON document. @@ -59,7 +59,7 @@ ActivatedJobResult.customHeaders; deadline: number; ``` -Defined in: [gen/types.gen.ts:11734](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11734) +Defined in: [gen/types.gen.ts:4042](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4042) When the job can be activated again, sent as a UNIX epoch timestamp. @@ -77,7 +77,7 @@ ActivatedJobResult.deadline; elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:11716](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11716) +Defined in: [gen/types.gen.ts:4024](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4024) The associated task element ID. @@ -95,7 +95,9 @@ ActivatedJobResult.elementId; elementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:11757](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11757) +Defined in: [gen/types.gen.ts:4068](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4068) + +The element instance key of the task. #### Inherited from @@ -111,7 +113,7 @@ ActivatedJobResult.elementInstanceKey; jobKey: JobKey; ``` -Defined in: [gen/types.gen.ts:11748](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11748) +Defined in: [gen/types.gen.ts:4056](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4056) The key, a unique identifier for the job. @@ -129,7 +131,7 @@ ActivatedJobResult.jobKey; kind: JobKindEnum; ``` -Defined in: [gen/types.gen.ts:11758](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11758) +Defined in: [gen/types.gen.ts:4069](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4069) #### Inherited from @@ -145,7 +147,7 @@ ActivatedJobResult.kind; listenerEventType: JobListenerEventTypeEnum; ``` -Defined in: [gen/types.gen.ts:11759](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11759) +Defined in: [gen/types.gen.ts:4070](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4070) #### Inherited from @@ -161,7 +163,7 @@ ActivatedJobResult.listenerEventType; log: Logger; ``` -Defined in: [runtime/jobActions.ts:21](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L21) +Defined in: [runtime/jobActions.ts:21](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L21) --- @@ -171,7 +173,7 @@ Defined in: [runtime/jobActions.ts:21](https://github.com/camunda/orchestration- modifyJobTimeout: (__namedParameters) => Promise; ``` -Defined in: [runtime/jobActions.ts:19](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L19) +Defined in: [runtime/jobActions.ts:19](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L19) Extend the timeout for the job by setting a new timeout @@ -195,7 +197,7 @@ Extend the timeout for the job by setting a new timeout modifyRetries: (__namedParameters) => Promise; ``` -Defined in: [runtime/jobActions.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L20) +Defined in: [runtime/jobActions.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L20) #### Parameters @@ -217,7 +219,7 @@ Defined in: [runtime/jobActions.ts:20](https://github.com/camunda/orchestration- processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:11708](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11708) +Defined in: [gen/types.gen.ts:4016](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4016) The bpmn process ID of the job's process definition. @@ -235,7 +237,7 @@ ActivatedJobResult.processDefinitionId; processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:11756](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11756) +Defined in: [gen/types.gen.ts:4064](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4064) The key of the job's process definition. @@ -253,7 +255,7 @@ ActivatedJobResult.processDefinitionKey; processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:11712](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11712) +Defined in: [gen/types.gen.ts:4020](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4020) The version of the job's process definition. @@ -271,7 +273,7 @@ ActivatedJobResult.processDefinitionVersion; processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:11752](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11752) +Defined in: [gen/types.gen.ts:4060](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4060) The job's process instance key. @@ -289,7 +291,7 @@ ActivatedJobResult.processInstanceKey; retries: number; ``` -Defined in: [gen/types.gen.ts:11730](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11730) +Defined in: [gen/types.gen.ts:4038](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4038) The amount of retries left to this job (should always be positive). @@ -301,147 +303,88 @@ ActivatedJobResult.retries; --- -### tags? +### rootProcessInstanceKey ```ts -optional tags: TagSet; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:11805](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11805) +Defined in: [gen/types.gen.ts:4084](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4084) + +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. #### Inherited from ```ts -ActivatedJobResult.tags; +ActivatedJobResult.rootProcessInstanceKey; ``` --- -### tenantId +### tags ```ts -tenantId: TenantId; +tags: TagSet; ``` -Defined in: [gen/types.gen.ts:11744](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11744) - -The ID of the tenant that owns the job. +Defined in: [gen/types.gen.ts:4077](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4077) #### Inherited from ```ts -ActivatedJobResult.tenantId; +ActivatedJobResult.tags; ``` --- -### type +### tenantId ```ts -type: string; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:11704](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11704) +Defined in: [gen/types.gen.ts:4052](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4052) -The type of the job (should match what was requested). +The ID of the tenant that owns the job. #### Inherited from ```ts -ActivatedJobResult.type; +ActivatedJobResult.tenantId; ``` --- -### userTask? - -```ts -optional userTask: object; -``` - -Defined in: [gen/types.gen.ts:11763](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11763) - -Contains properties of a user task. - -#### action? - -```ts -optional action: string; -``` - -The action performed on the user task. - -#### assignee? - -```ts -optional assignee: string | null; -``` - -The user assigned to the task. - -#### candidateGroups? - -```ts -optional candidateGroups: string[]; -``` - -The groups eligible to claim the task. - -#### candidateUsers? - -```ts -optional candidateUsers: string[]; -``` - -The users eligible to claim the task. - -#### changedAttributes? - -```ts -optional changedAttributes: string[]; -``` - -The attributes that were changed in the task. - -#### dueDate? +### type ```ts -optional dueDate: string | null; +type: string; ``` -The due date of the user task in ISO 8601 format. - -#### followUpDate? +Defined in: [gen/types.gen.ts:4012](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4012) -```ts -optional followUpDate: string | null; -``` - -The follow-up date of the user task in ISO 8601 format. +The type of the job (should match what was requested). -#### formKey? +#### Inherited from ```ts -optional formKey: FormKey; +ActivatedJobResult.type; ``` -The key of the form associated with the user task. +--- -#### priority? +### userTask ```ts -optional priority: number | null; +userTask: UserTaskProperties | null; ``` -The priority of the user task. - -#### userTaskKey? - -```ts -optional userTaskKey: UserTaskKey | null; -``` +Defined in: [gen/types.gen.ts:4076](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4076) -The unique key identifying the user task. +User task properties, if the job is a user task. +This is `null` if the job is not a user task. #### Inherited from @@ -457,7 +400,7 @@ ActivatedJobResult.userTask; variables: object; ``` -Defined in: [gen/types.gen.ts:11738](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11738) +Defined in: [gen/types.gen.ts:4046](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4046) All variables visible to the task scope, computed at activation time. @@ -481,7 +424,7 @@ ActivatedJobResult.variables; worker: string; ``` -Defined in: [gen/types.gen.ts:11726](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11726) +Defined in: [gen/types.gen.ts:4034](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4034) The name of the worker which activated this job. @@ -499,7 +442,7 @@ ActivatedJobResult.worker; cancelWorkflow(): Promise<"JOB_ACTION_RECEIPT">; ``` -Defined in: [runtime/jobActions.ts:14](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L14) +Defined in: [runtime/jobActions.ts:14](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L14) #### Returns @@ -513,7 +456,7 @@ Defined in: [runtime/jobActions.ts:14](https://github.com/camunda/orchestration- complete(variables?): Promise<"JOB_ACTION_RECEIPT">; ``` -Defined in: [runtime/jobActions.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L11) +Defined in: [runtime/jobActions.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L11) #### Parameters @@ -531,7 +474,7 @@ Defined in: [runtime/jobActions.ts:11](https://github.com/camunda/orchestration- error(error): Promise<"JOB_ACTION_RECEIPT">; ``` -Defined in: [runtime/jobActions.ts:13](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L13) +Defined in: [runtime/jobActions.ts:13](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L13) #### Parameters @@ -551,7 +494,7 @@ Defined in: [runtime/jobActions.ts:13](https://github.com/camunda/orchestration- fail(body): Promise<"JOB_ACTION_RECEIPT">; ``` -Defined in: [runtime/jobActions.ts:12](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L12) +Defined in: [runtime/jobActions.ts:12](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L12) #### Parameters @@ -571,7 +514,7 @@ Defined in: [runtime/jobActions.ts:12](https://github.com/camunda/orchestration- ignore(): Promise<"JOB_ACTION_RECEIPT">; ``` -Defined in: [runtime/jobActions.ts:15](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobActions.ts#L15) +Defined in: [runtime/jobActions.ts:15](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobActions.ts#L15) #### Returns diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/ExtendedDeploymentResult.md b/docs/apis-tools/typescript/api-reference/index/interfaces/ExtendedDeploymentResult.md index c1fd2a47dbd..b653cfcbb09 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/ExtendedDeploymentResult.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/ExtendedDeploymentResult.md @@ -7,7 +7,7 @@ mdx: # Interface: ExtendedDeploymentResult -Defined in: [gen/CamundaClient.ts:1101](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1101) +Defined in: [gen/CamundaClient.ts:1098](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1098) Extended deployment result with typed buckets for direct access to deployed artifacts. @@ -23,7 +23,7 @@ Extended deployment result with typed buckets for direct access to deployed arti decisionRequirements: DeploymentDecisionRequirementsResult[]; ``` -Defined in: [gen/CamundaClient.ts:1104](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1104) +Defined in: [gen/CamundaClient.ts:1101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1101) --- @@ -33,7 +33,7 @@ Defined in: [gen/CamundaClient.ts:1104](https://github.com/camunda/orchestration decisions: DeploymentDecisionResult[]; ``` -Defined in: [gen/CamundaClient.ts:1103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1103) +Defined in: [gen/CamundaClient.ts:1100](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1100) --- @@ -43,7 +43,7 @@ Defined in: [gen/CamundaClient.ts:1103](https://github.com/camunda/orchestration deploymentKey: DeploymentKey; ``` -Defined in: [gen/types.gen.ts:9975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9975) +Defined in: [gen/types.gen.ts:2058](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2058) The unique key identifying the deployment. @@ -58,80 +58,13 @@ _DataOf.deploymentKey; ### deployments ```ts -deployments: object[]; +deployments: DeploymentMetadataResult[]; ``` -Defined in: [gen/types.gen.ts:9983](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9983) +Defined in: [gen/types.gen.ts:2066](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2066) Items deployed by the request. -#### decisionDefinition? - -```ts -optional decisionDefinition: DeploymentDecisionResult; -``` - -#### decisionRequirements? - -```ts -optional decisionRequirements: DeploymentDecisionRequirementsResult; -``` - -#### form? - -```ts -optional form: object; -``` - -A deployed form. - -##### form.formId? - -```ts -optional formId: FormId; -``` - -The form ID, as parsed during deployment, together with the version forms a -unique identifier for a specific form. - -##### form.formKey? - -```ts -optional formKey: FormKey; -``` - -The assigned key, which acts as a unique identifier for this form. - -##### form.resourceName? - -```ts -optional resourceName: string; -``` - -##### form.tenantId? - -```ts -optional tenantId: TenantId; -``` - -##### form.version? - -```ts -optional version: number; -``` - -#### processDefinition? - -```ts -optional processDefinition: DeploymentProcessResult; -``` - -#### resource? - -```ts -optional resource: DeploymentResourceResult; -``` - #### Inherited from ```ts @@ -143,45 +76,10 @@ _DataOf.deployments; ### forms ```ts -forms: object[]; -``` - -Defined in: [gen/CamundaClient.ts:1105](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1105) - -#### formId? - -```ts -optional formId: FormId; -``` - -The form ID, as parsed during deployment, together with the version forms a -unique identifier for a specific form. - -#### formKey? - -```ts -optional formKey: FormKey; -``` - -The assigned key, which acts as a unique identifier for this form. - -#### resourceName? - -```ts -optional resourceName: string; -``` - -#### tenantId? - -```ts -optional tenantId: TenantId; +forms: DeploymentFormResult[]; ``` -#### version? - -```ts -optional version: number; -``` +Defined in: [gen/CamundaClient.ts:1102](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1102) --- @@ -191,7 +89,7 @@ optional version: number; processes: DeploymentProcessResult[]; ``` -Defined in: [gen/CamundaClient.ts:1102](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1102) +Defined in: [gen/CamundaClient.ts:1099](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1099) --- @@ -201,7 +99,7 @@ Defined in: [gen/CamundaClient.ts:1102](https://github.com/camunda/orchestration resources: DeploymentResourceResult[]; ``` -Defined in: [gen/CamundaClient.ts:1106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1106) +Defined in: [gen/CamundaClient.ts:1103](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1103) --- @@ -211,7 +109,7 @@ Defined in: [gen/CamundaClient.ts:1106](https://github.com/camunda/orchestration tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:9979](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9979) +Defined in: [gen/types.gen.ts:2062](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2062) The tenant ID associated with the deployment. diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/HttpRetryPolicy.md b/docs/apis-tools/typescript/api-reference/index/interfaces/HttpRetryPolicy.md new file mode 100644 index 00000000000..4b2f7f7ce21 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/HttpRetryPolicy.md @@ -0,0 +1,40 @@ +--- +title: "Interface: HttpRetryPolicy" +sidebar_label: "HttpRetryPolicy" +mdx: + format: md +--- + +# Interface: HttpRetryPolicy + +Defined in: [runtime/retry.ts:19](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/retry.ts#L19) + +## Properties + +### baseDelayMs + +```ts +baseDelayMs: number; +``` + +Defined in: [runtime/retry.ts:21](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/retry.ts#L21) + +--- + +### maxAttempts + +```ts +maxAttempts: number; +``` + +Defined in: [runtime/retry.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/retry.ts#L20) + +--- + +### maxDelayMs + +```ts +maxDelayMs: number; +``` + +Defined in: [runtime/retry.ts:22](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/retry.ts#L22) diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/JobWorker.md b/docs/apis-tools/typescript/api-reference/index/interfaces/JobWorker.md index 44868085253..f65a284015c 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/JobWorker.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/JobWorker.md @@ -7,7 +7,7 @@ mdx: # Interface: JobWorker -Defined in: [runtime/jobWorker.ts:72](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L72) +Defined in: [runtime/jobWorker.ts:79](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L79) ## Accessors @@ -19,7 +19,7 @@ Defined in: [runtime/jobWorker.ts:72](https://github.com/camunda/orchestration-c get activeJobs(): number; ``` -Defined in: [runtime/jobWorker.ts:99](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L99) +Defined in: [runtime/jobWorker.ts:106](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L106) ##### Returns @@ -35,7 +35,7 @@ Defined in: [runtime/jobWorker.ts:99](https://github.com/camunda/orchestration-c get name(): string; ``` -Defined in: [runtime/jobWorker.ts:96](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L96) +Defined in: [runtime/jobWorker.ts:103](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L103) ##### Returns @@ -51,7 +51,7 @@ Defined in: [runtime/jobWorker.ts:96](https://github.com/camunda/orchestration-c get stopped(): boolean; ``` -Defined in: [runtime/jobWorker.ts:102](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L102) +Defined in: [runtime/jobWorker.ts:109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L109) ##### Returns @@ -65,7 +65,7 @@ Defined in: [runtime/jobWorker.ts:102](https://github.com/camunda/orchestration- start(): void; ``` -Defined in: [runtime/jobWorker.ts:106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L106) +Defined in: [runtime/jobWorker.ts:113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L113) #### Returns @@ -79,7 +79,7 @@ Defined in: [runtime/jobWorker.ts:106](https://github.com/camunda/orchestration- stop(): void; ``` -Defined in: [runtime/jobWorker.ts:113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L113) +Defined in: [runtime/jobWorker.ts:127](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L127) #### Returns @@ -96,7 +96,7 @@ stopGracefully(opts?): Promise<{ }>; ``` -Defined in: [runtime/jobWorker.ts:132](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L132) +Defined in: [runtime/jobWorker.ts:146](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L146) 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. diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/JobWorkerConfig.md b/docs/apis-tools/typescript/api-reference/index/interfaces/JobWorkerConfig.md index 49306580dcc..60047495bba 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/JobWorkerConfig.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/JobWorkerConfig.md @@ -7,7 +7,7 @@ mdx: # Interface: JobWorkerConfig\ -Defined in: [runtime/jobWorker.ts:14](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L14) +Defined in: [runtime/jobWorker.ts:14](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L14) ## Type Parameters @@ -31,7 +31,7 @@ Defined in: [runtime/jobWorker.ts:14](https://github.com/camunda/orchestration-c optional autoStart: boolean; ``` -Defined in: [runtime/jobWorker.ts:29](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L29) +Defined in: [runtime/jobWorker.ts:29](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L29) Immediately start polling for work - default `true` @@ -43,7 +43,7 @@ Immediately start polling for work - default `true` optional customHeadersSchema: Headers; ``` -Defined in: [runtime/jobWorker.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L24) +Defined in: [runtime/jobWorker.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L24) Zod schema for custom headers in the activated job @@ -55,7 +55,7 @@ Zod schema for custom headers in the activated job optional fetchVariables: In extends ZodType> ? Extract>, string>[] : string[]; ``` -Defined in: [runtime/jobWorker.ts:44](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L44) +Defined in: [runtime/jobWorker.ts:44](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L44) Optional list of variable names to fetch during activation @@ -67,7 +67,7 @@ Optional list of variable names to fetch during activation optional inputSchema: In; ``` -Defined in: [runtime/jobWorker.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L20) +Defined in: [runtime/jobWorker.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L20) Zod schema for variables in the activated job @@ -79,7 +79,7 @@ Zod schema for variables in the activated job jobHandler: (job) => "JOB_ACTION_RECEIPT" | Promise<"JOB_ACTION_RECEIPT">; ``` -Defined in: [runtime/jobWorker.ts:27](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L27) +Defined in: [runtime/jobWorker.ts:27](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L27) #### Parameters @@ -99,7 +99,7 @@ Defined in: [runtime/jobWorker.ts:27](https://github.com/camunda/orchestration-c jobTimeoutMs: number; ``` -Defined in: [runtime/jobWorker.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L40) +Defined in: [runtime/jobWorker.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L40) Job activation timeout @@ -111,7 +111,7 @@ Job activation timeout jobType: string; ``` -Defined in: [runtime/jobWorker.ts:42](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L42) +Defined in: [runtime/jobWorker.ts:42](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L42) Zeebe job type @@ -123,7 +123,7 @@ Zeebe job type optional maxBackoffTimeMs: number; ``` -Defined in: [runtime/jobWorker.ts:46](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L46) +Defined in: [runtime/jobWorker.ts:46](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L46) #### Deprecated @@ -137,7 +137,7 @@ Not used; pacing handled by long polling + client backpressure. Present only for maxParallelJobs: number; ``` -Defined in: [runtime/jobWorker.ts:31](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L31) +Defined in: [runtime/jobWorker.ts:31](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L31) concurrency limit @@ -149,7 +149,7 @@ concurrency limit optional outputSchema: Out; ``` -Defined in: [runtime/jobWorker.ts:22](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L22) +Defined in: [runtime/jobWorker.ts:22](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L22) Zod schema for variables in the complete command @@ -161,7 +161,7 @@ Zod schema for variables in the complete command optional pollIntervalMs: number; ``` -Defined in: [runtime/jobWorker.ts:26](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L26) +Defined in: [runtime/jobWorker.ts:26](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L26) Backoff between polls - default 1ms @@ -173,7 +173,7 @@ Backoff between polls - default 1ms optional pollTimeoutMs: number; ``` -Defined in: [runtime/jobWorker.ts:38](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L38) +Defined in: [runtime/jobWorker.ts:38](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L38) 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. @@ -181,13 +181,28 @@ To immediately complete the request when no job is activated set the requestTime --- +### startupJitterMaxSeconds? + +```ts +optional startupJitterMaxSeconds: number; +``` + +Defined in: [runtime/jobWorker.ts:55](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L55) + +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. + +--- + ### validateSchemas? ```ts optional validateSchemas: boolean; ``` -Defined in: [runtime/jobWorker.ts:53](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L53) +Defined in: [runtime/jobWorker.ts:60](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L60) Validate any provided input, output, customheader schema default: false @@ -200,6 +215,6 @@ default: false optional workerName: string; ``` -Defined in: [runtime/jobWorker.ts:48](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L48) +Defined in: [runtime/jobWorker.ts:48](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L48) Optional explicit name diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/OperationOptions.md b/docs/apis-tools/typescript/api-reference/index/interfaces/OperationOptions.md new file mode 100644 index 00000000000..b00dec29386 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/OperationOptions.md @@ -0,0 +1,27 @@ +--- +title: "Interface: OperationOptions" +sidebar_label: "OperationOptions" +mdx: + format: md +--- + +# Interface: OperationOptions + +Defined in: [runtime/retry.ts:26](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/retry.ts#L26) + +Per-call options for individual SDK method invocations. + +## Properties + +### retry? + +```ts +optional retry: false | Partial; +``` + +Defined in: [runtime/retry.ts:31](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/retry.ts#L31) + +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). diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/SupportLogger.md b/docs/apis-tools/typescript/api-reference/index/interfaces/SupportLogger.md index 782c57d0654..b34b502088e 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/SupportLogger.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/SupportLogger.md @@ -7,7 +7,7 @@ mdx: # Interface: SupportLogger -Defined in: [runtime/supportLogger.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/supportLogger.ts#L10) +Defined in: [runtime/supportLogger.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/supportLogger.ts#L10) ## Methods @@ -17,7 +17,7 @@ Defined in: [runtime/supportLogger.ts:10](https://github.com/camunda/orchestrati log(message, addTimestamp?): void; ``` -Defined in: [runtime/supportLogger.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/supportLogger.ts#L11) +Defined in: [runtime/supportLogger.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/supportLogger.ts#L11) #### Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/TelemetryHooks.md b/docs/apis-tools/typescript/api-reference/index/interfaces/TelemetryHooks.md index 5b59288852e..eff6677bcd1 100644 --- a/docs/apis-tools/typescript/api-reference/index/interfaces/TelemetryHooks.md +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/TelemetryHooks.md @@ -7,7 +7,7 @@ mdx: # Interface: TelemetryHooks -Defined in: [runtime/telemetry.ts:5](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/telemetry.ts#L5) +Defined in: [runtime/telemetry.ts:5](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/telemetry.ts#L5) ## Methods @@ -17,7 +17,7 @@ Defined in: [runtime/telemetry.ts:5](https://github.com/camunda/orchestration-cl optional afterResponse(e): void; ``` -Defined in: [runtime/telemetry.ts:7](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/telemetry.ts#L7) +Defined in: [runtime/telemetry.ts:7](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/telemetry.ts#L7) #### Parameters @@ -37,7 +37,7 @@ Defined in: [runtime/telemetry.ts:7](https://github.com/camunda/orchestration-cl optional authError(e): void; ``` -Defined in: [runtime/telemetry.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/telemetry.ts#L11) +Defined in: [runtime/telemetry.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/telemetry.ts#L11) #### Parameters @@ -57,7 +57,7 @@ Defined in: [runtime/telemetry.ts:11](https://github.com/camunda/orchestration-c optional authStart(e): void; ``` -Defined in: [runtime/telemetry.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/telemetry.ts#L9) +Defined in: [runtime/telemetry.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/telemetry.ts#L9) #### Parameters @@ -77,7 +77,7 @@ Defined in: [runtime/telemetry.ts:9](https://github.com/camunda/orchestration-cl optional authSuccess(e): void; ``` -Defined in: [runtime/telemetry.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/telemetry.ts#L10) +Defined in: [runtime/telemetry.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/telemetry.ts#L10) #### Parameters @@ -97,7 +97,7 @@ Defined in: [runtime/telemetry.ts:10](https://github.com/camunda/orchestration-c optional beforeRequest(e): void; ``` -Defined in: [runtime/telemetry.ts:6](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/telemetry.ts#L6) +Defined in: [runtime/telemetry.ts:6](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/telemetry.ts#L6) #### Parameters @@ -117,7 +117,7 @@ Defined in: [runtime/telemetry.ts:6](https://github.com/camunda/orchestration-cl optional requestError(e): void; ``` -Defined in: [runtime/telemetry.ts:8](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/telemetry.ts#L8) +Defined in: [runtime/telemetry.ts:8](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/telemetry.ts#L8) #### Parameters @@ -137,7 +137,7 @@ Defined in: [runtime/telemetry.ts:8](https://github.com/camunda/orchestration-cl optional retry(e): void; ``` -Defined in: [runtime/telemetry.ts:12](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/telemetry.ts#L12) +Defined in: [runtime/telemetry.ts:12](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/telemetry.ts#L12) #### Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/ThreadPool.md b/docs/apis-tools/typescript/api-reference/index/interfaces/ThreadPool.md new file mode 100644 index 00000000000..5a8b5ee32af --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/ThreadPool.md @@ -0,0 +1,183 @@ +--- +title: "Interface: ThreadPool" +sidebar_label: "ThreadPool" +mdx: + format: md +--- + +# Interface: ThreadPool + +Defined in: [runtime/threadPool.ts:33](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadPool.ts#L33) + +## Accessors + +### busyCount + +#### Get Signature + +```ts +get busyCount(): number; +``` + +Defined in: [runtime/threadPool.ts:63](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadPool.ts#L63) + +Number of threads currently processing a job. + +##### Returns + +`number` + +--- + +### idleCount + +#### Get Signature + +```ts +get idleCount(): number; +``` + +Defined in: [runtime/threadPool.ts:68](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadPool.ts#L68) + +Number of threads that are ready and idle. + +##### Returns + +`number` + +--- + +### onThreadReady + +#### Set Signature + +```ts +set onThreadReady(cb): void; +``` + +Defined in: [runtime/threadPool.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadPool.ts#L73) + +Register a callback invoked whenever a thread becomes ready or idle. + +##### Parameters + +###### cb + +() => `void` | `undefined` + +##### Returns + +`void` + +--- + +### ready + +#### Get Signature + +```ts +get ready(): Promise; +``` + +Defined in: [runtime/threadPool.ts:53](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadPool.ts#L53) + +Resolves when all threads have been spawned and signalled ready. + +##### Returns + +`Promise`\<`void`\> + +--- + +### size + +#### Get Signature + +```ts +get size(): number; +``` + +Defined in: [runtime/threadPool.ts:58](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadPool.ts#L58) + +Total number of threads in the pool. + +##### Returns + +`number` + +## Methods + +### dispatch() + +```ts +dispatch( + pw, + jobData, + handlerModule, +callbacks): Promise; +``` + +Defined in: [runtime/threadPool.ts:86](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadPool.ts#L86) + +Dispatch a serialized job to a specific idle worker. +The caller is responsible for checking idleness first. + +#### Parameters + +##### pw + +`PoolWorker` + +##### jobData + +`Record`\<`string`, `unknown`\> + +##### handlerModule + +`string` + +##### callbacks + +###### onComplete + +(`completionAction?`) => `void` + +###### onError + +(`err`) => `void` + +#### Returns + +`Promise`\<`void`\> + +--- + +### getIdleWorker() + +```ts +getIdleWorker(): PoolWorker | undefined; +``` + +Defined in: [runtime/threadPool.ts:78](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadPool.ts#L78) + +Find the first ready & idle thread. + +#### Returns + +`PoolWorker` \| `undefined` + +--- + +### terminate() + +```ts +terminate(): void; +``` + +Defined in: [runtime/threadPool.ts:128](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadPool.ts#L128) + +Terminate all threads and reject any in-flight tasks. + +#### Returns + +`void` diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/ThreadedJobWorker.md b/docs/apis-tools/typescript/api-reference/index/interfaces/ThreadedJobWorker.md new file mode 100644 index 00000000000..70416350863 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/ThreadedJobWorker.md @@ -0,0 +1,179 @@ +--- +title: "Interface: ThreadedJobWorker" +sidebar_label: "ThreadedJobWorker" +mdx: + format: md +--- + +# Interface: ThreadedJobWorker + +Defined in: [runtime/threadedJobWorker.ts:107](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L107) + +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. + +## Accessors + +### activeJobs + +#### Get Signature + +```ts +get activeJobs(): number; +``` + +Defined in: [runtime/threadedJobWorker.ts:135](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L135) + +##### Returns + +`number` + +--- + +### busyThreads + +#### Get Signature + +```ts +get busyThreads(): number; +``` + +Defined in: [runtime/threadedJobWorker.ts:146](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L146) + +Number of threads currently processing a job (across all workers). + +##### Returns + +`number` + +--- + +### name + +#### Get Signature + +```ts +get name(): string; +``` + +Defined in: [runtime/threadedJobWorker.ts:132](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L132) + +##### Returns + +`string` + +--- + +### poolSize + +#### Get Signature + +```ts +get poolSize(): number; +``` + +Defined in: [runtime/threadedJobWorker.ts:142](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L142) + +Number of threads in the shared pool. + +##### Returns + +`number` + +--- + +### ready + +#### Get Signature + +```ts +get ready(): Promise; +``` + +Defined in: [runtime/threadedJobWorker.ts:150](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L150) + +Resolves when the shared thread pool has finished initialising. + +##### Returns + +`Promise`\<`void`\> + +--- + +### stopped + +#### Get Signature + +```ts +get stopped(): boolean; +``` + +Defined in: [runtime/threadedJobWorker.ts:138](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L138) + +##### Returns + +`boolean` + +## Methods + +### start() + +```ts +start(): void; +``` + +Defined in: [runtime/threadedJobWorker.ts:154](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L154) + +#### Returns + +`void` + +--- + +### stop() + +```ts +stop(): void; +``` + +Defined in: [runtime/threadedJobWorker.ts:168](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L168) + +#### Returns + +`void` + +--- + +### stopGracefully() + +```ts +stopGracefully(opts?): Promise<{ + remainingJobs: number; + timedOut: boolean; +}>; +``` + +Defined in: [runtime/threadedJobWorker.ts:182](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L182) + +#### Parameters + +##### opts? + +###### checkIntervalMs? + +`number` + +###### waitUpToMs? + +`number` + +#### Returns + +`Promise`\<\{ +`remainingJobs`: `number`; +`timedOut`: `boolean`; +\}\> diff --git a/docs/apis-tools/typescript/api-reference/index/interfaces/ThreadedJobWorkerConfig.md b/docs/apis-tools/typescript/api-reference/index/interfaces/ThreadedJobWorkerConfig.md new file mode 100644 index 00000000000..8bce0a1cd1b --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/interfaces/ThreadedJobWorkerConfig.md @@ -0,0 +1,216 @@ +--- +title: "Interface: ThreadedJobWorkerConfig" +sidebar_label: "ThreadedJobWorkerConfig" +mdx: + format: md +--- + +# Interface: ThreadedJobWorkerConfig\ + +Defined in: [runtime/threadedJobWorker.ts:41](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L41) + +Configuration for a threaded job worker. +Same as JobWorkerConfig but replaces `jobHandler` with `handlerModule`. + +## Type Parameters + +### In + +`In` _extends_ `z.ZodTypeAny` = `any` + +### Out + +`Out` _extends_ `z.ZodTypeAny` = `any` + +### Headers + +`Headers` _extends_ `z.ZodTypeAny` = `any` + +## Properties + +### autoStart? + +```ts +optional autoStart: boolean; +``` + +Defined in: [runtime/threadedJobWorker.ts:58](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L58) + +Immediately start polling for work - default `true` + +--- + +### customHeadersSchema? + +```ts +optional customHeadersSchema: Headers; +``` + +Defined in: [runtime/threadedJobWorker.ts:54](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L54) + +Zod schema for custom headers in the activated job + +--- + +### fetchVariables? + +```ts +optional fetchVariables: In extends ZodType> ? Extract>, string>[] : string[]; +``` + +Defined in: [runtime/threadedJobWorker.ts:72](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L72) + +Optional list of variable names to fetch during activation + +--- + +### handlerModule + +```ts +handlerModule: string; +``` + +Defined in: [runtime/threadedJobWorker.ts:48](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L48) + +Absolute or relative path to a JS/TS module that exports a default handler function. +The function signature must be: `(job, client) => Promise` + +--- + +### inputSchema? + +```ts +optional inputSchema: In; +``` + +Defined in: [runtime/threadedJobWorker.ts:50](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L50) + +Zod schema for variables in the activated job + +--- + +### jobTimeoutMs + +```ts +jobTimeoutMs: number; +``` + +Defined in: [runtime/threadedJobWorker.ts:68](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L68) + +Job activation timeout + +--- + +### jobType + +```ts +jobType: string; +``` + +Defined in: [runtime/threadedJobWorker.ts:70](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L70) + +Zeebe job type + +--- + +### maxParallelJobs + +```ts +maxParallelJobs: number; +``` + +Defined in: [runtime/threadedJobWorker.ts:60](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L60) + +concurrency limit + +--- + +### outputSchema? + +```ts +optional outputSchema: Out; +``` + +Defined in: [runtime/threadedJobWorker.ts:52](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L52) + +Zod schema for variables in the complete command + +--- + +### pollIntervalMs? + +```ts +optional pollIntervalMs: number; +``` + +Defined in: [runtime/threadedJobWorker.ts:56](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L56) + +Backoff between polls - default 1ms + +--- + +### pollTimeoutMs? + +```ts +optional pollTimeoutMs: number; +``` + +Defined in: [runtime/threadedJobWorker.ts:66](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L66) + +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 + +--- + +### startupJitterMaxSeconds? + +```ts +optional startupJitterMaxSeconds: number; +``` + +Defined in: [runtime/threadedJobWorker.ts:81](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L81) + +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. + +--- + +### threadPoolSize? + +```ts +optional threadPoolSize: number; +``` + +Defined in: [runtime/threadedJobWorker.ts:92](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L92) + +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. + +--- + +### validateSchemas? + +```ts +optional validateSchemas: boolean; +``` + +Defined in: [runtime/threadedJobWorker.ts:86](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L86) + +Validate any provided input, output, customheader schema +default: false + +--- + +### workerName? + +```ts +optional workerName: string; +``` + +Defined in: [runtime/threadedJobWorker.ts:74](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L74) + +Optional explicit name diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/assumeExists.md index 303616983ea..c38dcfcf594 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): AuditLogEntityKey; ``` -Defined in: [gen/types.gen.ts:17763](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17763) +Defined in: [gen/types.gen.ts:16639](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16639) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/getValue.md index bd1d8b64b02..e9b76e2bc13 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17766](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17766) +Defined in: [gen/types.gen.ts:16642](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16642) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/isValid.md index 5575c75d628..e07bb459391 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogEntityKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17767](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17767) +Defined in: [gen/types.gen.ts:16643](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16643) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/assumeExists.md index db7c03a570a..8fa8a2edff9 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): AuditLogKey; ``` -Defined in: [gen/types.gen.ts:17773](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17773) +Defined in: [gen/types.gen.ts:16649](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16649) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/getValue.md index a33b0043efe..11e0c69a005 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17777](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17777) +Defined in: [gen/types.gen.ts:16653](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16653) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/isValid.md index 3890016d07b..bc65288278d 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/AuditLogKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17778](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17778) +Defined in: [gen/types.gen.ts:16654](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16654) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/assumeExists.md index 0644a8a13ec..ca5c35bdf01 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): AuthorizationKey; ``` -Defined in: [gen/types.gen.ts:17787](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17787) +Defined in: [gen/types.gen.ts:16663](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16663) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/getValue.md index dc3665f2db1..7cfc1245a9a 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17791](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17791) +Defined in: [gen/types.gen.ts:16667](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16667) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/isValid.md index 26ebf1d2bd1..080cc5504df 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/AuthorizationKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17792](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17792) +Defined in: [gen/types.gen.ts:16668](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16668) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/assumeExists.md index c666971f933..46f6c93500e 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): BatchOperationKey; ``` -Defined in: [gen/types.gen.ts:17801](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17801) +Defined in: [gen/types.gen.ts:16677](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16677) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/getValue.md index 67a5b150f3a..e09e1d54a0d 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17804](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17804) +Defined in: [gen/types.gen.ts:16680](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16680) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/isValid.md index 5f2bcd68d32..0901d9de8c6 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/BatchOperationKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17805](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17805) +Defined in: [gen/types.gen.ts:16681](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16681) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/_category_.json b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/_category_.json new file mode 100644 index 00000000000..c6c17bc75fa --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "BusinessId" +} diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/_category_.json b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/_category_.json similarity index 100% rename from docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/_category_.json rename to docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/_category_.json diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/assumeExists.md new file mode 100644 index 00000000000..80a7b234821 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/assumeExists.md @@ -0,0 +1,24 @@ +--- +title: "Function: assumeExists()" +sidebar_label: "assumeExists()" +mdx: + format: md +--- + +# Function: assumeExists() + +```ts +function assumeExists(value): BusinessId; +``` + +Defined in: [gen/types.gen.ts:16687](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16687) + +## Parameters + +### value + +`string` + +## Returns + +[`BusinessId`](../../../type-aliases/BusinessId.md) diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/getValue.md new file mode 100644 index 00000000000..c01fc5cba41 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/getValue.md @@ -0,0 +1,24 @@ +--- +title: "Function: getValue()" +sidebar_label: "getValue()" +mdx: + format: md +--- + +# Function: getValue() + +```ts +function getValue(key): string; +``` + +Defined in: [gen/types.gen.ts:16691](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16691) + +## Parameters + +### key + +[`BusinessId`](../../../type-aliases/BusinessId.md) + +## Returns + +`string` diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/isValid.md similarity index 55% rename from docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/isValid.md rename to docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/isValid.md index a868fa73358..8775e2fcb10 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18112](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18112) +Defined in: [gen/types.gen.ts:16692](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16692) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/index.md b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/index.md similarity index 84% rename from docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/index.md rename to docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/index.md index 62755b966a9..9e58e345d42 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/index.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/BusinessId/index.md @@ -1,11 +1,11 @@ --- -title: "ScopeKey" +title: "BusinessId" sidebar_label: "Overview" mdx: format: md --- -# ScopeKey +# BusinessId ## Functions diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/assumeExists.md index 8e034b3bd2f..78a4d1375ac 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): ConditionalEvaluationKey; ``` -Defined in: [gen/types.gen.ts:17811](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17811) +Defined in: [gen/types.gen.ts:16701](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16701) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/getValue.md index 23232512371..8d853749592 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17815](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17815) +Defined in: [gen/types.gen.ts:16705](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16705) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/isValid.md index fa01ad30857..4eb4878b83d 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ConditionalEvaluationKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17816](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17816) +Defined in: [gen/types.gen.ts:16706](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16706) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/assumeExists.md index f6ac6e690f3..6a1a4e4c101 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): DecisionDefinitionId; ``` -Defined in: [gen/types.gen.ts:17825](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17825) +Defined in: [gen/types.gen.ts:16715](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16715) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/getValue.md index 7ba68c9d703..78c177af317 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17829](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17829) +Defined in: [gen/types.gen.ts:16719](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16719) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/isValid.md index 4a92427eeeb..ac16ac3cd22 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionId/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17830](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17830) +Defined in: [gen/types.gen.ts:16720](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16720) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/assumeExists.md index 3d18ba19724..346b043d242 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:17839](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17839) +Defined in: [gen/types.gen.ts:16729](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16729) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/getValue.md index 4736f8ee8a0..516e6b69506 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17843](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17843) +Defined in: [gen/types.gen.ts:16733](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16733) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/isValid.md index b8fafe90186..02bbb37a8ed 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionDefinitionKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17844](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17844) +Defined in: [gen/types.gen.ts:16734](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16734) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/assumeExists.md index 4940cf616d5..09ae3bfc5c2 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): DecisionEvaluationInstanceKey; ``` -Defined in: [gen/types.gen.ts:17853](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17853) +Defined in: [gen/types.gen.ts:16743](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16743) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/getValue.md index fca008ad2fc..bad34fe27c7 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17857](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17857) +Defined in: [gen/types.gen.ts:16747](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16747) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/isValid.md index d677ab7d67e..8a5dc1ed253 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationInstanceKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17858](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17858) +Defined in: [gen/types.gen.ts:16748](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16748) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/assumeExists.md index 1b3c032e862..36a4353fdba 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): DecisionEvaluationKey; ``` -Defined in: [gen/types.gen.ts:17867](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17867) +Defined in: [gen/types.gen.ts:16757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16757) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/getValue.md index 3e2bda8938e..550eed120fe 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17871](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17871) +Defined in: [gen/types.gen.ts:16761](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16761) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/isValid.md index cf4855d16c9..61b46bf9b5b 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionEvaluationKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17872](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17872) +Defined in: [gen/types.gen.ts:16762](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16762) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/assumeExists.md index f45966e2ff0..9283da86279 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): DecisionInstanceKey; ``` -Defined in: [gen/types.gen.ts:17881](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17881) +Defined in: [gen/types.gen.ts:16771](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16771) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/getValue.md index 7d2fdc45d0a..8fb801e6e7a 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17885](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17885) +Defined in: [gen/types.gen.ts:16775](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16775) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/isValid.md index 53bb25a8ff8..a9b89fa8f9b 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionInstanceKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17886](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17886) +Defined in: [gen/types.gen.ts:16776](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16776) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/assumeExists.md index 8fe4bac1190..39b4fb8cc0c 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:17895](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17895) +Defined in: [gen/types.gen.ts:16785](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16785) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/getValue.md index a737fba29e1..2ec6e05466a 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17899](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17899) +Defined in: [gen/types.gen.ts:16789](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16789) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/isValid.md index 76184e35384..82a5f88a21c 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DecisionRequirementsKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17900) +Defined in: [gen/types.gen.ts:16790](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16790) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/assumeExists.md index e4cddf20447..6c670f0625b 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): DeploymentKey; ``` -Defined in: [gen/types.gen.ts:17909](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17909) +Defined in: [gen/types.gen.ts:16799](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16799) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/getValue.md index ff9574352a1..4573ec541e2 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17913](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17913) +Defined in: [gen/types.gen.ts:16803](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16803) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/isValid.md index b6b4e14d8a5..fb96bc2fa5e 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DeploymentKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17914](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17914) +Defined in: [gen/types.gen.ts:16804](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16804) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/assumeExists.md index 2101b8e5b69..8fb546c63cb 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): DocumentId; ``` -Defined in: [gen/types.gen.ts:17923](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17923) +Defined in: [gen/types.gen.ts:16813](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16813) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/getValue.md index 767c6be79e9..5fc7a103d62 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17926](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17926) +Defined in: [gen/types.gen.ts:16816](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16816) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/isValid.md index b1c3d456f82..a1af78cdea7 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/DocumentId/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17927](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17927) +Defined in: [gen/types.gen.ts:16817](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16817) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/assumeExists.md index 284d51ea91b..f74bcb94053 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): ElementId; ``` -Defined in: [gen/types.gen.ts:17933](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17933) +Defined in: [gen/types.gen.ts:16823](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16823) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/getValue.md index 5fdf1b57d9a..4cb389c3b7f 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17936](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17936) +Defined in: [gen/types.gen.ts:16826](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16826) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/isValid.md index dc10e305671..5c329dd77be 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementId/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17937](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17937) +Defined in: [gen/types.gen.ts:16827](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16827) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/assumeExists.md index 273d25ad5fd..275b34672a6 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:17943](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17943) +Defined in: [gen/types.gen.ts:16833](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16833) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/getValue.md index 8522f5eccd9..1db0566e71b 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17947](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17947) +Defined in: [gen/types.gen.ts:16837](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16837) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/isValid.md index 5e498206e73..a2cc6da3cc9 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ElementInstanceKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17948](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17948) +Defined in: [gen/types.gen.ts:16838](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16838) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/assumeExists.md index 15b911a7eca..f80f96f1404 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): EndCursor; ``` -Defined in: [gen/types.gen.ts:17957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17957) +Defined in: [gen/types.gen.ts:16847](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16847) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/getValue.md index 82dc83b4d87..3f648172614 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17961](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17961) +Defined in: [gen/types.gen.ts:16851](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16851) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/isValid.md index f8628288a2f..c3d6dfa88f0 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/EndCursor/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17962](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17962) +Defined in: [gen/types.gen.ts:16852](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16852) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/assumeExists.md index 3b06f77bfa2..921fa9133ad 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): FormId; ``` -Defined in: [gen/types.gen.ts:17971](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17971) +Defined in: [gen/types.gen.ts:16861](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16861) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/getValue.md index 91a1a00d4bf..a004746398e 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17974](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17974) +Defined in: [gen/types.gen.ts:16864](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16864) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/isValid.md index 224e584feb4..5668d45f02b 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/FormId/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17975) +Defined in: [gen/types.gen.ts:16865](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16865) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/assumeExists.md index 30fb9253abf..64dc6e4bd82 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): FormKey; ``` -Defined in: [gen/types.gen.ts:17981](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17981) +Defined in: [gen/types.gen.ts:16871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16871) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/getValue.md index 73bc6bfd8ec..8887a314bea 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17985](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17985) +Defined in: [gen/types.gen.ts:16875](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16875) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/isValid.md index 99eb2c16bbe..bae3ce35d57 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/FormKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:17986](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17986) +Defined in: [gen/types.gen.ts:16876](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16876) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/_category_.json b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/_category_.json new file mode 100644 index 00000000000..6b1c7363d08 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "GlobalListenerId" +} diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/_category_.json b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/_category_.json similarity index 100% rename from docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/_category_.json rename to docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/_category_.json diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/assumeExists.md new file mode 100644 index 00000000000..b7c3c8d312a --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/assumeExists.md @@ -0,0 +1,24 @@ +--- +title: "Function: assumeExists()" +sidebar_label: "assumeExists()" +mdx: + format: md +--- + +# Function: assumeExists() + +```ts +function assumeExists(value): GlobalListenerId; +``` + +Defined in: [gen/types.gen.ts:16885](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16885) + +## Parameters + +### value + +`string` + +## Returns + +[`GlobalListenerId`](../../../type-aliases/GlobalListenerId.md) diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/getValue.md new file mode 100644 index 00000000000..2add3387395 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/getValue.md @@ -0,0 +1,24 @@ +--- +title: "Function: getValue()" +sidebar_label: "getValue()" +mdx: + format: md +--- + +# Function: getValue() + +```ts +function getValue(key): string; +``` + +Defined in: [gen/types.gen.ts:16888](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16888) + +## Parameters + +### key + +[`GlobalListenerId`](../../../type-aliases/GlobalListenerId.md) + +## Returns + +`string` diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/isValid.md similarity index 55% rename from docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/isValid.md rename to docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/isValid.md index 7a45ff7175f..59ccf82dfbe 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18098](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18098) +Defined in: [gen/types.gen.ts:16889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16889) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/index.md b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/index.md similarity index 76% rename from docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/index.md rename to docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/index.md index 2d6d3906721..b73b99117d6 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/index.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/GlobalListenerId/index.md @@ -1,11 +1,11 @@ --- -title: "RootProcessInstanceKey" +title: "GlobalListenerId" sidebar_label: "Overview" mdx: format: md --- -# RootProcessInstanceKey +# GlobalListenerId ## Functions diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/assumeExists.md index 863fb9d024e..6e1d23175de 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): IncidentKey; ``` -Defined in: [gen/types.gen.ts:17995](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17995) +Defined in: [gen/types.gen.ts:16895](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16895) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/getValue.md index a104012103c..9741a6aa643 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:17999](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17999) +Defined in: [gen/types.gen.ts:16899](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16899) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/isValid.md index 7c6f2c8038d..c3afaf04d03 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/IncidentKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18000](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18000) +Defined in: [gen/types.gen.ts:16900](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16900) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/assumeExists.md index 5469649a0f0..13d09f64d04 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): JobKey; ``` -Defined in: [gen/types.gen.ts:18009](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18009) +Defined in: [gen/types.gen.ts:16909](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16909) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/getValue.md index dc2e0818e20..49fc7dd84e0 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18013](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18013) +Defined in: [gen/types.gen.ts:16913](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16913) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/isValid.md index dd85c53e509..ce3676a0a44 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/JobKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18014](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18014) +Defined in: [gen/types.gen.ts:16914](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16914) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/assumeExists.md index 1867a7fdfd1..149a1ffa8a4 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): MessageKey; ``` -Defined in: [gen/types.gen.ts:18023](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18023) +Defined in: [gen/types.gen.ts:16923](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16923) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/getValue.md index 58a600e3d8c..45969985922 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18027](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18027) +Defined in: [gen/types.gen.ts:16927](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16927) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/isValid.md index 653be4c265a..689974cdafd 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18028](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18028) +Defined in: [gen/types.gen.ts:16928](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16928) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/assumeExists.md index b7a93e80cb7..c09b08f4e48 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): MessageSubscriptionKey; ``` -Defined in: [gen/types.gen.ts:18037](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18037) +Defined in: [gen/types.gen.ts:16937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16937) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/getValue.md index 574ec94e492..da90666d1a4 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18041](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18041) +Defined in: [gen/types.gen.ts:16941](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16941) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/isValid.md index ac92f98d0b8..b36bb6cb908 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/MessageSubscriptionKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18042](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18042) +Defined in: [gen/types.gen.ts:16942](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16942) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/assumeExists.md index 7fe1f32a5f1..42de37f53d1 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:18051](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18051) +Defined in: [gen/types.gen.ts:16951](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16951) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/getValue.md index a2d673c646a..845d743f4ce 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18055](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18055) +Defined in: [gen/types.gen.ts:16955](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16955) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/isValid.md index 52f04e36e38..eee912bc482 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionId/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18056](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18056) +Defined in: [gen/types.gen.ts:16956](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16956) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/assumeExists.md index 9569a507d6b..0aff749051f 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:18065](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18065) +Defined in: [gen/types.gen.ts:16965](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16965) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/getValue.md index 0c903ec365a..e4f5c767b11 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18069](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18069) +Defined in: [gen/types.gen.ts:16969](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16969) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/isValid.md index 193e8a874c7..2d02a47e81b 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessDefinitionKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18070](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18070) +Defined in: [gen/types.gen.ts:16970](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16970) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/assumeExists.md index ead14d48a7b..b1da8385650 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:18079](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18079) +Defined in: [gen/types.gen.ts:16979](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16979) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/getValue.md index 86a5b7650d3..427d5859791 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18083](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18083) +Defined in: [gen/types.gen.ts:16983](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16983) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/isValid.md index 2d38626f8f0..212468d58a4 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/ProcessInstanceKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18084](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18084) +Defined in: [gen/types.gen.ts:16984](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16984) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/_category_.json b/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/_category_.json deleted file mode 100644 index a01a8599780..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "RootProcessInstanceKey" -} diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/assumeExists.md deleted file mode 100644 index f29488206d2..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/assumeExists.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Function: assumeExists()" -sidebar_label: "assumeExists()" -mdx: - format: md ---- - -# Function: assumeExists() - -```ts -function assumeExists(value): RootProcessInstanceKey; -``` - -Defined in: [gen/types.gen.ts:18093](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18093) - -## Parameters - -### value - -`string` - -## Returns - -[`RootProcessInstanceKey`](../../../type-aliases/RootProcessInstanceKey.md) diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/getValue.md deleted file mode 100644 index 362092931f6..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/RootProcessInstanceKey/functions/getValue.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Function: getValue()" -sidebar_label: "getValue()" -mdx: - format: md ---- - -# Function: getValue() - -```ts -function getValue(key): string; -``` - -Defined in: [gen/types.gen.ts:18097](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18097) - -## Parameters - -### key - -[`RootProcessInstanceKey`](../../../type-aliases/RootProcessInstanceKey.md) - -## Returns - -`string` diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/_category_.json b/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/_category_.json deleted file mode 100644 index 4c86dd748dc..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "ScopeKey" -} diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/assumeExists.md deleted file mode 100644 index 6359456da69..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/assumeExists.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Function: assumeExists()" -sidebar_label: "assumeExists()" -mdx: - format: md ---- - -# Function: assumeExists() - -```ts -function assumeExists(value): ScopeKey; -``` - -Defined in: [gen/types.gen.ts:18107](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18107) - -## Parameters - -### value - -`string` - -## Returns - -[`ScopeKey`](../../../type-aliases/ScopeKey.md) diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/getValue.md deleted file mode 100644 index 89743bd2bcb..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/ScopeKey/functions/getValue.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Function: getValue()" -sidebar_label: "getValue()" -mdx: - format: md ---- - -# Function: getValue() - -```ts -function getValue(key): string; -``` - -Defined in: [gen/types.gen.ts:18111](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18111) - -## Parameters - -### key - -[`ScopeKey`](../../../type-aliases/ScopeKey.md) - -## Returns - -`string` diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/assumeExists.md index ab2f6b61b2a..f48abca46c3 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): SignalKey; ``` -Defined in: [gen/types.gen.ts:18121](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18121) +Defined in: [gen/types.gen.ts:16993](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16993) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/getValue.md index 5b65a4deaad..adae12796bb 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18125](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18125) +Defined in: [gen/types.gen.ts:16997](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16997) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/isValid.md index 21e1f87ac26..b137410801c 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/SignalKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18126](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18126) +Defined in: [gen/types.gen.ts:16998](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16998) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/assumeExists.md index d51fff7bd4d..6d27f528ba9 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): StartCursor; ``` -Defined in: [gen/types.gen.ts:18135](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18135) +Defined in: [gen/types.gen.ts:17007](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17007) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/getValue.md index 0668e70edc4..60d461e2b0f 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18139](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18139) +Defined in: [gen/types.gen.ts:17011](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17011) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/isValid.md index ab66634d529..7b3f1f75f5c 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/StartCursor/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18140](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18140) +Defined in: [gen/types.gen.ts:17012](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17012) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/fromString.md b/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/fromString.md index 6aca18d5a55..95c973f6602 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/fromString.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/fromString.md @@ -11,7 +11,7 @@ mdx: function fromString(value): Tag; ``` -Defined in: [gen/types.gen.ts:18149](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18149) +Defined in: [gen/types.gen.ts:17021](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17021) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/getValue.md index 3ba4da8266b..7f242a35457 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18153](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18153) +Defined in: [gen/types.gen.ts:17025](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17025) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/isValid.md index 6763341f9ac..97808e7bec7 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/Tag/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18154](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18154) +Defined in: [gen/types.gen.ts:17026](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17026) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/assumeExists.md index 0326a8689f3..89efa1f5de1 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): TenantId; ``` -Defined in: [gen/types.gen.ts:18163](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18163) +Defined in: [gen/types.gen.ts:17035](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17035) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/getValue.md index bf63080692b..a18f7c6679c 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18167](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18167) +Defined in: [gen/types.gen.ts:17039](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17039) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/isValid.md index 5cec2b8765c..e3ac2087541 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/TenantId/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18168](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18168) +Defined in: [gen/types.gen.ts:17040](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17040) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/assumeExists.md index 889c14e5c96..6ce45f862e7 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): UserTaskKey; ``` -Defined in: [gen/types.gen.ts:18191](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18191) +Defined in: [gen/types.gen.ts:17063](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17063) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/getValue.md index 91c2a4348f0..9e443828b03 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18195](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18195) +Defined in: [gen/types.gen.ts:17067](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17067) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/isValid.md index 918fd8d2e14..f362d5eebf2 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/UserTaskKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18196](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18196) +Defined in: [gen/types.gen.ts:17068](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17068) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/assumeExists.md index 25222bd9ba3..d26e80a4407 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): Username; ``` -Defined in: [gen/types.gen.ts:18177](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18177) +Defined in: [gen/types.gen.ts:17049](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17049) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/getValue.md index 6a61b8a0989..ebad84e5ee5 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18181](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18181) +Defined in: [gen/types.gen.ts:17053](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17053) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/isValid.md index 1ef6d4b53d2..04f1f45d126 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/Username/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18182](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18182) +Defined in: [gen/types.gen.ts:17054](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17054) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/assumeExists.md b/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/assumeExists.md index d97a7771cfb..54fb2cf0528 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/assumeExists.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/assumeExists.md @@ -11,7 +11,7 @@ mdx: function assumeExists(value): VariableKey; ``` -Defined in: [gen/types.gen.ts:18205](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18205) +Defined in: [gen/types.gen.ts:17077](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17077) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/getValue.md b/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/getValue.md index da0e5db8c03..a4db1da5f07 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/getValue.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/getValue.md @@ -11,7 +11,7 @@ mdx: function getValue(key): string; ``` -Defined in: [gen/types.gen.ts:18209](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18209) +Defined in: [gen/types.gen.ts:17081](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17081) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/isValid.md b/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/isValid.md index 4db20005ba8..abcb3862682 100644 --- a/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/isValid.md +++ b/docs/apis-tools/typescript/api-reference/index/namespaces/VariableKey/functions/isValid.md @@ -11,7 +11,7 @@ mdx: function isValid(value): boolean; ``` -Defined in: [gen/types.gen.ts:18210](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18210) +Defined in: [gen/types.gen.ts:17082](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17082) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesData.md index 92cc9231387..2ec3bd07032 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesData.md @@ -11,7 +11,7 @@ mdx: type ActivateAdHocSubProcessActivitiesData = object; ``` -Defined in: [gen/types.gen.ts:10229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10229) +Defined in: [gen/types.gen.ts:10323](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10323) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10229](https://github.com/camunda/orchestration-cl body: AdHocSubProcessActivateActivitiesInstruction; ``` -Defined in: [gen/types.gen.ts:10230](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10230) +Defined in: [gen/types.gen.ts:10324](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10324) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10230](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10231](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10231) +Defined in: [gen/types.gen.ts:10325](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10325) #### adHocSubProcessInstanceKey @@ -49,7 +49,7 @@ The key of the ad-hoc sub-process instance that contains the activities. optional query: never; ``` -Defined in: [gen/types.gen.ts:10237](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10237) +Defined in: [gen/types.gen.ts:10331](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10331) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:10237](https://github.com/camunda/orchestration-cl url: "/element-instances/ad-hoc-activities/{adHocSubProcessInstanceKey}/activation"; ``` -Defined in: [gen/types.gen.ts:10238](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10238) +Defined in: [gen/types.gen.ts:10332](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10332) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesError.md index a5c2e68d9a6..1b840002ab5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesError.md @@ -12,4 +12,4 @@ type ActivateAdHocSubProcessActivitiesError = ActivateAdHocSubProcessActivitiesErrors[keyof ActivateAdHocSubProcessActivitiesErrors]; ``` -Defined in: [gen/types.gen.ts:10269](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10269) +Defined in: [gen/types.gen.ts:10363](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10363) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesErrors.md index 8c1c0253096..546d7581b5e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesErrors.md @@ -11,7 +11,7 @@ mdx: type ActivateAdHocSubProcessActivitiesErrors = object; ``` -Defined in: [gen/types.gen.ts:10241](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10241) +Defined in: [gen/types.gen.ts:10335](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10335) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10241](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10245](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10245) +Defined in: [gen/types.gen.ts:10339](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10339) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10249](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10249) +Defined in: [gen/types.gen.ts:10343](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10343) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10253](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10253) +Defined in: [gen/types.gen.ts:10347](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10347) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10257](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10257) +Defined in: [gen/types.gen.ts:10351](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10351) The ad-hoc sub-process instance is not found or the provided key does not identify an ad-hoc sub-process. @@ -69,7 +69,7 @@ The ad-hoc sub-process instance is not found or the provided key does not identi 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10261](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10261) +Defined in: [gen/types.gen.ts:10355](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10355) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10266](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10266) +Defined in: [gen/types.gen.ts:10360](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10360) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesResponse.md index 6f088759b90..9e633e42c16 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesResponse.md @@ -12,4 +12,4 @@ type ActivateAdHocSubProcessActivitiesResponse = ActivateAdHocSubProcessActivitiesResponses[keyof ActivateAdHocSubProcessActivitiesResponses]; ``` -Defined in: [gen/types.gen.ts:10278](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10278) +Defined in: [gen/types.gen.ts:10372](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10372) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesResponses.md index 9fbcb61c0f1..fcef379f1f2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateAdHocSubProcessActivitiesResponses.md @@ -11,7 +11,7 @@ mdx: type ActivateAdHocSubProcessActivitiesResponses = object; ``` -Defined in: [gen/types.gen.ts:10271](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10271) +Defined in: [gen/types.gen.ts:10365](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10365) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10271](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:10275](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10275) +Defined in: [gen/types.gen.ts:10369](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10369) The ad-hoc sub-process instance is modified. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsData.md index 24825abde49..799aef50385 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsData.md @@ -11,7 +11,7 @@ mdx: type ActivateJobsData = object; ``` -Defined in: [gen/types.gen.ts:11663](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11663) +Defined in: [gen/types.gen.ts:11789](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11789) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11663](https://github.com/camunda/orchestration-cl body: JobActivationRequest; ``` -Defined in: [gen/types.gen.ts:11664](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11664) +Defined in: [gen/types.gen.ts:11790](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11790) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11664](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:11665](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11665) +Defined in: [gen/types.gen.ts:11791](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11791) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:11665](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:11666](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11666) +Defined in: [gen/types.gen.ts:11792](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11792) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:11666](https://github.com/camunda/orchestration-cl url: "/jobs/activation"; ``` -Defined in: [gen/types.gen.ts:11667](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11667) +Defined in: [gen/types.gen.ts:11793](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11793) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsError.md index 38bf6d25351..e73361a5aaf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsError.md @@ -11,4 +11,4 @@ mdx: type ActivateJobsError = ActivateJobsErrors[keyof ActivateJobsErrors]; ``` -Defined in: [gen/types.gen.ts:11690](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11690) +Defined in: [gen/types.gen.ts:11816](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11816) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsErrors.md index ba67e08d511..ba70d9ba3d6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsErrors.md @@ -11,7 +11,7 @@ mdx: type ActivateJobsErrors = object; ``` -Defined in: [gen/types.gen.ts:11670](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11670) +Defined in: [gen/types.gen.ts:11796](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11796) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11670](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11674](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11674) +Defined in: [gen/types.gen.ts:11800](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11800) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11678](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11678) +Defined in: [gen/types.gen.ts:11804](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11804) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11682](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11682) +Defined in: [gen/types.gen.ts:11808](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11808) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11687](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11687) +Defined in: [gen/types.gen.ts:11813](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11813) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsResponse.md index 27ee9f44426..c92a1af31b4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsResponse.md @@ -11,4 +11,4 @@ mdx: type ActivateJobsResponse = ActivateJobsResponses[keyof ActivateJobsResponses]; ``` -Defined in: [gen/types.gen.ts:11810](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11810) +Defined in: [gen/types.gen.ts:11825](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11825) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsResponses.md index b89d9dbf16a..d0e477918a9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivateJobsResponses.md @@ -11,24 +11,16 @@ mdx: type ActivateJobsResponses = object; ``` -Defined in: [gen/types.gen.ts:11692](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11692) +Defined in: [gen/types.gen.ts:11818](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11818) ## Properties ### 200 ```ts -200: object; +200: JobActivationResult; ``` -Defined in: [gen/types.gen.ts:11696](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11696) +Defined in: [gen/types.gen.ts:11822](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11822) -The list of activated jobs - -#### jobs - -```ts -jobs: object[]; -``` - -The activated jobs. +The list of activated jobs. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivatedJobResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivatedJobResult.md index 3eed6032fc4..59be0f40763 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivatedJobResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ActivatedJobResult.md @@ -11,7 +11,7 @@ mdx: type ActivatedJobResult = object; ``` -Defined in: [gen/types.gen.ts:3386](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3386) +Defined in: [gen/types.gen.ts:4008](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4008) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:3386](https://github.com/camunda/orchestration-clu customHeaders: object; ``` -Defined in: [gen/types.gen.ts:3406](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3406) +Defined in: [gen/types.gen.ts:4028](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4028) A set of custom headers defined during modelling; returned as a serialized JSON document. @@ -39,7 +39,7 @@ A set of custom headers defined during modelling; returned as a serialized JSON deadline: number; ``` -Defined in: [gen/types.gen.ts:3420](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3420) +Defined in: [gen/types.gen.ts:4042](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4042) When the job can be activated again, sent as a UNIX epoch timestamp. @@ -51,7 +51,7 @@ When the job can be activated again, sent as a UNIX epoch timestamp. elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:3402](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3402) +Defined in: [gen/types.gen.ts:4024](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4024) The associated task element ID. @@ -63,7 +63,9 @@ The associated task element ID. elementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:3443](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3443) +Defined in: [gen/types.gen.ts:4068](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4068) + +The element instance key of the task. --- @@ -73,7 +75,7 @@ Defined in: [gen/types.gen.ts:3443](https://github.com/camunda/orchestration-clu jobKey: JobKey; ``` -Defined in: [gen/types.gen.ts:3434](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3434) +Defined in: [gen/types.gen.ts:4056](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4056) The key, a unique identifier for the job. @@ -85,7 +87,7 @@ The key, a unique identifier for the job. kind: JobKindEnum; ``` -Defined in: [gen/types.gen.ts:3444](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3444) +Defined in: [gen/types.gen.ts:4069](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4069) --- @@ -95,7 +97,7 @@ Defined in: [gen/types.gen.ts:3444](https://github.com/camunda/orchestration-clu listenerEventType: JobListenerEventTypeEnum; ``` -Defined in: [gen/types.gen.ts:3445](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3445) +Defined in: [gen/types.gen.ts:4070](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4070) --- @@ -105,7 +107,7 @@ Defined in: [gen/types.gen.ts:3445](https://github.com/camunda/orchestration-clu processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:3394](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3394) +Defined in: [gen/types.gen.ts:4016](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4016) The bpmn process ID of the job's process definition. @@ -117,7 +119,7 @@ The bpmn process ID of the job's process definition. processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:3442](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3442) +Defined in: [gen/types.gen.ts:4064](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4064) The key of the job's process definition. @@ -129,7 +131,7 @@ The key of the job's process definition. processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:3398](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3398) +Defined in: [gen/types.gen.ts:4020](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4020) The version of the job's process definition. @@ -141,7 +143,7 @@ The version of the job's process definition. processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:3438](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3438) +Defined in: [gen/types.gen.ts:4060](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4060) The job's process instance key. @@ -153,19 +155,33 @@ The job's process instance key. retries: number; ``` -Defined in: [gen/types.gen.ts:3416](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3416) +Defined in: [gen/types.gen.ts:4038](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4038) The amount of retries left to this job (should always be positive). --- -### tags? +### rootProcessInstanceKey + +```ts +rootProcessInstanceKey: ProcessInstanceKey | null; +``` + +Defined in: [gen/types.gen.ts:4084](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4084) + +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. + +--- + +### tags ```ts -optional tags: TagSet; +tags: TagSet; ``` -Defined in: [gen/types.gen.ts:3447](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3447) +Defined in: [gen/types.gen.ts:4077](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4077) --- @@ -175,7 +191,7 @@ Defined in: [gen/types.gen.ts:3447](https://github.com/camunda/orchestration-clu tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:3430](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3430) +Defined in: [gen/types.gen.ts:4052](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4052) The ID of the tenant that owns the job. @@ -187,19 +203,22 @@ The ID of the tenant that owns the job. type: string; ``` -Defined in: [gen/types.gen.ts:3390](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3390) +Defined in: [gen/types.gen.ts:4012](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4012) The type of the job (should match what was requested). --- -### userTask? +### userTask ```ts -optional userTask: UserTaskProperties; +userTask: UserTaskProperties | null; ``` -Defined in: [gen/types.gen.ts:3446](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3446) +Defined in: [gen/types.gen.ts:4076](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4076) + +User task properties, if the job is a user task. +This is `null` if the job is not a user task. --- @@ -209,7 +228,7 @@ Defined in: [gen/types.gen.ts:3446](https://github.com/camunda/orchestration-clu variables: object; ``` -Defined in: [gen/types.gen.ts:3424](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3424) +Defined in: [gen/types.gen.ts:4046](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4046) All variables visible to the task scope, computed at activation time. @@ -227,6 +246,6 @@ All variables visible to the task scope, computed at activation time. worker: string; ``` -Defined in: [gen/types.gen.ts:3412](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3412) +Defined in: [gen/types.gen.ts:4034](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4034) The name of the worker which activated this job. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdHocSubProcessActivateActivitiesInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdHocSubProcessActivateActivitiesInstruction.md index 942f15c9598..47637f76bc1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdHocSubProcessActivateActivitiesInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdHocSubProcessActivateActivitiesInstruction.md @@ -11,7 +11,7 @@ mdx: type AdHocSubProcessActivateActivitiesInstruction = object; ``` -Defined in: [gen/types.gen.ts:2559](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2559) +Defined in: [gen/types.gen.ts:2704](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2704) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2559](https://github.com/camunda/orchestration-clu optional cancelRemainingInstances: boolean; ``` -Defined in: [gen/types.gen.ts:2567](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2567) +Defined in: [gen/types.gen.ts:2712](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2712) Whether to cancel remaining instances of the ad-hoc sub-process. @@ -33,6 +33,6 @@ Whether to cancel remaining instances of the ad-hoc sub-process. elements: AdHocSubProcessActivateActivityReference[]; ``` -Defined in: [gen/types.gen.ts:2563](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2563) +Defined in: [gen/types.gen.ts:2708](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2708) Activities to activate. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdHocSubProcessActivateActivityReference.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdHocSubProcessActivateActivityReference.md index 655d3c151b1..d6ee0441654 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdHocSubProcessActivateActivityReference.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdHocSubProcessActivateActivityReference.md @@ -11,7 +11,7 @@ mdx: type AdHocSubProcessActivateActivityReference = object; ``` -Defined in: [gen/types.gen.ts:2570](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2570) +Defined in: [gen/types.gen.ts:2715](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2715) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2570](https://github.com/camunda/orchestration-clu elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:2574](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2574) +Defined in: [gen/types.gen.ts:2719](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2719) The ID of the element that should be activated. @@ -33,7 +33,7 @@ The ID of the element that should be activated. optional variables: object; ``` -Defined in: [gen/types.gen.ts:2578](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2578) +Defined in: [gen/types.gen.ts:2723](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2723) Variables to be set when activating the element. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedActorTypeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedActorTypeFilter.md index afb93a4613b..be4b272da08 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedActorTypeFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedActorTypeFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedActorTypeFilter = object; ``` -Defined in: [gen/types.gen.ts:468](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L468) +Defined in: [gen/types.gen.ts:481](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L481) Advanced filter @@ -25,7 +25,7 @@ Advanced AuditLogActorTypeEnum filter. optional $eq: AuditLogActorTypeEnum; ``` -Defined in: [gen/types.gen.ts:472](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L472) +Defined in: [gen/types.gen.ts:485](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L485) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:480](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L480) +Defined in: [gen/types.gen.ts:493](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L493) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: AuditLogActorTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:484](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L484) +Defined in: [gen/types.gen.ts:497](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L497) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:485](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L485) +Defined in: [gen/types.gen.ts:498](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L498) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:485](https://github.com/camunda/orchestration-clus optional $neq: AuditLogActorTypeEnum; ``` -Defined in: [gen/types.gen.ts:476](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L476) +Defined in: [gen/types.gen.ts:489](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L489) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedAuditLogEntityKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedAuditLogEntityKeyFilter.md index 313710fad26..cb1e330eeb3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedAuditLogEntityKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedAuditLogEntityKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedAuditLogEntityKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:315](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L315) +Defined in: [gen/types.gen.ts:328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L328) Advanced filter @@ -25,7 +25,7 @@ Advanced entityKey filter. optional $eq: AuditLogEntityKey; ``` -Defined in: [gen/types.gen.ts:319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L319) +Defined in: [gen/types.gen.ts:332](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L332) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:327](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L327) +Defined in: [gen/types.gen.ts:340](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L340) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: AuditLogEntityKey[]; ``` -Defined in: [gen/types.gen.ts:331](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L331) +Defined in: [gen/types.gen.ts:344](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L344) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: AuditLogEntityKey; ``` -Defined in: [gen/types.gen.ts:323](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L323) +Defined in: [gen/types.gen.ts:336](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L336) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: AuditLogEntityKey[]; ``` -Defined in: [gen/types.gen.ts:335](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L335) +Defined in: [gen/types.gen.ts:348](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L348) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedAuditLogKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedAuditLogKeyFilter.md index f0f710eec13..2c570419924 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedAuditLogKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedAuditLogKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedAuditLogKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4377](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4377) +Defined in: [gen/types.gen.ts:5018](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5018) Advanced filter @@ -25,7 +25,7 @@ Advanced AuditLogKey filter. optional $eq: AuditLogKey; ``` -Defined in: [gen/types.gen.ts:4381](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4381) +Defined in: [gen/types.gen.ts:5022](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5022) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4389](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4389) +Defined in: [gen/types.gen.ts:5030](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5030) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: AuditLogKey[]; ``` -Defined in: [gen/types.gen.ts:4393](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4393) +Defined in: [gen/types.gen.ts:5034](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5034) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: AuditLogKey; ``` -Defined in: [gen/types.gen.ts:4385](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4385) +Defined in: [gen/types.gen.ts:5026](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5026) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: AuditLogKey[]; ``` -Defined in: [gen/types.gen.ts:4397](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4397) +Defined in: [gen/types.gen.ts:5038](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5038) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationItemStateFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationItemStateFilter.md index 2aeb1fc2312..ad971c7b6c4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationItemStateFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationItemStateFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedBatchOperationItemStateFilter = object; ``` -Defined in: [gen/types.gen.ts:1081](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1081) +Defined in: [gen/types.gen.ts:1112](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1112) Advanced filter @@ -25,7 +25,7 @@ Advanced BatchOperationItemStateEnum filter. optional $eq: BatchOperationItemStateEnum; ``` -Defined in: [gen/types.gen.ts:1085](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1085) +Defined in: [gen/types.gen.ts:1116](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1116) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:1093](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1093) +Defined in: [gen/types.gen.ts:1124](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1124) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: BatchOperationItemStateEnum[]; ``` -Defined in: [gen/types.gen.ts:1097](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1097) +Defined in: [gen/types.gen.ts:1128](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1128) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:1098](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1098) +Defined in: [gen/types.gen.ts:1129](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1129) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:1098](https://github.com/camunda/orchestration-clu optional $neq: BatchOperationItemStateEnum; ``` -Defined in: [gen/types.gen.ts:1089](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1089) +Defined in: [gen/types.gen.ts:1120](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1120) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationStateFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationStateFilter.md index 4b560748690..7d2a7e2496f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationStateFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationStateFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedBatchOperationStateFilter = object; ``` -Defined in: [gen/types.gen.ts:1051](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1051) +Defined in: [gen/types.gen.ts:1082](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1082) Advanced filter @@ -25,7 +25,7 @@ Advanced BatchOperationStateEnum filter. optional $eq: BatchOperationStateEnum; ``` -Defined in: [gen/types.gen.ts:1055](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1055) +Defined in: [gen/types.gen.ts:1086](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1086) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:1063](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1063) +Defined in: [gen/types.gen.ts:1094](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1094) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: BatchOperationStateEnum[]; ``` -Defined in: [gen/types.gen.ts:1067](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1067) +Defined in: [gen/types.gen.ts:1098](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1098) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:1068](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1068) +Defined in: [gen/types.gen.ts:1099](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1099) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:1068](https://github.com/camunda/orchestration-clu optional $neq: BatchOperationStateEnum; ``` -Defined in: [gen/types.gen.ts:1059](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1059) +Defined in: [gen/types.gen.ts:1090](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1090) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationTypeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationTypeFilter.md index 89221f31dd1..1b5d6095c53 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationTypeFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedBatchOperationTypeFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedBatchOperationTypeFilter = object; ``` -Defined in: [gen/types.gen.ts:1021](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1021) +Defined in: [gen/types.gen.ts:1052](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1052) Advanced filter @@ -25,7 +25,7 @@ Advanced BatchOperationTypeEnum filter. optional $eq: BatchOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:1025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1025) +Defined in: [gen/types.gen.ts:1056](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1056) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:1033](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1033) +Defined in: [gen/types.gen.ts:1064](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1064) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: BatchOperationTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:1037](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1037) +Defined in: [gen/types.gen.ts:1068](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1068) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:1038](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1038) +Defined in: [gen/types.gen.ts:1069](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1069) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:1038](https://github.com/camunda/orchestration-clu optional $neq: BatchOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:1029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1029) +Defined in: [gen/types.gen.ts:1060](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1060) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedCategoryFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedCategoryFilter.md index 96b7666242f..a6d7fb19e85 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedCategoryFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedCategoryFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedCategoryFilter = object; ``` -Defined in: [gen/types.gen.ts:408](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L408) +Defined in: [gen/types.gen.ts:421](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L421) Advanced filter @@ -25,7 +25,7 @@ Advanced AuditLogCategoryEnum filter. optional $eq: AuditLogCategoryEnum; ``` -Defined in: [gen/types.gen.ts:412](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L412) +Defined in: [gen/types.gen.ts:425](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L425) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:420](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L420) +Defined in: [gen/types.gen.ts:433](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L433) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: AuditLogCategoryEnum[]; ``` -Defined in: [gen/types.gen.ts:424](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L424) +Defined in: [gen/types.gen.ts:437](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L437) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:425](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L425) +Defined in: [gen/types.gen.ts:438](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L438) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:425](https://github.com/camunda/orchestration-clus optional $neq: AuditLogCategoryEnum; ``` -Defined in: [gen/types.gen.ts:416](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L416) +Defined in: [gen/types.gen.ts:429](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L429) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedClusterVariableScopeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedClusterVariableScopeFilter.md index da0823590a6..a4e2889a2ea 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedClusterVariableScopeFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedClusterVariableScopeFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedClusterVariableScopeFilter = object; ``` -Defined in: [gen/types.gen.ts:1230](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1230) +Defined in: [gen/types.gen.ts:1261](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1261) Advanced filter @@ -25,7 +25,7 @@ Advanced ClusterVariableScopeEnum filter. optional $eq: ClusterVariableScopeEnum; ``` -Defined in: [gen/types.gen.ts:1234](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1234) +Defined in: [gen/types.gen.ts:1265](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1265) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:1242](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1242) +Defined in: [gen/types.gen.ts:1273](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1273) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: ClusterVariableScopeEnum[]; ``` -Defined in: [gen/types.gen.ts:1246](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1246) +Defined in: [gen/types.gen.ts:1277](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1277) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:1247](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1247) +Defined in: [gen/types.gen.ts:1278](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1278) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:1247](https://github.com/camunda/orchestration-clu optional $neq: ClusterVariableScopeEnum; ``` -Defined in: [gen/types.gen.ts:1238](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1238) +Defined in: [gen/types.gen.ts:1269](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1269) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDateTimeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDateTimeFilter.md index 402f222e2c0..e04305bf441 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDateTimeFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDateTimeFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedDateTimeFilter = object; ``` -Defined in: [gen/types.gen.ts:2719](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2719) +Defined in: [gen/types.gen.ts:2877](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2877) Advanced filter @@ -25,7 +25,7 @@ Advanced date-time filter. optional $eq: string; ``` -Defined in: [gen/types.gen.ts:2723](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2723) +Defined in: [gen/types.gen.ts:2881](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2881) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:2731](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2731) +Defined in: [gen/types.gen.ts:2889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2889) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $gt: string; ``` -Defined in: [gen/types.gen.ts:2735](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2735) +Defined in: [gen/types.gen.ts:2893](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2893) Greater than comparison with the provided value. @@ -61,7 +61,7 @@ Greater than comparison with the provided value. optional $gte: string; ``` -Defined in: [gen/types.gen.ts:2739](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2739) +Defined in: [gen/types.gen.ts:2897](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2897) Greater than or equal comparison with the provided value. @@ -73,7 +73,7 @@ Greater than or equal comparison with the provided value. optional $in: string[]; ``` -Defined in: [gen/types.gen.ts:2751](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2751) +Defined in: [gen/types.gen.ts:2909](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2909) Checks if the property matches any of the provided values. @@ -85,7 +85,7 @@ Checks if the property matches any of the provided values. optional $lt: string; ``` -Defined in: [gen/types.gen.ts:2743](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2743) +Defined in: [gen/types.gen.ts:2901](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2901) Lower than comparison with the provided value. @@ -97,7 +97,7 @@ Lower than comparison with the provided value. optional $lte: string; ``` -Defined in: [gen/types.gen.ts:2747](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2747) +Defined in: [gen/types.gen.ts:2905](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2905) Lower than or equal comparison with the provided value. @@ -109,6 +109,6 @@ Lower than or equal comparison with the provided value. optional $neq: string; ``` -Defined in: [gen/types.gen.ts:2727](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2727) +Defined in: [gen/types.gen.ts:2885](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2885) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionDefinitionKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionDefinitionKeyFilter.md index d016ea5d0e4..426ef675745 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionDefinitionKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionDefinitionKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedDecisionDefinitionKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4245](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4245) +Defined in: [gen/types.gen.ts:4884](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4884) Advanced filter @@ -25,7 +25,7 @@ Advanced DecisionDefinitionKey filter. optional $eq: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:4249](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4249) +Defined in: [gen/types.gen.ts:4888](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4888) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4257](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4257) +Defined in: [gen/types.gen.ts:4896](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4896) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: DecisionDefinitionKey[]; ``` -Defined in: [gen/types.gen.ts:4261](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4261) +Defined in: [gen/types.gen.ts:4900](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4900) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:4253](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4253) +Defined in: [gen/types.gen.ts:4892](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4892) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: DecisionDefinitionKey[]; ``` -Defined in: [gen/types.gen.ts:4265](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4265) +Defined in: [gen/types.gen.ts:4904](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4904) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionEvaluationInstanceKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionEvaluationInstanceKeyFilter.md index 6f232f2103a..064129f7f85 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionEvaluationInstanceKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionEvaluationInstanceKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedDecisionEvaluationInstanceKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4344](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4344) +Defined in: [gen/types.gen.ts:4985](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4985) Advanced filter @@ -25,7 +25,7 @@ Advanced DecisionEvaluationInstanceKey filter. optional $eq: DecisionEvaluationInstanceKey; ``` -Defined in: [gen/types.gen.ts:4348](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4348) +Defined in: [gen/types.gen.ts:4989](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4989) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4356](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4356) +Defined in: [gen/types.gen.ts:4997](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4997) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: DecisionEvaluationInstanceKey[]; ``` -Defined in: [gen/types.gen.ts:4360](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4360) +Defined in: [gen/types.gen.ts:5001](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5001) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: DecisionEvaluationInstanceKey; ``` -Defined in: [gen/types.gen.ts:4352](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4352) +Defined in: [gen/types.gen.ts:4993](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4993) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: DecisionEvaluationInstanceKey[]; ``` -Defined in: [gen/types.gen.ts:4364](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4364) +Defined in: [gen/types.gen.ts:5005](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5005) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionEvaluationKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionEvaluationKeyFilter.md index e699cb3c892..9ddf147acda 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionEvaluationKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionEvaluationKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedDecisionEvaluationKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4443](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4443) +Defined in: [gen/types.gen.ts:5084](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5084) Advanced filter @@ -25,7 +25,7 @@ Advanced DecisionEvaluationKey filter. optional $eq: DecisionEvaluationKey; ``` -Defined in: [gen/types.gen.ts:4447](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4447) +Defined in: [gen/types.gen.ts:5088](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5088) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4455](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4455) +Defined in: [gen/types.gen.ts:5096](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5096) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: DecisionEvaluationKey[]; ``` -Defined in: [gen/types.gen.ts:4459](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4459) +Defined in: [gen/types.gen.ts:5100](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5100) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: DecisionEvaluationKey; ``` -Defined in: [gen/types.gen.ts:4451](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4451) +Defined in: [gen/types.gen.ts:5092](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5092) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: DecisionEvaluationKey[]; ``` -Defined in: [gen/types.gen.ts:4463](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4463) +Defined in: [gen/types.gen.ts:5104](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5104) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionInstanceStateFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionInstanceStateFilter.md index 19ea44bc6fb..5159fa94685 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionInstanceStateFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionInstanceStateFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedDecisionInstanceStateFilter = object; ``` -Defined in: [gen/types.gen.ts:1884](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1884) +Defined in: [gen/types.gen.ts:1945](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1945) Advanced filter @@ -25,7 +25,7 @@ Advanced DecisionInstanceStateEnum filter. optional $eq: DecisionInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:1888](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1888) +Defined in: [gen/types.gen.ts:1949](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1949) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:1896](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1896) +Defined in: [gen/types.gen.ts:1957](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1957) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: DecisionInstanceStateEnum[]; ``` -Defined in: [gen/types.gen.ts:1900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1900) +Defined in: [gen/types.gen.ts:1961](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1961) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:1905](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1905) +Defined in: [gen/types.gen.ts:1966](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1966) --- @@ -71,7 +71,7 @@ Defined in: [gen/types.gen.ts:1905](https://github.com/camunda/orchestration-clu optional $neq: DecisionInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:1892](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1892) +Defined in: [gen/types.gen.ts:1953](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1953) Checks for inequality with the provided value. @@ -83,6 +83,6 @@ Checks for inequality with the provided value. optional $notIn: DecisionInstanceStateEnum[]; ``` -Defined in: [gen/types.gen.ts:1904](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1904) +Defined in: [gen/types.gen.ts:1965](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1965) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionRequirementsKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionRequirementsKeyFilter.md index 10a6391f567..22c35436310 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionRequirementsKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDecisionRequirementsKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedDecisionRequirementsKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4476](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4476) +Defined in: [gen/types.gen.ts:5117](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5117) Advanced filter @@ -25,7 +25,7 @@ Advanced DecisionRequirementsKey filter. optional $eq: DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:4480](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4480) +Defined in: [gen/types.gen.ts:5121](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5121) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4488](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4488) +Defined in: [gen/types.gen.ts:5129](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5129) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: DecisionRequirementsKey[]; ``` -Defined in: [gen/types.gen.ts:4492](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4492) +Defined in: [gen/types.gen.ts:5133](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5133) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:4484](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4484) +Defined in: [gen/types.gen.ts:5125](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5125) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: DecisionRequirementsKey[]; ``` -Defined in: [gen/types.gen.ts:4496](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4496) +Defined in: [gen/types.gen.ts:5137](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5137) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDeploymentKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDeploymentKeyFilter.md index 9d0f3e1684d..12fc9889239 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDeploymentKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedDeploymentKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedDeploymentKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:2213](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2213) +Defined in: [gen/types.gen.ts:2316](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2316) Advanced filter @@ -25,7 +25,7 @@ Advanced DeploymentKey filter. optional $eq: DeploymentKey; ``` -Defined in: [gen/types.gen.ts:2217](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2217) +Defined in: [gen/types.gen.ts:2320](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2320) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:2225](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2225) +Defined in: [gen/types.gen.ts:2328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2328) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: DeploymentKey[]; ``` -Defined in: [gen/types.gen.ts:2229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2229) +Defined in: [gen/types.gen.ts:2332](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2332) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: DeploymentKey; ``` -Defined in: [gen/types.gen.ts:2221](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2221) +Defined in: [gen/types.gen.ts:2324](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2324) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: DeploymentKey[]; ``` -Defined in: [gen/types.gen.ts:2233](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2233) +Defined in: [gen/types.gen.ts:2336](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2336) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedElementInstanceKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedElementInstanceKeyFilter.md index 079bd9d1840..bf725d890c6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedElementInstanceKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedElementInstanceKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedElementInstanceKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4179](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4179) +Defined in: [gen/types.gen.ts:4818](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4818) Advanced filter @@ -25,7 +25,7 @@ Advanced ElementInstanceKey filter. optional $eq: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:4183](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4183) +Defined in: [gen/types.gen.ts:4822](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4822) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4191](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4191) +Defined in: [gen/types.gen.ts:4830](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4830) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: ElementInstanceKey[]; ``` -Defined in: [gen/types.gen.ts:4195](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4195) +Defined in: [gen/types.gen.ts:4834](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4834) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:4187](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4187) +Defined in: [gen/types.gen.ts:4826](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4826) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: ElementInstanceKey[]; ``` -Defined in: [gen/types.gen.ts:4199](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4199) +Defined in: [gen/types.gen.ts:4838](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4838) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedElementInstanceStateFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedElementInstanceStateFilter.md index 64c2191aeab..246d49dd3ef 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedElementInstanceStateFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedElementInstanceStateFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedElementInstanceStateFilter = object; ``` -Defined in: [gen/types.gen.ts:2471](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2471) +Defined in: [gen/types.gen.ts:2610](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2610) Advanced filter @@ -25,7 +25,7 @@ Advanced ElementInstanceStateEnum filter. optional $eq: ElementInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:2475](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2475) +Defined in: [gen/types.gen.ts:2614](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2614) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:2483](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2483) +Defined in: [gen/types.gen.ts:2622](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2622) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: ElementInstanceStateEnum[]; ``` -Defined in: [gen/types.gen.ts:2487](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2487) +Defined in: [gen/types.gen.ts:2626](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2626) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:2488](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2488) +Defined in: [gen/types.gen.ts:2627](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2627) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:2488](https://github.com/camunda/orchestration-clu optional $neq: ElementInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:2479](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2479) +Defined in: [gen/types.gen.ts:2618](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2618) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedEntityTypeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedEntityTypeFilter.md index 1b4833e3483..8ec1566c37f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedEntityTypeFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedEntityTypeFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedEntityTypeFilter = object; ``` -Defined in: [gen/types.gen.ts:348](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L348) +Defined in: [gen/types.gen.ts:361](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L361) Advanced filter @@ -25,7 +25,7 @@ Advanced AuditLogEntityTypeEnum filter. optional $eq: AuditLogEntityTypeEnum; ``` -Defined in: [gen/types.gen.ts:352](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L352) +Defined in: [gen/types.gen.ts:365](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L365) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:360](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L360) +Defined in: [gen/types.gen.ts:373](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L373) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: AuditLogEntityTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:364](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L364) +Defined in: [gen/types.gen.ts:377](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L377) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:365](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L365) +Defined in: [gen/types.gen.ts:378](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L378) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:365](https://github.com/camunda/orchestration-clus optional $neq: AuditLogEntityTypeEnum; ``` -Defined in: [gen/types.gen.ts:356](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L356) +Defined in: [gen/types.gen.ts:369](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L369) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedFormKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedFormKeyFilter.md index 92b1088c198..a1df993d037 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedFormKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedFormKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedFormKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4410](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4410) +Defined in: [gen/types.gen.ts:5051](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5051) Advanced filter @@ -25,7 +25,7 @@ Advanced FormKey filter. optional $eq: FormKey; ``` -Defined in: [gen/types.gen.ts:4414](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4414) +Defined in: [gen/types.gen.ts:5055](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5055) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4422](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4422) +Defined in: [gen/types.gen.ts:5063](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5063) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: FormKey[]; ``` -Defined in: [gen/types.gen.ts:4426](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4426) +Defined in: [gen/types.gen.ts:5067](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5067) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: FormKey; ``` -Defined in: [gen/types.gen.ts:4418](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4418) +Defined in: [gen/types.gen.ts:5059](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5059) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: FormKey[]; ``` -Defined in: [gen/types.gen.ts:4430](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4430) +Defined in: [gen/types.gen.ts:5071](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5071) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedGlobalListenerSourceFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedGlobalListenerSourceFilter.md new file mode 100644 index 00000000000..4f588d50ac6 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedGlobalListenerSourceFilter.md @@ -0,0 +1,76 @@ +--- +title: "Type Alias: AdvancedGlobalListenerSourceFilter" +sidebar_label: "AdvancedGlobalListenerSourceFilter" +mdx: + format: md +--- + +# Type Alias: AdvancedGlobalListenerSourceFilter + +```ts +type AdvancedGlobalListenerSourceFilter = object; +``` + +Defined in: [gen/types.gen.ts:3057](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3057) + +Advanced filter + +Advanced global listener source filter. + +## Properties + +### $eq? + +```ts +optional $eq: GlobalListenerSourceEnum; +``` + +Defined in: [gen/types.gen.ts:3061](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3061) + +Checks for equality with the provided value. + +--- + +### $exists? + +```ts +optional $exists: boolean; +``` + +Defined in: [gen/types.gen.ts:3069](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3069) + +Checks if the current property exists. + +--- + +### $in? + +```ts +optional $in: GlobalListenerSourceEnum[]; +``` + +Defined in: [gen/types.gen.ts:3073](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3073) + +Checks if the property matches any of the provided values. + +--- + +### $like? + +```ts +optional $like: LikeFilter; +``` + +Defined in: [gen/types.gen.ts:3074](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3074) + +--- + +### $neq? + +```ts +optional $neq: GlobalListenerSourceEnum; +``` + +Defined in: [gen/types.gen.ts:3065](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3065) + +Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedGlobalTaskListenerEventTypeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedGlobalTaskListenerEventTypeFilter.md new file mode 100644 index 00000000000..d6fe8a525fc --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedGlobalTaskListenerEventTypeFilter.md @@ -0,0 +1,76 @@ +--- +title: "Type Alias: AdvancedGlobalTaskListenerEventTypeFilter" +sidebar_label: "AdvancedGlobalTaskListenerEventTypeFilter" +mdx: + format: md +--- + +# Type Alias: AdvancedGlobalTaskListenerEventTypeFilter + +```ts +type AdvancedGlobalTaskListenerEventTypeFilter = object; +``` + +Defined in: [gen/types.gen.ts:3087](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3087) + +Advanced filter + +Advanced global listener event type filter. + +## Properties + +### $eq? + +```ts +optional $eq: GlobalTaskListenerEventTypeEnum; +``` + +Defined in: [gen/types.gen.ts:3091](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3091) + +Checks for equality with the provided value. + +--- + +### $exists? + +```ts +optional $exists: boolean; +``` + +Defined in: [gen/types.gen.ts:3099](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3099) + +Checks if the current property exists. + +--- + +### $in? + +```ts +optional $in: GlobalTaskListenerEventTypeEnum[]; +``` + +Defined in: [gen/types.gen.ts:3103](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3103) + +Checks if the property matches any of the provided values. + +--- + +### $like? + +```ts +optional $like: LikeFilter; +``` + +Defined in: [gen/types.gen.ts:3104](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3104) + +--- + +### $neq? + +```ts +optional $neq: GlobalTaskListenerEventTypeEnum; +``` + +Defined in: [gen/types.gen.ts:3095](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3095) + +Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIncidentErrorTypeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIncidentErrorTypeFilter.md index 0fd607d2e8f..2d5262a2561 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIncidentErrorTypeFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIncidentErrorTypeFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedIncidentErrorTypeFilter = object; ``` -Defined in: [gen/types.gen.ts:3074](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3074) +Defined in: [gen/types.gen.ts:3436](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3436) Advanced filter @@ -25,7 +25,7 @@ Advanced IncidentErrorTypeEnum filter optional $eq: IncidentErrorTypeEnum; ``` -Defined in: [gen/types.gen.ts:3078](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3078) +Defined in: [gen/types.gen.ts:3440](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3440) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:3086](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3086) +Defined in: [gen/types.gen.ts:3448](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3448) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: IncidentErrorTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:3090](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3090) +Defined in: [gen/types.gen.ts:3452](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3452) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:3095](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3095) +Defined in: [gen/types.gen.ts:3457](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3457) --- @@ -71,7 +71,7 @@ Defined in: [gen/types.gen.ts:3095](https://github.com/camunda/orchestration-clu optional $neq: IncidentErrorTypeEnum; ``` -Defined in: [gen/types.gen.ts:3082](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3082) +Defined in: [gen/types.gen.ts:3444](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3444) Checks for inequality with the provided value. @@ -83,6 +83,6 @@ Checks for inequality with the provided value. optional $notIn: IncidentErrorTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:3094](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3094) +Defined in: [gen/types.gen.ts:3456](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3456) Checks if the property does not match any of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIncidentStateFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIncidentStateFilter.md index 6c56ef91d1b..b1dbb9af0b2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIncidentStateFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIncidentStateFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedIncidentStateFilter = object; ``` -Defined in: [gen/types.gen.ts:3113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3113) +Defined in: [gen/types.gen.ts:3475](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3475) Advanced filter @@ -25,7 +25,7 @@ Advanced IncidentStateEnum filter optional $eq: IncidentStateEnum; ``` -Defined in: [gen/types.gen.ts:3117](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3117) +Defined in: [gen/types.gen.ts:3479](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3479) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:3125](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3125) +Defined in: [gen/types.gen.ts:3487](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3487) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: IncidentStateEnum[]; ``` -Defined in: [gen/types.gen.ts:3129](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3129) +Defined in: [gen/types.gen.ts:3491](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3491) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:3134](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3134) +Defined in: [gen/types.gen.ts:3496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3496) --- @@ -71,7 +71,7 @@ Defined in: [gen/types.gen.ts:3134](https://github.com/camunda/orchestration-clu optional $neq: IncidentStateEnum; ``` -Defined in: [gen/types.gen.ts:3121](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3121) +Defined in: [gen/types.gen.ts:3483](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3483) Checks for inequality with the provided value. @@ -83,6 +83,6 @@ Checks for inequality with the provided value. optional $notIn: IncidentStateEnum[]; ``` -Defined in: [gen/types.gen.ts:3133](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3133) +Defined in: [gen/types.gen.ts:3495](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3495) Checks if the property does not match any of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIntegerFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIntegerFilter.md index 16cca6f94df..e2b6ed9a146 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIntegerFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedIntegerFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedIntegerFilter = object; ``` -Defined in: [gen/types.gen.ts:2674](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2674) +Defined in: [gen/types.gen.ts:2832](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2832) Advanced filter @@ -25,7 +25,7 @@ Advanced integer (int32) filter. optional $eq: number; ``` -Defined in: [gen/types.gen.ts:2678](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2678) +Defined in: [gen/types.gen.ts:2836](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2836) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:2686](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2686) +Defined in: [gen/types.gen.ts:2844](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2844) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $gt: number; ``` -Defined in: [gen/types.gen.ts:2690](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2690) +Defined in: [gen/types.gen.ts:2848](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2848) Greater than comparison with the provided value. @@ -61,7 +61,7 @@ Greater than comparison with the provided value. optional $gte: number; ``` -Defined in: [gen/types.gen.ts:2694](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2694) +Defined in: [gen/types.gen.ts:2852](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2852) Greater than or equal comparison with the provided value. @@ -73,7 +73,7 @@ Greater than or equal comparison with the provided value. optional $in: number[]; ``` -Defined in: [gen/types.gen.ts:2706](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2706) +Defined in: [gen/types.gen.ts:2864](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2864) Checks if the property matches any of the provided values. @@ -85,7 +85,7 @@ Checks if the property matches any of the provided values. optional $lt: number; ``` -Defined in: [gen/types.gen.ts:2698](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2698) +Defined in: [gen/types.gen.ts:2856](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2856) Lower than comparison with the provided value. @@ -97,7 +97,7 @@ Lower than comparison with the provided value. optional $lte: number; ``` -Defined in: [gen/types.gen.ts:2702](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2702) +Defined in: [gen/types.gen.ts:2860](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2860) Lower than or equal comparison with the provided value. @@ -109,6 +109,6 @@ Lower than or equal comparison with the provided value. optional $neq: number; ``` -Defined in: [gen/types.gen.ts:2682](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2682) +Defined in: [gen/types.gen.ts:2840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2840) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobKeyFilter.md index 3f5ec4abfed..49381e07f4c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedJobKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4212](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4212) +Defined in: [gen/types.gen.ts:4851](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4851) Advanced filter @@ -25,7 +25,7 @@ Advanced JobKey filter. optional $eq: JobKey; ``` -Defined in: [gen/types.gen.ts:4216](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4216) +Defined in: [gen/types.gen.ts:4855](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4855) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4224](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4224) +Defined in: [gen/types.gen.ts:4863](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4863) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: JobKey[]; ``` -Defined in: [gen/types.gen.ts:4228](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4228) +Defined in: [gen/types.gen.ts:4867](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4867) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: JobKey; ``` -Defined in: [gen/types.gen.ts:4220](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4220) +Defined in: [gen/types.gen.ts:4859](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4859) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: JobKey[]; ``` -Defined in: [gen/types.gen.ts:4232](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4232) +Defined in: [gen/types.gen.ts:4871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4871) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobKindFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobKindFilter.md index 3ab36dfdd0c..de43bdcde66 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobKindFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobKindFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedJobKindFilter = object; ``` -Defined in: [gen/types.gen.ts:3923](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3923) +Defined in: [gen/types.gen.ts:4568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4568) Advanced filter @@ -25,7 +25,7 @@ Advanced JobKindEnum filter. optional $eq: JobKindEnum; ``` -Defined in: [gen/types.gen.ts:3927](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3927) +Defined in: [gen/types.gen.ts:4572](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4572) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:3935](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3935) +Defined in: [gen/types.gen.ts:4580](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4580) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: JobKindEnum[]; ``` -Defined in: [gen/types.gen.ts:3939](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3939) +Defined in: [gen/types.gen.ts:4584](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4584) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:3940](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3940) +Defined in: [gen/types.gen.ts:4585](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4585) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:3940](https://github.com/camunda/orchestration-clu optional $neq: JobKindEnum; ``` -Defined in: [gen/types.gen.ts:3931](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3931) +Defined in: [gen/types.gen.ts:4576](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4576) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobListenerEventTypeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobListenerEventTypeFilter.md index 3dcf80c5798..06b123b4c84 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobListenerEventTypeFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobListenerEventTypeFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedJobListenerEventTypeFilter = object; ``` -Defined in: [gen/types.gen.ts:3953](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3953) +Defined in: [gen/types.gen.ts:4598](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4598) Advanced filter @@ -25,7 +25,7 @@ Advanced JobListenerEventTypeEnum filter. optional $eq: JobListenerEventTypeEnum; ``` -Defined in: [gen/types.gen.ts:3957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3957) +Defined in: [gen/types.gen.ts:4602](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4602) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:3965](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3965) +Defined in: [gen/types.gen.ts:4610](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4610) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: JobListenerEventTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:3969](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3969) +Defined in: [gen/types.gen.ts:4614](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4614) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:3970](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3970) +Defined in: [gen/types.gen.ts:4615](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4615) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:3970](https://github.com/camunda/orchestration-clu optional $neq: JobListenerEventTypeEnum; ``` -Defined in: [gen/types.gen.ts:3961](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3961) +Defined in: [gen/types.gen.ts:4606](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4606) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobStateFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobStateFilter.md index 3643e5d6806..74f545b3200 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobStateFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedJobStateFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedJobStateFilter = object; ``` -Defined in: [gen/types.gen.ts:3983](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3983) +Defined in: [gen/types.gen.ts:4628](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4628) Advanced filter @@ -25,7 +25,7 @@ Advanced JobStateEnum filter. optional $eq: JobStateEnum; ``` -Defined in: [gen/types.gen.ts:3987](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3987) +Defined in: [gen/types.gen.ts:4632](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4632) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:3995](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3995) +Defined in: [gen/types.gen.ts:4640](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4640) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: JobStateEnum[]; ``` -Defined in: [gen/types.gen.ts:3999](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3999) +Defined in: [gen/types.gen.ts:4644](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4644) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:4000](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4000) +Defined in: [gen/types.gen.ts:4645](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4645) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:4000](https://github.com/camunda/orchestration-clu optional $neq: JobStateEnum; ``` -Defined in: [gen/types.gen.ts:3991](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3991) +Defined in: [gen/types.gen.ts:4636](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4636) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedMessageSubscriptionKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedMessageSubscriptionKeyFilter.md index 0a3b514a69c..0a00e03b3dd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedMessageSubscriptionKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedMessageSubscriptionKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedMessageSubscriptionKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:5012](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5012) +Defined in: [gen/types.gen.ts:5667](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5667) Advanced filter @@ -25,7 +25,7 @@ Advanced MessageSubscriptionKey filter. optional $eq: MessageSubscriptionKey; ``` -Defined in: [gen/types.gen.ts:5016](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5016) +Defined in: [gen/types.gen.ts:5671](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5671) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:5024](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5024) +Defined in: [gen/types.gen.ts:5679](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5679) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: MessageSubscriptionKey[]; ``` -Defined in: [gen/types.gen.ts:5028](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5028) +Defined in: [gen/types.gen.ts:5683](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5683) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: MessageSubscriptionKey; ``` -Defined in: [gen/types.gen.ts:5020](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5020) +Defined in: [gen/types.gen.ts:5675](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5675) Checks for equality with the provided value. @@ -73,6 +73,6 @@ Checks for equality with the provided value. optional $notIn: MessageSubscriptionKey[]; ``` -Defined in: [gen/types.gen.ts:5032](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5032) +Defined in: [gen/types.gen.ts:5687](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5687) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedMessageSubscriptionStateFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedMessageSubscriptionStateFilter.md index 22ea67c0a5b..c0a4a87eec4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedMessageSubscriptionStateFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedMessageSubscriptionStateFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedMessageSubscriptionStateFilter = object; ``` -Defined in: [gen/types.gen.ts:4987](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4987) +Defined in: [gen/types.gen.ts:5642](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5642) Advanced filter @@ -25,7 +25,7 @@ Advanced MessageSubscriptionStateEnum filter optional $eq: MessageSubscriptionStateEnum; ``` -Defined in: [gen/types.gen.ts:4991](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4991) +Defined in: [gen/types.gen.ts:5646](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5646) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4999](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4999) +Defined in: [gen/types.gen.ts:5654](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5654) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: MessageSubscriptionStateEnum[]; ``` -Defined in: [gen/types.gen.ts:5003](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5003) +Defined in: [gen/types.gen.ts:5658](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5658) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:5004](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5004) +Defined in: [gen/types.gen.ts:5659](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5659) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:5004](https://github.com/camunda/orchestration-clu optional $neq: MessageSubscriptionStateEnum; ``` -Defined in: [gen/types.gen.ts:4995](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4995) +Defined in: [gen/types.gen.ts:5650](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5650) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedOperationTypeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedOperationTypeFilter.md index 7399499f9fd..ddce59af904 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedOperationTypeFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedOperationTypeFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedOperationTypeFilter = object; ``` -Defined in: [gen/types.gen.ts:378](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L378) +Defined in: [gen/types.gen.ts:391](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L391) Advanced filter @@ -25,7 +25,7 @@ Advanced AuditLogOperationTypeEnum filter. optional $eq: AuditLogOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:382](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L382) +Defined in: [gen/types.gen.ts:395](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L395) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:390](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L390) +Defined in: [gen/types.gen.ts:403](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L403) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: AuditLogOperationTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:394](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L394) +Defined in: [gen/types.gen.ts:407](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L407) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:395](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L395) +Defined in: [gen/types.gen.ts:408](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L408) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:395](https://github.com/camunda/orchestration-clus optional $neq: AuditLogOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:386](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L386) +Defined in: [gen/types.gen.ts:399](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L399) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessDefinitionKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessDefinitionKeyFilter.md index 5cfe3b68ba7..61c0f1581f8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessDefinitionKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessDefinitionKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedProcessDefinitionKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4113) +Defined in: [gen/types.gen.ts:4752](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4752) Advanced filter @@ -25,7 +25,7 @@ Advanced ProcessDefinitionKey filter. optional $eq: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:4117](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4117) +Defined in: [gen/types.gen.ts:4756](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4756) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4125](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4125) +Defined in: [gen/types.gen.ts:4764](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4764) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: ProcessDefinitionKey[]; ``` -Defined in: [gen/types.gen.ts:4129](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4129) +Defined in: [gen/types.gen.ts:4768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4768) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:4121](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4121) +Defined in: [gen/types.gen.ts:4760](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4760) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: ProcessDefinitionKey[]; ``` -Defined in: [gen/types.gen.ts:4133](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4133) +Defined in: [gen/types.gen.ts:4772](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4772) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessInstanceKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessInstanceKeyFilter.md index a1a5b3b150d..1c99eb4555d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessInstanceKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessInstanceKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedProcessInstanceKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4146](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4146) +Defined in: [gen/types.gen.ts:4785](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4785) Advanced filter @@ -25,7 +25,7 @@ Advanced ProcessInstanceKey filter. optional $eq: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:4150](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4150) +Defined in: [gen/types.gen.ts:4789](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4789) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4158](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4158) +Defined in: [gen/types.gen.ts:4797](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4797) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: ProcessInstanceKey[]; ``` -Defined in: [gen/types.gen.ts:4162](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4162) +Defined in: [gen/types.gen.ts:4801](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4801) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:4154](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4154) +Defined in: [gen/types.gen.ts:4793](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4793) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: ProcessInstanceKey[]; ``` -Defined in: [gen/types.gen.ts:4166](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4166) +Defined in: [gen/types.gen.ts:4805](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4805) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessInstanceStateFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessInstanceStateFilter.md index 9b37076ca75..1f078d87869 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessInstanceStateFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedProcessInstanceStateFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedProcessInstanceStateFilter = object; ``` -Defined in: [gen/types.gen.ts:6165](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6165) +Defined in: [gen/types.gen.ts:6878](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6878) Advanced filter @@ -25,7 +25,7 @@ Advanced ProcessInstanceStateEnum filter. optional $eq: ProcessInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:6169](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6169) +Defined in: [gen/types.gen.ts:6882](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6882) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:6177](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6177) +Defined in: [gen/types.gen.ts:6890](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6890) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: ProcessInstanceStateEnum[]; ``` -Defined in: [gen/types.gen.ts:6181](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6181) +Defined in: [gen/types.gen.ts:6894](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6894) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:6182](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6182) +Defined in: [gen/types.gen.ts:6895](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6895) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:6182](https://github.com/camunda/orchestration-clu optional $neq: ProcessInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:6173](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6173) +Defined in: [gen/types.gen.ts:6886](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6886) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedResourceKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedResourceKeyFilter.md index 60ac5eb0528..2a35e459de3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedResourceKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedResourceKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedResourceKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:2246](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2246) +Defined in: [gen/types.gen.ts:2349](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2349) Advanced filter @@ -25,7 +25,7 @@ Advanced ResourceKey filter. optional $eq: ResourceKey; ``` -Defined in: [gen/types.gen.ts:2250](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2250) +Defined in: [gen/types.gen.ts:2353](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2353) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:2258](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2258) +Defined in: [gen/types.gen.ts:2361](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2361) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: ResourceKey[]; ``` -Defined in: [gen/types.gen.ts:2262](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2262) +Defined in: [gen/types.gen.ts:2365](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2365) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: ResourceKey; ``` -Defined in: [gen/types.gen.ts:2254](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2254) +Defined in: [gen/types.gen.ts:2357](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2357) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: ResourceKey[]; ``` -Defined in: [gen/types.gen.ts:2266](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2266) +Defined in: [gen/types.gen.ts:2369](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2369) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedResultFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedResultFilter.md index c3bff27ea26..7a8df222a0b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedResultFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedResultFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedResultFilter = object; ``` -Defined in: [gen/types.gen.ts:438](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L438) +Defined in: [gen/types.gen.ts:451](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L451) Advanced filter @@ -25,7 +25,7 @@ Advanced AuditLogResultEnum filter. optional $eq: AuditLogResultEnum; ``` -Defined in: [gen/types.gen.ts:442](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L442) +Defined in: [gen/types.gen.ts:455](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L455) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:450](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L450) +Defined in: [gen/types.gen.ts:463](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L463) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: AuditLogResultEnum[]; ``` -Defined in: [gen/types.gen.ts:454](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L454) +Defined in: [gen/types.gen.ts:467](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L467) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:455](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L455) +Defined in: [gen/types.gen.ts:468](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L468) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:455](https://github.com/camunda/orchestration-clus optional $neq: AuditLogResultEnum; ``` -Defined in: [gen/types.gen.ts:446](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L446) +Defined in: [gen/types.gen.ts:459](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L459) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedScopeKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedScopeKeyFilter.md index b91dec99da3..0bbf7fa2c0d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedScopeKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedScopeKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedScopeKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4278](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4278) +Defined in: [gen/types.gen.ts:4919](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4919) Advanced filter @@ -25,7 +25,7 @@ Advanced ScopeKey filter. optional $eq: ScopeKey; ``` -Defined in: [gen/types.gen.ts:4282](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4282) +Defined in: [gen/types.gen.ts:4923](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4923) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4290](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4290) +Defined in: [gen/types.gen.ts:4931](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4931) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: ScopeKey[]; ``` -Defined in: [gen/types.gen.ts:4294](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4294) +Defined in: [gen/types.gen.ts:4935](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4935) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: ScopeKey; ``` -Defined in: [gen/types.gen.ts:4286](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4286) +Defined in: [gen/types.gen.ts:4927](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4927) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: ScopeKey[]; ``` -Defined in: [gen/types.gen.ts:4298](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4298) +Defined in: [gen/types.gen.ts:4939](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4939) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedStringFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedStringFilter.md index 3861505de9a..ee2b7833b41 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedStringFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedStringFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedStringFilter = BasicStringFilter & object; ``` -Defined in: [gen/types.gen.ts:2655](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2655) +Defined in: [gen/types.gen.ts:2813](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2813) Advanced filter diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedUserTaskStateFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedUserTaskStateFilter.md index ac4809a5190..b141cf9a8a4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedUserTaskStateFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedUserTaskStateFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedUserTaskStateFilter = object; ``` -Defined in: [gen/types.gen.ts:7084](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7084) +Defined in: [gen/types.gen.ts:7891](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7891) Advanced filter @@ -25,7 +25,7 @@ Advanced UserTaskStateEnum filter. optional $eq: UserTaskStateEnum; ``` -Defined in: [gen/types.gen.ts:7088](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7088) +Defined in: [gen/types.gen.ts:7895](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7895) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:7096](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7096) +Defined in: [gen/types.gen.ts:7903](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7903) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: UserTaskStateEnum[]; ``` -Defined in: [gen/types.gen.ts:7100](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7100) +Defined in: [gen/types.gen.ts:7907](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7907) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $like: LikeFilter; ``` -Defined in: [gen/types.gen.ts:7101](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7101) +Defined in: [gen/types.gen.ts:7908](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7908) --- @@ -71,6 +71,6 @@ Defined in: [gen/types.gen.ts:7101](https://github.com/camunda/orchestration-clu optional $neq: UserTaskStateEnum; ``` -Defined in: [gen/types.gen.ts:7092](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7092) +Defined in: [gen/types.gen.ts:7899](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7899) Checks for inequality with the provided value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedVariableKeyFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedVariableKeyFilter.md index 20b1b0db330..dcccccd6a3b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedVariableKeyFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AdvancedVariableKeyFilter.md @@ -11,7 +11,7 @@ mdx: type AdvancedVariableKeyFilter = object; ``` -Defined in: [gen/types.gen.ts:4311](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4311) +Defined in: [gen/types.gen.ts:4952](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4952) Advanced filter @@ -25,7 +25,7 @@ Advanced VariableKey filter. optional $eq: VariableKey; ``` -Defined in: [gen/types.gen.ts:4315](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4315) +Defined in: [gen/types.gen.ts:4956](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4956) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:4323](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4323) +Defined in: [gen/types.gen.ts:4964](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4964) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: VariableKey[]; ``` -Defined in: [gen/types.gen.ts:4327](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4327) +Defined in: [gen/types.gen.ts:4968](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4968) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: VariableKey; ``` -Defined in: [gen/types.gen.ts:4319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4319) +Defined in: [gen/types.gen.ts:4960](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4960) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: VariableKey[]; ``` -Defined in: [gen/types.gen.ts:4331](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4331) +Defined in: [gen/types.gen.ts:4972](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4972) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AncestorScopeInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AncestorScopeInstruction.md index f2f6887ec42..e30ebaca15f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AncestorScopeInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AncestorScopeInstruction.md @@ -14,7 +14,7 @@ type AncestorScopeInstruction = | (object & UseSourceParentKeyInstruction); ``` -Defined in: [gen/types.gen.ts:6080](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6080) +Defined in: [gen/types.gen.ts:6793](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6793) Defines the ancestor scope for the created element instances. The default behavior resembles a "direct" scope instruction with an `ancestorElementInstanceKey` of `"-1"`. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupData.md index cdf16c469d0..23ffb17135e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupData.md @@ -11,7 +11,7 @@ mdx: type AssignClientToGroupData = object; ``` -Defined in: [gen/types.gen.ts:10962](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10962) +Defined in: [gen/types.gen.ts:11146](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11146) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10962](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:10963](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10963) +Defined in: [gen/types.gen.ts:11147](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11147) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10963](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10964](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10964) +Defined in: [gen/types.gen.ts:11148](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11148) #### clientId @@ -57,7 +57,7 @@ The group ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:10974](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10974) +Defined in: [gen/types.gen.ts:11158](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11158) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:10974](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/clients/{clientId}"; ``` -Defined in: [gen/types.gen.ts:10975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10975) +Defined in: [gen/types.gen.ts:11159](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11159) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupError.md index e981c79b396..b69e4276bc2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupError.md @@ -12,4 +12,4 @@ type AssignClientToGroupError = AssignClientToGroupErrors[keyof AssignClientToGroupErrors]; ``` -Defined in: [gen/types.gen.ts:11006](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11006) +Defined in: [gen/types.gen.ts:11190](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11190) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupErrors.md index e8c6c4ccfe2..e6c8f117d35 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupErrors.md @@ -11,7 +11,7 @@ mdx: type AssignClientToGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:10978](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10978) +Defined in: [gen/types.gen.ts:11162](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11162) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10978](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10982](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10982) +Defined in: [gen/types.gen.ts:11166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11166) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10986](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10986) +Defined in: [gen/types.gen.ts:11170](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11170) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10990](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10990) +Defined in: [gen/types.gen.ts:11174](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11174) The group with the given ID was not found. @@ -57,7 +57,7 @@ The group with the given ID was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10994](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10994) +Defined in: [gen/types.gen.ts:11178](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11178) The client with the given ID is already assigned to the group. @@ -69,7 +69,7 @@ The client with the given ID is already assigned to the group. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10998](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10998) +Defined in: [gen/types.gen.ts:11182](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11182) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11003](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11003) +Defined in: [gen/types.gen.ts:11187](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11187) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupResponse.md index f6365e7d7bd..099c632d2c1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupResponse.md @@ -12,4 +12,4 @@ type AssignClientToGroupResponse = AssignClientToGroupResponses[keyof AssignClientToGroupResponses]; ``` -Defined in: [gen/types.gen.ts:11015](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11015) +Defined in: [gen/types.gen.ts:11199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11199) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupResponses.md index 86180fa78f3..1787cdbbd4a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToGroupResponses.md @@ -11,7 +11,7 @@ mdx: type AssignClientToGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:11008](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11008) +Defined in: [gen/types.gen.ts:11192](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11192) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:11008](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:11012](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11012) +Defined in: [gen/types.gen.ts:11196](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11196) The client was assigned successfully to the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantData.md index 7c28bf8c361..e6abffdf269 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantData.md @@ -11,7 +11,7 @@ mdx: type AssignClientToTenantData = object; ``` -Defined in: [gen/types.gen.ts:15854](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15854) +Defined in: [gen/types.gen.ts:15168](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15168) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15854](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15855](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15855) +Defined in: [gen/types.gen.ts:15169](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15169) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15855](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15856](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15856) +Defined in: [gen/types.gen.ts:15170](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15170) #### clientId @@ -57,7 +57,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:15866](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15866) +Defined in: [gen/types.gen.ts:15180](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15180) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:15866](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/clients/{clientId}"; ``` -Defined in: [gen/types.gen.ts:15867](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15867) +Defined in: [gen/types.gen.ts:15181](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15181) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantError.md index cf4d9d33818..8f74b52917b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantError.md @@ -12,4 +12,4 @@ type AssignClientToTenantError = AssignClientToTenantErrors[keyof AssignClientToTenantErrors]; ``` -Defined in: [gen/types.gen.ts:15894](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15894) +Defined in: [gen/types.gen.ts:15208](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15208) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantErrors.md index ad4a1a74e52..96312ec1d0d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantErrors.md @@ -11,7 +11,7 @@ mdx: type AssignClientToTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:15870](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15870) +Defined in: [gen/types.gen.ts:15184](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15184) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15870](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15874](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15874) +Defined in: [gen/types.gen.ts:15188](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15188) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15878](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15878) +Defined in: [gen/types.gen.ts:15192](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15192) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15882](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15882) +Defined in: [gen/types.gen.ts:15196](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15196) The tenant was not found. @@ -57,7 +57,7 @@ The tenant was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15886](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15886) +Defined in: [gen/types.gen.ts:15200](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15200) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15891](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15891) +Defined in: [gen/types.gen.ts:15205](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15205) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantResponse.md index efac17ce4dc..007dadd42d2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantResponse.md @@ -12,4 +12,4 @@ type AssignClientToTenantResponse = AssignClientToTenantResponses[keyof AssignClientToTenantResponses]; ``` -Defined in: [gen/types.gen.ts:15903](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15903) +Defined in: [gen/types.gen.ts:15217](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15217) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantResponses.md index 8c28a7c97a6..3a402d7c734 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignClientToTenantResponses.md @@ -11,7 +11,7 @@ mdx: type AssignClientToTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:15896](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15896) +Defined in: [gen/types.gen.ts:15210](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15210) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15896](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15900) +Defined in: [gen/types.gen.ts:15214](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15214) The client was successfully assigned to the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantData.md index 9430ffa9c73..4841b381bc6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantData.md @@ -11,7 +11,7 @@ mdx: type AssignGroupToTenantData = object; ``` -Defined in: [gen/types.gen.ts:15988](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15988) +Defined in: [gen/types.gen.ts:15291](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15291) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15988](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15989](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15989) +Defined in: [gen/types.gen.ts:15292](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15292) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15989](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15990](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15990) +Defined in: [gen/types.gen.ts:15293](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15293) #### groupId @@ -57,7 +57,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:16000](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16000) +Defined in: [gen/types.gen.ts:15303](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15303) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:16000](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/groups/{groupId}"; ``` -Defined in: [gen/types.gen.ts:16001](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16001) +Defined in: [gen/types.gen.ts:15304](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15304) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantError.md index ca88954d421..f9988ad0ea4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantError.md @@ -12,4 +12,4 @@ type AssignGroupToTenantError = AssignGroupToTenantErrors[keyof AssignGroupToTenantErrors]; ``` -Defined in: [gen/types.gen.ts:16028](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16028) +Defined in: [gen/types.gen.ts:15331](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15331) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantErrors.md index 2ce4ef2654b..ff0f92507e9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantErrors.md @@ -11,7 +11,7 @@ mdx: type AssignGroupToTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:16004](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16004) +Defined in: [gen/types.gen.ts:15307](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15307) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16004](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16008](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16008) +Defined in: [gen/types.gen.ts:15311](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15311) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16012](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16012) +Defined in: [gen/types.gen.ts:15315](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15315) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16016](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16016) +Defined in: [gen/types.gen.ts:15319](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15319) Not found. The tenant or group was not found. @@ -57,7 +57,7 @@ Not found. The tenant or group was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16020](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16020) +Defined in: [gen/types.gen.ts:15323](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15323) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16025) +Defined in: [gen/types.gen.ts:15328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15328) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantResponse.md index c993d8b84b7..480ca9adc15 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantResponse.md @@ -12,4 +12,4 @@ type AssignGroupToTenantResponse = AssignGroupToTenantResponses[keyof AssignGroupToTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16037](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16037) +Defined in: [gen/types.gen.ts:15340](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15340) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantResponses.md index 2ddaa6d22de..091d8244dcc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignGroupToTenantResponses.md @@ -11,7 +11,7 @@ mdx: type AssignGroupToTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16030](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16030) +Defined in: [gen/types.gen.ts:15333](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15333) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16030](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:16034](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16034) +Defined in: [gen/types.gen.ts:15337](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15337) The group was successfully assigned to the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupData.md index a931148d73c..d0f9a912525 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupData.md @@ -11,7 +11,7 @@ mdx: type AssignMappingRuleToGroupData = object; ``` -Defined in: [gen/types.gen.ts:11114](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11114) +Defined in: [gen/types.gen.ts:11303](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11303) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11114](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:11115](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11115) +Defined in: [gen/types.gen.ts:11304](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11304) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11115](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11116](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11116) +Defined in: [gen/types.gen.ts:11305](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11305) #### groupId @@ -57,7 +57,7 @@ The mapping rule ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:11126](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11126) +Defined in: [gen/types.gen.ts:11315](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11315) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:11126](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/mapping-rules/{mappingRuleId}"; ``` -Defined in: [gen/types.gen.ts:11127](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11127) +Defined in: [gen/types.gen.ts:11316](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11316) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupError.md index 471e07a575a..03fbdb628ea 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupError.md @@ -12,4 +12,4 @@ type AssignMappingRuleToGroupError = AssignMappingRuleToGroupErrors[keyof AssignMappingRuleToGroupErrors]; ``` -Defined in: [gen/types.gen.ts:11158](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11158) +Defined in: [gen/types.gen.ts:11347](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11347) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupErrors.md index 5a4babb5817..b2ab98d4205 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupErrors.md @@ -11,7 +11,7 @@ mdx: type AssignMappingRuleToGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:11130](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11130) +Defined in: [gen/types.gen.ts:11319](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11319) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11130](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11134](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11134) +Defined in: [gen/types.gen.ts:11323](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11323) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11138](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11138) +Defined in: [gen/types.gen.ts:11327](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11327) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11142](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11142) +Defined in: [gen/types.gen.ts:11331](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11331) The group or mapping rule with the given ID was not found. @@ -57,7 +57,7 @@ The group or mapping rule with the given ID was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11146](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11146) +Defined in: [gen/types.gen.ts:11335](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11335) The mapping rule with the given ID is already assigned to the group. @@ -69,7 +69,7 @@ The mapping rule with the given ID is already assigned to the group. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11150](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11150) +Defined in: [gen/types.gen.ts:11339](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11339) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11155](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11155) +Defined in: [gen/types.gen.ts:11344](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11344) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupResponse.md index 2035a495f7d..67a07217161 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupResponse.md @@ -12,4 +12,4 @@ type AssignMappingRuleToGroupResponse = AssignMappingRuleToGroupResponses[keyof AssignMappingRuleToGroupResponses]; ``` -Defined in: [gen/types.gen.ts:11167](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11167) +Defined in: [gen/types.gen.ts:11356](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11356) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupResponses.md index 9d7963494cd..d980c889967 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToGroupResponses.md @@ -11,7 +11,7 @@ mdx: type AssignMappingRuleToGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:11160](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11160) +Defined in: [gen/types.gen.ts:11349](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11349) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:11160](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:11164](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11164) +Defined in: [gen/types.gen.ts:11353](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11353) The mapping rule was assigned successfully to the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantData.md index a75b1e8181d..e1f3ae9e9e2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantData.md @@ -11,7 +11,7 @@ mdx: type AssignMappingRuleToTenantData = object; ``` -Defined in: [gen/types.gen.ts:16111](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16111) +Defined in: [gen/types.gen.ts:15419](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15419) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16111](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16112](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16112) +Defined in: [gen/types.gen.ts:15420](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15420) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16112](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16113) +Defined in: [gen/types.gen.ts:15421](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15421) #### mappingRuleId @@ -57,7 +57,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:16123](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16123) +Defined in: [gen/types.gen.ts:15431](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15431) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:16123](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/mapping-rules/{mappingRuleId}"; ``` -Defined in: [gen/types.gen.ts:16124](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16124) +Defined in: [gen/types.gen.ts:15432](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15432) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantError.md index 6172b5b9031..040891150b8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantError.md @@ -12,4 +12,4 @@ type AssignMappingRuleToTenantError = AssignMappingRuleToTenantErrors[keyof AssignMappingRuleToTenantErrors]; ``` -Defined in: [gen/types.gen.ts:16151](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16151) +Defined in: [gen/types.gen.ts:15459](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15459) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantErrors.md index 78bfdf07bf4..fef72035329 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantErrors.md @@ -11,7 +11,7 @@ mdx: type AssignMappingRuleToTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:16127](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16127) +Defined in: [gen/types.gen.ts:15435](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15435) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16127](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16131](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16131) +Defined in: [gen/types.gen.ts:15439](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15439) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16135](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16135) +Defined in: [gen/types.gen.ts:15443](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15443) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16139](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16139) +Defined in: [gen/types.gen.ts:15447](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15447) Not found. The tenant or mapping rule was not found. @@ -57,7 +57,7 @@ Not found. The tenant or mapping rule was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16143](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16143) +Defined in: [gen/types.gen.ts:15451](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15451) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16148](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16148) +Defined in: [gen/types.gen.ts:15456](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15456) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantResponse.md index 8618b3e93e6..d84214387d7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantResponse.md @@ -12,4 +12,4 @@ type AssignMappingRuleToTenantResponse = AssignMappingRuleToTenantResponses[keyof AssignMappingRuleToTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16160](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16160) +Defined in: [gen/types.gen.ts:15468](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15468) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantResponses.md index 3083d801acc..2fdf189aa95 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignMappingRuleToTenantResponses.md @@ -11,7 +11,7 @@ mdx: type AssignMappingRuleToTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16153](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16153) +Defined in: [gen/types.gen.ts:15461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15461) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16153](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:16157](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16157) +Defined in: [gen/types.gen.ts:15465](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15465) The mapping rule was successfully assigned to the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientData.md index 95a716668b9..5400f0767b7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientData.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToClientData = object; ``` -Defined in: [gen/types.gen.ts:14840](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14840) +Defined in: [gen/types.gen.ts:14132](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14132) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14840](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14841](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14841) +Defined in: [gen/types.gen.ts:14133](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14133) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14841](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14842](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14842) +Defined in: [gen/types.gen.ts:14134](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14134) #### clientId @@ -57,7 +57,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:14852](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14852) +Defined in: [gen/types.gen.ts:14144](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14144) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:14852](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/clients/{clientId}"; ``` -Defined in: [gen/types.gen.ts:14853](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14853) +Defined in: [gen/types.gen.ts:14145](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14145) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientError.md index 231731fdc96..a0524793492 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientError.md @@ -12,4 +12,4 @@ type AssignRoleToClientError = AssignRoleToClientErrors[keyof AssignRoleToClientErrors]; ``` -Defined in: [gen/types.gen.ts:14884](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14884) +Defined in: [gen/types.gen.ts:14176](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14176) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientErrors.md index 442af518ac4..68ae64e7ed3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientErrors.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToClientErrors = object; ``` -Defined in: [gen/types.gen.ts:14856](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14856) +Defined in: [gen/types.gen.ts:14148](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14148) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14856](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14860](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14860) +Defined in: [gen/types.gen.ts:14152](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14152) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14864](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14864) +Defined in: [gen/types.gen.ts:14156](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14156) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14868](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14868) +Defined in: [gen/types.gen.ts:14160](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14160) The role with the given ID was not found. @@ -57,7 +57,7 @@ The role with the given ID was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14872](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14872) +Defined in: [gen/types.gen.ts:14164](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14164) The role was already assigned to the client with the given ID. @@ -69,7 +69,7 @@ The role was already assigned to the client with the given ID. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14876](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14876) +Defined in: [gen/types.gen.ts:14168](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14168) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14881](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14881) +Defined in: [gen/types.gen.ts:14173](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14173) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientResponse.md index 09b5afd060d..f0b34d8e787 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientResponse.md @@ -12,4 +12,4 @@ type AssignRoleToClientResponse = AssignRoleToClientResponses[keyof AssignRoleToClientResponses]; ``` -Defined in: [gen/types.gen.ts:14893](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14893) +Defined in: [gen/types.gen.ts:14185](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14185) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientResponses.md index 340285e3a8a..ae2f6ceaf63 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToClientResponses.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToClientResponses = object; ``` -Defined in: [gen/types.gen.ts:14886](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14886) +Defined in: [gen/types.gen.ts:14178](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14178) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14886](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:14890](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14890) +Defined in: [gen/types.gen.ts:14182](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14182) The role was assigned successfully to the client. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupData.md index 206f957746a..7d6456b8a44 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupData.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToGroupData = object; ``` -Defined in: [gen/types.gen.ts:15003](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15003) +Defined in: [gen/types.gen.ts:14284](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14284) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15003](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15004](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15004) +Defined in: [gen/types.gen.ts:14285](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14285) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15004](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15005](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15005) +Defined in: [gen/types.gen.ts:14286](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14286) #### groupId @@ -57,7 +57,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:15015](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15015) +Defined in: [gen/types.gen.ts:14296](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14296) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:15015](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/groups/{groupId}"; ``` -Defined in: [gen/types.gen.ts:15016](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15016) +Defined in: [gen/types.gen.ts:14297](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14297) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupError.md index edd6ee6c8bb..f0f2b208c10 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupError.md @@ -12,4 +12,4 @@ type AssignRoleToGroupError = AssignRoleToGroupErrors[keyof AssignRoleToGroupErrors]; ``` -Defined in: [gen/types.gen.ts:15047](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15047) +Defined in: [gen/types.gen.ts:14328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14328) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupErrors.md index 832a39f235d..d15c7ee6a27 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupErrors.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:15019](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15019) +Defined in: [gen/types.gen.ts:14300](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14300) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15019](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15023](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15023) +Defined in: [gen/types.gen.ts:14304](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14304) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15027](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15027) +Defined in: [gen/types.gen.ts:14308](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14308) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15031](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15031) +Defined in: [gen/types.gen.ts:14312](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14312) The role or group with the given ID was not found. @@ -57,7 +57,7 @@ The role or group with the given ID was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15035](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15035) +Defined in: [gen/types.gen.ts:14316](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14316) The role is already assigned to the group with the given ID. @@ -69,7 +69,7 @@ The role is already assigned to the group with the given ID. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15039](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15039) +Defined in: [gen/types.gen.ts:14320](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14320) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15044](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15044) +Defined in: [gen/types.gen.ts:14325](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14325) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupResponse.md index e18308835bd..769797e1ac3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupResponse.md @@ -12,4 +12,4 @@ type AssignRoleToGroupResponse = AssignRoleToGroupResponses[keyof AssignRoleToGroupResponses]; ``` -Defined in: [gen/types.gen.ts:15056](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15056) +Defined in: [gen/types.gen.ts:14337](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14337) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupResponses.md index f833db30969..8403d33da94 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToGroupResponses.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:15049](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15049) +Defined in: [gen/types.gen.ts:14330](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14330) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15049](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15053](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15053) +Defined in: [gen/types.gen.ts:14334](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14334) The role was assigned successfully to the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleData.md index 4c8f8dc4d3c..ffee25b4f15 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleData.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToMappingRuleData = object; ``` -Defined in: [gen/types.gen.ts:15155](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15155) +Defined in: [gen/types.gen.ts:14441](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14441) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15155](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15156](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15156) +Defined in: [gen/types.gen.ts:14442](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14442) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15156](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15157](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15157) +Defined in: [gen/types.gen.ts:14443](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14443) #### mappingRuleId @@ -57,7 +57,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:15167](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15167) +Defined in: [gen/types.gen.ts:14453](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14453) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:15167](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/mapping-rules/{mappingRuleId}"; ``` -Defined in: [gen/types.gen.ts:15168](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15168) +Defined in: [gen/types.gen.ts:14454](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14454) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleError.md index 8548e81b9cd..f71d2ad2d8a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleError.md @@ -12,4 +12,4 @@ type AssignRoleToMappingRuleError = AssignRoleToMappingRuleErrors[keyof AssignRoleToMappingRuleErrors]; ``` -Defined in: [gen/types.gen.ts:15199](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15199) +Defined in: [gen/types.gen.ts:14485](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14485) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleErrors.md index b6bb0609a6f..28da06bb634 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleErrors.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToMappingRuleErrors = object; ``` -Defined in: [gen/types.gen.ts:15171](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15171) +Defined in: [gen/types.gen.ts:14457](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14457) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15171](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15175](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15175) +Defined in: [gen/types.gen.ts:14461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14461) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15179](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15179) +Defined in: [gen/types.gen.ts:14465](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14465) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15183](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15183) +Defined in: [gen/types.gen.ts:14469](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14469) The role or mapping rule with the given ID was not found. @@ -57,7 +57,7 @@ The role or mapping rule with the given ID was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15187](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15187) +Defined in: [gen/types.gen.ts:14473](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14473) The role is already assigned to the mapping rule with the given ID. @@ -69,7 +69,7 @@ The role is already assigned to the mapping rule with the given ID. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15191](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15191) +Defined in: [gen/types.gen.ts:14477](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14477) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15196](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15196) +Defined in: [gen/types.gen.ts:14482](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14482) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleResponse.md index eee0c910c10..48190c88412 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleResponse.md @@ -12,4 +12,4 @@ type AssignRoleToMappingRuleResponse = AssignRoleToMappingRuleResponses[keyof AssignRoleToMappingRuleResponses]; ``` -Defined in: [gen/types.gen.ts:15208](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15208) +Defined in: [gen/types.gen.ts:14494](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14494) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleResponses.md index 531c3af9813..60e606dfb50 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToMappingRuleResponses.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToMappingRuleResponses = object; ``` -Defined in: [gen/types.gen.ts:15201](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15201) +Defined in: [gen/types.gen.ts:14487](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14487) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15201](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15205](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15205) +Defined in: [gen/types.gen.ts:14491](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14491) The role was assigned successfully to the mapping rule. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantData.md index 0af2f40cd42..93b261b3fad 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantData.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToTenantData = object; ``` -Defined in: [gen/types.gen.ts:16234](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16234) +Defined in: [gen/types.gen.ts:15547](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15547) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16234](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16235](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16235) +Defined in: [gen/types.gen.ts:15548](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15548) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16235](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16236](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16236) +Defined in: [gen/types.gen.ts:15549](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15549) #### roleId @@ -57,7 +57,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:16246](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16246) +Defined in: [gen/types.gen.ts:15559](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15559) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:16246](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/roles/{roleId}"; ``` -Defined in: [gen/types.gen.ts:16247](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16247) +Defined in: [gen/types.gen.ts:15560](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15560) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantError.md index 274abc8eac5..7f05b6d4963 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantError.md @@ -12,4 +12,4 @@ type AssignRoleToTenantError = AssignRoleToTenantErrors[keyof AssignRoleToTenantErrors]; ``` -Defined in: [gen/types.gen.ts:16274](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16274) +Defined in: [gen/types.gen.ts:15587](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15587) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantErrors.md index 23add68379a..f7e02b51f71 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantErrors.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:16250](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16250) +Defined in: [gen/types.gen.ts:15563](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15563) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16250](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16254](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16254) +Defined in: [gen/types.gen.ts:15567](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15567) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16258](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16258) +Defined in: [gen/types.gen.ts:15571](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15571) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16262](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16262) +Defined in: [gen/types.gen.ts:15575](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15575) Not found. The tenant or role was not found. @@ -57,7 +57,7 @@ Not found. The tenant or role was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16266](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16266) +Defined in: [gen/types.gen.ts:15579](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15579) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16271](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16271) +Defined in: [gen/types.gen.ts:15584](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15584) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantResponse.md index 8fcc9c3cd94..da355cfa7ba 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantResponse.md @@ -12,4 +12,4 @@ type AssignRoleToTenantResponse = AssignRoleToTenantResponses[keyof AssignRoleToTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16283) +Defined in: [gen/types.gen.ts:15596](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15596) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantResponses.md index b945083f698..8839a15cea7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToTenantResponses.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16276](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16276) +Defined in: [gen/types.gen.ts:15589](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15589) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16276](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:16280](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16280) +Defined in: [gen/types.gen.ts:15593](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15593) The role was successfully assigned to the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserData.md index b4f520c0249..65ce4b2ddab 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserData.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToUserData = object; ``` -Defined in: [gen/types.gen.ts:15318](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15318) +Defined in: [gen/types.gen.ts:14611](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14611) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15318](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15319) +Defined in: [gen/types.gen.ts:14612](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14612) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15319](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15320](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15320) +Defined in: [gen/types.gen.ts:14613](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14613) #### roleId @@ -57,7 +57,7 @@ The user username. optional query: never; ``` -Defined in: [gen/types.gen.ts:15330](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15330) +Defined in: [gen/types.gen.ts:14623](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14623) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:15330](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/users/{username}"; ``` -Defined in: [gen/types.gen.ts:15331](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15331) +Defined in: [gen/types.gen.ts:14624](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14624) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserError.md index 759bb7ab538..f71ed52cb0c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserError.md @@ -12,4 +12,4 @@ type AssignRoleToUserError = AssignRoleToUserErrors[keyof AssignRoleToUserErrors]; ``` -Defined in: [gen/types.gen.ts:15362](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15362) +Defined in: [gen/types.gen.ts:14655](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14655) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserErrors.md index 6731a40261b..0eeb8cb0fbb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserErrors.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToUserErrors = object; ``` -Defined in: [gen/types.gen.ts:15334](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15334) +Defined in: [gen/types.gen.ts:14627](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14627) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15334](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15338](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15338) +Defined in: [gen/types.gen.ts:14631](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14631) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15342](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15342) +Defined in: [gen/types.gen.ts:14635](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14635) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15346](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15346) +Defined in: [gen/types.gen.ts:14639](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14639) The role or user with the given ID or username was not found. @@ -57,7 +57,7 @@ The role or user with the given ID or username was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15350](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15350) +Defined in: [gen/types.gen.ts:14643](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14643) The role is already assigned to the user with the given ID. @@ -69,7 +69,7 @@ The role is already assigned to the user with the given ID. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15354](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15354) +Defined in: [gen/types.gen.ts:14647](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14647) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15359](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15359) +Defined in: [gen/types.gen.ts:14652](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14652) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserResponse.md index e5aa52430d2..9fd6a64dc5b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserResponse.md @@ -12,4 +12,4 @@ type AssignRoleToUserResponse = AssignRoleToUserResponses[keyof AssignRoleToUserResponses]; ``` -Defined in: [gen/types.gen.ts:15371](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15371) +Defined in: [gen/types.gen.ts:14664](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14664) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserResponses.md index 919c9884dba..af42c37af25 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignRoleToUserResponses.md @@ -11,7 +11,7 @@ mdx: type AssignRoleToUserResponses = object; ``` -Defined in: [gen/types.gen.ts:15364](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15364) +Defined in: [gen/types.gen.ts:14657](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14657) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15364](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15368](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15368) +Defined in: [gen/types.gen.ts:14661](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14661) The role was assigned successfully to the user. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskData.md index 17c64b40ee6..7904804bef5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskData.md @@ -11,7 +11,7 @@ mdx: type AssignUserTaskData = object; ``` -Defined in: [gen/types.gen.ts:17127](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17127) +Defined in: [gen/types.gen.ts:16209](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16209) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17127](https://github.com/camunda/orchestration-cl body: UserTaskAssignmentRequest; ``` -Defined in: [gen/types.gen.ts:17128](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17128) +Defined in: [gen/types.gen.ts:16210](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16210) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:17128](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:17129](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17129) +Defined in: [gen/types.gen.ts:16211](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16211) #### userTaskKey @@ -49,7 +49,7 @@ The key of the user task to assign. optional query: never; ``` -Defined in: [gen/types.gen.ts:17135](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17135) +Defined in: [gen/types.gen.ts:16217](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16217) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:17135](https://github.com/camunda/orchestration-cl url: "/user-tasks/{userTaskKey}/assignment"; ``` -Defined in: [gen/types.gen.ts:17136](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17136) +Defined in: [gen/types.gen.ts:16218](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16218) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskError.md index 3c5911d4d30..5e6a05c7a81 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskError.md @@ -11,4 +11,4 @@ mdx: type AssignUserTaskError = AssignUserTaskErrors[keyof AssignUserTaskErrors]; ``` -Defined in: [gen/types.gen.ts:17164](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17164) +Defined in: [gen/types.gen.ts:16252](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16252) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskErrors.md index 9a339e36937..661ca2c8766 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskErrors.md @@ -11,7 +11,7 @@ mdx: type AssignUserTaskErrors = object; ``` -Defined in: [gen/types.gen.ts:17139](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17139) +Defined in: [gen/types.gen.ts:16221](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16221) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17139](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17143](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17143) +Defined in: [gen/types.gen.ts:16225](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16225) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17147](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17147) +Defined in: [gen/types.gen.ts:16229](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16229) The user task with the given key was not found. @@ -45,7 +45,7 @@ The user task with the given key was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17152](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17152) +Defined in: [gen/types.gen.ts:16234](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16234) The user task with the given key is in the wrong state currently. More details are provided in the response body. @@ -57,7 +57,7 @@ The user task with the given key is in the wrong state currently. More details a 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17156](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17156) +Defined in: [gen/types.gen.ts:16238](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16238) An internal error occurred while processing the request. @@ -69,6 +69,19 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17161](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17161) +Defined in: [gen/types.gen.ts:16243](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16243) 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 . + +--- + +### 504 + +```ts +504: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:16249](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16249) + +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 diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskResponse.md index 17a8b45baa6..54f7f995917 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskResponse.md @@ -12,4 +12,4 @@ type AssignUserTaskResponse = AssignUserTaskResponses[keyof AssignUserTaskResponses]; ``` -Defined in: [gen/types.gen.ts:17173](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17173) +Defined in: [gen/types.gen.ts:16261](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16261) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskResponses.md index d1547cc67cf..34694a974b0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserTaskResponses.md @@ -11,7 +11,7 @@ mdx: type AssignUserTaskResponses = object; ``` -Defined in: [gen/types.gen.ts:17166](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17166) +Defined in: [gen/types.gen.ts:16254](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16254) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:17166](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:17170](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17170) +Defined in: [gen/types.gen.ts:16258](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16258) The user task's assignment was adjusted. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupData.md index 9011e690db1..6f6f843b131 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupData.md @@ -11,7 +11,7 @@ mdx: type AssignUserToGroupData = object; ``` -Defined in: [gen/types.gen.ts:11317](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11317) +Defined in: [gen/types.gen.ts:11524](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11524) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11317](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:11318](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11318) +Defined in: [gen/types.gen.ts:11525](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11525) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11318](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11319) +Defined in: [gen/types.gen.ts:11526](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11526) #### groupId @@ -57,7 +57,7 @@ The user username. optional query: never; ``` -Defined in: [gen/types.gen.ts:11329](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11329) +Defined in: [gen/types.gen.ts:11536](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11536) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:11329](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/users/{username}"; ``` -Defined in: [gen/types.gen.ts:11330](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11330) +Defined in: [gen/types.gen.ts:11537](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11537) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupError.md index 5e2ab518197..4680c84d162 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupError.md @@ -12,4 +12,4 @@ type AssignUserToGroupError = AssignUserToGroupErrors[keyof AssignUserToGroupErrors]; ``` -Defined in: [gen/types.gen.ts:11361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11361) +Defined in: [gen/types.gen.ts:11568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11568) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupErrors.md index 1ec736ac5af..82dacda74c6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupErrors.md @@ -11,7 +11,7 @@ mdx: type AssignUserToGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:11333](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11333) +Defined in: [gen/types.gen.ts:11540](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11540) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11333](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11337](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11337) +Defined in: [gen/types.gen.ts:11544](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11544) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11341](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11341) +Defined in: [gen/types.gen.ts:11548](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11548) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11345](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11345) +Defined in: [gen/types.gen.ts:11552](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11552) The group or user with the given ID or username was not found. @@ -57,7 +57,7 @@ The group or user with the given ID or username was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11349](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11349) +Defined in: [gen/types.gen.ts:11556](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11556) The user with the given ID is already assigned to the group. @@ -69,7 +69,7 @@ The user with the given ID is already assigned to the group. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11353](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11353) +Defined in: [gen/types.gen.ts:11560](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11560) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11358](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11358) +Defined in: [gen/types.gen.ts:11565](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11565) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupResponse.md index cf74572ec29..b09f000bbef 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupResponse.md @@ -12,4 +12,4 @@ type AssignUserToGroupResponse = AssignUserToGroupResponses[keyof AssignUserToGroupResponses]; ``` -Defined in: [gen/types.gen.ts:11370](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11370) +Defined in: [gen/types.gen.ts:11577](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11577) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupResponses.md index fc30961def9..8cfabda420c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToGroupResponses.md @@ -11,7 +11,7 @@ mdx: type AssignUserToGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:11363](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11363) +Defined in: [gen/types.gen.ts:11570](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11570) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:11363](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:11367](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11367) +Defined in: [gen/types.gen.ts:11574](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11574) The user was assigned successfully to the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantData.md index 9e2fed538aa..dc010a591e5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantData.md @@ -11,7 +11,7 @@ mdx: type AssignUserToTenantData = object; ``` -Defined in: [gen/types.gen.ts:16368](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16368) +Defined in: [gen/types.gen.ts:15688](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15688) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16368](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16369](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16369) +Defined in: [gen/types.gen.ts:15689](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15689) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16369](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16370](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16370) +Defined in: [gen/types.gen.ts:15690](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15690) #### tenantId @@ -57,7 +57,7 @@ The unique identifier of the user. optional query: never; ``` -Defined in: [gen/types.gen.ts:16380](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16380) +Defined in: [gen/types.gen.ts:15700](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15700) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:16380](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/users/{username}"; ``` -Defined in: [gen/types.gen.ts:16381](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16381) +Defined in: [gen/types.gen.ts:15701](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15701) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantError.md index 20b04fe0ad5..5c85ab2c7f5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantError.md @@ -12,4 +12,4 @@ type AssignUserToTenantError = AssignUserToTenantErrors[keyof AssignUserToTenantErrors]; ``` -Defined in: [gen/types.gen.ts:16408](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16408) +Defined in: [gen/types.gen.ts:15728](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15728) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantErrors.md index 2546793dacb..54c53c43965 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantErrors.md @@ -11,7 +11,7 @@ mdx: type AssignUserToTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:16384](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16384) +Defined in: [gen/types.gen.ts:15704](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15704) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16384](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16388](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16388) +Defined in: [gen/types.gen.ts:15708](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15708) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16392](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16392) +Defined in: [gen/types.gen.ts:15712](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15712) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16396](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16396) +Defined in: [gen/types.gen.ts:15716](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15716) Not found. The tenant or user was not found. @@ -57,7 +57,7 @@ Not found. The tenant or user was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16400](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16400) +Defined in: [gen/types.gen.ts:15720](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15720) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16405](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16405) +Defined in: [gen/types.gen.ts:15725](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15725) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantResponse.md index cd94d6af7b6..4b526183e76 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantResponse.md @@ -12,4 +12,4 @@ type AssignUserToTenantResponse = AssignUserToTenantResponses[keyof AssignUserToTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16417](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16417) +Defined in: [gen/types.gen.ts:15737](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15737) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantResponses.md index 033230adbc4..ca8188b07a9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AssignUserToTenantResponses.md @@ -11,7 +11,7 @@ mdx: type AssignUserToTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16410](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16410) +Defined in: [gen/types.gen.ts:15730](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15730) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16410](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:16414](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16414) +Defined in: [gen/types.gen.ts:15734](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15734) The user was successfully assigned to the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeEnum.md index 7718f9a8408..d674ca2807e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeEnum.md @@ -11,6 +11,6 @@ mdx: type AuditLogActorTypeEnum = "ANONYMOUS" | "CLIENT" | "UNKNOWN" | "USER"; ``` -Defined in: [gen/types.gen.ts:293](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L293) +Defined in: [gen/types.gen.ts:306](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L306) The type of actor who performed the operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeExactMatch.md index 77081d8e14a..dabfc0beb9f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeExactMatch.md @@ -11,7 +11,7 @@ mdx: type AuditLogActorTypeExactMatch = AuditLogActorTypeEnum; ``` -Defined in: [gen/types.gen.ts:7437](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7437) +Defined in: [gen/types.gen.ts:8269](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8269) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeFilterProperty.md index 3eef5097a47..6558ec8e134 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogActorTypeFilterProperty.md @@ -13,6 +13,6 @@ type AuditLogActorTypeFilterProperty = | AdvancedActorTypeFilter; ``` -Defined in: [gen/types.gen.ts:461](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L461) +Defined in: [gen/types.gen.ts:474](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L474) AuditLogActorTypeEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogCategoryEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogCategoryEnum.md index d07c8a560e6..f68e8c1662f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogCategoryEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogCategoryEnum.md @@ -11,6 +11,6 @@ mdx: type AuditLogCategoryEnum = "ADMIN" | "DEPLOYED_RESOURCES" | "USER_TASKS"; ``` -Defined in: [gen/types.gen.ts:303](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L303) +Defined in: [gen/types.gen.ts:316](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L316) The category of the audit log operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKey.md index a82b16a1647..dd8da16f7c2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKey.md @@ -11,6 +11,6 @@ mdx: type AuditLogEntityKey = CamundaKey<"AuditLogEntityKey">; ``` -Defined in: [gen/types.gen.ts:278](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L278) +Defined in: [gen/types.gen.ts:291](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L291) System-generated entity key for an audit log entry. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKeyExactMatch.md index 1e387774688..48519437b01 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type AuditLogEntityKeyExactMatch = AuditLogEntityKey; ``` -Defined in: [gen/types.gen.ts:7402](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7402) +Defined in: [gen/types.gen.ts:8234](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8234) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKeyFilterProperty.md index fe75953901b..b847607cd85 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityKeyFilterProperty.md @@ -13,6 +13,6 @@ type AuditLogEntityKeyFilterProperty = | AdvancedAuditLogEntityKeyFilter; ``` -Defined in: [gen/types.gen.ts:308](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L308) +Defined in: [gen/types.gen.ts:321](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L321) EntityKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityTypeEnum.md index 49232645938..5fdd5c71ac2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogEntityTypeEnum.md @@ -14,6 +14,7 @@ type AuditLogEntityTypeEnum = | "DECISION" | "GROUP" | "INCIDENT" + | "JOB" | "MAPPING_RULE" | "PROCESS_INSTANCE" | "RESOURCE" @@ -25,6 +26,6 @@ type AuditLogEntityTypeEnum = | "CLIENT"; ``` -Defined in: [gen/types.gen.ts:283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L283) +Defined in: [gen/types.gen.ts:296](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L296) The type of entity affected by the operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogFilter.md index d078f6b08a8..ad8ac51d1c7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogFilter.md @@ -11,7 +11,7 @@ mdx: type AuditLogFilter = object; ``` -Defined in: [gen/types.gen.ts:150](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L150) +Defined in: [gen/types.gen.ts:159](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L159) Audit log filter request @@ -23,7 +23,7 @@ Audit log filter request optional actorId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:182](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L182) +Defined in: [gen/types.gen.ts:191](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L191) The actor ID search filter. @@ -35,19 +35,31 @@ The actor ID search filter. optional actorType: AuditLogActorTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:186](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L186) +Defined in: [gen/types.gen.ts:195](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L195) The actor type search filter. --- +### agentElementId? + +```ts +optional agentElementId: StringFilterProperty; +``` + +Defined in: [gen/types.gen.ts:199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L199) + +The agent element ID search filter. + +--- + ### auditLogKey? ```ts optional auditLogKey: AuditLogKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:154](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L154) +Defined in: [gen/types.gen.ts:163](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L163) The audit log key search filter. @@ -59,7 +71,7 @@ The audit log key search filter. optional batchOperationType: BatchOperationTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:218](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L218) +Defined in: [gen/types.gen.ts:231](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L231) The batch operation type search filter. @@ -71,7 +83,7 @@ The batch operation type search filter. optional category: CategoryFilterProperty; ``` -Defined in: [gen/types.gen.ts:202](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L202) +Defined in: [gen/types.gen.ts:215](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L215) The category search filter. @@ -83,7 +95,7 @@ The category search filter. optional decisionDefinitionId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:242](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L242) +Defined in: [gen/types.gen.ts:255](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L255) The decision definition ID search filter. @@ -95,7 +107,7 @@ The decision definition ID search filter. optional decisionDefinitionKey: DecisionDefinitionKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:246](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L246) +Defined in: [gen/types.gen.ts:259](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L259) The decision definition key search filter. @@ -107,7 +119,7 @@ The decision definition key search filter. optional decisionEvaluationKey: DecisionEvaluationKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:250](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L250) +Defined in: [gen/types.gen.ts:263](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L263) The decision evaluation key search filter. @@ -119,7 +131,7 @@ The decision evaluation key search filter. optional decisionRequirementsId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:234](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L234) +Defined in: [gen/types.gen.ts:247](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L247) The decision requirements ID search filter. @@ -131,7 +143,7 @@ The decision requirements ID search filter. optional decisionRequirementsKey: DecisionRequirementsKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:238](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L238) +Defined in: [gen/types.gen.ts:251](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L251) The decision requirements key search filter. @@ -143,7 +155,7 @@ The decision requirements key search filter. optional deploymentKey: DeploymentKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:206](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L206) +Defined in: [gen/types.gen.ts:219](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L219) The deployment key search filter. @@ -155,7 +167,7 @@ The deployment key search filter. optional elementInstanceKey: ElementInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:166](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L166) +Defined in: [gen/types.gen.ts:175](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L175) The element instance key search filter. @@ -167,7 +179,7 @@ The element instance key search filter. optional entityDescription: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:262](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L262) +Defined in: [gen/types.gen.ts:275](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L275) The entity description filter. @@ -179,7 +191,7 @@ The entity description filter. optional entityKey: AuditLogEntityKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L190) +Defined in: [gen/types.gen.ts:203](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L203) The entity key search filter. @@ -191,7 +203,7 @@ The entity key search filter. optional entityType: EntityTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:194](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L194) +Defined in: [gen/types.gen.ts:207](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L207) The entity type search filter. @@ -203,7 +215,7 @@ The entity type search filter. optional formKey: FormKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:210](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L210) +Defined in: [gen/types.gen.ts:223](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L223) The form key search filter. @@ -215,7 +227,7 @@ The form key search filter. optional jobKey: JobKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:226](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L226) +Defined in: [gen/types.gen.ts:239](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L239) The job key search filter. @@ -227,7 +239,7 @@ The job key search filter. optional operationType: OperationTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:170](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L170) +Defined in: [gen/types.gen.ts:179](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L179) The operation type search filter. @@ -239,7 +251,7 @@ The operation type search filter. optional processDefinitionId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:222](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L222) +Defined in: [gen/types.gen.ts:235](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L235) The process definition ID search filter. @@ -251,7 +263,7 @@ The process definition ID search filter. optional processDefinitionKey: ProcessDefinitionKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:158](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L158) +Defined in: [gen/types.gen.ts:167](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L167) The process definition key search filter. @@ -263,7 +275,7 @@ The process definition key search filter. optional processInstanceKey: ProcessInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:162](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L162) +Defined in: [gen/types.gen.ts:171](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L171) The process instance key search filter. @@ -275,7 +287,7 @@ The process instance key search filter. optional relatedEntityKey: AuditLogEntityKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:254](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L254) +Defined in: [gen/types.gen.ts:267](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L267) The related entity key search filter. @@ -287,7 +299,7 @@ The related entity key search filter. optional relatedEntityType: EntityTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:258](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L258) +Defined in: [gen/types.gen.ts:271](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L271) The related entity type search filter. @@ -299,7 +311,7 @@ The related entity type search filter. optional resourceKey: ResourceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:214](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L214) +Defined in: [gen/types.gen.ts:227](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L227) The resource key search filter. @@ -311,7 +323,7 @@ The resource key search filter. optional result: AuditLogResultFilterProperty; ``` -Defined in: [gen/types.gen.ts:174](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L174) +Defined in: [gen/types.gen.ts:183](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L183) The result search filter. @@ -323,7 +335,7 @@ The result search filter. optional tenantId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:198](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L198) +Defined in: [gen/types.gen.ts:211](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L211) The tenant ID search filter. @@ -335,7 +347,7 @@ The tenant ID search filter. optional timestamp: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:178](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L178) +Defined in: [gen/types.gen.ts:187](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L187) The timestamp search filter. @@ -347,6 +359,6 @@ The timestamp search filter. optional userTaskKey: BasicStringFilterProperty; ``` -Defined in: [gen/types.gen.ts:230](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L230) +Defined in: [gen/types.gen.ts:243](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L243) The user task key search filter. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKey.md index 3dc5f012eed..c7c18590455 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKey.md @@ -11,6 +11,6 @@ mdx: type AuditLogKey = CamundaKey<"AuditLogKey">; ``` -Defined in: [gen/types.gen.ts:4101](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4101) +Defined in: [gen/types.gen.ts:4740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4740) System-generated key for an audit log entry. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKeyExactMatch.md index 207f26575a6..2d1ef119a4a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type AuditLogKeyExactMatch = AuditLogKey; ``` -Defined in: [gen/types.gen.ts:7591](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7591) +Defined in: [gen/types.gen.ts:8437](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8437) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKeyFilterProperty.md index bd4110b8c82..04023b9bdf9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogKeyFilterProperty.md @@ -13,6 +13,6 @@ type AuditLogKeyFilterProperty = | AdvancedAuditLogKeyFilter; ``` -Defined in: [gen/types.gen.ts:4370](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4370) +Defined in: [gen/types.gen.ts:5011](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5011) AuditLogKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogOperationTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogOperationTypeEnum.md index 64a97a19795..49a760954f2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogOperationTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogOperationTypeEnum.md @@ -25,6 +25,6 @@ type AuditLogOperationTypeEnum = | "UPDATE"; ``` -Defined in: [gen/types.gen.ts:288](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L288) +Defined in: [gen/types.gen.ts:301](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L301) The type of operation performed. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResult.md index 7d73da13371..f32ccbe43e3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResult.md @@ -11,367 +11,373 @@ mdx: type AuditLogResult = object; ``` -Defined in: [gen/types.gen.ts:13](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13) +Defined in: [gen/types.gen.ts:13](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13) Audit log item. ## Properties -### actorId? +### actorId ```ts -optional actorId: string; +actorId: string | null; ``` -Defined in: [gen/types.gen.ts:36](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L36) +Defined in: [gen/types.gen.ts:36](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L36) The ID of the actor who performed the operation. --- -### actorType? +### actorType ```ts -optional actorType: AuditLogActorTypeEnum; +actorType: AuditLogActorTypeEnum | null; ``` -Defined in: [gen/types.gen.ts:37](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L37) +Defined in: [gen/types.gen.ts:40](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L40) + +The type of the actor who performed the operation. --- -### annotation? +### agentElementId ```ts -optional annotation: string; +agentElementId: string | null; ``` -Defined in: [gen/types.gen.ts:46](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L46) +Defined in: [gen/types.gen.ts:44](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L44) -Additional notes about the operation. +The element ID of the agent that performed the operation (e.g. ad-hoc subprocess element ID). --- -### auditLogKey? +### auditLogKey ```ts -optional auditLogKey: AuditLogKey; +auditLogKey: AuditLogKey; ``` -Defined in: [gen/types.gen.ts:17](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17) +Defined in: [gen/types.gen.ts:17](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L17) The unique key of the audit log entry. --- -### batchOperationKey? +### batchOperationKey ```ts -optional batchOperationKey: BatchOperationKey; +batchOperationKey: BatchOperationKey | null; ``` -Defined in: [gen/types.gen.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L24) +Defined in: [gen/types.gen.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L24) Key of the batch operation. --- -### batchOperationType? +### batchOperationType ```ts -optional batchOperationType: BatchOperationTypeEnum; +batchOperationType: BatchOperationTypeEnum | null; ``` -Defined in: [gen/types.gen.ts:28](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L28) +Defined in: [gen/types.gen.ts:28](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L28) The type of batch operation performed, if this is part of a batch. --- -### category? +### category ```ts -optional category: AuditLogCategoryEnum; +category: AuditLogCategoryEnum; ``` -Defined in: [gen/types.gen.ts:47](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L47) +Defined in: [gen/types.gen.ts:50](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L50) --- -### decisionDefinitionId? +### decisionDefinitionId ```ts -optional decisionDefinitionId: DecisionDefinitionId; +decisionDefinitionId: DecisionDefinitionId | null; ``` -Defined in: [gen/types.gen.ts:84](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L84) +Defined in: [gen/types.gen.ts:93](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L93) The decision definition ID. --- -### decisionDefinitionKey? +### decisionDefinitionKey ```ts -optional decisionDefinitionKey: DecisionDefinitionKey; +decisionDefinitionKey: DecisionDefinitionKey | null; ``` -Defined in: [gen/types.gen.ts:88](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L88) +Defined in: [gen/types.gen.ts:97](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L97) The key of the decision definition. --- -### decisionEvaluationKey? +### decisionEvaluationKey ```ts -optional decisionEvaluationKey: DecisionEvaluationKey; +decisionEvaluationKey: DecisionEvaluationKey | null; ``` -Defined in: [gen/types.gen.ts:92](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L92) +Defined in: [gen/types.gen.ts:101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L101) The key of the decision evaluation. --- -### decisionRequirementsId? +### decisionRequirementsId ```ts -optional decisionRequirementsId: string; +decisionRequirementsId: string | null; ``` -Defined in: [gen/types.gen.ts:76](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L76) +Defined in: [gen/types.gen.ts:85](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L85) The decision requirements ID. --- -### decisionRequirementsKey? +### decisionRequirementsKey ```ts -optional decisionRequirementsKey: DecisionRequirementsKey; +decisionRequirementsKey: DecisionRequirementsKey | null; ``` -Defined in: [gen/types.gen.ts:80](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L80) +Defined in: [gen/types.gen.ts:89](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L89) The assigned key of the decision requirements. --- -### deploymentKey? +### deploymentKey ```ts -optional deploymentKey: DeploymentKey; +deploymentKey: DeploymentKey | null; ``` -Defined in: [gen/types.gen.ts:96](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L96) +Defined in: [gen/types.gen.ts:105](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L105) The key of the deployment. --- -### elementInstanceKey? +### elementInstanceKey ```ts -optional elementInstanceKey: ElementInstanceKey; +elementInstanceKey: ElementInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:64](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L64) +Defined in: [gen/types.gen.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L73) The key of the element instance. --- -### entityDescription? +### entityDescription ```ts -optional entityDescription: string; +entityDescription: string | null; ``` -Defined in: [gen/types.gen.ts:122](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L122) +Defined in: [gen/types.gen.ts:131](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L131) Additional description of the entity affected by the operation. For example, for variable operations, this will contain the variable name. --- -### entityKey? +### entityKey ```ts -optional entityKey: AuditLogEntityKey; +entityKey: AuditLogEntityKey; ``` -Defined in: [gen/types.gen.ts:18](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L18) +Defined in: [gen/types.gen.ts:18](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L18) --- -### entityType? +### entityType ```ts -optional entityType: AuditLogEntityTypeEnum; +entityType: AuditLogEntityTypeEnum; ``` -Defined in: [gen/types.gen.ts:19](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L19) +Defined in: [gen/types.gen.ts:19](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L19) --- -### formKey? +### formKey ```ts -optional formKey: FormKey; +formKey: FormKey | null; ``` -Defined in: [gen/types.gen.ts:100](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L100) +Defined in: [gen/types.gen.ts:109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L109) The key of the form. --- -### jobKey? +### jobKey ```ts -optional jobKey: JobKey; +jobKey: JobKey | null; ``` -Defined in: [gen/types.gen.ts:68](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L68) +Defined in: [gen/types.gen.ts:77](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L77) The key of the job. --- -### operationType? +### operationType ```ts -optional operationType: AuditLogOperationTypeEnum; +operationType: AuditLogOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L20) +Defined in: [gen/types.gen.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L20) --- -### processDefinitionId? +### processDefinitionId ```ts -optional processDefinitionId: ProcessDefinitionId; +processDefinitionId: ProcessDefinitionId | null; ``` -Defined in: [gen/types.gen.ts:51](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L51) +Defined in: [gen/types.gen.ts:54](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L54) The process definition ID. --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey | null; ``` -Defined in: [gen/types.gen.ts:55](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L55) +Defined in: [gen/types.gen.ts:58](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L58) The key of the process definition. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:59](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L59) +Defined in: [gen/types.gen.ts:62](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L62) The key of the process instance. --- -### relatedEntityKey? +### relatedEntityKey ```ts -optional relatedEntityKey: AuditLogEntityKey; +relatedEntityKey: AuditLogEntityKey | null; ``` -Defined in: [gen/types.gen.ts:110](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L110) +Defined in: [gen/types.gen.ts:119](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L119) 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. --- -### relatedEntityType? +### relatedEntityType ```ts -optional relatedEntityType: AuditLogEntityTypeEnum; +relatedEntityType: AuditLogEntityTypeEnum | null; ``` -Defined in: [gen/types.gen.ts:116](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L116) +Defined in: [gen/types.gen.ts:125](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L125) 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. --- -### resourceKey? +### resourceKey ```ts -optional resourceKey: ResourceKey; +resourceKey: ResourceKey | null; ``` -Defined in: [gen/types.gen.ts:104](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L104) +Defined in: [gen/types.gen.ts:113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L113) The system-assigned key for this resource. --- -### result? +### result ```ts -optional result: AuditLogResultEnum; +result: AuditLogResultEnum; ``` -Defined in: [gen/types.gen.ts:42](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L42) +Defined in: [gen/types.gen.ts:49](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L49) --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:60](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L60) +Defined in: [gen/types.gen.ts:69](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L69) + +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. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId | null; ``` -Defined in: [gen/types.gen.ts:41](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L41) +Defined in: [gen/types.gen.ts:48](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L48) The tenant ID of the audit log. --- -### timestamp? +### timestamp ```ts -optional timestamp: string; +timestamp: string; ``` -Defined in: [gen/types.gen.ts:32](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L32) +Defined in: [gen/types.gen.ts:32](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L32) The timestamp when the operation occurred. --- -### userTaskKey? +### userTaskKey ```ts -optional userTaskKey: UserTaskKey; +userTaskKey: UserTaskKey | null; ``` -Defined in: [gen/types.gen.ts:72](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L72) +Defined in: [gen/types.gen.ts:81](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L81) The key of the user task. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultEnum.md index a5e91bd8b7d..df6f39ea206 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultEnum.md @@ -11,6 +11,6 @@ mdx: type AuditLogResultEnum = "FAIL" | "SUCCESS"; ``` -Defined in: [gen/types.gen.ts:298](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L298) +Defined in: [gen/types.gen.ts:311](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L311) The result status of the operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultExactMatch.md index 29a6a060d23..c99581e8fde 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultExactMatch.md @@ -11,7 +11,7 @@ mdx: type AuditLogResultExactMatch = AuditLogResultEnum; ``` -Defined in: [gen/types.gen.ts:7430](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7430) +Defined in: [gen/types.gen.ts:8262](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8262) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultFilterProperty.md index 9d7557d1425..3d3774c6343 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogResultFilterProperty.md @@ -13,6 +13,6 @@ type AuditLogResultFilterProperty = | AdvancedResultFilter; ``` -Defined in: [gen/types.gen.ts:431](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L431) +Defined in: [gen/types.gen.ts:444](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L444) AuditLogResultEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQueryRequest.md index 3cdc1b06cdd..63687a169e6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type AuditLogSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:136](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L136) +Defined in: [gen/types.gen.ts:145](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L145) Audit log search request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQueryResult.md index 6152e24e222..248654193ce 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQueryResult.md @@ -11,16 +11,16 @@ mdx: type AuditLogSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:268](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L268) +Defined in: [gen/types.gen.ts:281](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L281) Audit log search response. ## Type Declaration -### items? +### items ```ts -optional items: AuditLogResult[]; +items: AuditLogResult[]; ``` The matching audit logs. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQuerySortRequest.md index 4cb8be5ef54..45d06ae41d3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuditLogSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type AuditLogSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:125](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L125) +Defined in: [gen/types.gen.ts:134](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L134) ## Properties @@ -21,7 +21,6 @@ Defined in: [gen/types.gen.ts:125](https://github.com/camunda/orchestration-clus field: | "actorId" | "actorType" - | "annotation" | "auditLogKey" | "batchOperationKey" | "batchOperationType" @@ -45,7 +44,7 @@ field: | "userTaskKey"; ``` -Defined in: [gen/types.gen.ts:129](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L129) +Defined in: [gen/types.gen.ts:138](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L138) The field to sort by. @@ -57,4 +56,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:130](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L130) +Defined in: [gen/types.gen.ts:139](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L139) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthStrategy.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthStrategy.md index 4f81bbfd07f..4459d88dcd5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthStrategy.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthStrategy.md @@ -11,4 +11,4 @@ mdx: type AuthStrategy = "NONE" | "OAUTH" | "BASIC"; ``` -Defined in: [runtime/unifiedConfiguration.ts:21](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L21) +Defined in: [runtime/unifiedConfiguration.ts:21](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L21) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationCreateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationCreateResult.md index 6bda5e22a48..78990def8c8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationCreateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationCreateResult.md @@ -11,16 +11,16 @@ mdx: type AuthorizationCreateResult = object; ``` -Defined in: [gen/types.gen.ts:657](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L657) +Defined in: [gen/types.gen.ts:670](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L670) ## Properties -### authorizationKey? +### authorizationKey ```ts -optional authorizationKey: AuthorizationKey; +authorizationKey: AuthorizationKey; ``` -Defined in: [gen/types.gen.ts:661](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L661) +Defined in: [gen/types.gen.ts:674](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L674) The key of the created authorization. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationFilter.md index 41e69bfe70a..34db902787f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationFilter.md @@ -11,7 +11,7 @@ mdx: type AuthorizationFilter = object; ``` -Defined in: [gen/types.gen.ts:602](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L602) +Defined in: [gen/types.gen.ts:615](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L615) Authorization search filter. @@ -23,7 +23,7 @@ Authorization search filter. optional ownerId: string; ``` -Defined in: [gen/types.gen.ts:606](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L606) +Defined in: [gen/types.gen.ts:619](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L619) The ID of the owner of permissions. @@ -35,7 +35,7 @@ The ID of the owner of permissions. optional ownerType: OwnerTypeEnum; ``` -Defined in: [gen/types.gen.ts:607](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L607) +Defined in: [gen/types.gen.ts:620](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L620) --- @@ -45,7 +45,7 @@ Defined in: [gen/types.gen.ts:607](https://github.com/camunda/orchestration-clus optional resourceIds: string[]; ``` -Defined in: [gen/types.gen.ts:611](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L611) +Defined in: [gen/types.gen.ts:624](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L624) The IDs of the resource to search permissions for. @@ -57,7 +57,7 @@ The IDs of the resource to search permissions for. optional resourcePropertyNames: string[]; ``` -Defined in: [gen/types.gen.ts:615](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L615) +Defined in: [gen/types.gen.ts:628](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L628) The names of the resource properties to search permissions for. @@ -69,6 +69,6 @@ The names of the resource properties to search permissions for. optional resourceType: ResourceTypeEnum; ``` -Defined in: [gen/types.gen.ts:619](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L619) +Defined in: [gen/types.gen.ts:632](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L632) The type of resource to search permissions for. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationIdBasedRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationIdBasedRequest.md index 297ce078c07..6bf0238abd4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationIdBasedRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationIdBasedRequest.md @@ -11,7 +11,7 @@ mdx: type AuthorizationIdBasedRequest = object; ``` -Defined in: [gen/types.gen.ts:533](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L533) +Defined in: [gen/types.gen.ts:546](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L546) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:533](https://github.com/camunda/orchestration-clus ownerId: string; ``` -Defined in: [gen/types.gen.ts:537](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L537) +Defined in: [gen/types.gen.ts:550](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L550) The ID of the owner of the permissions. @@ -33,7 +33,7 @@ The ID of the owner of the permissions. ownerType: OwnerTypeEnum; ``` -Defined in: [gen/types.gen.ts:538](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L538) +Defined in: [gen/types.gen.ts:551](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L551) --- @@ -43,7 +43,7 @@ Defined in: [gen/types.gen.ts:538](https://github.com/camunda/orchestration-clus permissionTypes: PermissionTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:550](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L550) +Defined in: [gen/types.gen.ts:563](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L563) The permission types to add. @@ -55,7 +55,7 @@ The permission types to add. resourceId: string; ``` -Defined in: [gen/types.gen.ts:542](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L542) +Defined in: [gen/types.gen.ts:555](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L555) The ID of the resource to add permissions to. @@ -67,6 +67,6 @@ The ID of the resource to add permissions to. resourceType: ResourceTypeEnum; ``` -Defined in: [gen/types.gen.ts:546](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L546) +Defined in: [gen/types.gen.ts:559](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L559) The type of resource to add permissions to. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationKey.md index 82c33e8e591..8661e34181c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationKey.md @@ -11,6 +11,6 @@ mdx: type AuthorizationKey = CamundaKey<"AuthorizationKey">; ``` -Defined in: [gen/types.gen.ts:682](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L682) +Defined in: [gen/types.gen.ts:695](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L695) System-generated key for an authorization. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationPropertyBasedRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationPropertyBasedRequest.md index 6c08ed7caa5..b48172deefe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationPropertyBasedRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationPropertyBasedRequest.md @@ -11,7 +11,7 @@ mdx: type AuthorizationPropertyBasedRequest = object; ``` -Defined in: [gen/types.gen.ts:553](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L553) +Defined in: [gen/types.gen.ts:566](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L566) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:553](https://github.com/camunda/orchestration-clus ownerId: string; ``` -Defined in: [gen/types.gen.ts:557](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L557) +Defined in: [gen/types.gen.ts:570](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L570) The ID of the owner of the permissions. @@ -33,7 +33,7 @@ The ID of the owner of the permissions. ownerType: OwnerTypeEnum; ``` -Defined in: [gen/types.gen.ts:558](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L558) +Defined in: [gen/types.gen.ts:571](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L571) --- @@ -43,7 +43,7 @@ Defined in: [gen/types.gen.ts:558](https://github.com/camunda/orchestration-clus permissionTypes: PermissionTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:570](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L570) +Defined in: [gen/types.gen.ts:583](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L583) The permission types to add. @@ -55,7 +55,7 @@ The permission types to add. resourcePropertyName: string; ``` -Defined in: [gen/types.gen.ts:562](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L562) +Defined in: [gen/types.gen.ts:575](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L575) The name of the resource property on which this authorization is based. @@ -67,6 +67,6 @@ The name of the resource property on which this authorization is based. resourceType: ResourceTypeEnum; ``` -Defined in: [gen/types.gen.ts:566](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L566) +Defined in: [gen/types.gen.ts:579](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L579) The type of resource to add permissions to. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationRequest.md index afc17147c7a..c112d36872a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationRequest.md @@ -13,7 +13,7 @@ type AuthorizationRequest = | AuthorizationPropertyBasedRequest; ``` -Defined in: [gen/types.gen.ts:578](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L578) +Defined in: [gen/types.gen.ts:591](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L591) Defines an authorization request. Either an id-based or a property-based authorization can be provided. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationResult.md index 0cd66493002..b5cd5e5cbb9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationResult.md @@ -11,86 +11,86 @@ mdx: type AuthorizationResult = object; ``` -Defined in: [gen/types.gen.ts:622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L622) +Defined in: [gen/types.gen.ts:635](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L635) ## Properties -### authorizationKey? +### authorizationKey ```ts -optional authorizationKey: AuthorizationKey; +authorizationKey: AuthorizationKey; ``` -Defined in: [gen/types.gen.ts:647](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L647) +Defined in: [gen/types.gen.ts:660](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L660) The key of the authorization. --- -### ownerId? +### ownerId ```ts -optional ownerId: string; +ownerId: string; ``` -Defined in: [gen/types.gen.ts:626](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L626) +Defined in: [gen/types.gen.ts:639](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L639) The ID of the owner of permissions. --- -### ownerType? +### ownerType ```ts -optional ownerType: OwnerTypeEnum; +ownerType: OwnerTypeEnum; ``` -Defined in: [gen/types.gen.ts:627](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L627) +Defined in: [gen/types.gen.ts:640](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L640) --- -### permissionTypes? +### permissionTypes ```ts -optional permissionTypes: PermissionTypeEnum[]; +permissionTypes: PermissionTypeEnum[]; ``` -Defined in: [gen/types.gen.ts:643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L643) +Defined in: [gen/types.gen.ts:656](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L656) Specifies the types of the permissions. --- -### resourceId? +### resourceId ```ts -optional resourceId: string; +resourceId: string | null; ``` -Defined in: [gen/types.gen.ts:635](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L635) +Defined in: [gen/types.gen.ts:648](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L648) ID of the resource the permission relates to (mutually exclusive with `resourcePropertyName`). --- -### resourcePropertyName? +### resourcePropertyName ```ts -optional resourcePropertyName: string; +resourcePropertyName: string | null; ``` -Defined in: [gen/types.gen.ts:639](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L639) +Defined in: [gen/types.gen.ts:652](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L652) The name of the resource property the permission relates to (mutually exclusive with `resourceId`). --- -### resourceType? +### resourceType ```ts -optional resourceType: ResourceTypeEnum; +resourceType: ResourceTypeEnum; ``` -Defined in: [gen/types.gen.ts:631](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L631) +Defined in: [gen/types.gen.ts:644](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L644) The type of resource that the permissions relate to. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchQuery.md index 637ef095a72..ce9edd17894 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchQuery.md @@ -11,7 +11,7 @@ mdx: type AuthorizationSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:588](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L588) +Defined in: [gen/types.gen.ts:601](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L601) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchQuerySortRequest.md index 6ea50c5a0bd..f332f8f4859 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type AuthorizationSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:580](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L580) +Defined in: [gen/types.gen.ts:593](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L593) ## Properties @@ -26,7 +26,7 @@ field: | "resourceType"; ``` -Defined in: [gen/types.gen.ts:584](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L584) +Defined in: [gen/types.gen.ts:597](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L597) The field to sort by. @@ -38,4 +38,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:585](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L585) +Defined in: [gen/types.gen.ts:598](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L598) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchResult.md index 7122850b3d5..43a826471df 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/AuthorizationSearchResult.md @@ -11,14 +11,14 @@ mdx: type AuthorizationSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:650](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L650) +Defined in: [gen/types.gen.ts:663](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L663) ## Type Declaration -### items? +### items ```ts -optional items: AuthorizationResult[]; +items: AuthorizationResult[]; ``` The matching authorizations. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BackpressureSeverity.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BackpressureSeverity.md index bc08c1e58b5..0323c218670 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BackpressureSeverity.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BackpressureSeverity.md @@ -11,4 +11,4 @@ mdx: type BackpressureSeverity = "healthy" | "soft" | "severe"; ``` -Defined in: [runtime/backpressure.ts:20](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/backpressure.ts#L20) +Defined in: [runtime/backpressure.ts:26](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/backpressure.ts#L26) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BaseProcessInstanceFilterFields.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BaseProcessInstanceFilterFields.md index 2b974ed38e1..322592b54d2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BaseProcessInstanceFilterFields.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BaseProcessInstanceFilterFields.md @@ -11,21 +11,48 @@ mdx: type BaseProcessInstanceFilterFields = object; ``` -Defined in: [gen/types.gen.ts:5624](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5624) +Defined in: [gen/types.gen.ts:6300](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6300) Base process instance search filter. ## Properties -### batchOperationId? +### ~~batchOperationId?~~ ```ts optional batchOperationId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:5664](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5664) +Defined in: [gen/types.gen.ts:6344](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6344) 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 + +--- + +### batchOperationKey? + +```ts +optional batchOperationKey: StringFilterProperty; +``` + +Defined in: [gen/types.gen.ts:6348](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6348) + +The batch operation key. + +--- + +### businessId? + +```ts +optional businessId: StringFilterProperty; +``` + +Defined in: [gen/types.gen.ts:6377](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6377) + +The business id associated with the process instance. --- @@ -35,7 +62,7 @@ The batch operation id. optional elementId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:5680](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5680) +Defined in: [gen/types.gen.ts:6364](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6364) The element id associated with the process instance. @@ -47,7 +74,7 @@ The element id associated with the process instance. optional elementInstanceState: ElementInstanceStateFilterProperty; ``` -Defined in: [gen/types.gen.ts:5676](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5676) +Defined in: [gen/types.gen.ts:6360](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6360) The state of the element instances associated with the process instance. @@ -59,7 +86,7 @@ The state of the element instances associated with the process instance. optional endDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:5632](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5632) +Defined in: [gen/types.gen.ts:6308](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6308) The end date. @@ -71,7 +98,7 @@ The end date. optional errorMessage: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:5668](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5668) +Defined in: [gen/types.gen.ts:6352](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6352) The error message related to the process. @@ -83,7 +110,7 @@ The error message related to the process. optional hasElementInstanceIncident: boolean; ``` -Defined in: [gen/types.gen.ts:5684](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5684) +Defined in: [gen/types.gen.ts:6368](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6368) Whether the element instance has an incident or not. @@ -95,7 +122,7 @@ Whether the element instance has an incident or not. optional hasIncident: boolean; ``` -Defined in: [gen/types.gen.ts:5640](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5640) +Defined in: [gen/types.gen.ts:6316](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6316) Whether this process instance has a related incident or not. @@ -107,7 +134,7 @@ Whether this process instance has a related incident or not. optional hasRetriesLeft: boolean; ``` -Defined in: [gen/types.gen.ts:5672](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5672) +Defined in: [gen/types.gen.ts:6356](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6356) Whether the process has failed jobs with retries left. @@ -119,7 +146,7 @@ Whether the process has failed jobs with retries left. optional incidentErrorHashCode: IntegerFilterProperty; ``` -Defined in: [gen/types.gen.ts:5688](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5688) +Defined in: [gen/types.gen.ts:6372](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6372) The incident error hash code, associated with this process. @@ -131,7 +158,7 @@ The incident error hash code, associated with this process. optional parentElementInstanceKey: ElementInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:5660](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5660) +Defined in: [gen/types.gen.ts:6336](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6336) The parent element instance key. @@ -143,7 +170,7 @@ The parent element instance key. optional parentProcessInstanceKey: ProcessInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:5656](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5656) +Defined in: [gen/types.gen.ts:6332](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6332) The parent process instance key. @@ -155,7 +182,7 @@ The parent process instance key. optional processInstanceKey: ProcessInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:5652](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5652) +Defined in: [gen/types.gen.ts:6328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6328) The key of this process instance. @@ -167,7 +194,7 @@ The key of this process instance. optional startDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:5628](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5628) +Defined in: [gen/types.gen.ts:6304](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6304) The start date. @@ -179,7 +206,7 @@ The start date. optional state: ProcessInstanceStateFilterProperty; ``` -Defined in: [gen/types.gen.ts:5636](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5636) +Defined in: [gen/types.gen.ts:6312](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6312) The process instance state. @@ -191,7 +218,7 @@ The process instance state. optional tags: TagSet; ``` -Defined in: [gen/types.gen.ts:5689](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5689) +Defined in: [gen/types.gen.ts:6373](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6373) --- @@ -201,7 +228,7 @@ Defined in: [gen/types.gen.ts:5689](https://github.com/camunda/orchestration-clu optional tenantId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:5644](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5644) +Defined in: [gen/types.gen.ts:6320](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6320) The tenant id. @@ -213,6 +240,6 @@ The tenant id. optional variables: VariableValueFilterProperty[]; ``` -Defined in: [gen/types.gen.ts:5648](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5648) +Defined in: [gen/types.gen.ts:6324](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6324) The process instance variables. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BasicStringFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BasicStringFilter.md index 89b64398a55..3c46e77d177 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BasicStringFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BasicStringFilter.md @@ -11,7 +11,7 @@ mdx: type BasicStringFilter = object; ``` -Defined in: [gen/types.gen.ts:2627](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2627) +Defined in: [gen/types.gen.ts:2785](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2785) Advanced filter @@ -25,7 +25,7 @@ Basic advanced string filter. optional $eq: string; ``` -Defined in: [gen/types.gen.ts:2631](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2631) +Defined in: [gen/types.gen.ts:2789](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2789) Checks for equality with the provided value. @@ -37,7 +37,7 @@ Checks for equality with the provided value. optional $exists: boolean; ``` -Defined in: [gen/types.gen.ts:2639](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2639) +Defined in: [gen/types.gen.ts:2797](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2797) Checks if the current property exists. @@ -49,7 +49,7 @@ Checks if the current property exists. optional $in: string[]; ``` -Defined in: [gen/types.gen.ts:2643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2643) +Defined in: [gen/types.gen.ts:2801](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2801) Checks if the property matches any of the provided values. @@ -61,7 +61,7 @@ Checks if the property matches any of the provided values. optional $neq: string; ``` -Defined in: [gen/types.gen.ts:2635](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2635) +Defined in: [gen/types.gen.ts:2793](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2793) Checks for inequality with the provided value. @@ -73,6 +73,6 @@ Checks for inequality with the provided value. optional $notIn: string[]; ``` -Defined in: [gen/types.gen.ts:2647](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2647) +Defined in: [gen/types.gen.ts:2805](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2805) Checks if the property matches none of the provided values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BasicStringFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BasicStringFilterProperty.md index a2c31cb6fec..f22a168dd04 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BasicStringFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BasicStringFilterProperty.md @@ -11,6 +11,6 @@ mdx: type BasicStringFilterProperty = string | BasicStringFilter; ``` -Defined in: [gen/types.gen.ts:2662](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2662) +Defined in: [gen/types.gen.ts:2820](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2820) String property with basic advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationCreatedResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationCreatedResult.md index 3ae1893a707..5a56744564e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationCreatedResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationCreatedResult.md @@ -11,28 +11,28 @@ mdx: type BatchOperationCreatedResult = object; ``` -Defined in: [gen/types.gen.ts:687](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L687) +Defined in: [gen/types.gen.ts:700](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L700) The created batch operation. ## Properties -### batchOperationKey? +### batchOperationKey ```ts -optional batchOperationKey: BatchOperationKey; +batchOperationKey: BatchOperationKey; ``` -Defined in: [gen/types.gen.ts:691](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L691) +Defined in: [gen/types.gen.ts:704](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L704) Key of the batch operation. --- -### batchOperationType? +### batchOperationType ```ts -optional batchOperationType: BatchOperationTypeEnum; +batchOperationType: BatchOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:692](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L692) +Defined in: [gen/types.gen.ts:705](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L705) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationError.md index 794aa0d3988..a77c99c1337 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationError.md @@ -11,40 +11,40 @@ mdx: type BatchOperationError = object; ``` -Defined in: [gen/types.gen.ts:791](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L791) +Defined in: [gen/types.gen.ts:814](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L814) ## Properties -### message? +### message ```ts -optional message: string; +message: string; ``` -Defined in: [gen/types.gen.ts:803](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L803) +Defined in: [gen/types.gen.ts:826](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L826) The error message that occurred during the batch operation. --- -### partitionId? +### partitionId ```ts -optional partitionId: number; +partitionId: number; ``` -Defined in: [gen/types.gen.ts:795](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L795) +Defined in: [gen/types.gen.ts:818](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L818) The partition ID where the error occurred. --- -### type? +### type ```ts -optional type: "QUERY_FAILED" | "RESULT_BUFFER_SIZE_EXCEEDED"; +type: "QUERY_FAILED" | "RESULT_BUFFER_SIZE_EXCEEDED"; ``` -Defined in: [gen/types.gen.ts:799](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L799) +Defined in: [gen/types.gen.ts:822](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L822) The type of the error that occurred during the batch operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationFilter.md index 8d61cdd8bc6..f8d6d67fe41 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationFilter.md @@ -11,7 +11,7 @@ mdx: type BatchOperationFilter = object; ``` -Defined in: [gen/types.gen.ts:720](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L720) +Defined in: [gen/types.gen.ts:733](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L733) Batch operation filter request. @@ -23,7 +23,7 @@ Batch operation filter request. optional actorId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:740](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L740) +Defined in: [gen/types.gen.ts:753](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L753) The ID of the actor who performed the operation. @@ -35,7 +35,7 @@ The ID of the actor who performed the operation. optional actorType: AuditLogActorTypeEnum; ``` -Defined in: [gen/types.gen.ts:736](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L736) +Defined in: [gen/types.gen.ts:749](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L749) The type of the actor who performed the operation. @@ -47,7 +47,7 @@ The type of the actor who performed the operation. optional batchOperationKey: BasicStringFilterProperty; ``` -Defined in: [gen/types.gen.ts:724](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L724) +Defined in: [gen/types.gen.ts:737](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L737) The key (or operate legacy ID) of the batch operation. @@ -59,7 +59,7 @@ The key (or operate legacy ID) of the batch operation. optional operationType: BatchOperationTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:728](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L728) +Defined in: [gen/types.gen.ts:741](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L741) The type of the batch operation. @@ -71,6 +71,6 @@ The type of the batch operation. optional state: BatchOperationStateFilterProperty; ``` -Defined in: [gen/types.gen.ts:732](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L732) +Defined in: [gen/types.gen.ts:745](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L745) The state of the batch operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemFilter.md index 36334fcb3fe..6f2e2bd6307 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemFilter.md @@ -11,7 +11,7 @@ mdx: type BatchOperationItemFilter = object; ``` -Defined in: [gen/types.gen.ts:831](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L831) +Defined in: [gen/types.gen.ts:854](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L854) Batch operation item filter request. @@ -23,7 +23,7 @@ Batch operation item filter request. optional batchOperationKey: BasicStringFilterProperty; ``` -Defined in: [gen/types.gen.ts:835](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L835) +Defined in: [gen/types.gen.ts:858](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L858) The key (or operate legacy ID) of the batch operation. @@ -35,7 +35,7 @@ The key (or operate legacy ID) of the batch operation. optional itemKey: BasicStringFilterProperty; ``` -Defined in: [gen/types.gen.ts:839](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L839) +Defined in: [gen/types.gen.ts:862](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L862) The key of the item, e.g. a process instance key. @@ -47,7 +47,7 @@ The key of the item, e.g. a process instance key. optional operationType: BatchOperationTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:851](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L851) +Defined in: [gen/types.gen.ts:874](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L874) The type of the batch operation. @@ -59,7 +59,7 @@ The type of the batch operation. optional processInstanceKey: ProcessInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:843](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L843) +Defined in: [gen/types.gen.ts:866](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L866) The process instance key of the processed item. @@ -71,6 +71,6 @@ The process instance key of the processed item. optional state: BatchOperationItemStateFilterProperty; ``` -Defined in: [gen/types.gen.ts:847](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L847) +Defined in: [gen/types.gen.ts:870](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L870) The state of the batch operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemResponse.md index 803a560040a..81b415da716 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemResponse.md @@ -11,96 +11,101 @@ mdx: type BatchOperationItemResponse = object; ``` -Defined in: [gen/types.gen.ts:861](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L861) +Defined in: [gen/types.gen.ts:884](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L884) ## Properties -### batchOperationKey? +### batchOperationKey ```ts -optional batchOperationKey: BatchOperationKey; +batchOperationKey: BatchOperationKey; ``` -Defined in: [gen/types.gen.ts:866](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L866) +Defined in: [gen/types.gen.ts:889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L889) The key (or operate legacy ID) of the batch operation. --- -### errorMessage? +### errorMessage ```ts -optional errorMessage: string; +errorMessage: string | null; ``` -Defined in: [gen/types.gen.ts:887](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L887) +Defined in: [gen/types.gen.ts:918](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L918) -the error message from the engine in case of a failed operation. +The error message from the engine in case of a failed operation. --- -### itemKey? +### itemKey ```ts -optional itemKey: string; +itemKey: string; ``` -Defined in: [gen/types.gen.ts:870](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L870) +Defined in: [gen/types.gen.ts:893](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L893) Key of the item, e.g. a process instance key. --- -### operationType? +### operationType ```ts -optional operationType: BatchOperationTypeEnum; +operationType: BatchOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:862](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L862) +Defined in: [gen/types.gen.ts:885](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L885) --- -### processedDate? +### processedDate ```ts -optional processedDate: string; +processedDate: string | null; ``` -Defined in: [gen/types.gen.ts:883](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L883) +Defined in: [gen/types.gen.ts:914](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L914) -the date this item was processed. +The date this item was processed. +This is `null` if the item has not yet been processed. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:874](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L874) +Defined in: [gen/types.gen.ts:897](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L897) the process instance key of the processed item. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:875](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L875) +Defined in: [gen/types.gen.ts:904](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L904) + +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. --- -### state? +### state ```ts -optional state: "ACTIVE" | "COMPLETED" | "SKIPPED" | "CANCELED" | "FAILED"; +state: "ACTIVE" | "COMPLETED" | "SKIPPED" | "CANCELED" | "FAILED"; ``` -Defined in: [gen/types.gen.ts:879](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L879) +Defined in: [gen/types.gen.ts:908](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L908) State of the item. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQuery.md index 806fe7b9e09..9622ce2cced 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQuery.md @@ -11,7 +11,7 @@ mdx: type BatchOperationItemSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:817](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L817) +Defined in: [gen/types.gen.ts:840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L840) Batch operation item search request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQueryResult.md index f764d489781..268bca5e1d8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQueryResult.md @@ -11,14 +11,14 @@ mdx: type BatchOperationItemSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:854](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L854) +Defined in: [gen/types.gen.ts:877](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L877) ## Type Declaration -### items? +### items ```ts -optional items: BatchOperationItemResponse[]; +items: BatchOperationItemResponse[]; ``` The matching batch operation items. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQuerySortRequest.md index 4a5cc2129a9..8588d7ed318 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type BatchOperationItemSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:806](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L806) +Defined in: [gen/types.gen.ts:829](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L829) ## Properties @@ -26,7 +26,7 @@ field: | "state"; ``` -Defined in: [gen/types.gen.ts:810](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L810) +Defined in: [gen/types.gen.ts:833](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L833) The field to sort by. @@ -38,4 +38,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:811](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L811) +Defined in: [gen/types.gen.ts:834](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L834) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateEnum.md index 00d665680ac..13bce594d2f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateEnum.md @@ -15,6 +15,6 @@ type BatchOperationItemStateEnum = | "FAILED"; ``` -Defined in: [gen/types.gen.ts:999](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L999) +Defined in: [gen/types.gen.ts:1030](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1030) The batch operation item state. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateExactMatch.md index f4cbfcc3677..5d9b6d64ddf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateExactMatch.md @@ -11,7 +11,7 @@ mdx: type BatchOperationItemStateExactMatch = BatchOperationItemStateEnum; ``` -Defined in: [gen/types.gen.ts:7458](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7458) +Defined in: [gen/types.gen.ts:8290](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8290) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateFilterProperty.md index f25c5098251..96e77b73db1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationItemStateFilterProperty.md @@ -13,6 +13,6 @@ type BatchOperationItemStateFilterProperty = | AdvancedBatchOperationItemStateFilter; ``` -Defined in: [gen/types.gen.ts:1074](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1074) +Defined in: [gen/types.gen.ts:1105](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1105) BatchOperationItemStateEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationKey.md index f4f750446d8..20dc17f70bd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationKey.md @@ -11,6 +11,6 @@ mdx: type BatchOperationKey = CamundaKey<"BatchOperationKey">; ``` -Defined in: [gen/types.gen.ts:4089](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4089) +Defined in: [gen/types.gen.ts:4728](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4728) System-generated key for an batch operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationResponse.md index 16239d6524d..ba1ebd2e3e1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationResponse.md @@ -11,130 +11,136 @@ mdx: type BatchOperationResponse = object; ``` -Defined in: [gen/types.gen.ts:753](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L753) +Defined in: [gen/types.gen.ts:766](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L766) ## Properties -### actorId? +### actorId ```ts -optional actorId: string; +actorId: string | null; ``` -Defined in: [gen/types.gen.ts:772](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L772) +Defined in: [gen/types.gen.ts:795](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L795) The ID of the actor who performed the operation. Available for batch operations created since 8.9. --- -### actorType? +### actorType ```ts -optional actorType: AuditLogActorTypeEnum; +actorType: AuditLogActorTypeEnum | null; ``` -Defined in: [gen/types.gen.ts:768](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L768) +Defined in: [gen/types.gen.ts:791](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L791) + +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. --- -### batchOperationKey? +### batchOperationKey ```ts -optional batchOperationKey: BatchOperationKey; +batchOperationKey: BatchOperationKey; ``` -Defined in: [gen/types.gen.ts:757](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L757) +Defined in: [gen/types.gen.ts:770](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L770) Key or (Operate Legacy ID = UUID) of the batch operation. --- -### batchOperationType? +### batchOperationType ```ts -optional batchOperationType: BatchOperationTypeEnum; +batchOperationType: BatchOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:759](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L759) +Defined in: [gen/types.gen.ts:772](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L772) --- -### endDate? +### endDate ```ts -optional endDate: string; +endDate: string | null; ``` -Defined in: [gen/types.gen.ts:767](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L767) +Defined in: [gen/types.gen.ts:784](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L784) The end date of the batch operation. +This is `null` if the batch operation is still running. --- -### errors? +### errors ```ts -optional errors: BatchOperationError[]; +errors: BatchOperationError[]; ``` -Defined in: [gen/types.gen.ts:788](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L788) +Defined in: [gen/types.gen.ts:811](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L811) The errors that occurred per partition during the batch operation. --- -### operationsCompletedCount? +### operationsCompletedCount ```ts -optional operationsCompletedCount: number; +operationsCompletedCount: number; ``` -Defined in: [gen/types.gen.ts:784](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L784) +Defined in: [gen/types.gen.ts:807](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L807) The number of successfully completed tasks. --- -### operationsFailedCount? +### operationsFailedCount ```ts -optional operationsFailedCount: number; +operationsFailedCount: number; ``` -Defined in: [gen/types.gen.ts:780](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L780) +Defined in: [gen/types.gen.ts:803](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L803) The number of items which failed during execution of the batch operation. (e.g. because they are rejected by the Zeebe engine). --- -### operationsTotalCount? +### operationsTotalCount ```ts -optional operationsTotalCount: number; +operationsTotalCount: number; ``` -Defined in: [gen/types.gen.ts:776](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L776) +Defined in: [gen/types.gen.ts:799](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L799) The total number of items contained in this batch operation. --- -### startDate? +### startDate ```ts -optional startDate: string; +startDate: string | null; ``` -Defined in: [gen/types.gen.ts:763](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L763) +Defined in: [gen/types.gen.ts:778](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L778) The start date of the batch operation. +This is `null` if the batch operation has not yet started. --- -### state? +### state ```ts -optional state: BatchOperationStateEnum; +state: BatchOperationStateEnum; ``` -Defined in: [gen/types.gen.ts:758](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L758) +Defined in: [gen/types.gen.ts:771](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L771) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQuery.md index 43dad67d57f..7164bed995a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQuery.md @@ -11,7 +11,7 @@ mdx: type BatchOperationSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:706](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L706) +Defined in: [gen/types.gen.ts:719](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L719) Batch operation search request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQueryResult.md index c337337c35b..0a058077409 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQueryResult.md @@ -11,16 +11,16 @@ mdx: type BatchOperationSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:746](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L746) +Defined in: [gen/types.gen.ts:759](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L759) The batch operation search query result. ## Type Declaration -### items? +### items ```ts -optional items: BatchOperationResponse[]; +items: BatchOperationResponse[]; ``` The matching batch operations. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQuerySortRequest.md index c3fe6b0c7cf..adfc145decc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type BatchOperationSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:695](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L695) +Defined in: [gen/types.gen.ts:708](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L708) ## Properties @@ -28,7 +28,7 @@ field: | "actorId"; ``` -Defined in: [gen/types.gen.ts:699](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L699) +Defined in: [gen/types.gen.ts:712](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L712) The field to sort by. @@ -40,4 +40,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:700](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L700) +Defined in: [gen/types.gen.ts:713](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L713) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateEnum.md index d4213bc2b8e..8b0c0d0025a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateEnum.md @@ -18,6 +18,6 @@ type BatchOperationStateEnum = | "SUSPENDED"; ``` -Defined in: [gen/types.gen.ts:1004](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1004) +Defined in: [gen/types.gen.ts:1035](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1035) The batch operation state. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateExactMatch.md index 9f01c290e18..d69fc617287 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateExactMatch.md @@ -11,7 +11,7 @@ mdx: type BatchOperationStateExactMatch = BatchOperationStateEnum; ``` -Defined in: [gen/types.gen.ts:7451](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7451) +Defined in: [gen/types.gen.ts:8283](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8283) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateFilterProperty.md index e6506bb4aa9..ed3808db501 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationStateFilterProperty.md @@ -13,6 +13,6 @@ type BatchOperationStateFilterProperty = | AdvancedBatchOperationStateFilter; ``` -Defined in: [gen/types.gen.ts:1044](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1044) +Defined in: [gen/types.gen.ts:1075](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1075) BatchOperationStateEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeEnum.md index 2a94ba8ade3..5d91c59e6ef 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeEnum.md @@ -21,6 +21,6 @@ type BatchOperationTypeEnum = | "UPDATE_VARIABLE"; ``` -Defined in: [gen/types.gen.ts:1009](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1009) +Defined in: [gen/types.gen.ts:1040](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1040) The type of the batch operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeExactMatch.md index 2c128e4fb5c..ba9066224eb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeExactMatch.md @@ -11,7 +11,7 @@ mdx: type BatchOperationTypeExactMatch = BatchOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:7444](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7444) +Defined in: [gen/types.gen.ts:8276](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8276) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeFilterProperty.md index 2c8b71d4dff..8a76b5f62a7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BatchOperationTypeFilterProperty.md @@ -13,6 +13,6 @@ type BatchOperationTypeFilterProperty = | AdvancedBatchOperationTypeFilter; ``` -Defined in: [gen/types.gen.ts:1014](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1014) +Defined in: [gen/types.gen.ts:1045](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1045) BatchOperationTypeEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalData.md index 47765bbc934..2a8e5227b79 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalData.md @@ -11,7 +11,7 @@ mdx: type BroadcastSignalData = object; ``` -Defined in: [gen/types.gen.ts:15411](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15411) +Defined in: [gen/types.gen.ts:14704](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14704) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15411](https://github.com/camunda/orchestration-cl body: SignalBroadcastRequest; ``` -Defined in: [gen/types.gen.ts:15412](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15412) +Defined in: [gen/types.gen.ts:14705](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14705) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15412](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:15413](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15413) +Defined in: [gen/types.gen.ts:14706](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14706) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:15413](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:15414](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15414) +Defined in: [gen/types.gen.ts:14707](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14707) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:15414](https://github.com/camunda/orchestration-cl url: "/signals/broadcast"; ``` -Defined in: [gen/types.gen.ts:15415](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15415) +Defined in: [gen/types.gen.ts:14708](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14708) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalError.md index 74a8508a948..b5a50f6df08 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalError.md @@ -11,4 +11,4 @@ mdx: type BroadcastSignalError = BroadcastSignalErrors[keyof BroadcastSignalErrors]; ``` -Defined in: [gen/types.gen.ts:15438](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15438) +Defined in: [gen/types.gen.ts:14731](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14731) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalErrors.md index 4bbc90c38db..336d67cd929 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalErrors.md @@ -11,7 +11,7 @@ mdx: type BroadcastSignalErrors = object; ``` -Defined in: [gen/types.gen.ts:15418](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15418) +Defined in: [gen/types.gen.ts:14711](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14711) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15418](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15422](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15422) +Defined in: [gen/types.gen.ts:14715](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14715) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15426](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15426) +Defined in: [gen/types.gen.ts:14719](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14719) The signal is not found. @@ -45,7 +45,7 @@ The signal is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15430](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15430) +Defined in: [gen/types.gen.ts:14723](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14723) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15435](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15435) +Defined in: [gen/types.gen.ts:14728](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14728) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalResponse.md index 290c7b2f2b1..a958dc1f22f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalResponse.md @@ -12,4 +12,4 @@ type BroadcastSignalResponse = BroadcastSignalResponses[keyof BroadcastSignalResponses]; ``` -Defined in: [gen/types.gen.ts:15447](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15447) +Defined in: [gen/types.gen.ts:14740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14740) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalResponses.md index efef8586d07..4d3a44198d6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BroadcastSignalResponses.md @@ -11,7 +11,7 @@ mdx: type BroadcastSignalResponses = object; ``` -Defined in: [gen/types.gen.ts:15440](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15440) +Defined in: [gen/types.gen.ts:14733](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14733) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15440](https://github.com/camunda/orchestration-cl 200: SignalBroadcastResult; ``` -Defined in: [gen/types.gen.ts:15444](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15444) +Defined in: [gen/types.gen.ts:14737](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14737) The signal was broadcast. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BrokerInfo.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BrokerInfo.md index 29fe1e4b189..9d5ff18b878 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/BrokerInfo.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BrokerInfo.md @@ -11,7 +11,7 @@ mdx: type BrokerInfo = object; ``` -Defined in: [gen/types.gen.ts:1297](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1297) +Defined in: [gen/types.gen.ts:1328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1328) Provides information on a broker node. @@ -23,7 +23,7 @@ Provides information on a broker node. host: string; ``` -Defined in: [gen/types.gen.ts:1305](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1305) +Defined in: [gen/types.gen.ts:1336](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1336) The hostname for reaching the broker. @@ -35,7 +35,7 @@ The hostname for reaching the broker. nodeId: number; ``` -Defined in: [gen/types.gen.ts:1301](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1301) +Defined in: [gen/types.gen.ts:1332](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1332) The unique (within a cluster) node ID for the broker. @@ -47,7 +47,7 @@ The unique (within a cluster) node ID for the broker. partitions: Partition[]; ``` -Defined in: [gen/types.gen.ts:1313](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1313) +Defined in: [gen/types.gen.ts:1344](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1344) A list of partitions managed or replicated on this broker. @@ -59,7 +59,7 @@ A list of partitions managed or replicated on this broker. port: number; ``` -Defined in: [gen/types.gen.ts:1309](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1309) +Defined in: [gen/types.gen.ts:1340](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1340) The port for reaching the broker. @@ -71,6 +71,6 @@ The port for reaching the broker. version: string; ``` -Defined in: [gen/types.gen.ts:1317](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1317) +Defined in: [gen/types.gen.ts:1348](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1348) The broker version. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/BusinessId.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/BusinessId.md new file mode 100644 index 00000000000..6d5f61d0487 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/BusinessId.md @@ -0,0 +1,20 @@ +--- +title: "Type Alias: BusinessId" +sidebar_label: "BusinessId" +mdx: + format: md +--- + +# Type Alias: BusinessId + +```ts +type BusinessId = CamundaKey<"BusinessId">; +``` + +Defined in: [gen/types.gen.ts:3359](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3359) + +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. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaClientLoose.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaClientLoose.md index 5bf6b24e60a..f8aaad35e41 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaClientLoose.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaClientLoose.md @@ -11,4 +11,4 @@ mdx: type CamundaClientLoose = ReturnType; ``` -Defined in: [loose.ts:50](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/loose.ts#L50) +Defined in: [loose.ts:50](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/loose.ts#L50) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaFpClient.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaFpClient.md index 70991670222..96de7f5894f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaFpClient.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaFpClient.md @@ -11,4 +11,4 @@ mdx: type CamundaFpClient = Fpify; ``` -Defined in: [fp-ts.ts:79](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L79) +Defined in: [fp-ts.ts:79](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L79) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaKey.md index ad237eea7a5..d9ce4750ab2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaKey.md @@ -11,7 +11,7 @@ mdx: type CamundaKey = string & object; ``` -Defined in: [gen/types.gen.ts:3](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3) +Defined in: [gen/types.gen.ts:3](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaResultClient.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaResultClient.md index bb71acc0407..4d4dc63eead 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaResultClient.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaResultClient.md @@ -23,7 +23,7 @@ type CamundaResultClient = object & { }; ``` -Defined in: [resultClient.ts:48](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/resultClient.ts#L48) +Defined in: [resultClient.ts:48](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/resultClient.ts#L48) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaUserResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaUserResult.md index 655b8f4c70e..8239f2da571 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaUserResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CamundaUserResult.md @@ -11,17 +11,17 @@ mdx: type CamundaUserResult = object; ``` -Defined in: [gen/types.gen.ts:488](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L488) +Defined in: [gen/types.gen.ts:501](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L501) ## Properties -### authorizedComponents? +### authorizedComponents ```ts -optional authorizedComponents: string[]; +authorizedComponents: string[]; ``` -Defined in: [gen/types.gen.ts:504](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L504) +Defined in: [gen/types.gen.ts:517](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L517) The web components the user is authorized to use. @@ -33,7 +33,7 @@ The web components the user is authorized to use. c8Links: object; ``` -Defined in: [gen/types.gen.ts:524](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L524) +Defined in: [gen/types.gen.ts:537](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L537) The links to the components in the C8 stack. @@ -51,31 +51,31 @@ The links to the components in the C8 stack. canLogout: boolean; ``` -Defined in: [gen/types.gen.ts:530](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L530) +Defined in: [gen/types.gen.ts:543](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L543) Flag for understanding if the user is able to perform logout. --- -### displayName? +### displayName ```ts -optional displayName: string | null; +displayName: string | null; ``` -Defined in: [gen/types.gen.ts:496](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L496) +Defined in: [gen/types.gen.ts:509](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L509) The display name of the user. --- -### email? +### email ```ts -optional email: string | null; +email: string | null; ``` -Defined in: [gen/types.gen.ts:500](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L500) +Defined in: [gen/types.gen.ts:513](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L513) The email of the user. @@ -87,7 +87,7 @@ The email of the user. groups: string[]; ``` -Defined in: [gen/types.gen.ts:512](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L512) +Defined in: [gen/types.gen.ts:525](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L525) The groups assigned to the user. @@ -99,7 +99,7 @@ The groups assigned to the user. roles: string[]; ``` -Defined in: [gen/types.gen.ts:516](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L516) +Defined in: [gen/types.gen.ts:529](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L529) The roles assigned to the user. @@ -108,10 +108,10 @@ The roles assigned to the user. ### salesPlanType ```ts -salesPlanType: string; +salesPlanType: string | null; ``` -Defined in: [gen/types.gen.ts:520](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L520) +Defined in: [gen/types.gen.ts:533](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L533) The plan of the user. @@ -123,18 +123,18 @@ The plan of the user. tenants: TenantResult[]; ``` -Defined in: [gen/types.gen.ts:508](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L508) +Defined in: [gen/types.gen.ts:521](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L521) The tenants the user is a member of. --- -### username? +### username ```ts -optional username: Username | null; +username: Username | null; ``` -Defined in: [gen/types.gen.ts:492](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L492) +Defined in: [gen/types.gen.ts:505](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L505) The username of the user. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationData.md index bbbd2477db9..305d177f011 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationData.md @@ -11,7 +11,7 @@ mdx: type CancelBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:8384](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8384) +Defined in: [gen/types.gen.ts:8907](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8907) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8384](https://github.com/camunda/orchestration-clu optional body: unknown; ``` -Defined in: [gen/types.gen.ts:8385](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8385) +Defined in: [gen/types.gen.ts:8908](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8908) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8385](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8386](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8386) +Defined in: [gen/types.gen.ts:8909](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8909) #### batchOperationKey @@ -49,7 +49,7 @@ The key (or operate legacy ID) of the batch operation. optional query: never; ``` -Defined in: [gen/types.gen.ts:8392](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8392) +Defined in: [gen/types.gen.ts:8915](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8915) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8392](https://github.com/camunda/orchestration-clu url: "/batch-operations/{batchOperationKey}/cancellation"; ``` -Defined in: [gen/types.gen.ts:8393](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8393) +Defined in: [gen/types.gen.ts:8916](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8916) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationError.md index f19e7956237..ff423d26921 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationError.md @@ -12,4 +12,4 @@ type CancelBatchOperationError = CancelBatchOperationErrors[keyof CancelBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:8415](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8415) +Defined in: [gen/types.gen.ts:8938](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8938) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationErrors.md index 39293ea49e7..2813375c9e0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type CancelBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:8396](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8396) +Defined in: [gen/types.gen.ts:8919](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8919) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8396](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8400](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8400) +Defined in: [gen/types.gen.ts:8923](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8923) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8404](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8404) +Defined in: [gen/types.gen.ts:8927](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8927) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8408](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8408) +Defined in: [gen/types.gen.ts:8931](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8931) Not found. The batch operation was not found. @@ -57,6 +57,6 @@ Not found. The batch operation was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8412](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8412) +Defined in: [gen/types.gen.ts:8935](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8935) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationResponse.md index 5506af10dda..7beaacb98c0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationResponse.md @@ -12,4 +12,4 @@ type CancelBatchOperationResponse = CancelBatchOperationResponses[keyof CancelBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:8424](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8424) +Defined in: [gen/types.gen.ts:8947](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8947) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationResponses.md index 8d53669a063..eccc134c57f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type CancelBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:8417](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8417) +Defined in: [gen/types.gen.ts:8940](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8940) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8417](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:8421](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8421) +Defined in: [gen/types.gen.ts:8944](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8944) The batch operation cancel request was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceData.md index f23afc3e179..b7e18c8f7a5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceData.md @@ -11,7 +11,7 @@ mdx: type CancelProcessInstanceData = object; ``` -Defined in: [gen/types.gen.ts:13926](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13926) +Defined in: [gen/types.gen.ts:13317](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13317) ## Properties @@ -25,7 +25,7 @@ optional body: | null; ``` -Defined in: [gen/types.gen.ts:13927](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13927) +Defined in: [gen/types.gen.ts:13318](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13318) --- @@ -35,7 +35,7 @@ Defined in: [gen/types.gen.ts:13927](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:13930](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13930) +Defined in: [gen/types.gen.ts:13321](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13321) #### processInstanceKey @@ -53,7 +53,7 @@ The key of the process instance to cancel. optional query: never; ``` -Defined in: [gen/types.gen.ts:13936](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13936) +Defined in: [gen/types.gen.ts:13327](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13327) --- @@ -63,4 +63,4 @@ Defined in: [gen/types.gen.ts:13936](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}/cancellation"; ``` -Defined in: [gen/types.gen.ts:13937](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13937) +Defined in: [gen/types.gen.ts:13328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13328) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceError.md index db10add3c1a..5c23fd4ce33 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceError.md @@ -12,4 +12,4 @@ type CancelProcessInstanceError = CancelProcessInstanceErrors[keyof CancelProcessInstanceErrors]; ``` -Defined in: [gen/types.gen.ts:13960](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13960) +Defined in: [gen/types.gen.ts:13357](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13357) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceErrors.md index 598cd8d16b3..6ec417d0b92 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceErrors.md @@ -11,7 +11,7 @@ mdx: type CancelProcessInstanceErrors = object; ``` -Defined in: [gen/types.gen.ts:13940](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13940) +Defined in: [gen/types.gen.ts:13331](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13331) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13940](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13944](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13944) +Defined in: [gen/types.gen.ts:13335](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13335) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13948](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13948) +Defined in: [gen/types.gen.ts:13339](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13339) The process instance is not found. @@ -45,7 +45,7 @@ The process instance is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13952](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13952) +Defined in: [gen/types.gen.ts:13343](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13343) An internal error occurred while processing the request. @@ -57,6 +57,19 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13957) +Defined in: [gen/types.gen.ts:13348](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13348) 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 . + +--- + +### 504 + +```ts +504: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:13354](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13354) + +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 diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceRequest.md index 309d1f02be8..5a761e671fd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceRequest.md @@ -13,4 +13,4 @@ type CancelProcessInstanceRequest = { } | null; ``` -Defined in: [gen/types.gen.ts:5850](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5850) +Defined in: [gen/types.gen.ts:6557](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6557) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceResponse.md index 8e9597a6c01..1fe9c2ebcbf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceResponse.md @@ -12,4 +12,4 @@ type CancelProcessInstanceResponse = CancelProcessInstanceResponses[keyof CancelProcessInstanceResponses]; ``` -Defined in: [gen/types.gen.ts:13969](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13969) +Defined in: [gen/types.gen.ts:13366](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13366) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceResponses.md index cb6d021b648..4973c05ff93 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstanceResponses.md @@ -11,7 +11,7 @@ mdx: type CancelProcessInstanceResponses = object; ``` -Defined in: [gen/types.gen.ts:13962](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13962) +Defined in: [gen/types.gen.ts:13359](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13359) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13962](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:13966](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13966) +Defined in: [gen/types.gen.ts:13363](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13363) The process instance is canceled. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationData.md index 9f0e9f82f7f..c536d045213 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationData.md @@ -11,33 +11,17 @@ mdx: type CancelProcessInstancesBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:13381](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13381) +Defined in: [gen/types.gen.ts:12998](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12998) ## Properties ### body ```ts -body: object; +body: ProcessInstanceCancellationBatchOperationRequest; ``` -Defined in: [gen/types.gen.ts:13385](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13385) - -The process instance filter that defines which process instances should be canceled. - -#### filter - -```ts -filter: ProcessInstanceFilter; -``` - -The process instance filter. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` +Defined in: [gen/types.gen.ts:12999](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12999) --- @@ -47,7 +31,7 @@ optional operationReference: OperationReference; optional path: never; ``` -Defined in: [gen/types.gen.ts:13392](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13392) +Defined in: [gen/types.gen.ts:13000](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13000) --- @@ -57,7 +41,7 @@ Defined in: [gen/types.gen.ts:13392](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:13393](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13393) +Defined in: [gen/types.gen.ts:13001](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13001) --- @@ -67,4 +51,4 @@ Defined in: [gen/types.gen.ts:13393](https://github.com/camunda/orchestration-cl url: "/process-instances/cancellation"; ``` -Defined in: [gen/types.gen.ts:13394](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13394) +Defined in: [gen/types.gen.ts:13002](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13002) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationError.md index 5c65586f0d8..80bddd81102 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationError.md @@ -12,4 +12,4 @@ type CancelProcessInstancesBatchOperationError = CancelProcessInstancesBatchOperationErrors[keyof CancelProcessInstancesBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:13417](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13417) +Defined in: [gen/types.gen.ts:13025](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13025) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationErrors.md index 5b7a20329a4..38f6b115395 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type CancelProcessInstancesBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:13397](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13397) +Defined in: [gen/types.gen.ts:13005](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13005) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13397](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13402](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13402) +Defined in: [gen/types.gen.ts:13010](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13010) The process instance batch operation failed. More details are provided in the response body. @@ -33,7 +33,7 @@ The process instance batch operation failed. More details are provided in the re 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13406](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13406) +Defined in: [gen/types.gen.ts:13014](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13014) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13410](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13410) +Defined in: [gen/types.gen.ts:13018](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13018) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13414](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13414) +Defined in: [gen/types.gen.ts:13022](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13022) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationResponse.md index 29fe6d23cd6..cbfbe39132b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationResponse.md @@ -12,4 +12,4 @@ type CancelProcessInstancesBatchOperationResponse = CancelProcessInstancesBatchOperationResponses[keyof CancelProcessInstancesBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:13426](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13426) +Defined in: [gen/types.gen.ts:13034](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13034) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationResponses.md index 3b766a7cd25..c1be6e48dd8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CancelProcessInstancesBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type CancelProcessInstancesBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:13419](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13419) +Defined in: [gen/types.gen.ts:13027](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13027) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13419](https://github.com/camunda/orchestration-cl 200: BatchOperationCreatedResult; ``` -Defined in: [gen/types.gen.ts:13423](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13423) +Defined in: [gen/types.gen.ts:13031](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13031) The batch operation request was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CategoryExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CategoryExactMatch.md index 4634b946cb9..1721a71f657 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CategoryExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CategoryExactMatch.md @@ -11,7 +11,7 @@ mdx: type CategoryExactMatch = AuditLogCategoryEnum; ``` -Defined in: [gen/types.gen.ts:7423](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7423) +Defined in: [gen/types.gen.ts:8255](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8255) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CategoryFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CategoryFilterProperty.md index 6cc50e24f54..d525f1e50c4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CategoryFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CategoryFilterProperty.md @@ -11,6 +11,6 @@ mdx: type CategoryFilterProperty = CategoryExactMatch | AdvancedCategoryFilter; ``` -Defined in: [gen/types.gen.ts:401](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L401) +Defined in: [gen/types.gen.ts:414](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L414) AuditLogCategoryEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/Changeset.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/Changeset.md index ec4f2cae627..03740765767 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/Changeset.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/Changeset.md @@ -18,7 +18,7 @@ type Changeset = { } | null; ``` -Defined in: [gen/types.gen.ts:7002](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7002) +Defined in: [gen/types.gen.ts:7788](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7788) JSON object with changed task attribute values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClientOptions.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClientOptions.md index 6925e72f544..0b77a9ebcb4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClientOptions.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClientOptions.md @@ -11,7 +11,7 @@ mdx: type ClientOptions = object; ``` -Defined in: [gen/types.gen.ts:6](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6) +Defined in: [gen/types.gen.ts:6](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/types.gen.ts:6](https://github.com/camunda/orchestration-cluste baseUrl: "{schema}://{host}:{port}/v2" | (string & object); ``` -Defined in: [gen/types.gen.ts:7](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7) +Defined in: [gen/types.gen.ts:7](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClockPinRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClockPinRequest.md index 89cd6a61b33..c8a9e2ccf7b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClockPinRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClockPinRequest.md @@ -11,7 +11,7 @@ mdx: type ClockPinRequest = object; ``` -Defined in: [gen/types.gen.ts:1101](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1101) +Defined in: [gen/types.gen.ts:1132](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1132) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:1101](https://github.com/camunda/orchestration-clu timestamp: number; ``` -Defined in: [gen/types.gen.ts:1105](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1105) +Defined in: [gen/types.gen.ts:1136](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1136) The exact time in epoch milliseconds to which the clock should be pinned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableResult.md index b37b8f62cc7..92b089ea0b2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableResult.md @@ -11,14 +11,14 @@ mdx: type ClusterVariableResult = ClusterVariableResultBase & object; ``` -Defined in: [gen/types.gen.ts:1135](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1135) +Defined in: [gen/types.gen.ts:1166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1166) ## Type Declaration -### value? +### value ```ts -optional value: string; +value: string; ``` Full value of this cluster variable. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableResultBase.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableResultBase.md index e57c76f7679..75565570b95 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableResultBase.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableResultBase.md @@ -11,7 +11,7 @@ mdx: type ClusterVariableResultBase = object; ``` -Defined in: [gen/types.gen.ts:1159](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1159) +Defined in: [gen/types.gen.ts:1190](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1190) Cluster variable response item. @@ -23,7 +23,7 @@ Cluster variable response item. name: string; ``` -Defined in: [gen/types.gen.ts:1163](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1163) +Defined in: [gen/types.gen.ts:1194](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1194) The name of the cluster variable. Unique within its scope (global or tenant-specific). @@ -35,16 +35,16 @@ The name of the cluster variable. Unique within its scope (global or tenant-spec scope: ClusterVariableScopeEnum; ``` -Defined in: [gen/types.gen.ts:1164](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1164) +Defined in: [gen/types.gen.ts:1195](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1195) --- -### tenantId? +### tenantId ```ts -optional tenantId: string; +tenantId: string | null; ``` -Defined in: [gen/types.gen.ts:1168](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1168) +Defined in: [gen/types.gen.ts:1199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1199) -Only provided if the cluster variable scope is TENANT. +Only provided if the cluster variable scope is TENANT. Null for global scope variables. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeEnum.md index f0bf4c844e0..ec430b80b11 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeEnum.md @@ -11,6 +11,6 @@ mdx: type ClusterVariableScopeEnum = "GLOBAL" | "TENANT"; ``` -Defined in: [gen/types.gen.ts:1111](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1111) +Defined in: [gen/types.gen.ts:1142](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1142) The scope of a cluster variable. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeExactMatch.md index 251b49f3a96..989f187a3aa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeExactMatch.md @@ -11,7 +11,7 @@ mdx: type ClusterVariableScopeExactMatch = ClusterVariableScopeEnum; ``` -Defined in: [gen/types.gen.ts:7465](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7465) +Defined in: [gen/types.gen.ts:8297](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8297) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeFilterProperty.md index 6ebfe555105..63f91e6dae5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableScopeFilterProperty.md @@ -13,6 +13,6 @@ type ClusterVariableScopeFilterProperty = | AdvancedClusterVariableScopeFilter; ``` -Defined in: [gen/types.gen.ts:1223](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1223) +Defined in: [gen/types.gen.ts:1254](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1254) ClusterVariableScopeEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryFilterRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryFilterRequest.md index 5dfc76ef89c..040333ca686 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryFilterRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryFilterRequest.md @@ -11,7 +11,7 @@ mdx: type ClusterVariableSearchQueryFilterRequest = object; ``` -Defined in: [gen/types.gen.ts:1196](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1196) +Defined in: [gen/types.gen.ts:1227](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1227) Cluster variable filter request. @@ -23,7 +23,7 @@ Cluster variable filter request. optional isTruncated: boolean; ``` -Defined in: [gen/types.gen.ts:1217](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1217) +Defined in: [gen/types.gen.ts:1248](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1248) 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. @@ -35,7 +35,7 @@ Filter cluster variables by truncation status of their stored values. When true, optional name: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:1200](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1200) +Defined in: [gen/types.gen.ts:1231](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1231) Name of the cluster variable. @@ -47,7 +47,7 @@ Name of the cluster variable. optional scope: ClusterVariableScopeFilterProperty; ``` -Defined in: [gen/types.gen.ts:1208](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1208) +Defined in: [gen/types.gen.ts:1239](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1239) The scope filter for cluster variables. @@ -59,7 +59,7 @@ The scope filter for cluster variables. optional tenantId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:1212](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1212) +Defined in: [gen/types.gen.ts:1243](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1243) Tenant ID of this variable. @@ -71,6 +71,6 @@ Tenant ID of this variable. optional value: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:1204](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1204) +Defined in: [gen/types.gen.ts:1235](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1235) The value of the cluster variable. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryRequest.md index c6761b440ff..eab3cad58f3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type ClusterVariableSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:1174](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1174) +Defined in: [gen/types.gen.ts:1205](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1205) Cluster variable search query request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryResult.md index 7d84cf604b3..3cb6af5fe6d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQueryResult.md @@ -11,16 +11,16 @@ mdx: type ClusterVariableSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:1253](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1253) +Defined in: [gen/types.gen.ts:1284](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1284) Cluster variable search query response. ## Type Declaration -### items? +### items ```ts -optional items: ClusterVariableSearchResult[]; +items: ClusterVariableSearchResult[]; ``` The matching cluster variables. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQuerySortRequest.md index 82c30ed8048..ea405512526 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type ClusterVariableSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:1185](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1185) +Defined in: [gen/types.gen.ts:1216](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1216) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:1185](https://github.com/camunda/orchestration-clu field: "name" | "value" | "tenantId" | "scope"; ``` -Defined in: [gen/types.gen.ts:1189](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1189) +Defined in: [gen/types.gen.ts:1220](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1220) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:1190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1190) +Defined in: [gen/types.gen.ts:1221](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1221) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchResult.md index 53dd26ef922..bbf17d5dc98 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ClusterVariableSearchResult.md @@ -11,24 +11,24 @@ mdx: type ClusterVariableSearchResult = ClusterVariableResultBase & object; ``` -Defined in: [gen/types.gen.ts:1145](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1145) +Defined in: [gen/types.gen.ts:1176](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1176) Cluster variable search response item. ## Type Declaration -### isTruncated? +### isTruncated ```ts -optional isTruncated: boolean; +isTruncated: boolean; ``` Whether the value is truncated or not. -### value? +### value ```ts -optional value: string; +value: string; ``` Value of this cluster variable. Can be truncated. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobData.md index 0193922e706..33520d5d663 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobData.md @@ -11,7 +11,7 @@ mdx: type CompleteJobData = object; ``` -Defined in: [gen/types.gen.ts:11986](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11986) +Defined in: [gen/types.gen.ts:11912](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11912) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11986](https://github.com/camunda/orchestration-cl optional body: JobCompletionRequest; ``` -Defined in: [gen/types.gen.ts:11987](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11987) +Defined in: [gen/types.gen.ts:11913](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11913) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11987](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11988](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11988) +Defined in: [gen/types.gen.ts:11914](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11914) #### jobKey @@ -49,7 +49,7 @@ The key of the job to complete. optional query: never; ``` -Defined in: [gen/types.gen.ts:11994](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11994) +Defined in: [gen/types.gen.ts:11920](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11920) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:11994](https://github.com/camunda/orchestration-cl url: "/jobs/{jobKey}/completion"; ``` -Defined in: [gen/types.gen.ts:11995](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11995) +Defined in: [gen/types.gen.ts:11921](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11921) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobError.md index 0b97ac7b203..0fe4a4c6bae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobError.md @@ -11,4 +11,4 @@ mdx: type CompleteJobError = CompleteJobErrors[keyof CompleteJobErrors]; ``` -Defined in: [gen/types.gen.ts:12023](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12023) +Defined in: [gen/types.gen.ts:11949](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11949) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobErrors.md index b7fed23e4d8..eb4abbce735 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobErrors.md @@ -11,7 +11,7 @@ mdx: type CompleteJobErrors = object; ``` -Defined in: [gen/types.gen.ts:11998](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11998) +Defined in: [gen/types.gen.ts:11924](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11924) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11998](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12002](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12002) +Defined in: [gen/types.gen.ts:11928](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11928) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12006](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12006) +Defined in: [gen/types.gen.ts:11932](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11932) The job with the given key was not found. @@ -45,7 +45,7 @@ The job with the given key was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12011](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12011) +Defined in: [gen/types.gen.ts:11937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11937) The job with the given key is in the wrong state currently. More details are provided in the response body. @@ -57,7 +57,7 @@ The job with the given key is in the wrong state currently. More details are pro 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12015](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12015) +Defined in: [gen/types.gen.ts:11941](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11941) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12020](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12020) +Defined in: [gen/types.gen.ts:11946](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11946) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobResponse.md index 47894224e2b..9bded421789 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobResponse.md @@ -11,4 +11,4 @@ mdx: type CompleteJobResponse = CompleteJobResponses[keyof CompleteJobResponses]; ``` -Defined in: [gen/types.gen.ts:12032](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12032) +Defined in: [gen/types.gen.ts:11958](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11958) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobResponses.md index 9ac5c6e012f..ac9a8380cc0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteJobResponses.md @@ -11,7 +11,7 @@ mdx: type CompleteJobResponses = object; ``` -Defined in: [gen/types.gen.ts:12025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12025) +Defined in: [gen/types.gen.ts:11951](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11951) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12025](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:12029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12029) +Defined in: [gen/types.gen.ts:11955](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11955) The job was completed successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskData.md index d8b13093650..118c99d3ce9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskData.md @@ -11,7 +11,7 @@ mdx: type CompleteUserTaskData = object; ``` -Defined in: [gen/types.gen.ts:17333](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17333) +Defined in: [gen/types.gen.ts:16297](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16297) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17333](https://github.com/camunda/orchestration-cl optional body: UserTaskCompletionRequest; ``` -Defined in: [gen/types.gen.ts:17334](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17334) +Defined in: [gen/types.gen.ts:16298](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16298) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:17334](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:17335](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17335) +Defined in: [gen/types.gen.ts:16299](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16299) #### userTaskKey @@ -49,7 +49,7 @@ The key of the user task to complete. optional query: never; ``` -Defined in: [gen/types.gen.ts:17341](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17341) +Defined in: [gen/types.gen.ts:16305](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16305) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:17341](https://github.com/camunda/orchestration-cl url: "/user-tasks/{userTaskKey}/completion"; ``` -Defined in: [gen/types.gen.ts:17342](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17342) +Defined in: [gen/types.gen.ts:16306](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16306) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskError.md index 2731fdecb45..53556868961 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskError.md @@ -12,4 +12,4 @@ type CompleteUserTaskError = CompleteUserTaskErrors[keyof CompleteUserTaskErrors]; ``` -Defined in: [gen/types.gen.ts:17370](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17370) +Defined in: [gen/types.gen.ts:16340](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16340) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskErrors.md index 20e3e468510..abd4e4698b5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskErrors.md @@ -11,7 +11,7 @@ mdx: type CompleteUserTaskErrors = object; ``` -Defined in: [gen/types.gen.ts:17345](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17345) +Defined in: [gen/types.gen.ts:16309](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16309) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17345](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17349](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17349) +Defined in: [gen/types.gen.ts:16313](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16313) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17353](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17353) +Defined in: [gen/types.gen.ts:16317](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16317) The user task with the given key was not found. @@ -45,7 +45,7 @@ The user task with the given key was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17358](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17358) +Defined in: [gen/types.gen.ts:16322](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16322) The user task with the given key is in the wrong state currently. More details are provided in the response body. @@ -57,7 +57,7 @@ The user task with the given key is in the wrong state currently. More details a 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17362](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17362) +Defined in: [gen/types.gen.ts:16326](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16326) An internal error occurred while processing the request. @@ -69,6 +69,19 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17367](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17367) +Defined in: [gen/types.gen.ts:16331](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16331) 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 . + +--- + +### 504 + +```ts +504: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:16337](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16337) + +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 diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskResponse.md index 3c8801df5a4..61729176ffb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskResponse.md @@ -12,4 +12,4 @@ type CompleteUserTaskResponse = CompleteUserTaskResponses[keyof CompleteUserTaskResponses]; ``` -Defined in: [gen/types.gen.ts:17379](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17379) +Defined in: [gen/types.gen.ts:16349](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16349) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskResponses.md index b24d56b85b7..e52d43176ff 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CompleteUserTaskResponses.md @@ -11,7 +11,7 @@ mdx: type CompleteUserTaskResponses = object; ``` -Defined in: [gen/types.gen.ts:17372](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17372) +Defined in: [gen/types.gen.ts:16342](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16342) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:17372](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:17376](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17376) +Defined in: [gen/types.gen.ts:16346](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16346) The user task was completed successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ConditionalEvaluationInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ConditionalEvaluationInstruction.md index d6af1eaa00e..1e075f60632 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ConditionalEvaluationInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ConditionalEvaluationInstruction.md @@ -11,7 +11,7 @@ mdx: type ConditionalEvaluationInstruction = object; ``` -Defined in: [gen/types.gen.ts:1338](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1338) +Defined in: [gen/types.gen.ts:1369](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1369) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:1338](https://github.com/camunda/orchestration-clu optional processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1349](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1349) +Defined in: [gen/types.gen.ts:1380](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1380) Used to evaluate root-level conditional start events of the process definition with the given key. @@ -33,7 +33,7 @@ Used to evaluate root-level conditional start events of the process definition w optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1344](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1344) +Defined in: [gen/types.gen.ts:1375](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1375) 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. @@ -46,7 +46,7 @@ This will only evaluate root-level conditional start events of process definitio variables: object; ``` -Defined in: [gen/types.gen.ts:1354](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1354) +Defined in: [gen/types.gen.ts:1385](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1385) JSON object representing the variables to use for evaluation of the conditions and to pass to the process instances that have been triggered. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ConditionalEvaluationKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ConditionalEvaluationKey.md index a4b007e9add..6f0c317e8b6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ConditionalEvaluationKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ConditionalEvaluationKey.md @@ -11,6 +11,6 @@ mdx: type ConditionalEvaluationKey = CamundaKey<"ConditionalEvaluationKey">; ``` -Defined in: [gen/types.gen.ts:1377](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1377) +Defined in: [gen/types.gen.ts:1408](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1408) System-generated key for a conditional evaluation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageData.md index 8a706d00575..50176b594ce 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageData.md @@ -11,7 +11,7 @@ mdx: type CorrelateMessageData = object; ``` -Defined in: [gen/types.gen.ts:12557](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12557) +Defined in: [gen/types.gen.ts:12531](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12531) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12557](https://github.com/camunda/orchestration-cl body: MessageCorrelationRequest; ``` -Defined in: [gen/types.gen.ts:12558](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12558) +Defined in: [gen/types.gen.ts:12532](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12532) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12558](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:12559](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12559) +Defined in: [gen/types.gen.ts:12533](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12533) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:12559](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:12560](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12560) +Defined in: [gen/types.gen.ts:12534](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12534) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:12560](https://github.com/camunda/orchestration-cl url: "/messages/correlation"; ``` -Defined in: [gen/types.gen.ts:12561](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12561) +Defined in: [gen/types.gen.ts:12535](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12535) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageError.md index 618e90cf397..baa128f3bb1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageError.md @@ -12,4 +12,4 @@ type CorrelateMessageError = CorrelateMessageErrors[keyof CorrelateMessageErrors]; ``` -Defined in: [gen/types.gen.ts:12588](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12588) +Defined in: [gen/types.gen.ts:12562](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12562) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageErrors.md index 451dd215534..585951af085 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageErrors.md @@ -11,7 +11,7 @@ mdx: type CorrelateMessageErrors = object; ``` -Defined in: [gen/types.gen.ts:12564](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12564) +Defined in: [gen/types.gen.ts:12538](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12538) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12564](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12568](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12568) +Defined in: [gen/types.gen.ts:12542](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12542) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12572](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12572) +Defined in: [gen/types.gen.ts:12546](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12546) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12576](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12576) +Defined in: [gen/types.gen.ts:12550](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12550) Not found @@ -57,7 +57,7 @@ Not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12580](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12580) +Defined in: [gen/types.gen.ts:12554](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12554) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12585](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12585) +Defined in: [gen/types.gen.ts:12559](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12559) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageResponse.md index e70eae21b49..bba7cf4f035 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageResponse.md @@ -12,4 +12,4 @@ type CorrelateMessageResponse = CorrelateMessageResponses[keyof CorrelateMessageResponses]; ``` -Defined in: [gen/types.gen.ts:12597](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12597) +Defined in: [gen/types.gen.ts:12571](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12571) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageResponses.md index 926a562057c..38b068d7812 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelateMessageResponses.md @@ -11,7 +11,7 @@ mdx: type CorrelateMessageResponses = object; ``` -Defined in: [gen/types.gen.ts:12590](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12590) +Defined in: [gen/types.gen.ts:12564](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12564) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12590](https://github.com/camunda/orchestration-cl 200: MessageCorrelationResult; ``` -Defined in: [gen/types.gen.ts:12594](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12594) +Defined in: [gen/types.gen.ts:12568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12568) The message is correlated to one or more process instances diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionFilter.md index e1ce1541f68..fd9b73f3649 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionFilter.md @@ -11,7 +11,7 @@ mdx: type CorrelatedMessageSubscriptionFilter = object; ``` -Defined in: [gen/types.gen.ts:4926](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4926) +Defined in: [gen/types.gen.ts:5581](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5581) Correlated message subscriptions search filter. @@ -23,7 +23,7 @@ Correlated message subscriptions search filter. optional correlationKey: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4930](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4930) +Defined in: [gen/types.gen.ts:5585](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5585) The correlation key of the message. @@ -35,7 +35,7 @@ The correlation key of the message. optional correlationTime: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:4934](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4934) +Defined in: [gen/types.gen.ts:5589](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5589) The time when the message was correlated. @@ -47,7 +47,7 @@ The time when the message was correlated. optional elementId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4938](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4938) +Defined in: [gen/types.gen.ts:5593](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5593) The element ID that received the message. @@ -59,7 +59,7 @@ The element ID that received the message. optional elementInstanceKey: ElementInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:4942](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4942) +Defined in: [gen/types.gen.ts:5597](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5597) The element instance key that received the message. @@ -71,7 +71,7 @@ The element instance key that received the message. optional messageKey: BasicStringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4946](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4946) +Defined in: [gen/types.gen.ts:5601](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5601) The message key. @@ -83,7 +83,7 @@ The message key. optional messageName: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4950) +Defined in: [gen/types.gen.ts:5605](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5605) The name of the message. @@ -95,7 +95,7 @@ The name of the message. optional partitionId: IntegerFilterProperty; ``` -Defined in: [gen/types.gen.ts:4954](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4954) +Defined in: [gen/types.gen.ts:5609](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5609) The partition ID that correlated the message. @@ -107,7 +107,7 @@ The partition ID that correlated the message. optional processDefinitionId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4958](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4958) +Defined in: [gen/types.gen.ts:5613](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5613) The process definition ID associated with this correlated message subscription. @@ -119,7 +119,7 @@ The process definition ID associated with this correlated message subscription. optional processDefinitionKey: ProcessDefinitionKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:4962](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4962) +Defined in: [gen/types.gen.ts:5617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5617) 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. @@ -131,7 +131,7 @@ The process definition key associated with this correlated message subscription. optional processInstanceKey: ProcessInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:4966](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4966) +Defined in: [gen/types.gen.ts:5621](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5621) The process instance key associated with this correlated message subscription. @@ -143,7 +143,7 @@ The process instance key associated with this correlated message subscription. optional subscriptionKey: MessageSubscriptionKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:4970](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4970) +Defined in: [gen/types.gen.ts:5625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5625) The subscription key that received the message. @@ -155,6 +155,6 @@ The subscription key that received the message. optional tenantId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4974](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4974) +Defined in: [gen/types.gen.ts:5629](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5629) The tenant ID associated with this correlated message subscription. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionResult.md index 1426fc2a33f..916f26806b4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionResult.md @@ -11,17 +11,17 @@ mdx: type CorrelatedMessageSubscriptionResult = object; ``` -Defined in: [gen/types.gen.ts:4847](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4847) +Defined in: [gen/types.gen.ts:5494](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5494) ## Properties ### correlationKey ```ts -correlationKey: string; +correlationKey: string | null; ``` -Defined in: [gen/types.gen.ts:4851](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4851) +Defined in: [gen/types.gen.ts:5498](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5498) The correlation key of the message. @@ -33,7 +33,7 @@ The correlation key of the message. correlationTime: string; ``` -Defined in: [gen/types.gen.ts:4855](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4855) +Defined in: [gen/types.gen.ts:5502](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5502) The time when the message was correlated. @@ -45,21 +45,22 @@ The time when the message was correlated. elementId: string; ``` -Defined in: [gen/types.gen.ts:4859](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4859) +Defined in: [gen/types.gen.ts:5506](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5506) The element ID that received the message. --- -### elementInstanceKey? +### elementInstanceKey ```ts -optional elementInstanceKey: ElementInstanceKey; +elementInstanceKey: ElementInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:4863](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4863) +Defined in: [gen/types.gen.ts:5512](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5512) The element instance key that received the message. +It is `null` for start event subscriptions. --- @@ -69,7 +70,7 @@ The element instance key that received the message. messageKey: MessageKey; ``` -Defined in: [gen/types.gen.ts:4867](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4867) +Defined in: [gen/types.gen.ts:5516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5516) The message key. @@ -81,7 +82,7 @@ The message key. messageName: string; ``` -Defined in: [gen/types.gen.ts:4871](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4871) +Defined in: [gen/types.gen.ts:5520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5520) The name of the message. @@ -93,7 +94,7 @@ The name of the message. partitionId: number; ``` -Defined in: [gen/types.gen.ts:4875](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4875) +Defined in: [gen/types.gen.ts:5524](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5524) The partition ID that correlated the message. @@ -105,19 +106,19 @@ The partition ID that correlated the message. processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:4879](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4879) +Defined in: [gen/types.gen.ts:5528](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5528) The process definition ID associated with this correlated message subscription. --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:4883](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4883) +Defined in: [gen/types.gen.ts:5532](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5532) The process definition key associated with this correlated message subscription. @@ -129,19 +130,23 @@ The process definition key associated with this correlated message subscription. processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:4887](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4887) +Defined in: [gen/types.gen.ts:5536](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5536) The process instance key associated with this correlated message subscription. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:4888](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4888) +Defined in: [gen/types.gen.ts:5543](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5543) + +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. --- @@ -151,7 +156,7 @@ Defined in: [gen/types.gen.ts:4888](https://github.com/camunda/orchestration-clu subscriptionKey: MessageSubscriptionKey; ``` -Defined in: [gen/types.gen.ts:4892](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4892) +Defined in: [gen/types.gen.ts:5547](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5547) The subscription key that received the message. @@ -163,6 +168,6 @@ The subscription key that received the message. tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:4896](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4896) +Defined in: [gen/types.gen.ts:5551](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5551) The tenant ID associated with this correlated message subscription. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQuery.md index ef6b56980b0..1183866e3ce 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQuery.md @@ -11,7 +11,7 @@ mdx: type CorrelatedMessageSubscriptionSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:4899](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4899) +Defined in: [gen/types.gen.ts:5554](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5554) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQueryResult.md index b9a6dcd6d20..babf643e51d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQueryResult.md @@ -12,14 +12,14 @@ type CorrelatedMessageSubscriptionSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:4840](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4840) +Defined in: [gen/types.gen.ts:5487](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5487) ## Type Declaration -### items? +### items ```ts -optional items: CorrelatedMessageSubscriptionResult[]; +items: CorrelatedMessageSubscriptionResult[]; ``` The matching correlated message subscriptions. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQuerySortRequest.md index f154a13bbbd..d5b308a3401 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CorrelatedMessageSubscriptionSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type CorrelatedMessageSubscriptionSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:4910](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4910) +Defined in: [gen/types.gen.ts:5565](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5565) ## Properties @@ -33,7 +33,7 @@ field: | "tenantId"; ``` -Defined in: [gen/types.gen.ts:4914](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4914) +Defined in: [gen/types.gen.ts:5569](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5569) The field to sort by. @@ -45,4 +45,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:4915](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4915) +Defined in: [gen/types.gen.ts:5570](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5570) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserData.md index 4104d25205a..e90291fe9bc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserData.md @@ -11,7 +11,7 @@ mdx: type CreateAdminUserData = object; ``` -Defined in: [gen/types.gen.ts:15373](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15373) +Defined in: [gen/types.gen.ts:14666](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14666) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15373](https://github.com/camunda/orchestration-cl body: UserRequest; ``` -Defined in: [gen/types.gen.ts:15374](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15374) +Defined in: [gen/types.gen.ts:14667](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14667) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15374](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:15375](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15375) +Defined in: [gen/types.gen.ts:14668](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14668) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:15375](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:15376](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15376) +Defined in: [gen/types.gen.ts:14669](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14669) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:15376](https://github.com/camunda/orchestration-cl url: "/setup/user"; ``` -Defined in: [gen/types.gen.ts:15377](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15377) +Defined in: [gen/types.gen.ts:14670](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14670) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserError.md index 267943ba644..e13be426109 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserError.md @@ -11,4 +11,4 @@ mdx: type CreateAdminUserError = CreateAdminUserErrors[keyof CreateAdminUserErrors]; ``` -Defined in: [gen/types.gen.ts:15400](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15400) +Defined in: [gen/types.gen.ts:14693](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14693) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserErrors.md index 8b7e9b1b335..d8c61d76f4b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserErrors.md @@ -11,7 +11,7 @@ mdx: type CreateAdminUserErrors = object; ``` -Defined in: [gen/types.gen.ts:15380](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15380) +Defined in: [gen/types.gen.ts:14673](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14673) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15380](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15384](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15384) +Defined in: [gen/types.gen.ts:14677](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14677) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15388](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15388) +Defined in: [gen/types.gen.ts:14681](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14681) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15392](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15392) +Defined in: [gen/types.gen.ts:14685](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14685) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15397](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15397) +Defined in: [gen/types.gen.ts:14690](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14690) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserResponse.md index 6a9dbf2fb23..fde52c9d1ed 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserResponse.md @@ -12,4 +12,4 @@ type CreateAdminUserResponse = CreateAdminUserResponses[keyof CreateAdminUserResponses]; ``` -Defined in: [gen/types.gen.ts:15409](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15409) +Defined in: [gen/types.gen.ts:14702](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14702) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserResponses.md index 59653c07d7a..1fb9d3aa480 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAdminUserResponses.md @@ -11,7 +11,7 @@ mdx: type CreateAdminUserResponses = object; ``` -Defined in: [gen/types.gen.ts:15402](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15402) +Defined in: [gen/types.gen.ts:14695](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14695) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15402](https://github.com/camunda/orchestration-cl 201: UserCreateResult; ``` -Defined in: [gen/types.gen.ts:15406](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15406) +Defined in: [gen/types.gen.ts:14699](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14699) The admin user was created successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationData.md index c75528c60c4..73ef14c14d6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationData.md @@ -11,7 +11,7 @@ mdx: type CreateAuthorizationData = object; ``` -Defined in: [gen/types.gen.ts:7979](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7979) +Defined in: [gen/types.gen.ts:8600](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8600) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7979](https://github.com/camunda/orchestration-clu body: AuthorizationRequest; ``` -Defined in: [gen/types.gen.ts:7980](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7980) +Defined in: [gen/types.gen.ts:8601](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8601) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:7980](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:7981](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7981) +Defined in: [gen/types.gen.ts:8602](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8602) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:7981](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:7982](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7982) +Defined in: [gen/types.gen.ts:8603](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8603) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:7982](https://github.com/camunda/orchestration-clu url: "/authorizations"; ``` -Defined in: [gen/types.gen.ts:7983](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7983) +Defined in: [gen/types.gen.ts:8604](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8604) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationError.md index 0dc87e66ac7..24067e5cb16 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationError.md @@ -12,4 +12,4 @@ type CreateAuthorizationError = CreateAuthorizationErrors[keyof CreateAuthorizationErrors]; ``` -Defined in: [gen/types.gen.ts:8014](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8014) +Defined in: [gen/types.gen.ts:8635](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8635) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationErrors.md index 7cc7501b738..174313cc652 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationErrors.md @@ -11,7 +11,7 @@ mdx: type CreateAuthorizationErrors = object; ``` -Defined in: [gen/types.gen.ts:7986](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7986) +Defined in: [gen/types.gen.ts:8607](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8607) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7986](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7990](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7990) +Defined in: [gen/types.gen.ts:8611](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8611) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7994](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7994) +Defined in: [gen/types.gen.ts:8615](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8615) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7998](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7998) +Defined in: [gen/types.gen.ts:8619](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8619) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8002](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8002) +Defined in: [gen/types.gen.ts:8623](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8623) The owner was not found. @@ -69,7 +69,7 @@ The owner was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8006](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8006) +Defined in: [gen/types.gen.ts:8627](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8627) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8011](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8011) +Defined in: [gen/types.gen.ts:8632](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8632) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationResponse.md index 6a2c56daacd..b2beee3693e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationResponse.md @@ -12,4 +12,4 @@ type CreateAuthorizationResponse = CreateAuthorizationResponses[keyof CreateAuthorizationResponses]; ``` -Defined in: [gen/types.gen.ts:8023](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8023) +Defined in: [gen/types.gen.ts:8644](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8644) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationResponses.md index 93bad6e7f78..eb74fccedbb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateAuthorizationResponses.md @@ -11,7 +11,7 @@ mdx: type CreateAuthorizationResponses = object; ``` -Defined in: [gen/types.gen.ts:8016](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8016) +Defined in: [gen/types.gen.ts:8637](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8637) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8016](https://github.com/camunda/orchestration-clu 201: AuthorizationCreateResult; ``` -Defined in: [gen/types.gen.ts:8020](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8020) +Defined in: [gen/types.gen.ts:8641](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8641) The authorization was created successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateClusterVariableRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateClusterVariableRequest.md index 4bda8e0e92a..60f3ff1e20e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateClusterVariableRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateClusterVariableRequest.md @@ -11,7 +11,7 @@ mdx: type CreateClusterVariableRequest = object; ``` -Defined in: [gen/types.gen.ts:1113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1113) +Defined in: [gen/types.gen.ts:1144](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1144) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:1113](https://github.com/camunda/orchestration-clu name: string; ``` -Defined in: [gen/types.gen.ts:1117](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1117) +Defined in: [gen/types.gen.ts:1148](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1148) The name of the cluster variable. Must be unique within its scope (global or tenant-specific). @@ -33,7 +33,7 @@ The name of the cluster variable. Must be unique within its scope (global or ten value: object; ``` -Defined in: [gen/types.gen.ts:1121](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1121) +Defined in: [gen/types.gen.ts:1152](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1152) The value of the cluster variable. Can be any JSON object or primitive value. Will be serialized as a JSON string in responses. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentData.md index bb2019dc896..0d5b99911fc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentData.md @@ -11,7 +11,7 @@ mdx: type CreateDeploymentData = object; ``` -Defined in: [gen/types.gen.ts:9939](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9939) +Defined in: [gen/types.gen.ts:10069](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10069) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9939](https://github.com/camunda/orchestration-clu body: object; ``` -Defined in: [gen/types.gen.ts:9940](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9940) +Defined in: [gen/types.gen.ts:10070](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10070) #### resources @@ -45,7 +45,7 @@ optional tenantId: TenantId; optional path: never; ``` -Defined in: [gen/types.gen.ts:9948](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9948) +Defined in: [gen/types.gen.ts:10078](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10078) --- @@ -55,7 +55,7 @@ Defined in: [gen/types.gen.ts:9948](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:9949](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9949) +Defined in: [gen/types.gen.ts:10079](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10079) --- @@ -65,4 +65,4 @@ Defined in: [gen/types.gen.ts:9949](https://github.com/camunda/orchestration-clu url: "/deployments"; ``` -Defined in: [gen/types.gen.ts:9950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9950) +Defined in: [gen/types.gen.ts:10080](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10080) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentError.md index 3a7a25723a7..5cbddf36b8d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentError.md @@ -12,4 +12,4 @@ type CreateDeploymentError = CreateDeploymentErrors[keyof CreateDeploymentErrors]; ``` -Defined in: [gen/types.gen.ts:9965](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9965) +Defined in: [gen/types.gen.ts:10095](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10095) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentErrors.md index 40d33d1121c..2f22bbf9dda 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentErrors.md @@ -11,7 +11,7 @@ mdx: type CreateDeploymentErrors = object; ``` -Defined in: [gen/types.gen.ts:9953](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9953) +Defined in: [gen/types.gen.ts:10083](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10083) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9953](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9957) +Defined in: [gen/types.gen.ts:10087](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10087) The provided data is not valid. @@ -33,6 +33,6 @@ The provided data is not valid. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9962](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9962) +Defined in: [gen/types.gen.ts:10092](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10092) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentResponse.md index fb80ff539fd..b9149aea998 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentResponse.md @@ -12,4 +12,4 @@ type CreateDeploymentResponse = CreateDeploymentResponses[keyof CreateDeploymentResponses]; ``` -Defined in: [gen/types.gen.ts:10010](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10010) +Defined in: [gen/types.gen.ts:10104](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10104) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentResponses.md index eb2172ac425..90de4787bf0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDeploymentResponses.md @@ -11,40 +11,16 @@ mdx: type CreateDeploymentResponses = object; ``` -Defined in: [gen/types.gen.ts:9967](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9967) +Defined in: [gen/types.gen.ts:10097](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10097) ## Properties ### 200 ```ts -200: object; +200: DeploymentResult; ``` -Defined in: [gen/types.gen.ts:9971](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9971) +Defined in: [gen/types.gen.ts:10101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10101) The resources are deployed. - -#### deploymentKey - -```ts -deploymentKey: DeploymentKey; -``` - -The unique key identifying the deployment. - -#### deployments - -```ts -deployments: object[]; -``` - -Items deployed by the request. - -#### tenantId - -```ts -tenantId: TenantId; -``` - -The tenant ID associated with the deployment. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentData.md index 383dbce82ca..f31cbd26399 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentData.md @@ -11,7 +11,7 @@ mdx: type CreateDocumentData = object; ``` -Defined in: [gen/types.gen.ts:10012](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10012) +Defined in: [gen/types.gen.ts:10106](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10106) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10012](https://github.com/camunda/orchestration-cl body: object; ``` -Defined in: [gen/types.gen.ts:10013](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10013) +Defined in: [gen/types.gen.ts:10107](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10107) #### file @@ -43,7 +43,7 @@ optional metadata: DocumentMetadata; optional path: never; ``` -Defined in: [gen/types.gen.ts:10017](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10017) +Defined in: [gen/types.gen.ts:10111](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10111) --- @@ -53,7 +53,7 @@ Defined in: [gen/types.gen.ts:10017](https://github.com/camunda/orchestration-cl optional query: object; ``` -Defined in: [gen/types.gen.ts:10018](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10018) +Defined in: [gen/types.gen.ts:10112](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10112) #### documentId? @@ -79,4 +79,4 @@ The ID of the document store to upload the documents to. Currently, only a singl url: "/documents"; ``` -Defined in: [gen/types.gen.ts:10029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10029) +Defined in: [gen/types.gen.ts:10123](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10123) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentError.md index c82f325e2f1..d8fe8a8dcb1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentError.md @@ -11,4 +11,4 @@ mdx: type CreateDocumentError = CreateDocumentErrors[keyof CreateDocumentErrors]; ``` -Defined in: [gen/types.gen.ts:10045](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10045) +Defined in: [gen/types.gen.ts:10139](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10139) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentErrors.md index 4b967d82fae..9159311b6ed 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentErrors.md @@ -11,7 +11,7 @@ mdx: type CreateDocumentErrors = object; ``` -Defined in: [gen/types.gen.ts:10032](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10032) +Defined in: [gen/types.gen.ts:10126](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10126) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10032](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10036](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10036) +Defined in: [gen/types.gen.ts:10130](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10130) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 415: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10042](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10042) +Defined in: [gen/types.gen.ts:10136](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10136) 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. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkData.md index dd9f15b253a..abbcd7f4fde 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkData.md @@ -11,7 +11,7 @@ mdx: type CreateDocumentLinkData = object; ``` -Defined in: [gen/types.gen.ts:10189](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10189) +Defined in: [gen/types.gen.ts:10283](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10283) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10189](https://github.com/camunda/orchestration-cl optional body: DocumentLinkRequest; ``` -Defined in: [gen/types.gen.ts:10190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10190) +Defined in: [gen/types.gen.ts:10284](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10284) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10190](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10191](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10191) +Defined in: [gen/types.gen.ts:10285](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10285) #### documentId @@ -49,7 +49,7 @@ The ID of the document to link. optional query: object; ``` -Defined in: [gen/types.gen.ts:10197](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10197) +Defined in: [gen/types.gen.ts:10291](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10291) #### contentHash? @@ -75,4 +75,4 @@ The ID of the document store where the document is located. url: "/documents/{documentId}/links"; ``` -Defined in: [gen/types.gen.ts:10208](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10208) +Defined in: [gen/types.gen.ts:10302](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10302) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkError.md index dcae2f272ec..4020a2ebe3b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkError.md @@ -12,4 +12,4 @@ type CreateDocumentLinkError = CreateDocumentLinkErrors[keyof CreateDocumentLinkErrors]; ``` -Defined in: [gen/types.gen.ts:10218](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10218) +Defined in: [gen/types.gen.ts:10312](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10312) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkErrors.md index ac9f1034085..f56144f72fd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkErrors.md @@ -11,7 +11,7 @@ mdx: type CreateDocumentLinkErrors = object; ``` -Defined in: [gen/types.gen.ts:10211](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10211) +Defined in: [gen/types.gen.ts:10305](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10305) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10211](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10215](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10215) +Defined in: [gen/types.gen.ts:10309](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10309) The provided data is not valid. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkResponse.md index e70d9fa162e..05f99e6a7f2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkResponse.md @@ -12,4 +12,4 @@ type CreateDocumentLinkResponse = CreateDocumentLinkResponses[keyof CreateDocumentLinkResponses]; ``` -Defined in: [gen/types.gen.ts:10227](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10227) +Defined in: [gen/types.gen.ts:10321](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10321) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkResponses.md index 5c56533ae40..c64623f3261 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentLinkResponses.md @@ -11,7 +11,7 @@ mdx: type CreateDocumentLinkResponses = object; ``` -Defined in: [gen/types.gen.ts:10220](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10220) +Defined in: [gen/types.gen.ts:10314](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10314) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10220](https://github.com/camunda/orchestration-cl 201: DocumentLink; ``` -Defined in: [gen/types.gen.ts:10224](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10224) +Defined in: [gen/types.gen.ts:10318](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10318) The document link was created successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentResponse.md index a5eae689390..40c42e331f4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentResponse.md @@ -12,4 +12,4 @@ type CreateDocumentResponse = CreateDocumentResponses[keyof CreateDocumentResponses]; ``` -Defined in: [gen/types.gen.ts:10054](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10054) +Defined in: [gen/types.gen.ts:10148](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10148) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentResponses.md index a613addb4a1..967680c784a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentResponses.md @@ -11,7 +11,7 @@ mdx: type CreateDocumentResponses = object; ``` -Defined in: [gen/types.gen.ts:10047](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10047) +Defined in: [gen/types.gen.ts:10141](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10141) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10047](https://github.com/camunda/orchestration-cl 201: DocumentReference; ``` -Defined in: [gen/types.gen.ts:10051](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10051) +Defined in: [gen/types.gen.ts:10145](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10145) The document was uploaded successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsData.md index 3afec1fbd48..57fb873dd9d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsData.md @@ -11,7 +11,7 @@ mdx: type CreateDocumentsData = object; ``` -Defined in: [gen/types.gen.ts:10056](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10056) +Defined in: [gen/types.gen.ts:10150](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10150) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10056](https://github.com/camunda/orchestration-cl body: object; ``` -Defined in: [gen/types.gen.ts:10057](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10057) +Defined in: [gen/types.gen.ts:10151](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10151) #### files @@ -47,7 +47,7 @@ Optional JSON array of metadata object whose index aligns with each file entry. optional path: never; ``` -Defined in: [gen/types.gen.ts:10068](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10068) +Defined in: [gen/types.gen.ts:10162](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10162) --- @@ -57,7 +57,7 @@ Defined in: [gen/types.gen.ts:10068](https://github.com/camunda/orchestration-cl optional query: object; ``` -Defined in: [gen/types.gen.ts:10069](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10069) +Defined in: [gen/types.gen.ts:10163](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10163) #### storeId? @@ -75,4 +75,4 @@ The ID of the document store to upload the documents to. Currently, only a singl url: "/documents/batch"; ``` -Defined in: [gen/types.gen.ts:10075](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10075) +Defined in: [gen/types.gen.ts:10169](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10169) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsError.md index 2a8649531c3..4cf88db0960 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsError.md @@ -11,4 +11,4 @@ mdx: type CreateDocumentsError = CreateDocumentsErrors[keyof CreateDocumentsErrors]; ``` -Defined in: [gen/types.gen.ts:10091](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10091) +Defined in: [gen/types.gen.ts:10185](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10185) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsErrors.md index aca3e62f325..acf1b15379d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsErrors.md @@ -11,7 +11,7 @@ mdx: type CreateDocumentsErrors = object; ``` -Defined in: [gen/types.gen.ts:10078](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10078) +Defined in: [gen/types.gen.ts:10172](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10172) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10078](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10082](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10082) +Defined in: [gen/types.gen.ts:10176](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10176) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 415: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10088](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10088) +Defined in: [gen/types.gen.ts:10182](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10182) 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. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsResponse.md index 8083ce9c943..5294ad4e557 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsResponse.md @@ -12,4 +12,4 @@ type CreateDocumentsResponse = CreateDocumentsResponses[keyof CreateDocumentsResponses]; ``` -Defined in: [gen/types.gen.ts:10104](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10104) +Defined in: [gen/types.gen.ts:10198](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10198) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsResponses.md index 0231d8d4772..c35ce12e0ef 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateDocumentsResponses.md @@ -11,7 +11,7 @@ mdx: type CreateDocumentsResponses = object; ``` -Defined in: [gen/types.gen.ts:10093](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10093) +Defined in: [gen/types.gen.ts:10187](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10187) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10093](https://github.com/camunda/orchestration-cl 201: DocumentCreationBatchResponse; ``` -Defined in: [gen/types.gen.ts:10097](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10097) +Defined in: [gen/types.gen.ts:10191](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10191) All documents were uploaded successfully. @@ -33,6 +33,6 @@ All documents were uploaded successfully. 207: DocumentCreationBatchResponse; ``` -Defined in: [gen/types.gen.ts:10101](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10101) +Defined in: [gen/types.gen.ts:10195](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10195) Some documents were uploaded successfully, others failed. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesData.md index de157dd3ead..108039dda77 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesData.md @@ -11,7 +11,7 @@ mdx: type CreateElementInstanceVariablesData = object; ``` -Defined in: [gen/types.gen.ts:10570](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10570) +Defined in: [gen/types.gen.ts:10505](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10505) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10570](https://github.com/camunda/orchestration-cl body: SetVariableRequest; ``` -Defined in: [gen/types.gen.ts:10571](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10571) +Defined in: [gen/types.gen.ts:10506](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10506) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10571](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10572](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10572) +Defined in: [gen/types.gen.ts:10507](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10507) #### elementInstanceKey @@ -51,7 +51,7 @@ element, such as a service task (see the `elementInstanceKey` on the job message optional query: never; ``` -Defined in: [gen/types.gen.ts:10581](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10581) +Defined in: [gen/types.gen.ts:10516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10516) --- @@ -61,4 +61,4 @@ Defined in: [gen/types.gen.ts:10581](https://github.com/camunda/orchestration-cl url: "/element-instances/{elementInstanceKey}/variables"; ``` -Defined in: [gen/types.gen.ts:10582](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10582) +Defined in: [gen/types.gen.ts:10517](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10517) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesError.md index d90f61b15a3..49027614bd0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesError.md @@ -12,4 +12,4 @@ type CreateElementInstanceVariablesError = CreateElementInstanceVariablesErrors[keyof CreateElementInstanceVariablesErrors]; ``` -Defined in: [gen/types.gen.ts:10601](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10601) +Defined in: [gen/types.gen.ts:10542](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10542) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesErrors.md index 934ae022632..44aa4a6545c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesErrors.md @@ -11,7 +11,7 @@ mdx: type CreateElementInstanceVariablesErrors = object; ``` -Defined in: [gen/types.gen.ts:10585](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10585) +Defined in: [gen/types.gen.ts:10520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10520) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10585](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10589](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10589) +Defined in: [gen/types.gen.ts:10524](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10524) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10593](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10593) +Defined in: [gen/types.gen.ts:10528](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10528) An internal error occurred while processing the request. @@ -45,6 +45,19 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10598](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10598) +Defined in: [gen/types.gen.ts:10533](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10533) 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 . + +--- + +### 504 + +```ts +504: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10539](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10539) + +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 diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesResponse.md index 16281b0f1df..b5e48651b27 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesResponse.md @@ -12,4 +12,4 @@ type CreateElementInstanceVariablesResponse = CreateElementInstanceVariablesResponses[keyof CreateElementInstanceVariablesResponses]; ``` -Defined in: [gen/types.gen.ts:10610](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10610) +Defined in: [gen/types.gen.ts:10551](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10551) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesResponses.md index 97227386b90..0811131a353 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateElementInstanceVariablesResponses.md @@ -11,7 +11,7 @@ mdx: type CreateElementInstanceVariablesResponses = object; ``` -Defined in: [gen/types.gen.ts:10603](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10603) +Defined in: [gen/types.gen.ts:10544](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10544) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10603](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:10607](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10607) +Defined in: [gen/types.gen.ts:10548](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10548) The variables were updated. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableData.md index d783ca532af..42b21522890 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableData.md @@ -11,7 +11,7 @@ mdx: type CreateGlobalClusterVariableData = object; ``` -Defined in: [gen/types.gen.ts:8584](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8584) +Defined in: [gen/types.gen.ts:9107](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9107) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8584](https://github.com/camunda/orchestration-clu body: CreateClusterVariableRequest; ``` -Defined in: [gen/types.gen.ts:8585](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8585) +Defined in: [gen/types.gen.ts:9108](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9108) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8585](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:8586](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8586) +Defined in: [gen/types.gen.ts:9109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9109) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:8586](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:8587](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8587) +Defined in: [gen/types.gen.ts:9110](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9110) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:8587](https://github.com/camunda/orchestration-clu url: "/cluster-variables/global"; ``` -Defined in: [gen/types.gen.ts:8588](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8588) +Defined in: [gen/types.gen.ts:9111](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9111) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableError.md index 3957ef390f4..7c0f9c629ed 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableError.md @@ -12,4 +12,4 @@ type CreateGlobalClusterVariableError = CreateGlobalClusterVariableErrors[keyof CreateGlobalClusterVariableErrors]; ``` -Defined in: [gen/types.gen.ts:8610](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8610) +Defined in: [gen/types.gen.ts:9133](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9133) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableErrors.md index ffc51e3c945..a356acbbb1e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableErrors.md @@ -11,7 +11,7 @@ mdx: type CreateGlobalClusterVariableErrors = object; ``` -Defined in: [gen/types.gen.ts:8591](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8591) +Defined in: [gen/types.gen.ts:9114](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9114) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8591](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8595](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8595) +Defined in: [gen/types.gen.ts:9118](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9118) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8599](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8599) +Defined in: [gen/types.gen.ts:9122](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9122) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8603](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8603) +Defined in: [gen/types.gen.ts:9126](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9126) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8607](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8607) +Defined in: [gen/types.gen.ts:9130](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9130) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableResponse.md index 66daf07a36d..fbd817175c6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableResponse.md @@ -12,4 +12,4 @@ type CreateGlobalClusterVariableResponse = CreateGlobalClusterVariableResponses[keyof CreateGlobalClusterVariableResponses]; ``` -Defined in: [gen/types.gen.ts:8619](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8619) +Defined in: [gen/types.gen.ts:9142](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9142) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableResponses.md index 145a18cf84a..277cc8cff2d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalClusterVariableResponses.md @@ -11,7 +11,7 @@ mdx: type CreateGlobalClusterVariableResponses = object; ``` -Defined in: [gen/types.gen.ts:8612](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8612) +Defined in: [gen/types.gen.ts:9135](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9135) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8612](https://github.com/camunda/orchestration-clu 200: ClusterVariableResult; ``` -Defined in: [gen/types.gen.ts:8616](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8616) +Defined in: [gen/types.gen.ts:9139](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9139) Cluster variable created diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerData.md new file mode 100644 index 00000000000..481bec7ffc3 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerData.md @@ -0,0 +1,54 @@ +--- +title: "Type Alias: CreateGlobalTaskListenerData" +sidebar_label: "CreateGlobalTaskListenerData" +mdx: + format: md +--- + +# Type Alias: CreateGlobalTaskListenerData + +```ts +type CreateGlobalTaskListenerData = object; +``` + +Defined in: [gen/types.gen.ts:10590](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10590) + +## Properties + +### body + +```ts +body: CreateGlobalTaskListenerRequest; +``` + +Defined in: [gen/types.gen.ts:10591](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10591) + +--- + +### path? + +```ts +optional path: never; +``` + +Defined in: [gen/types.gen.ts:10592](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10592) + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:10593](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10593) + +--- + +### url + +```ts +url: "/global-task-listeners"; +``` + +Defined in: [gen/types.gen.ts:10594](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10594) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerError.md new file mode 100644 index 00000000000..ea651d71d80 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: CreateGlobalTaskListenerError" +sidebar_label: "CreateGlobalTaskListenerError" +mdx: + format: md +--- + +# Type Alias: CreateGlobalTaskListenerError + +```ts +type CreateGlobalTaskListenerError = + CreateGlobalTaskListenerErrors[keyof CreateGlobalTaskListenerErrors]; +``` + +Defined in: [gen/types.gen.ts:10625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10625) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerErrors.md new file mode 100644 index 00000000000..01f42d84d1a --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerErrors.md @@ -0,0 +1,86 @@ +--- +title: "Type Alias: CreateGlobalTaskListenerErrors" +sidebar_label: "CreateGlobalTaskListenerErrors" +mdx: + format: md +--- + +# Type Alias: CreateGlobalTaskListenerErrors + +```ts +type CreateGlobalTaskListenerErrors = object; +``` + +Defined in: [gen/types.gen.ts:10597](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10597) + +## Properties + +### 400 + +```ts +400: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10601](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10601) + +The provided data is not valid. + +--- + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10605](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10605) + +The request lacks valid authentication credentials. + +--- + +### 403 + +```ts +403: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10609](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10609) + +Forbidden. The request is not allowed. + +--- + +### 409 + +```ts +409: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10613](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10613) + +A global listener with this id already exists. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10617) + +An internal error occurred while processing the request. + +--- + +### 503 + +```ts +503: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10622](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10622) + +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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerRequest.md new file mode 100644 index 00000000000..be123554fb0 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerRequest.md @@ -0,0 +1,28 @@ +--- +title: "Type Alias: CreateGlobalTaskListenerRequest" +sidebar_label: "CreateGlobalTaskListenerRequest" +mdx: + format: md +--- + +# Type Alias: CreateGlobalTaskListenerRequest + +```ts +type CreateGlobalTaskListenerRequest = GlobalTaskListenerBase & object; +``` + +Defined in: [gen/types.gen.ts:2978](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2978) + +## Type Declaration + +### eventTypes + +```ts +eventTypes: GlobalTaskListenerEventTypes; +``` + +### id + +```ts +id: GlobalListenerId; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerResponse.md new file mode 100644 index 00000000000..605d8e7a1c0 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: CreateGlobalTaskListenerResponse" +sidebar_label: "CreateGlobalTaskListenerResponse" +mdx: + format: md +--- + +# Type Alias: CreateGlobalTaskListenerResponse + +```ts +type CreateGlobalTaskListenerResponse = + CreateGlobalTaskListenerResponses[keyof CreateGlobalTaskListenerResponses]; +``` + +Defined in: [gen/types.gen.ts:10634](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10634) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerResponses.md new file mode 100644 index 00000000000..8fb47ec46fb --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGlobalTaskListenerResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: CreateGlobalTaskListenerResponses" +sidebar_label: "CreateGlobalTaskListenerResponses" +mdx: + format: md +--- + +# Type Alias: CreateGlobalTaskListenerResponses + +```ts +type CreateGlobalTaskListenerResponses = object; +``` + +Defined in: [gen/types.gen.ts:10627](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10627) + +## Properties + +### 201 + +```ts +201: GlobalTaskListenerResult; +``` + +Defined in: [gen/types.gen.ts:10631](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10631) + +The global user task listener was created successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupData.md index 2f0477372f3..007a035dcbf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupData.md @@ -11,7 +11,7 @@ mdx: type CreateGroupData = object; ``` -Defined in: [gen/types.gen.ts:10649](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10649) +Defined in: [gen/types.gen.ts:10817](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10817) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10649](https://github.com/camunda/orchestration-cl optional body: GroupCreateRequest; ``` -Defined in: [gen/types.gen.ts:10650](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10650) +Defined in: [gen/types.gen.ts:10818](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10818) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10650](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:10651](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10651) +Defined in: [gen/types.gen.ts:10819](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10819) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:10651](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:10652](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10652) +Defined in: [gen/types.gen.ts:10820](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10820) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:10652](https://github.com/camunda/orchestration-cl url: "/groups"; ``` -Defined in: [gen/types.gen.ts:10653](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10653) +Defined in: [gen/types.gen.ts:10821](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10821) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupError.md index 7bb815f159b..3d42ba914ff 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupError.md @@ -11,4 +11,4 @@ mdx: type CreateGroupError = CreateGroupErrors[keyof CreateGroupErrors]; ``` -Defined in: [gen/types.gen.ts:10680](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10680) +Defined in: [gen/types.gen.ts:10848](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10848) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupErrors.md index 4efcbf36370..631fee37449 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupErrors.md @@ -11,7 +11,7 @@ mdx: type CreateGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:10656](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10656) +Defined in: [gen/types.gen.ts:10824](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10824) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10656](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10660](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10660) +Defined in: [gen/types.gen.ts:10828](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10828) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10664](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10664) +Defined in: [gen/types.gen.ts:10832](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10832) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10668](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10668) +Defined in: [gen/types.gen.ts:10836](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10836) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10672](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10672) +Defined in: [gen/types.gen.ts:10840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10840) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10677](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10677) +Defined in: [gen/types.gen.ts:10845](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10845) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupResponse.md index 9608536dce5..a75d5cf835a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupResponse.md @@ -11,4 +11,4 @@ mdx: type CreateGroupResponse = CreateGroupResponses[keyof CreateGroupResponses]; ``` -Defined in: [gen/types.gen.ts:10689](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10689) +Defined in: [gen/types.gen.ts:10857](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10857) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupResponses.md index 7296bf3faf5..a6ec1f9b38b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateGroupResponses.md @@ -11,7 +11,7 @@ mdx: type CreateGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:10682](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10682) +Defined in: [gen/types.gen.ts:10850](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10850) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10682](https://github.com/camunda/orchestration-cl 201: GroupCreateResult; ``` -Defined in: [gen/types.gen.ts:10686](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10686) +Defined in: [gen/types.gen.ts:10854](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10854) The group was created successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleData.md index 3b24eb4b818..7b94509ff40 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleData.md @@ -11,7 +11,7 @@ mdx: type CreateMappingRuleData = object; ``` -Defined in: [gen/types.gen.ts:12209](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12209) +Defined in: [gen/types.gen.ts:12283](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12283) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12209](https://github.com/camunda/orchestration-cl optional body: MappingRuleCreateRequest; ``` -Defined in: [gen/types.gen.ts:12210](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12210) +Defined in: [gen/types.gen.ts:12284](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12284) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12210](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:12211](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12211) +Defined in: [gen/types.gen.ts:12285](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12285) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:12211](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:12212](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12212) +Defined in: [gen/types.gen.ts:12286](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12286) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:12212](https://github.com/camunda/orchestration-cl url: "/mapping-rules"; ``` -Defined in: [gen/types.gen.ts:12213](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12213) +Defined in: [gen/types.gen.ts:12287](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12287) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleError.md index b3fe63200a0..b3053d6f2b6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleError.md @@ -12,4 +12,4 @@ type CreateMappingRuleError = CreateMappingRuleErrors[keyof CreateMappingRuleErrors]; ``` -Defined in: [gen/types.gen.ts:12237](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12237) +Defined in: [gen/types.gen.ts:12311](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12311) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleErrors.md index 8c4d26e444d..d8ddeb8504c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleErrors.md @@ -11,7 +11,7 @@ mdx: type CreateMappingRuleErrors = object; ``` -Defined in: [gen/types.gen.ts:12216](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12216) +Defined in: [gen/types.gen.ts:12290](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12290) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12216](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12220](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12220) +Defined in: [gen/types.gen.ts:12294](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12294) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12226](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12226) +Defined in: [gen/types.gen.ts:12300](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12300) The request to create a mapping rule was denied. More details are provided in the response body. @@ -46,7 +46,7 @@ More details are provided in the response body. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12230](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12230) +Defined in: [gen/types.gen.ts:12304](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12304) The request to create a mapping rule was denied. @@ -58,6 +58,6 @@ The request to create a mapping rule was denied. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12234](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12234) +Defined in: [gen/types.gen.ts:12308](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12308) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleResponse.md index 693145b25e1..d2604c78092 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleResponse.md @@ -12,4 +12,4 @@ type CreateMappingRuleResponse = CreateMappingRuleResponses[keyof CreateMappingRuleResponses]; ``` -Defined in: [gen/types.gen.ts:12246](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12246) +Defined in: [gen/types.gen.ts:12320](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12320) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleResponses.md index 3da947493af..e44363742d2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateMappingRuleResponses.md @@ -11,16 +11,16 @@ mdx: type CreateMappingRuleResponses = object; ``` -Defined in: [gen/types.gen.ts:12239](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12239) +Defined in: [gen/types.gen.ts:12313](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12313) ## Properties ### 201 ```ts -201: MappingRuleUpdateResult; +201: MappingRuleCreateUpdateResult; ``` -Defined in: [gen/types.gen.ts:12243](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12243) +Defined in: [gen/types.gen.ts:12317](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12317) The mapping rule was created successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceData.md index 4fdf4074d36..6d738715ffe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceData.md @@ -11,292 +11,17 @@ mdx: type CreateProcessInstanceData = object; ``` -Defined in: [gen/types.gen.ts:13212](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13212) +Defined in: [gen/types.gen.ts:12948](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12948) ## Properties ### body ```ts -body: - | { - awaitCompletion?: boolean; - fetchVariables?: string[]; - operationReference?: OperationReference; - processDefinitionId: ProcessDefinitionId; - processDefinitionVersion?: number; - requestTimeout?: number; - runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[]; - startInstructions?: ProcessInstanceCreationStartInstruction[]; - tags?: TagSet; - tenantId?: TenantId; - variables?: { - [key: string]: unknown; - }; -} - | { - awaitCompletion?: boolean; - fetchVariables?: string[]; - operationReference?: OperationReference; - processDefinitionKey: ProcessDefinitionKey; - processDefinitionVersion?: number; - requestTimeout?: number; - runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[]; - startInstructions?: ProcessInstanceCreationStartInstruction[]; - tags?: TagSet; - tenantId?: TenantId; - variables?: { - [key: string]: unknown; - }; -}; +body: ProcessInstanceCreationInstruction; ``` -Defined in: [gen/types.gen.ts:13218](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13218) - -Instructions for creating a process instance. The process definition can be specified -either by id or by key. - -#### Type Declaration - -```ts -{ - awaitCompletion?: boolean; - fetchVariables?: string[]; - operationReference?: OperationReference; - processDefinitionId: ProcessDefinitionId; - processDefinitionVersion?: number; - requestTimeout?: number; - runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[]; - startInstructions?: ProcessInstanceCreationStartInstruction[]; - tags?: TagSet; - tenantId?: TenantId; - variables?: { - [key: string]: unknown; - }; -} -``` - -#### awaitCompletion? - -```ts -optional awaitCompletion: boolean; -``` - -Wait for the process instance to complete. If the process instance completion does -not occur within the requestTimeout, the request will be closed. This can lead to a 504 -response status. Disabled by default. - -#### fetchVariables? - -```ts -optional fetchVariables: string[]; -``` - -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. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` - -#### processDefinitionId - -```ts -processDefinitionId: ProcessDefinitionId; -``` - -The BPMN process id of the process definition to start an instance of. - -#### processDefinitionVersion? - -```ts -optional processDefinitionVersion: number; -``` - -The version of the process. By default, the latest version of the process is used. - -#### requestTimeout? - -```ts -optional requestTimeout: number; -``` - -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. - -#### runtimeInstructions? - -```ts -optional runtimeInstructions: ProcessInstanceCreationRuntimeInstruction[]; -``` - -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. - -#### startInstructions? - -```ts -optional startInstructions: ProcessInstanceCreationStartInstruction[]; -``` - -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. - -#### tags? - -```ts -optional tags: TagSet; -``` - -#### tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant id of the process definition. - -#### variables? - -```ts -optional variables: object; -``` - -JSON object that will instantiate the variables for the root variable scope -of the process instance. - -##### Index Signature - -```ts -[key: string]: unknown -``` - -```ts -{ - awaitCompletion?: boolean; - fetchVariables?: string[]; - operationReference?: OperationReference; - processDefinitionKey: ProcessDefinitionKey; - processDefinitionVersion?: number; - requestTimeout?: number; - runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[]; - startInstructions?: ProcessInstanceCreationStartInstruction[]; - tags?: TagSet; - tenantId?: TenantId; - variables?: { - [key: string]: unknown; - }; -} -``` - -#### awaitCompletion? - -```ts -optional awaitCompletion: boolean; -``` - -Wait for the process instance to complete. If the process instance completion does -not occur within the requestTimeout, the request will be closed. This can lead to a 504 -response status. Disabled by default. - -#### fetchVariables? - -```ts -optional fetchVariables: string[]; -``` - -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. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` - -#### processDefinitionKey - -```ts -processDefinitionKey: ProcessDefinitionKey; -``` - -The unique key identifying the process definition, for example, returned for a process in the -deploy resources endpoint. - -#### processDefinitionVersion? - -```ts -optional processDefinitionVersion: number; -``` - -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. - -#### requestTimeout? - -```ts -optional requestTimeout: number; -``` - -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. - -#### runtimeInstructions? - -```ts -optional runtimeInstructions: ProcessInstanceCreationRuntimeInstruction[]; -``` - -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. - -#### startInstructions? - -```ts -optional startInstructions: ProcessInstanceCreationStartInstruction[]; -``` - -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. - -#### tags? - -```ts -optional tags: TagSet; -``` - -#### tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant id of the process definition. - -#### variables? - -```ts -optional variables: object; -``` - -JSON object that will instantiate the variables for the root variable scope -of the process instance. - -##### Index Signature - -```ts -[key: string]: unknown -``` +Defined in: [gen/types.gen.ts:12949](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12949) --- @@ -306,7 +31,7 @@ of the process instance. optional path: never; ``` -Defined in: [gen/types.gen.ts:13341](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13341) +Defined in: [gen/types.gen.ts:12950](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12950) --- @@ -316,7 +41,7 @@ Defined in: [gen/types.gen.ts:13341](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:13342](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13342) +Defined in: [gen/types.gen.ts:12951](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12951) --- @@ -326,4 +51,4 @@ Defined in: [gen/types.gen.ts:13342](https://github.com/camunda/orchestration-cl url: "/process-instances"; ``` -Defined in: [gen/types.gen.ts:13343](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13343) +Defined in: [gen/types.gen.ts:12952](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12952) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceError.md index 71b051ffc42..a5500db2edb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceError.md @@ -12,4 +12,4 @@ type CreateProcessInstanceError = CreateProcessInstanceErrors[keyof CreateProcessInstanceErrors]; ``` -Defined in: [gen/types.gen.ts:13370](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13370) +Defined in: [gen/types.gen.ts:12987](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12987) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceErrors.md index 172512138aa..4011064e93f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceErrors.md @@ -11,7 +11,7 @@ mdx: type CreateProcessInstanceErrors = object; ``` -Defined in: [gen/types.gen.ts:13346](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13346) +Defined in: [gen/types.gen.ts:12955](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12955) ## Properties @@ -21,19 +21,34 @@ Defined in: [gen/types.gen.ts:13346](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13350](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13350) +Defined in: [gen/types.gen.ts:12959](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12959) The provided data is not valid. --- +### 409 + +```ts +409: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12967](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12967) + +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. + +--- + ### 500 ```ts 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13354](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13354) +Defined in: [gen/types.gen.ts:12971](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12971) An internal error occurred while processing the request. @@ -45,7 +60,7 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13359](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13359) +Defined in: [gen/types.gen.ts:12976](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12976) 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 . @@ -57,7 +72,7 @@ The service is currently unavailable. This may happen only on some requests wher 504: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13367](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13367) +Defined in: [gen/types.gen.ts:12984](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12984) The process instance creation request timed out in the gateway. This can happen if the `awaitCompletion` request parameter is set to `true` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResponse.md index c8cf23ec041..6e62cb2c1ed 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResponse.md @@ -12,4 +12,4 @@ type CreateProcessInstanceResponse = CreateProcessInstanceResponses[keyof CreateProcessInstanceResponses]; ``` -Defined in: [gen/types.gen.ts:13379](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13379) +Defined in: [gen/types.gen.ts:12996](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12996) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResponses.md index cd7c851a6c7..d96c1290cd5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResponses.md @@ -11,7 +11,7 @@ mdx: type CreateProcessInstanceResponses = object; ``` -Defined in: [gen/types.gen.ts:13372](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13372) +Defined in: [gen/types.gen.ts:12989](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12989) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13372](https://github.com/camunda/orchestration-cl 200: CreateProcessInstanceResult; ``` -Defined in: [gen/types.gen.ts:13376](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13376) +Defined in: [gen/types.gen.ts:12993](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12993) The process instance was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResult.md index d161f88e0c9..e1c60046b05 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateProcessInstanceResult.md @@ -11,17 +11,29 @@ mdx: type CreateProcessInstanceResult = object; ``` -Defined in: [gen/types.gen.ts:5563](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5563) +Defined in: [gen/types.gen.ts:6235](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6235) ## Properties +### businessId + +```ts +businessId: BusinessId | null; +``` + +Defined in: [gen/types.gen.ts:6272](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6272) + +Business id as provided on creation. + +--- + ### processDefinitionId ```ts processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:5569](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5569) +Defined in: [gen/types.gen.ts:6241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6241) The BPMN process id of the process definition which was used to create the process. instance @@ -34,7 +46,7 @@ instance processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5589](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5589) +Defined in: [gen/types.gen.ts:6261](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6261) The key of the process definition which was used to create the process instance. @@ -46,7 +58,7 @@ The key of the process definition which was used to create the process instance. processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:5574](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5574) +Defined in: [gen/types.gen.ts:6246](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6246) The version of the process definition which was used to create the process instance. @@ -58,20 +70,20 @@ The version of the process definition which was used to create the process insta processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:5595](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5595) +Defined in: [gen/types.gen.ts:6267](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6267) The unique identifier of the created process instance; to be used wherever a request needs a process instance key (e.g. CancelProcessInstanceRequest). --- -### tags? +### tags ```ts -optional tags: TagSet; +tags: TagSet; ``` -Defined in: [gen/types.gen.ts:5596](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5596) +Defined in: [gen/types.gen.ts:6268](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6268) --- @@ -81,7 +93,7 @@ Defined in: [gen/types.gen.ts:5596](https://github.com/camunda/orchestration-clu tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5578](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5578) +Defined in: [gen/types.gen.ts:6250](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6250) The tenant id of the created process instance. @@ -93,7 +105,7 @@ The tenant id of the created process instance. variables: object; ``` -Defined in: [gen/types.gen.ts:5582](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5582) +Defined in: [gen/types.gen.ts:6254](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6254) All the variables visible in the root scope. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleData.md index f82931bd4e3..1c5bd726de8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleData.md @@ -11,7 +11,7 @@ mdx: type CreateRoleData = object; ``` -Defined in: [gen/types.gen.ts:14521](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14521) +Defined in: [gen/types.gen.ts:13803](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13803) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14521](https://github.com/camunda/orchestration-cl optional body: RoleCreateRequest; ``` -Defined in: [gen/types.gen.ts:14522](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14522) +Defined in: [gen/types.gen.ts:13804](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13804) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14522](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:14523](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14523) +Defined in: [gen/types.gen.ts:13805](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13805) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:14523](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:14524](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14524) +Defined in: [gen/types.gen.ts:13806](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13806) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:14524](https://github.com/camunda/orchestration-cl url: "/roles"; ``` -Defined in: [gen/types.gen.ts:14525](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14525) +Defined in: [gen/types.gen.ts:13807](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13807) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleError.md index 538f4846ec5..aed87f6e6dd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleError.md @@ -11,4 +11,4 @@ mdx: type CreateRoleError = CreateRoleErrors[keyof CreateRoleErrors]; ``` -Defined in: [gen/types.gen.ts:14552](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14552) +Defined in: [gen/types.gen.ts:13834](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13834) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleErrors.md index 9a2bb95350b..d53a447ee10 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleErrors.md @@ -11,7 +11,7 @@ mdx: type CreateRoleErrors = object; ``` -Defined in: [gen/types.gen.ts:14528](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14528) +Defined in: [gen/types.gen.ts:13810](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13810) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14528](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14532](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14532) +Defined in: [gen/types.gen.ts:13814](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13814) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14536](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14536) +Defined in: [gen/types.gen.ts:13818](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13818) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14540](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14540) +Defined in: [gen/types.gen.ts:13822](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13822) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14544](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14544) +Defined in: [gen/types.gen.ts:13826](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13826) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14549](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14549) +Defined in: [gen/types.gen.ts:13831](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13831) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleResponse.md index 33eacb8499f..0447733769e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleResponse.md @@ -11,4 +11,4 @@ mdx: type CreateRoleResponse = CreateRoleResponses[keyof CreateRoleResponses]; ``` -Defined in: [gen/types.gen.ts:14561](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14561) +Defined in: [gen/types.gen.ts:13843](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13843) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleResponses.md index 0fcc26b4867..b23d9174b51 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateRoleResponses.md @@ -11,7 +11,7 @@ mdx: type CreateRoleResponses = object; ``` -Defined in: [gen/types.gen.ts:14554](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14554) +Defined in: [gen/types.gen.ts:13836](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13836) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14554](https://github.com/camunda/orchestration-cl 201: RoleCreateResult; ``` -Defined in: [gen/types.gen.ts:14558](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14558) +Defined in: [gen/types.gen.ts:13840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13840) The role was created successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableData.md index 60cc3972d93..56cc875ab7f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableData.md @@ -11,7 +11,7 @@ mdx: type CreateTenantClusterVariableData = object; ``` -Defined in: [gen/types.gen.ts:8867](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8867) +Defined in: [gen/types.gen.ts:9324](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9324) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8867](https://github.com/camunda/orchestration-clu body: CreateClusterVariableRequest; ``` -Defined in: [gen/types.gen.ts:8868](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8868) +Defined in: [gen/types.gen.ts:9325](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9325) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8868](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8869](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8869) +Defined in: [gen/types.gen.ts:9326](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9326) #### tenantId @@ -49,7 +49,7 @@ The tenant ID optional query: never; ``` -Defined in: [gen/types.gen.ts:8875](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8875) +Defined in: [gen/types.gen.ts:9332](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9332) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8875](https://github.com/camunda/orchestration-clu url: "/cluster-variables/tenants/{tenantId}"; ``` -Defined in: [gen/types.gen.ts:8876](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8876) +Defined in: [gen/types.gen.ts:9333](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9333) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableError.md index 997c694279f..ce95527089e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableError.md @@ -12,4 +12,4 @@ type CreateTenantClusterVariableError = CreateTenantClusterVariableErrors[keyof CreateTenantClusterVariableErrors]; ``` -Defined in: [gen/types.gen.ts:8898](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8898) +Defined in: [gen/types.gen.ts:9355](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9355) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableErrors.md index 8e583693bff..11bec5f1899 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableErrors.md @@ -11,7 +11,7 @@ mdx: type CreateTenantClusterVariableErrors = object; ``` -Defined in: [gen/types.gen.ts:8879](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8879) +Defined in: [gen/types.gen.ts:9336](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9336) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8879](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8883](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8883) +Defined in: [gen/types.gen.ts:9340](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9340) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8887](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8887) +Defined in: [gen/types.gen.ts:9344](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9344) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8891](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8891) +Defined in: [gen/types.gen.ts:9348](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9348) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8895](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8895) +Defined in: [gen/types.gen.ts:9352](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9352) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableResponse.md index d338c1d96a9..061b33b16fe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableResponse.md @@ -12,4 +12,4 @@ type CreateTenantClusterVariableResponse = CreateTenantClusterVariableResponses[keyof CreateTenantClusterVariableResponses]; ``` -Defined in: [gen/types.gen.ts:8907](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8907) +Defined in: [gen/types.gen.ts:9364](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9364) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableResponses.md index 0f3a758a0f2..4f400fc19d0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantClusterVariableResponses.md @@ -11,7 +11,7 @@ mdx: type CreateTenantClusterVariableResponses = object; ``` -Defined in: [gen/types.gen.ts:8900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8900) +Defined in: [gen/types.gen.ts:9357](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9357) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8900](https://github.com/camunda/orchestration-clu 200: ClusterVariableResult; ``` -Defined in: [gen/types.gen.ts:8904](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8904) +Defined in: [gen/types.gen.ts:9361](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9361) Cluster variable created diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantData.md index 9da437112fa..5c597432ff2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantData.md @@ -11,7 +11,7 @@ mdx: type CreateTenantData = object; ``` -Defined in: [gen/types.gen.ts:15526](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15526) +Defined in: [gen/types.gen.ts:14848](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14848) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15526](https://github.com/camunda/orchestration-cl body: TenantCreateRequest; ``` -Defined in: [gen/types.gen.ts:15527](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15527) +Defined in: [gen/types.gen.ts:14849](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14849) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15527](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:15528](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15528) +Defined in: [gen/types.gen.ts:14850](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14850) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:15528](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:15529](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15529) +Defined in: [gen/types.gen.ts:14851](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14851) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:15529](https://github.com/camunda/orchestration-cl url: "/tenants"; ``` -Defined in: [gen/types.gen.ts:15530](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15530) +Defined in: [gen/types.gen.ts:14852](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14852) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantError.md index e6c43bdebc9..17589198afe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantError.md @@ -11,4 +11,4 @@ mdx: type CreateTenantError = CreateTenantErrors[keyof CreateTenantErrors]; ``` -Defined in: [gen/types.gen.ts:15561](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15561) +Defined in: [gen/types.gen.ts:14883](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14883) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantErrors.md index d4e58e8c269..fd80e2acfc8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantErrors.md @@ -11,7 +11,7 @@ mdx: type CreateTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:15533](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15533) +Defined in: [gen/types.gen.ts:14855](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14855) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15533](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15537](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15537) +Defined in: [gen/types.gen.ts:14859](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14859) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15541](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15541) +Defined in: [gen/types.gen.ts:14863](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14863) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15545](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15545) +Defined in: [gen/types.gen.ts:14867](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14867) Not found. The resource was not found. @@ -57,7 +57,7 @@ Not found. The resource was not found. 409: unknown; ``` -Defined in: [gen/types.gen.ts:15549](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15549) +Defined in: [gen/types.gen.ts:14871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14871) Tenant with this id already exists. @@ -69,7 +69,7 @@ Tenant with this id already exists. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15553](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15553) +Defined in: [gen/types.gen.ts:14875](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14875) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15558](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15558) +Defined in: [gen/types.gen.ts:14880](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14880) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantResponse.md index 3afd9dc5ce9..c3c7eb343a4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantResponse.md @@ -11,4 +11,4 @@ mdx: type CreateTenantResponse = CreateTenantResponses[keyof CreateTenantResponses]; ``` -Defined in: [gen/types.gen.ts:15570](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15570) +Defined in: [gen/types.gen.ts:14892](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14892) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantResponses.md index c626c33b72f..60c2e2c6b2d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateTenantResponses.md @@ -11,7 +11,7 @@ mdx: type CreateTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:15563](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15563) +Defined in: [gen/types.gen.ts:14885](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14885) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15563](https://github.com/camunda/orchestration-cl 201: TenantCreateResult; ``` -Defined in: [gen/types.gen.ts:15567](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15567) +Defined in: [gen/types.gen.ts:14889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14889) The tenant was created successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserData.md index f996728758c..dcca2d19439 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserData.md @@ -11,7 +11,7 @@ mdx: type CreateUserData = object; ``` -Defined in: [gen/types.gen.ts:16448](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16448) +Defined in: [gen/types.gen.ts:15768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15768) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16448](https://github.com/camunda/orchestration-cl body: UserRequest; ``` -Defined in: [gen/types.gen.ts:16449](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16449) +Defined in: [gen/types.gen.ts:15769](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15769) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16449](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:16450](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16450) +Defined in: [gen/types.gen.ts:15770](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15770) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:16450](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:16451](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16451) +Defined in: [gen/types.gen.ts:15771](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15771) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:16451](https://github.com/camunda/orchestration-cl url: "/users"; ``` -Defined in: [gen/types.gen.ts:16452](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16452) +Defined in: [gen/types.gen.ts:15772](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15772) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserError.md index f06f3a68482..c176d4317da 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserError.md @@ -11,4 +11,4 @@ mdx: type CreateUserError = CreateUserErrors[keyof CreateUserErrors]; ``` -Defined in: [gen/types.gen.ts:16483](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16483) +Defined in: [gen/types.gen.ts:15803](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15803) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserErrors.md index 4ea352f440c..e7d9c02ba23 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserErrors.md @@ -11,7 +11,7 @@ mdx: type CreateUserErrors = object; ``` -Defined in: [gen/types.gen.ts:16455](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16455) +Defined in: [gen/types.gen.ts:15775](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15775) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16455](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16459](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16459) +Defined in: [gen/types.gen.ts:15779](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15779) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16463](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16463) +Defined in: [gen/types.gen.ts:15783](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15783) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16467](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16467) +Defined in: [gen/types.gen.ts:15787](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15787) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16471](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16471) +Defined in: [gen/types.gen.ts:15791](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15791) A user with this username already exists. @@ -69,7 +69,7 @@ A user with this username already exists. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16475](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16475) +Defined in: [gen/types.gen.ts:15795](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15795) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16480](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16480) +Defined in: [gen/types.gen.ts:15800](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15800) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserResponse.md index ceb63fedac8..746b01e40e3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserResponse.md @@ -11,4 +11,4 @@ mdx: type CreateUserResponse = CreateUserResponses[keyof CreateUserResponses]; ``` -Defined in: [gen/types.gen.ts:16492](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16492) +Defined in: [gen/types.gen.ts:15812](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15812) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserResponses.md index db62eed8e4a..1dec02a2144 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CreateUserResponses.md @@ -11,7 +11,7 @@ mdx: type CreateUserResponses = object; ``` -Defined in: [gen/types.gen.ts:16485](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16485) +Defined in: [gen/types.gen.ts:15805](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15805) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16485](https://github.com/camunda/orchestration-cl 201: UserCreateResult; ``` -Defined in: [gen/types.gen.ts:16489](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16489) +Defined in: [gen/types.gen.ts:15809](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15809) The user was created successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CursorBackwardPagination.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CursorBackwardPagination.md index 694aeb7e43f..6cfb8e69523 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CursorBackwardPagination.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CursorBackwardPagination.md @@ -11,7 +11,7 @@ mdx: type CursorBackwardPagination = object; ``` -Defined in: [gen/types.gen.ts:6447](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6447) +Defined in: [gen/types.gen.ts:7167](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7167) Cursor-based backward pagination @@ -23,7 +23,7 @@ Cursor-based backward pagination before: StartCursor; ``` -Defined in: [gen/types.gen.ts:6451](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6451) +Defined in: [gen/types.gen.ts:7171](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7171) Use the `startCursor` value from the previous response to fetch the previous page of results. @@ -35,6 +35,6 @@ Use the `startCursor` value from the previous response to fetch the previous pag optional limit: number; ``` -Defined in: [gen/types.gen.ts:6455](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6455) +Defined in: [gen/types.gen.ts:7175](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7175) The maximum number of items to return in one request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/CursorForwardPagination.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/CursorForwardPagination.md index c88384257c7..70b8ceddc30 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/CursorForwardPagination.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/CursorForwardPagination.md @@ -11,7 +11,7 @@ mdx: type CursorForwardPagination = object; ``` -Defined in: [gen/types.gen.ts:6433](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6433) +Defined in: [gen/types.gen.ts:7153](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7153) Cursor-based forward pagination @@ -23,7 +23,7 @@ Cursor-based forward pagination after: EndCursor; ``` -Defined in: [gen/types.gen.ts:6437](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6437) +Defined in: [gen/types.gen.ts:7157](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7157) Use the `endCursor` value from the previous response to fetch the next page of results. @@ -35,6 +35,6 @@ Use the `endCursor` value from the previous response to fetch the next page of r optional limit: number; ``` -Defined in: [gen/types.gen.ts:6441](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6441) +Defined in: [gen/types.gen.ts:7161](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7161) The maximum number of items to return in one request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DateTimeFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DateTimeFilterProperty.md index 7355c22fa59..245c850612f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DateTimeFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DateTimeFilterProperty.md @@ -11,6 +11,6 @@ mdx: type DateTimeFilterProperty = string | AdvancedDateTimeFilter; ``` -Defined in: [gen/types.gen.ts:2757](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2757) +Defined in: [gen/types.gen.ts:2915](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2915) Date-time property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionFilter.md index 0d5571f9922..2cc6aa09f53 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionFilter.md @@ -11,7 +11,7 @@ mdx: type DecisionDefinitionFilter = object; ``` -Defined in: [gen/types.gen.ts:1422](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1422) +Defined in: [gen/types.gen.ts:1453](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1453) Decision definition search filter. @@ -23,7 +23,7 @@ Decision definition search filter. optional decisionDefinitionId: DecisionDefinitionId; ``` -Defined in: [gen/types.gen.ts:1426](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1426) +Defined in: [gen/types.gen.ts:1457](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1457) The DMN ID of the decision definition. @@ -35,7 +35,7 @@ The DMN ID of the decision definition. optional decisionDefinitionKey: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1453](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1453) +Defined in: [gen/types.gen.ts:1484](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1484) The assigned key, which acts as a unique identifier for this decision definition. @@ -47,7 +47,7 @@ The assigned key, which acts as a unique identifier for this decision definition optional decisionRequirementsId: string; ``` -Defined in: [gen/types.gen.ts:1445](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1445) +Defined in: [gen/types.gen.ts:1476](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1476) the DMN ID of the decision requirements graph that the decision definition is part of. @@ -59,7 +59,7 @@ the DMN ID of the decision requirements graph that the decision definition is pa optional decisionRequirementsKey: DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:1457](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1457) +Defined in: [gen/types.gen.ts:1488](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1488) The assigned key of the decision requirements graph that the decision definition is part of. @@ -71,7 +71,7 @@ The assigned key of the decision requirements graph that the decision definition optional decisionRequirementsName: string; ``` -Defined in: [gen/types.gen.ts:1461](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1461) +Defined in: [gen/types.gen.ts:1492](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1492) The DMN name of the decision requirements that the decision definition is part of. @@ -83,7 +83,7 @@ The DMN name of the decision requirements that the decision definition is part o optional decisionRequirementsVersion: number; ``` -Defined in: [gen/types.gen.ts:1465](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1465) +Defined in: [gen/types.gen.ts:1496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1496) The assigned version of the decision requirements that the decision definition is part of. @@ -95,7 +95,7 @@ The assigned version of the decision requirements that the decision definition i optional isLatestVersion: boolean; ``` -Defined in: [gen/types.gen.ts:1437](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1437) +Defined in: [gen/types.gen.ts:1468](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1468) 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`. @@ -109,7 +109,7 @@ The response contains no `startCursor` in the `page`, and requests ignore the `f optional name: string; ``` -Defined in: [gen/types.gen.ts:1430](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1430) +Defined in: [gen/types.gen.ts:1461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1461) The DMN name of the decision definition. @@ -121,7 +121,7 @@ The DMN name of the decision definition. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1449](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1449) +Defined in: [gen/types.gen.ts:1480](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1480) The tenant ID of the decision definition. @@ -133,6 +133,6 @@ The tenant ID of the decision definition. optional version: number; ``` -Defined in: [gen/types.gen.ts:1441](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1441) +Defined in: [gen/types.gen.ts:1472](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1472) The assigned version of the decision definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionId.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionId.md index cab1cde6336..2d6544170b5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionId.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionId.md @@ -11,6 +11,6 @@ mdx: type DecisionDefinitionId = CamundaKey<"DecisionDefinitionId">; ``` -Defined in: [gen/types.gen.ts:2977](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2977) +Defined in: [gen/types.gen.ts:3324](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3324) Id of a decision definition, from the model. Only ids of decision definitions that are deployed are useful. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKey.md index 85b9c1a7a9b..907b914a6fa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKey.md @@ -11,6 +11,6 @@ mdx: type DecisionDefinitionKey = CamundaKey<"DecisionDefinitionKey">; ``` -Defined in: [gen/types.gen.ts:4064](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4064) +Defined in: [gen/types.gen.ts:4703](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4703) System-generated key for a decision definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKeyExactMatch.md index 8ed18c7625d..62ea20ce9ea 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type DecisionDefinitionKeyExactMatch = DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:7563](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7563) +Defined in: [gen/types.gen.ts:8409](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8409) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKeyFilterProperty.md index b988b3ebd92..26cc8e24ab6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionKeyFilterProperty.md @@ -13,6 +13,6 @@ type DecisionDefinitionKeyFilterProperty = | AdvancedDecisionDefinitionKeyFilter; ``` -Defined in: [gen/types.gen.ts:4238](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4238) +Defined in: [gen/types.gen.ts:4877](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4877) DecisionDefinitionKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionResult.md index 9acdf546aec..fef7ca8d184 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionResult.md @@ -11,112 +11,112 @@ mdx: type DecisionDefinitionResult = object; ``` -Defined in: [gen/types.gen.ts:1475](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1475) +Defined in: [gen/types.gen.ts:1506](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1506) ## Properties -### decisionDefinitionId? +### decisionDefinitionId ```ts -optional decisionDefinitionId: DecisionDefinitionId; +decisionDefinitionId: DecisionDefinitionId; ``` -Defined in: [gen/types.gen.ts:1479](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1479) +Defined in: [gen/types.gen.ts:1510](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1510) The DMN ID of the decision definition. --- -### decisionDefinitionKey? +### decisionDefinitionKey ```ts -optional decisionDefinitionKey: DecisionDefinitionKey; +decisionDefinitionKey: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1499](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1499) +Defined in: [gen/types.gen.ts:1514](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1514) The assigned key, which acts as a unique identifier for this decision definition. --- -### decisionRequirementsId? +### decisionRequirementsId ```ts -optional decisionRequirementsId: string; +decisionRequirementsId: string; ``` -Defined in: [gen/types.gen.ts:1491](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1491) +Defined in: [gen/types.gen.ts:1518](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1518) the DMN ID of the decision requirements graph that the decision definition is part of. --- -### decisionRequirementsKey? +### decisionRequirementsKey ```ts -optional decisionRequirementsKey: DecisionRequirementsKey; +decisionRequirementsKey: DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:1503](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1503) +Defined in: [gen/types.gen.ts:1522](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1522) The assigned key of the decision requirements graph that the decision definition is part of. --- -### decisionRequirementsName? +### decisionRequirementsName ```ts -optional decisionRequirementsName: string; +decisionRequirementsName: string; ``` -Defined in: [gen/types.gen.ts:1507](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1507) +Defined in: [gen/types.gen.ts:1526](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1526) The DMN name of the decision requirements that the decision definition is part of. --- -### decisionRequirementsVersion? +### decisionRequirementsVersion ```ts -optional decisionRequirementsVersion: number; +decisionRequirementsVersion: number; ``` -Defined in: [gen/types.gen.ts:1511](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1511) +Defined in: [gen/types.gen.ts:1530](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1530) The assigned version of the decision requirements that the decision definition is part of. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:1483](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1483) +Defined in: [gen/types.gen.ts:1534](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1534) The DMN name of the decision definition. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1495](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1495) +Defined in: [gen/types.gen.ts:1538](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1538) The tenant ID of the decision definition. --- -### version? +### version ```ts -optional version: number; +version: number; ``` -Defined in: [gen/types.gen.ts:1487](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1487) +Defined in: [gen/types.gen.ts:1542](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1542) The assigned version of the decision definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQuery.md index 7494cc66da6..b2f61b962f2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQuery.md @@ -11,7 +11,7 @@ mdx: type DecisionDefinitionSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:1408](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1408) +Defined in: [gen/types.gen.ts:1439](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1439) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQueryResult.md index 446eb6dfba4..631fa9cf09c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQueryResult.md @@ -11,14 +11,14 @@ mdx: type DecisionDefinitionSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:1468](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1468) +Defined in: [gen/types.gen.ts:1499](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1499) ## Type Declaration -### items? +### items ```ts -optional items: DecisionDefinitionResult[]; +items: DecisionDefinitionResult[]; ``` The matching decision definitions. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQuerySortRequest.md index 73488246395..e8b1978cbb1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type DecisionDefinitionSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:1400](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1400) +Defined in: [gen/types.gen.ts:1431](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1431) ## Properties @@ -30,7 +30,7 @@ field: | "tenantId"; ``` -Defined in: [gen/types.gen.ts:1404](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1404) +Defined in: [gen/types.gen.ts:1435](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1435) The field to sort by. @@ -42,4 +42,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:1405](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1405) +Defined in: [gen/types.gen.ts:1436](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1436) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionTypeEnum.md index ee76bd86354..66079b3d77c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionDefinitionTypeEnum.md @@ -11,9 +11,10 @@ mdx: type DecisionDefinitionTypeEnum = | "DECISION_TABLE" | "LITERAL_EXPRESSION" + | "UNSPECIFIED" | "UNKNOWN"; ``` -Defined in: [gen/types.gen.ts:1872](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1872) +Defined in: [gen/types.gen.ts:1933](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1933) -The type of the decision. +The type of the decision. UNSPECIFIED is deprecated and should not be used anymore, for removal in 8.10 diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationById.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationById.md index a846cfe1833..01974785b77 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationById.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationById.md @@ -11,7 +11,7 @@ mdx: type DecisionEvaluationById = object; ``` -Defined in: [gen/types.gen.ts:1519](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1519) +Defined in: [gen/types.gen.ts:1550](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1550) Decision evaluation by ID @@ -23,7 +23,7 @@ Decision evaluation by ID decisionDefinitionId: DecisionDefinitionId; ``` -Defined in: [gen/types.gen.ts:1526](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1526) +Defined in: [gen/types.gen.ts:1557](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1557) The ID of the decision to be evaluated. When using the decision ID, the latest @@ -37,7 +37,7 @@ deployed version of the decision is used. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1536](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1536) +Defined in: [gen/types.gen.ts:1567](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1567) The tenant ID of the decision. @@ -49,9 +49,9 @@ The tenant ID of the decision. optional variables: object; ``` -Defined in: [gen/types.gen.ts:1530](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1530) +Defined in: [gen/types.gen.ts:1561](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1561) -The message variables as JSON document. +The decision evaluation variables as JSON document. #### Index Signature diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationByKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationByKey.md index 420ee61b254..edec46e535a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationByKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationByKey.md @@ -11,7 +11,7 @@ mdx: type DecisionEvaluationByKey = object; ``` -Defined in: [gen/types.gen.ts:1542](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1542) +Defined in: [gen/types.gen.ts:1573](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1573) Decision evaluation by key @@ -23,7 +23,7 @@ Decision evaluation by key decisionDefinitionKey: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1543](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1543) +Defined in: [gen/types.gen.ts:1574](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1574) --- @@ -33,7 +33,7 @@ Defined in: [gen/types.gen.ts:1543](https://github.com/camunda/orchestration-clu optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1553](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1553) +Defined in: [gen/types.gen.ts:1584](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1584) The tenant ID of the decision. @@ -45,9 +45,9 @@ The tenant ID of the decision. optional variables: object; ``` -Defined in: [gen/types.gen.ts:1547](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1547) +Defined in: [gen/types.gen.ts:1578](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1578) -The message variables as JSON document. +The decision evaluation variables as JSON document. #### Index Signature diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKey.md index d08d2ee2ad8..384133d09f0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKey.md @@ -12,6 +12,6 @@ type DecisionEvaluationInstanceKey = CamundaKey<"DecisionEvaluationInstanceKey">; ``` -Defined in: [gen/types.gen.ts:4069](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4069) +Defined in: [gen/types.gen.ts:4708](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4708) System-generated key for a decision evaluation instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKeyExactMatch.md index fabd273a0f0..e5048359872 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type DecisionEvaluationInstanceKeyExactMatch = DecisionEvaluationInstanceKey; ``` -Defined in: [gen/types.gen.ts:7584](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7584) +Defined in: [gen/types.gen.ts:8430](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8430) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKeyFilterProperty.md index 2b14db506d9..c9649208d07 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstanceKeyFilterProperty.md @@ -13,6 +13,6 @@ type DecisionEvaluationInstanceKeyFilterProperty = | AdvancedDecisionEvaluationInstanceKeyFilter; ``` -Defined in: [gen/types.gen.ts:4337](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4337) +Defined in: [gen/types.gen.ts:4978](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4978) DecisionEvaluationInstanceKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstruction.md index 93ef0f5d704..9a766330a8f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationInstruction.md @@ -13,4 +13,4 @@ type DecisionEvaluationInstruction = | DecisionEvaluationByKey; ``` -Defined in: [gen/types.gen.ts:1514](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1514) +Defined in: [gen/types.gen.ts:1545](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1545) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKey.md index 97091fbeac1..f80652652b3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKey.md @@ -11,6 +11,6 @@ mdx: type DecisionEvaluationKey = CamundaKey<"DecisionEvaluationKey">; ``` -Defined in: [gen/types.gen.ts:4074](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4074) +Defined in: [gen/types.gen.ts:4713](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4713) System-generated key for a decision evaluation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKeyExactMatch.md index 0b481c13af8..df573a7cac5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type DecisionEvaluationKeyExactMatch = DecisionEvaluationKey; ``` -Defined in: [gen/types.gen.ts:7605](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7605) +Defined in: [gen/types.gen.ts:8451](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8451) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKeyFilterProperty.md index cec89e3c20f..155dba90890 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionEvaluationKeyFilterProperty.md @@ -13,6 +13,6 @@ type DecisionEvaluationKeyFilterProperty = | AdvancedDecisionEvaluationKeyFilter; ``` -Defined in: [gen/types.gen.ts:4436](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4436) +Defined in: [gen/types.gen.ts:5077](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5077) DecisionEvaluationKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceDeletionBatchOperationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceDeletionBatchOperationRequest.md index c8e588aa7c2..0b5c94fd080 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceDeletionBatchOperationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceDeletionBatchOperationRequest.md @@ -11,7 +11,7 @@ mdx: type DecisionInstanceDeletionBatchOperationRequest = object; ``` -Defined in: [gen/types.gen.ts:893](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L893) +Defined in: [gen/types.gen.ts:924](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L924) The decision instance filter that defines which decision instances should be deleted. @@ -23,7 +23,7 @@ The decision instance filter that defines which decision instances should be del filter: DecisionInstanceFilter; ``` -Defined in: [gen/types.gen.ts:897](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L897) +Defined in: [gen/types.gen.ts:928](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L928) The decision instance filter. @@ -35,4 +35,4 @@ The decision instance filter. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:898](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L898) +Defined in: [gen/types.gen.ts:929](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L929) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceFilter.md index eac370aee5b..54782c5eb46 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceFilter.md @@ -11,7 +11,7 @@ mdx: type DecisionInstanceFilter = object; ``` -Defined in: [gen/types.gen.ts:1683](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1683) +Defined in: [gen/types.gen.ts:1714](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1714) Decision instance search filter. @@ -23,7 +23,7 @@ Decision instance search filter. optional decisionDefinitionId: DecisionDefinitionId; ``` -Defined in: [gen/types.gen.ts:1703](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1703) +Defined in: [gen/types.gen.ts:1734](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1734) The ID of the DMN decision. @@ -35,7 +35,7 @@ The ID of the DMN decision. optional decisionDefinitionKey: DecisionDefinitionKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:1733](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1733) +Defined in: [gen/types.gen.ts:1764](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1764) The key of the decision. @@ -47,7 +47,7 @@ The key of the decision. optional decisionDefinitionName: string; ``` -Defined in: [gen/types.gen.ts:1707](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1707) +Defined in: [gen/types.gen.ts:1738](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1738) The name of the DMN decision. @@ -59,7 +59,7 @@ The name of the DMN decision. optional decisionDefinitionType: DecisionDefinitionTypeEnum; ``` -Defined in: [gen/types.gen.ts:1712](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1712) +Defined in: [gen/types.gen.ts:1743](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1743) --- @@ -69,7 +69,7 @@ Defined in: [gen/types.gen.ts:1712](https://github.com/camunda/orchestration-clu optional decisionDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:1711](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1711) +Defined in: [gen/types.gen.ts:1742](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1742) The version of the decision. @@ -81,7 +81,7 @@ The version of the decision. optional decisionEvaluationInstanceKey: DecisionEvaluationInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:1687](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1687) +Defined in: [gen/types.gen.ts:1718](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1718) The key of the decision evaluation instance. @@ -93,7 +93,7 @@ The key of the decision evaluation instance. optional decisionEvaluationKey: DecisionEvaluationKey; ``` -Defined in: [gen/types.gen.ts:1721](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1721) +Defined in: [gen/types.gen.ts:1752](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1752) 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. @@ -105,7 +105,7 @@ The key of the parent decision evaluation. Note that this is not the identifier optional decisionRequirementsKey: DecisionRequirementsKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:1745](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1745) +Defined in: [gen/types.gen.ts:1776](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1776) The key of the decision requirements definition. @@ -117,7 +117,7 @@ The key of the decision requirements definition. optional elementInstanceKey: ElementInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:1737](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1737) +Defined in: [gen/types.gen.ts:1768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1768) The key of the element instance this decision instance is linked to. @@ -129,7 +129,7 @@ The key of the element instance this decision instance is linked to. optional evaluationDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:1699](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1699) +Defined in: [gen/types.gen.ts:1730](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1730) The evaluation date of the decision instance. @@ -141,7 +141,7 @@ The evaluation date of the decision instance. optional evaluationFailure: string; ``` -Defined in: [gen/types.gen.ts:1695](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1695) +Defined in: [gen/types.gen.ts:1726](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1726) The evaluation failure of the decision instance. @@ -153,7 +153,7 @@ The evaluation failure of the decision instance. optional processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1725](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1725) +Defined in: [gen/types.gen.ts:1756](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1756) The key of the process definition. @@ -165,7 +165,7 @@ The key of the process definition. optional processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:1729](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1729) +Defined in: [gen/types.gen.ts:1760](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1760) The key of the process instance. @@ -177,7 +177,7 @@ The key of the process instance. optional rootDecisionDefinitionKey: DecisionDefinitionKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:1741](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1741) +Defined in: [gen/types.gen.ts:1772](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1772) The key of the root decision definition. @@ -189,7 +189,7 @@ The key of the root decision definition. optional state: DecisionInstanceStateFilterProperty; ``` -Defined in: [gen/types.gen.ts:1691](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1691) +Defined in: [gen/types.gen.ts:1722](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1722) The state of the decision instance. @@ -201,6 +201,6 @@ The state of the decision instance. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1716](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1716) +Defined in: [gen/types.gen.ts:1747](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1747) The tenant ID of the decision instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceGetQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceGetQueryResult.md index 5d4441bd106..24d6517f89d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceGetQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceGetQueryResult.md @@ -11,22 +11,22 @@ mdx: type DecisionInstanceGetQueryResult = DecisionInstanceResult & object; ``` -Defined in: [gen/types.gen.ts:1818](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1818) +Defined in: [gen/types.gen.ts:1855](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1855) ## Type Declaration -### evaluatedInputs? +### evaluatedInputs ```ts -optional evaluatedInputs: EvaluatedDecisionInputItem[]; +evaluatedInputs: EvaluatedDecisionInputItem[]; ``` The evaluated inputs of the decision instance. -### matchedRules? +### matchedRules ```ts -optional matchedRules: MatchedDecisionRuleItem[]; +matchedRules: MatchedDecisionRuleItem[]; ``` The matched rules of the decision instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceKey.md index c4b50c37b94..376c9576e1b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceKey.md @@ -11,6 +11,6 @@ mdx: type DecisionInstanceKey = CamundaKey<"DecisionInstanceKey">; ``` -Defined in: [gen/types.gen.ts:4084](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4084) +Defined in: [gen/types.gen.ts:4723](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4723) System-generated key for a deployed decision instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceResult.md index 52efa68ab01..e1fd38e465c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceResult.md @@ -11,200 +11,204 @@ mdx: type DecisionInstanceResult = object; ``` -Defined in: [gen/types.gen.ts:1759](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1759) +Defined in: [gen/types.gen.ts:1790](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1790) ## Properties -### decisionDefinitionId? +### decisionDefinitionId ```ts -optional decisionDefinitionId: DecisionDefinitionId; +decisionDefinitionId: DecisionDefinitionId; ``` -Defined in: [gen/types.gen.ts:1773](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1773) +Defined in: [gen/types.gen.ts:1794](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1794) The ID of the DMN decision. --- -### decisionDefinitionKey? +### decisionDefinitionKey ```ts -optional decisionDefinitionKey: DecisionDefinitionKey; +decisionDefinitionKey: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1807](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1807) +Defined in: [gen/types.gen.ts:1798](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1798) The key of the decision. --- -### decisionDefinitionName? +### decisionDefinitionName ```ts -optional decisionDefinitionName: string; +decisionDefinitionName: string; ``` -Defined in: [gen/types.gen.ts:1777](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1777) +Defined in: [gen/types.gen.ts:1802](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1802) The name of the DMN decision. --- -### decisionDefinitionType? +### decisionDefinitionType ```ts -optional decisionDefinitionType: DecisionDefinitionTypeEnum; +decisionDefinitionType: DecisionDefinitionTypeEnum; ``` -Defined in: [gen/types.gen.ts:1782](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1782) +Defined in: [gen/types.gen.ts:1803](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1803) --- -### decisionDefinitionVersion? +### decisionDefinitionVersion ```ts -optional decisionDefinitionVersion: number; +decisionDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:1781](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1781) +Defined in: [gen/types.gen.ts:1807](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1807) The version of the decision. --- -### decisionEvaluationInstanceKey? +### decisionEvaluationInstanceKey ```ts -optional decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey; +decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey; ``` -Defined in: [gen/types.gen.ts:1760](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1760) +Defined in: [gen/types.gen.ts:1808](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1808) --- -### decisionEvaluationKey? +### decisionEvaluationKey ```ts -optional decisionEvaluationKey: DecisionEvaluationKey; +decisionEvaluationKey: DecisionEvaluationKey; ``` -Defined in: [gen/types.gen.ts:1794](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1794) +Defined in: [gen/types.gen.ts:1812](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1812) The key of the decision evaluation where this instance was created. --- -### elementInstanceKey? +### elementInstanceKey ```ts -optional elementInstanceKey: ElementInstanceKey; +elementInstanceKey: ElementInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:1811](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1811) +Defined in: [gen/types.gen.ts:1816](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1816) The key of the element instance this decision instance is linked to. --- -### evaluationDate? +### evaluationDate ```ts -optional evaluationDate: string; +evaluationDate: string; ``` -Defined in: [gen/types.gen.ts:1765](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1765) +Defined in: [gen/types.gen.ts:1820](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1820) The evaluation date of the decision instance. --- -### evaluationFailure? +### evaluationFailure ```ts -optional evaluationFailure: string; +evaluationFailure: string | null; ``` -Defined in: [gen/types.gen.ts:1769](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1769) +Defined in: [gen/types.gen.ts:1824](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1824) The evaluation failure of the decision instance. --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey | null; ``` -Defined in: [gen/types.gen.ts:1798](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1798) +Defined in: [gen/types.gen.ts:1828](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1828) The key of the process definition. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:1802](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1802) +Defined in: [gen/types.gen.ts:1832](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1832) The key of the process instance. --- -### result? +### result ```ts -optional result: string; +result: string; ``` -Defined in: [gen/types.gen.ts:1786](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1786) +Defined in: [gen/types.gen.ts:1836](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1836) The result of the decision instance. --- -### rootDecisionDefinitionKey? +### rootDecisionDefinitionKey ```ts -optional rootDecisionDefinitionKey: DecisionDefinitionKey; +rootDecisionDefinitionKey: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1815](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1815) +Defined in: [gen/types.gen.ts:1840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1840) The key of the root decision definition. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:1803](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1803) +Defined in: [gen/types.gen.ts:1847](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1847) + +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. --- -### state? +### state ```ts -optional state: DecisionInstanceStateEnum; +state: DecisionInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:1761](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1761) +Defined in: [gen/types.gen.ts:1848](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1848) --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1790](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1790) +Defined in: [gen/types.gen.ts:1852](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1852) The tenant ID of the decision instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQuery.md index d0eafadbafa..bf385d6ef2e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQuery.md @@ -11,7 +11,7 @@ mdx: type DecisionInstanceSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:1669](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1669) +Defined in: [gen/types.gen.ts:1700](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1700) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQueryResult.md index 5eca0e277ca..7db97469b4c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQueryResult.md @@ -11,14 +11,14 @@ mdx: type DecisionInstanceSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:1752](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1752) +Defined in: [gen/types.gen.ts:1783](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1783) ## Type Declaration -### items? +### items ```ts -optional items: DecisionInstanceResult[]; +items: DecisionInstanceResult[]; ``` The matching decision instances. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQuerySortRequest.md index c5891b86ab1..0f9d9504abf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type DecisionInstanceSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:1661](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1661) +Defined in: [gen/types.gen.ts:1692](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1692) ## Properties @@ -36,7 +36,7 @@ field: | "tenantId"; ``` -Defined in: [gen/types.gen.ts:1665](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1665) +Defined in: [gen/types.gen.ts:1696](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1696) The field to sort by. @@ -48,4 +48,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:1666](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1666) +Defined in: [gen/types.gen.ts:1697](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1697) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateEnum.md index 3aece8a1038..0a2563aac31 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateEnum.md @@ -8,9 +8,13 @@ mdx: # Type Alias: DecisionInstanceStateEnum ```ts -type DecisionInstanceStateEnum = "EVALUATED" | "FAILED" | "UNSPECIFIED"; +type DecisionInstanceStateEnum = + | "EVALUATED" + | "FAILED" + | "UNSPECIFIED" + | "UNKNOWN"; ``` -Defined in: [gen/types.gen.ts:1877](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1877) +Defined in: [gen/types.gen.ts:1938](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1938) -The state of the decision instance. +The state of the decision instance. UNSPECIFIED and UNKNOWN are deprecated and should not be used anymore, for removal in 8.10 diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateExactMatch.md index b8b97934d1d..24b569b981a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateExactMatch.md @@ -11,7 +11,7 @@ mdx: type DecisionInstanceStateExactMatch = DecisionInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:7472](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7472) +Defined in: [gen/types.gen.ts:8304](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8304) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateFilterProperty.md index 7d1168a1eb1..0e309d3f99e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionInstanceStateFilterProperty.md @@ -13,6 +13,6 @@ type DecisionInstanceStateFilterProperty = | AdvancedDecisionInstanceStateFilter; ``` -Defined in: [gen/types.gen.ts:1911](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1911) +Defined in: [gen/types.gen.ts:1972](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1972) DecisionInstanceStateEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsFilter.md index bd2d9f8954c..ae6bb9aed64 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsFilter.md @@ -11,7 +11,7 @@ mdx: type DecisionRequirementsFilter = object; ``` -Defined in: [gen/types.gen.ts:1935](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1935) +Defined in: [gen/types.gen.ts:1996](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1996) Decision requirements search filter. @@ -23,7 +23,7 @@ Decision requirements search filter. optional decisionRequirementsId: string; ``` -Defined in: [gen/types.gen.ts:1943](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1943) +Defined in: [gen/types.gen.ts:2004](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2004) the DMN ID of the decision requirements. @@ -35,7 +35,7 @@ the DMN ID of the decision requirements. optional decisionRequirementsKey: DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:1944](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1944) +Defined in: [gen/types.gen.ts:2005](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2005) --- @@ -45,7 +45,7 @@ Defined in: [gen/types.gen.ts:1944](https://github.com/camunda/orchestration-clu optional decisionRequirementsName: string; ``` -Defined in: [gen/types.gen.ts:1939](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1939) +Defined in: [gen/types.gen.ts:2000](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2000) The DMN name of the decision requirements. @@ -57,7 +57,7 @@ The DMN name of the decision requirements. optional resourceName: string; ``` -Defined in: [gen/types.gen.ts:1956](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1956) +Defined in: [gen/types.gen.ts:2017](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2017) The name of the resource from which the decision requirements were parsed @@ -69,7 +69,7 @@ The name of the resource from which the decision requirements were parsed optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1952](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1952) +Defined in: [gen/types.gen.ts:2013](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2013) The tenant ID of the decision requirements. @@ -81,6 +81,6 @@ The tenant ID of the decision requirements. optional version: number; ``` -Defined in: [gen/types.gen.ts:1948](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1948) +Defined in: [gen/types.gen.ts:2009](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2009) The assigned version of the decision requirements. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKey.md index 3b04ce4a9d3..d48b6e7d70c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKey.md @@ -11,6 +11,6 @@ mdx: type DecisionRequirementsKey = CamundaKey<"DecisionRequirementsKey">; ``` -Defined in: [gen/types.gen.ts:4079](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4079) +Defined in: [gen/types.gen.ts:4718](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4718) System-generated key for a deployed decision requirements definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKeyExactMatch.md index 2dcc8dd9bb4..96b2e5877ac 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type DecisionRequirementsKeyExactMatch = DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:7612](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7612) +Defined in: [gen/types.gen.ts:8458](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8458) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKeyFilterProperty.md index 7da6a0f9c85..1eef7f434bf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsKeyFilterProperty.md @@ -13,6 +13,6 @@ type DecisionRequirementsKeyFilterProperty = | AdvancedDecisionRequirementsKeyFilter; ``` -Defined in: [gen/types.gen.ts:4469](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4469) +Defined in: [gen/types.gen.ts:5110](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5110) DecisionRequirementsKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsResult.md index 9c7b96fbefb..85948eefd44 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsResult.md @@ -11,76 +11,76 @@ mdx: type DecisionRequirementsResult = object; ``` -Defined in: [gen/types.gen.ts:1966](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1966) +Defined in: [gen/types.gen.ts:2027](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2027) ## Properties -### decisionRequirementsId? +### decisionRequirementsId ```ts -optional decisionRequirementsId: string; +decisionRequirementsId: string; ``` -Defined in: [gen/types.gen.ts:1978](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1978) +Defined in: [gen/types.gen.ts:2031](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2031) The DMN ID of the decision requirements. --- -### decisionRequirementsKey? +### decisionRequirementsKey ```ts -optional decisionRequirementsKey: DecisionRequirementsKey; +decisionRequirementsKey: DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:1990](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1990) +Defined in: [gen/types.gen.ts:2035](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2035) The assigned key, which acts as a unique identifier for this decision requirements. --- -### decisionRequirementsName? +### decisionRequirementsName ```ts -optional decisionRequirementsName: string; +decisionRequirementsName: string; ``` -Defined in: [gen/types.gen.ts:1970](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1970) +Defined in: [gen/types.gen.ts:2039](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2039) The DMN name of the decision requirements. --- -### resourceName? +### resourceName ```ts -optional resourceName: string; +resourceName: string; ``` -Defined in: [gen/types.gen.ts:1982](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1982) +Defined in: [gen/types.gen.ts:2043](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2043) The name of the resource from which this decision requirements was parsed. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1986](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1986) +Defined in: [gen/types.gen.ts:2047](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2047) The tenant ID of the decision requirements. --- -### version? +### version ```ts -optional version: number; +version: number; ``` -Defined in: [gen/types.gen.ts:1974](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1974) +Defined in: [gen/types.gen.ts:2051](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2051) The assigned version of the decision requirements. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQuery.md index c269ec82d0b..5c440e86ca7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQuery.md @@ -11,7 +11,7 @@ mdx: type DecisionRequirementsSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:1921](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1921) +Defined in: [gen/types.gen.ts:1982](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1982) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQueryResult.md index e75098ada3a..33891842584 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQueryResult.md @@ -11,14 +11,14 @@ mdx: type DecisionRequirementsSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:1959](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1959) +Defined in: [gen/types.gen.ts:2020](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2020) ## Type Declaration -### items? +### items ```ts -optional items: DecisionRequirementsResult[]; +items: DecisionRequirementsResult[]; ``` The matching decision requirements. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQuerySortRequest.md index 9e428b8267b..da69ceeded8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DecisionRequirementsSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type DecisionRequirementsSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:1913](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1913) +Defined in: [gen/types.gen.ts:1974](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1974) ## Properties @@ -26,7 +26,7 @@ field: | "tenantId"; ``` -Defined in: [gen/types.gen.ts:1917](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1917) +Defined in: [gen/types.gen.ts:1978](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1978) The field to sort by. @@ -38,4 +38,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:1918](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1918) +Defined in: [gen/types.gen.ts:1979](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1979) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationData.md index b62d7470ccb..9d90edfa77d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationData.md @@ -11,7 +11,7 @@ mdx: type DeleteAuthorizationData = object; ``` -Defined in: [gen/types.gen.ts:8062](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8062) +Defined in: [gen/types.gen.ts:8683](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8683) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8062](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:8063](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8063) +Defined in: [gen/types.gen.ts:8684](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8684) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8063](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8064](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8064) +Defined in: [gen/types.gen.ts:8685](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8685) #### authorizationKey @@ -49,7 +49,7 @@ The key of the authorization to delete. optional query: never; ``` -Defined in: [gen/types.gen.ts:8070](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8070) +Defined in: [gen/types.gen.ts:8691](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8691) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8070](https://github.com/camunda/orchestration-clu url: "/authorizations/{authorizationKey}"; ``` -Defined in: [gen/types.gen.ts:8071](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8071) +Defined in: [gen/types.gen.ts:8692](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8692) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationError.md index c105828fead..867cb2e6833 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationError.md @@ -12,4 +12,4 @@ type DeleteAuthorizationError = DeleteAuthorizationErrors[keyof DeleteAuthorizationErrors]; ``` -Defined in: [gen/types.gen.ts:8094](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8094) +Defined in: [gen/types.gen.ts:8715](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8715) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationErrors.md index 6e9cc2c39fe..2a65f59f9ca 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteAuthorizationErrors = object; ``` -Defined in: [gen/types.gen.ts:8074](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8074) +Defined in: [gen/types.gen.ts:8695](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8695) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8074](https://github.com/camunda/orchestration-clu 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8078](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8078) +Defined in: [gen/types.gen.ts:8699](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8699) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8082](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8082) +Defined in: [gen/types.gen.ts:8703](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8703) The authorization with the authorizationKey was not found. @@ -45,7 +45,7 @@ The authorization with the authorizationKey was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8086](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8086) +Defined in: [gen/types.gen.ts:8707](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8707) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8091](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8091) +Defined in: [gen/types.gen.ts:8712](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8712) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationResponse.md index d8a78b5f7a5..3b15c5685ec 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationResponse.md @@ -12,4 +12,4 @@ type DeleteAuthorizationResponse = DeleteAuthorizationResponses[keyof DeleteAuthorizationResponses]; ``` -Defined in: [gen/types.gen.ts:8103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8103) +Defined in: [gen/types.gen.ts:8724](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8724) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationResponses.md index 68ef2600c09..fb004f3d824 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteAuthorizationResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteAuthorizationResponses = object; ``` -Defined in: [gen/types.gen.ts:8096](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8096) +Defined in: [gen/types.gen.ts:8717](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8717) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8096](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:8100](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8100) +Defined in: [gen/types.gen.ts:8721](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8721) The authorization was deleted successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceData.md index c4fe8dcabd5..710a7df0f70 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceData.md @@ -11,17 +11,21 @@ mdx: type DeleteDecisionInstanceData = object; ``` -Defined in: [gen/types.gen.ts:9651](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9651) +Defined in: [gen/types.gen.ts:9851](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9851) ## Properties ### body? ```ts -optional body: DeleteProcessInstanceRequest; +optional body: + | { + operationReference?: OperationReference; +} + | null; ``` -Defined in: [gen/types.gen.ts:9652](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9652) +Defined in: [gen/types.gen.ts:9852](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9852) --- @@ -31,15 +35,15 @@ Defined in: [gen/types.gen.ts:9652](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:9653](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9653) +Defined in: [gen/types.gen.ts:9855](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9855) -#### decisionInstanceKey +#### decisionEvaluationKey ```ts -decisionInstanceKey: DecisionInstanceKey; +decisionEvaluationKey: DecisionEvaluationKey; ``` -The key of the decision instance to delete. +The key of the decision evaluation to delete. --- @@ -49,14 +53,14 @@ The key of the decision instance to delete. optional query: never; ``` -Defined in: [gen/types.gen.ts:9659](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9659) +Defined in: [gen/types.gen.ts:9861](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9861) --- ### url ```ts -url: "/decision-instances/{decisionInstanceKey}/deletion"; +url: "/decision-instances/{decisionEvaluationKey}/deletion"; ``` -Defined in: [gen/types.gen.ts:9660](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9660) +Defined in: [gen/types.gen.ts:9862](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9862) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceError.md index bfbe6258529..c174bdf5a21 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceError.md @@ -12,4 +12,4 @@ type DeleteDecisionInstanceError = DeleteDecisionInstanceErrors[keyof DeleteDecisionInstanceErrors]; ``` -Defined in: [gen/types.gen.ts:9687](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9687) +Defined in: [gen/types.gen.ts:9889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9889) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceErrors.md index c63f27af039..7edff3810bb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteDecisionInstanceErrors = object; ``` -Defined in: [gen/types.gen.ts:9663](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9663) +Defined in: [gen/types.gen.ts:9865](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9865) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9663](https://github.com/camunda/orchestration-clu 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9667](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9667) +Defined in: [gen/types.gen.ts:9869](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9869) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9671](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9671) +Defined in: [gen/types.gen.ts:9873](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9873) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9675](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9675) +Defined in: [gen/types.gen.ts:9877](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9877) The decision instance is not found. @@ -57,7 +57,7 @@ The decision instance is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9679](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9679) +Defined in: [gen/types.gen.ts:9881](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9881) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9684](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9684) +Defined in: [gen/types.gen.ts:9886](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9886) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceRequest.md index 0d523b79bcf..96dd7c919c4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceRequest.md @@ -13,4 +13,4 @@ type DeleteDecisionInstanceRequest = { } | null; ``` -Defined in: [gen/types.gen.ts:1748](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1748) +Defined in: [gen/types.gen.ts:1779](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1779) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceResponse.md index 689ce6f71d4..358e7ac26f7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceResponse.md @@ -12,4 +12,4 @@ type DeleteDecisionInstanceResponse = DeleteDecisionInstanceResponses[keyof DeleteDecisionInstanceResponses]; ``` -Defined in: [gen/types.gen.ts:9696](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9696) +Defined in: [gen/types.gen.ts:9898](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9898) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceResponses.md index fa252f510c9..083b6af50c9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstanceResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteDecisionInstanceResponses = object; ``` -Defined in: [gen/types.gen.ts:9689](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9689) +Defined in: [gen/types.gen.ts:9891](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9891) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9689](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:9693](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9693) +Defined in: [gen/types.gen.ts:9895](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9895) The decision instance is marked for deletion. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationData.md index 3568af48d0d..494dd3a1864 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationData.md @@ -11,159 +11,17 @@ mdx: type DeleteDecisionInstancesBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:9698](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9698) +Defined in: [gen/types.gen.ts:9900](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9900) ## Properties ### body ```ts -body: object; +body: DecisionInstanceDeletionBatchOperationRequest; ``` -Defined in: [gen/types.gen.ts:9702](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9702) - -The decision instance filter that defines which decision instances should be deleted. - -#### filter - -```ts -filter: object; -``` - -Decision instance search filter. - -##### filter.decisionDefinitionId? - -```ts -optional decisionDefinitionId: DecisionDefinitionId; -``` - -The ID of the DMN decision. - -##### filter.decisionDefinitionKey? - -```ts -optional decisionDefinitionKey: DecisionDefinitionKeyFilterProperty; -``` - -The key of the decision. - -##### filter.decisionDefinitionName? - -```ts -optional decisionDefinitionName: string; -``` - -The name of the DMN decision. - -##### filter.decisionDefinitionType? - -```ts -optional decisionDefinitionType: DecisionDefinitionTypeEnum; -``` - -##### filter.decisionDefinitionVersion? - -```ts -optional decisionDefinitionVersion: number; -``` - -The version of the decision. - -##### filter.decisionEvaluationInstanceKey? - -```ts -optional decisionEvaluationInstanceKey: DecisionEvaluationInstanceKeyFilterProperty; -``` - -The key of the decision evaluation instance. - -##### filter.decisionEvaluationKey? - -```ts -optional decisionEvaluationKey: DecisionEvaluationKey; -``` - -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. - -##### filter.decisionRequirementsKey? - -```ts -optional decisionRequirementsKey: DecisionRequirementsKeyFilterProperty; -``` - -The key of the decision requirements definition. - -##### filter.elementInstanceKey? - -```ts -optional elementInstanceKey: ElementInstanceKeyFilterProperty; -``` - -The key of the element instance this decision instance is linked to. - -##### filter.evaluationDate? - -```ts -optional evaluationDate: DateTimeFilterProperty; -``` - -The evaluation date of the decision instance. - -##### filter.evaluationFailure? - -```ts -optional evaluationFailure: string; -``` - -The evaluation failure of the decision instance. - -##### filter.processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKey; -``` - -The key of the process definition. - -##### filter.processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKey; -``` - -The key of the process instance. - -##### filter.rootDecisionDefinitionKey? - -```ts -optional rootDecisionDefinitionKey: DecisionDefinitionKeyFilterProperty; -``` - -The key of the root decision definition. - -##### filter.state? - -```ts -optional state: DecisionInstanceStateFilterProperty; -``` - -The state of the decision instance. - -##### filter.tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant ID of the decision instance. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` +Defined in: [gen/types.gen.ts:9901](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9901) --- @@ -173,7 +31,7 @@ optional operationReference: OperationReference; optional path: never; ``` -Defined in: [gen/types.gen.ts:9772](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9772) +Defined in: [gen/types.gen.ts:9902](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9902) --- @@ -183,7 +41,7 @@ Defined in: [gen/types.gen.ts:9772](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:9773](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9773) +Defined in: [gen/types.gen.ts:9903](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9903) --- @@ -193,4 +51,4 @@ Defined in: [gen/types.gen.ts:9773](https://github.com/camunda/orchestration-clu url: "/decision-instances/deletion"; ``` -Defined in: [gen/types.gen.ts:9774](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9774) +Defined in: [gen/types.gen.ts:9904](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9904) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationError.md index 494f2f9b4df..fab0da93d35 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationError.md @@ -12,4 +12,4 @@ type DeleteDecisionInstancesBatchOperationError = DeleteDecisionInstancesBatchOperationErrors[keyof DeleteDecisionInstancesBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:9797](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9797) +Defined in: [gen/types.gen.ts:9927](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9927) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationErrors.md index f538a7d81a6..480f9555980 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteDecisionInstancesBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:9777](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9777) +Defined in: [gen/types.gen.ts:9907](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9907) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9777](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9782](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9782) +Defined in: [gen/types.gen.ts:9912](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9912) The decision instance batch operation failed. More details are provided in the response body. @@ -33,7 +33,7 @@ The decision instance batch operation failed. More details are provided in the r 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9786](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9786) +Defined in: [gen/types.gen.ts:9916](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9916) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9790](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9790) +Defined in: [gen/types.gen.ts:9920](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9920) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9794](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9794) +Defined in: [gen/types.gen.ts:9924](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9924) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationResponse.md index 6a709dc536a..9978caff07e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationResponse.md @@ -12,4 +12,4 @@ type DeleteDecisionInstancesBatchOperationResponse = DeleteDecisionInstancesBatchOperationResponses[keyof DeleteDecisionInstancesBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:9806](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9806) +Defined in: [gen/types.gen.ts:9936](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9936) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationResponses.md index fd3c28a6b75..aeab4be9a3f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDecisionInstancesBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteDecisionInstancesBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:9799](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9799) +Defined in: [gen/types.gen.ts:9929](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9929) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9799](https://github.com/camunda/orchestration-clu 200: BatchOperationCreatedResult; ``` -Defined in: [gen/types.gen.ts:9803](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9803) +Defined in: [gen/types.gen.ts:9933](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9933) The batch operation request was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentData.md index d2d5baefcdd..73b85c17211 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentData.md @@ -11,7 +11,7 @@ mdx: type DeleteDocumentData = object; ``` -Defined in: [gen/types.gen.ts:10106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10106) +Defined in: [gen/types.gen.ts:10200](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10200) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10106](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:10107](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10107) +Defined in: [gen/types.gen.ts:10201](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10201) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10107](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10108](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10108) +Defined in: [gen/types.gen.ts:10202](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10202) #### documentId @@ -49,7 +49,7 @@ The ID of the document to delete. optional query: object; ``` -Defined in: [gen/types.gen.ts:10114](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10114) +Defined in: [gen/types.gen.ts:10208](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10208) #### storeId? @@ -67,4 +67,4 @@ The ID of the document store to delete the document from. url: "/documents/{documentId}"; ``` -Defined in: [gen/types.gen.ts:10120](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10120) +Defined in: [gen/types.gen.ts:10214](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10214) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentError.md index 2d1b11c4a6e..bdefeda01ec 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentError.md @@ -11,4 +11,4 @@ mdx: type DeleteDocumentError = DeleteDocumentErrors[keyof DeleteDocumentErrors]; ``` -Defined in: [gen/types.gen.ts:10134](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10134) +Defined in: [gen/types.gen.ts:10228](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10228) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentErrors.md index 26714c13ba8..971fb175b58 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteDocumentErrors = object; ``` -Defined in: [gen/types.gen.ts:10123](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10123) +Defined in: [gen/types.gen.ts:10217](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10217) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10123](https://github.com/camunda/orchestration-cl 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10127](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10127) +Defined in: [gen/types.gen.ts:10221](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10221) The document with the given ID was not found. @@ -33,6 +33,6 @@ The document with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10131](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10131) +Defined in: [gen/types.gen.ts:10225](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10225) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentResponse.md index 72fa36648b9..07a6ea80bf9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentResponse.md @@ -12,4 +12,4 @@ type DeleteDocumentResponse = DeleteDocumentResponses[keyof DeleteDocumentResponses]; ``` -Defined in: [gen/types.gen.ts:10143](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10143) +Defined in: [gen/types.gen.ts:10237](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10237) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentResponses.md index 6ea7e4a36db..b45003472e1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteDocumentResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteDocumentResponses = object; ``` -Defined in: [gen/types.gen.ts:10136](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10136) +Defined in: [gen/types.gen.ts:10230](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10230) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10136](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:10140](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10140) +Defined in: [gen/types.gen.ts:10234](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10234) The document was deleted successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableData.md index 33ead56d38a..87409d2d3e8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableData.md @@ -11,7 +11,7 @@ mdx: type DeleteGlobalClusterVariableData = object; ``` -Defined in: [gen/types.gen.ts:8621](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8621) +Defined in: [gen/types.gen.ts:9144](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9144) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8621](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:8622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8622) +Defined in: [gen/types.gen.ts:9145](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9145) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8622](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8623](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8623) +Defined in: [gen/types.gen.ts:9146](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9146) #### name @@ -49,7 +49,7 @@ The name of the cluster variable optional query: never; ``` -Defined in: [gen/types.gen.ts:8629](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8629) +Defined in: [gen/types.gen.ts:9152](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9152) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8629](https://github.com/camunda/orchestration-clu url: "/cluster-variables/global/{name}"; ``` -Defined in: [gen/types.gen.ts:8630](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8630) +Defined in: [gen/types.gen.ts:9153](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9153) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableError.md index 5a7e573e458..ccdd873081e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableError.md @@ -12,4 +12,4 @@ type DeleteGlobalClusterVariableError = DeleteGlobalClusterVariableErrors[keyof DeleteGlobalClusterVariableErrors]; ``` -Defined in: [gen/types.gen.ts:8656](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8656) +Defined in: [gen/types.gen.ts:9179](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9179) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableErrors.md index 67b89845228..1aba0f16caf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteGlobalClusterVariableErrors = object; ``` -Defined in: [gen/types.gen.ts:8633](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8633) +Defined in: [gen/types.gen.ts:9156](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9156) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8633](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8637](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8637) +Defined in: [gen/types.gen.ts:9160](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9160) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8641](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8641) +Defined in: [gen/types.gen.ts:9164](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9164) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8645](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8645) +Defined in: [gen/types.gen.ts:9168](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9168) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8649](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8649) +Defined in: [gen/types.gen.ts:9172](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9172) Cluster variable not found @@ -69,6 +69,6 @@ Cluster variable not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8653](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8653) +Defined in: [gen/types.gen.ts:9176](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9176) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableResponse.md index 2240f38aad0..11b4de1c2f8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableResponse.md @@ -12,4 +12,4 @@ type DeleteGlobalClusterVariableResponse = DeleteGlobalClusterVariableResponses[keyof DeleteGlobalClusterVariableResponses]; ``` -Defined in: [gen/types.gen.ts:8665](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8665) +Defined in: [gen/types.gen.ts:9188](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9188) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableResponses.md index f4171c0d00b..82ff1b333b8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalClusterVariableResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteGlobalClusterVariableResponses = object; ``` -Defined in: [gen/types.gen.ts:8658](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8658) +Defined in: [gen/types.gen.ts:9181](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9181) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8658](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:8662](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8662) +Defined in: [gen/types.gen.ts:9185](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9185) Cluster variable deleted successfully diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerData.md new file mode 100644 index 00000000000..0f1029791e3 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerData.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: DeleteGlobalTaskListenerData" +sidebar_label: "DeleteGlobalTaskListenerData" +mdx: + format: md +--- + +# Type Alias: DeleteGlobalTaskListenerData + +```ts +type DeleteGlobalTaskListenerData = object; +``` + +Defined in: [gen/types.gen.ts:10636](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10636) + +## Properties + +### body? + +```ts +optional body: never; +``` + +Defined in: [gen/types.gen.ts:10637](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10637) + +--- + +### path + +```ts +path: object; +``` + +Defined in: [gen/types.gen.ts:10638](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10638) + +#### id + +```ts +id: GlobalListenerId; +``` + +The id of the global user task listener to delete. + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:10644](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10644) + +--- + +### url + +```ts +url: "/global-task-listeners/{id}"; +``` + +Defined in: [gen/types.gen.ts:10645](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10645) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerError.md new file mode 100644 index 00000000000..e638ea05ca4 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: DeleteGlobalTaskListenerError" +sidebar_label: "DeleteGlobalTaskListenerError" +mdx: + format: md +--- + +# Type Alias: DeleteGlobalTaskListenerError + +```ts +type DeleteGlobalTaskListenerError = + DeleteGlobalTaskListenerErrors[keyof DeleteGlobalTaskListenerErrors]; +``` + +Defined in: [gen/types.gen.ts:10676](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10676) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerErrors.md new file mode 100644 index 00000000000..16b7ab847ee --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerErrors.md @@ -0,0 +1,86 @@ +--- +title: "Type Alias: DeleteGlobalTaskListenerErrors" +sidebar_label: "DeleteGlobalTaskListenerErrors" +mdx: + format: md +--- + +# Type Alias: DeleteGlobalTaskListenerErrors + +```ts +type DeleteGlobalTaskListenerErrors = object; +``` + +Defined in: [gen/types.gen.ts:10648](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10648) + +## Properties + +### 400 + +```ts +400: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10652](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10652) + +The provided data is not valid. + +--- + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10656](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10656) + +The request lacks valid authentication credentials. + +--- + +### 403 + +```ts +403: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10660](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10660) + +Forbidden. The request is not allowed. + +--- + +### 404 + +```ts +404: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10664](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10664) + +The global user task listener was not found. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10668](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10668) + +An internal error occurred while processing the request. + +--- + +### 503 + +```ts +503: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10673](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10673) + +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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerResponse.md new file mode 100644 index 00000000000..4fda55d6228 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: DeleteGlobalTaskListenerResponse" +sidebar_label: "DeleteGlobalTaskListenerResponse" +mdx: + format: md +--- + +# Type Alias: DeleteGlobalTaskListenerResponse + +```ts +type DeleteGlobalTaskListenerResponse = + DeleteGlobalTaskListenerResponses[keyof DeleteGlobalTaskListenerResponses]; +``` + +Defined in: [gen/types.gen.ts:10685](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10685) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerResponses.md new file mode 100644 index 00000000000..8a0e9e0a654 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGlobalTaskListenerResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: DeleteGlobalTaskListenerResponses" +sidebar_label: "DeleteGlobalTaskListenerResponses" +mdx: + format: md +--- + +# Type Alias: DeleteGlobalTaskListenerResponses + +```ts +type DeleteGlobalTaskListenerResponses = object; +``` + +Defined in: [gen/types.gen.ts:10678](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10678) + +## Properties + +### 204 + +```ts +204: void; +``` + +Defined in: [gen/types.gen.ts:10682](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10682) + +The global listener was deleted successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupData.md index 2474f969c10..6f8ec99d2f8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupData.md @@ -11,7 +11,7 @@ mdx: type DeleteGroupData = object; ``` -Defined in: [gen/types.gen.ts:10728](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10728) +Defined in: [gen/types.gen.ts:10896](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10896) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10728](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:10729](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10729) +Defined in: [gen/types.gen.ts:10897](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10897) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10729](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10730](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10730) +Defined in: [gen/types.gen.ts:10898](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10898) #### groupId @@ -49,7 +49,7 @@ The group ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:10736](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10736) +Defined in: [gen/types.gen.ts:10904](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10904) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:10736](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}"; ``` -Defined in: [gen/types.gen.ts:10737](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10737) +Defined in: [gen/types.gen.ts:10905](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10905) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupError.md index 4d181c4ba9b..d20820a92aa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupError.md @@ -11,4 +11,4 @@ mdx: type DeleteGroupError = DeleteGroupErrors[keyof DeleteGroupErrors]; ``` -Defined in: [gen/types.gen.ts:10760](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10760) +Defined in: [gen/types.gen.ts:10928](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10928) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupErrors.md index f4351063fda..18fbb01a41e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:10740](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10740) +Defined in: [gen/types.gen.ts:10908](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10908) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10740](https://github.com/camunda/orchestration-cl 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10744](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10744) +Defined in: [gen/types.gen.ts:10912](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10912) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10748](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10748) +Defined in: [gen/types.gen.ts:10916](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10916) The group with the given ID was not found. @@ -45,7 +45,7 @@ The group with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10752](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10752) +Defined in: [gen/types.gen.ts:10920](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10920) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10757](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10757) +Defined in: [gen/types.gen.ts:10925](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10925) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupResponse.md index 108475c6704..2320bbaf022 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupResponse.md @@ -11,4 +11,4 @@ mdx: type DeleteGroupResponse = DeleteGroupResponses[keyof DeleteGroupResponses]; ``` -Defined in: [gen/types.gen.ts:10769](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10769) +Defined in: [gen/types.gen.ts:10937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10937) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupResponses.md index 5a2823af465..23d836e6b93 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteGroupResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:10762](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10762) +Defined in: [gen/types.gen.ts:10930](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10930) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10762](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:10766](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10766) +Defined in: [gen/types.gen.ts:10934](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10934) The group was deleted successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleData.md index 1944b372142..70f260f2e8f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleData.md @@ -11,7 +11,7 @@ mdx: type DeleteMappingRuleData = object; ``` -Defined in: [gen/types.gen.ts:12285](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12285) +Defined in: [gen/types.gen.ts:12364](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12364) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12285](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:12286](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12286) +Defined in: [gen/types.gen.ts:12365](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12365) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12286](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:12287](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12287) +Defined in: [gen/types.gen.ts:12366](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12366) #### mappingRuleId @@ -49,7 +49,7 @@ The ID of the mapping rule to delete. optional query: never; ``` -Defined in: [gen/types.gen.ts:12293](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12293) +Defined in: [gen/types.gen.ts:12372](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12372) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:12293](https://github.com/camunda/orchestration-cl url: "/mapping-rules/{mappingRuleId}"; ``` -Defined in: [gen/types.gen.ts:12294](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12294) +Defined in: [gen/types.gen.ts:12373](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12373) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleError.md index a0097c646be..57b76c2aa6d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleError.md @@ -12,4 +12,4 @@ type DeleteMappingRuleError = DeleteMappingRuleErrors[keyof DeleteMappingRuleErrors]; ``` -Defined in: [gen/types.gen.ts:12317](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12317) +Defined in: [gen/types.gen.ts:12396](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12396) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleErrors.md index eb0d2fc270a..56792abf7fc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteMappingRuleErrors = object; ``` -Defined in: [gen/types.gen.ts:12297](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12297) +Defined in: [gen/types.gen.ts:12376](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12376) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12297](https://github.com/camunda/orchestration-cl 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12301](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12301) +Defined in: [gen/types.gen.ts:12380](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12380) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12305](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12305) +Defined in: [gen/types.gen.ts:12384](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12384) The mapping rule with the mappingRuleId was not found. @@ -45,7 +45,7 @@ The mapping rule with the mappingRuleId was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12309](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12309) +Defined in: [gen/types.gen.ts:12388](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12388) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12314](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12314) +Defined in: [gen/types.gen.ts:12393](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12393) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleResponse.md index 10853800f09..13e9269ba16 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleResponse.md @@ -12,4 +12,4 @@ type DeleteMappingRuleResponse = DeleteMappingRuleResponses[keyof DeleteMappingRuleResponses]; ``` -Defined in: [gen/types.gen.ts:12326](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12326) +Defined in: [gen/types.gen.ts:12405](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12405) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleResponses.md index 3406e12f475..4a487abae9b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteMappingRuleResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteMappingRuleResponses = object; ``` -Defined in: [gen/types.gen.ts:12319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12319) +Defined in: [gen/types.gen.ts:12398](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12398) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12319](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:12323](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12323) +Defined in: [gen/types.gen.ts:12402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12402) The mapping rule was deleted successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceData.md index cc3930d6384..cc0189b9423 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceData.md @@ -11,7 +11,7 @@ mdx: type DeleteProcessInstanceData = object; ``` -Defined in: [gen/types.gen.ts:13971](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13971) +Defined in: [gen/types.gen.ts:13368](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13368) ## Properties @@ -25,7 +25,7 @@ optional body: | null; ``` -Defined in: [gen/types.gen.ts:13972](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13972) +Defined in: [gen/types.gen.ts:13369](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13369) --- @@ -35,7 +35,7 @@ Defined in: [gen/types.gen.ts:13972](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:13975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13975) +Defined in: [gen/types.gen.ts:13372](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13372) #### processInstanceKey @@ -53,7 +53,7 @@ The key of the process instance to delete. optional query: never; ``` -Defined in: [gen/types.gen.ts:13981](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13981) +Defined in: [gen/types.gen.ts:13378](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13378) --- @@ -63,4 +63,4 @@ Defined in: [gen/types.gen.ts:13981](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}/deletion"; ``` -Defined in: [gen/types.gen.ts:13982](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13982) +Defined in: [gen/types.gen.ts:13379](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13379) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceError.md index 161c3d84cd8..52f8840c929 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceError.md @@ -12,4 +12,4 @@ type DeleteProcessInstanceError = DeleteProcessInstanceErrors[keyof DeleteProcessInstanceErrors]; ``` -Defined in: [gen/types.gen.ts:14013](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14013) +Defined in: [gen/types.gen.ts:13410](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13410) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceErrors.md index 1429e413102..686095c51f9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteProcessInstanceErrors = object; ``` -Defined in: [gen/types.gen.ts:13985](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13985) +Defined in: [gen/types.gen.ts:13382](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13382) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13985](https://github.com/camunda/orchestration-cl 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13989](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13989) +Defined in: [gen/types.gen.ts:13386](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13386) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13993](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13993) +Defined in: [gen/types.gen.ts:13390](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13390) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13997](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13997) +Defined in: [gen/types.gen.ts:13394](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13394) The process instance is not found. @@ -57,7 +57,7 @@ The process instance is not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14001](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14001) +Defined in: [gen/types.gen.ts:13398](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13398) The process instance is not in a completed or terminated state and cannot be deleted. @@ -69,7 +69,7 @@ The process instance is not in a completed or terminated state and cannot be del 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14005](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14005) +Defined in: [gen/types.gen.ts:13402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13402) An internal error occurred while processing the request. @@ -81,6 +81,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14010](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14010) +Defined in: [gen/types.gen.ts:13407](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13407) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceRequest.md index 63ebbdfe95e..31e7331f3ec 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceRequest.md @@ -13,4 +13,4 @@ type DeleteProcessInstanceRequest = { } | null; ``` -Defined in: [gen/types.gen.ts:5854](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5854) +Defined in: [gen/types.gen.ts:6561](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6561) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceResponse.md index ff755c4f6ba..de96670f648 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceResponse.md @@ -12,4 +12,4 @@ type DeleteProcessInstanceResponse = DeleteProcessInstanceResponses[keyof DeleteProcessInstanceResponses]; ``` -Defined in: [gen/types.gen.ts:14022](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14022) +Defined in: [gen/types.gen.ts:13419](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13419) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceResponses.md index 2d8274bde41..c3df20c0cb3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstanceResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteProcessInstanceResponses = object; ``` -Defined in: [gen/types.gen.ts:14015](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14015) +Defined in: [gen/types.gen.ts:13412](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13412) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14015](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:14019](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14019) +Defined in: [gen/types.gen.ts:13416](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13416) The process instance is marked for deletion. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationData.md index 8a092ad10b0..3364462a475 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationData.md @@ -11,33 +11,17 @@ mdx: type DeleteProcessInstancesBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:13428](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13428) +Defined in: [gen/types.gen.ts:13036](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13036) ## Properties ### body ```ts -body: object; +body: ProcessInstanceDeletionBatchOperationRequest; ``` -Defined in: [gen/types.gen.ts:13432](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13432) - -The process instance filter that defines which process instances should be deleted. - -#### filter - -```ts -filter: ProcessInstanceFilter; -``` - -The process instance filter. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` +Defined in: [gen/types.gen.ts:13037](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13037) --- @@ -47,7 +31,7 @@ optional operationReference: OperationReference; optional path: never; ``` -Defined in: [gen/types.gen.ts:13439](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13439) +Defined in: [gen/types.gen.ts:13038](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13038) --- @@ -57,7 +41,7 @@ Defined in: [gen/types.gen.ts:13439](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:13440](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13440) +Defined in: [gen/types.gen.ts:13039](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13039) --- @@ -67,4 +51,4 @@ Defined in: [gen/types.gen.ts:13440](https://github.com/camunda/orchestration-cl url: "/process-instances/deletion"; ``` -Defined in: [gen/types.gen.ts:13441](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13441) +Defined in: [gen/types.gen.ts:13040](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13040) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationError.md index b7e6447cf73..91f13b9dafe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationError.md @@ -12,4 +12,4 @@ type DeleteProcessInstancesBatchOperationError = DeleteProcessInstancesBatchOperationErrors[keyof DeleteProcessInstancesBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:13464](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13464) +Defined in: [gen/types.gen.ts:13063](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13063) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationErrors.md index 9ff94d502fb..6bd885dd15f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteProcessInstancesBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:13444](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13444) +Defined in: [gen/types.gen.ts:13043](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13043) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13444](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13449](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13449) +Defined in: [gen/types.gen.ts:13048](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13048) The process instance batch operation failed. More details are provided in the response body. @@ -33,7 +33,7 @@ The process instance batch operation failed. More details are provided in the re 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13453](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13453) +Defined in: [gen/types.gen.ts:13052](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13052) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13457](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13457) +Defined in: [gen/types.gen.ts:13056](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13056) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13461](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13461) +Defined in: [gen/types.gen.ts:13060](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13060) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationResponse.md index bb8a559c59e..c9f8fbae490 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationResponse.md @@ -12,4 +12,4 @@ type DeleteProcessInstancesBatchOperationResponse = DeleteProcessInstancesBatchOperationResponses[keyof DeleteProcessInstancesBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:13473](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13473) +Defined in: [gen/types.gen.ts:13072](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13072) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationResponses.md index 7e1f8626876..bef20beebca 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteProcessInstancesBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteProcessInstancesBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:13466](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13466) +Defined in: [gen/types.gen.ts:13065](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13065) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13466](https://github.com/camunda/orchestration-cl 200: BatchOperationCreatedResult; ``` -Defined in: [gen/types.gen.ts:13470](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13470) +Defined in: [gen/types.gen.ts:13069](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13069) The batch operation request was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceData.md index d08ef05c00c..4a988fad899 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceData.md @@ -11,53 +11,17 @@ mdx: type DeleteResourceData = object; ``` -Defined in: [gen/types.gen.ts:14462](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14462) +Defined in: [gen/types.gen.ts:13757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13757) ## Properties ### body? ```ts -optional body: - | { - deleteHistory?: boolean; - operationReference?: OperationReference; -} - | null; +optional body: DeleteResourceRequest; ``` -Defined in: [gen/types.gen.ts:14463](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14463) - -#### Type Declaration - -```ts -{ - deleteHistory?: boolean; - operationReference?: OperationReference; -} -``` - -#### deleteHistory? - -```ts -optional deleteHistory: boolean; -``` - -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. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` - -`null` +Defined in: [gen/types.gen.ts:13758](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13758) --- @@ -67,7 +31,7 @@ optional operationReference: OperationReference; path: object; ``` -Defined in: [gen/types.gen.ts:14477](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14477) +Defined in: [gen/types.gen.ts:13759](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13759) #### resourceKey @@ -87,7 +51,7 @@ definition or the key of a form definition optional query: never; ``` -Defined in: [gen/types.gen.ts:14486](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14486) +Defined in: [gen/types.gen.ts:13768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13768) --- @@ -97,4 +61,4 @@ Defined in: [gen/types.gen.ts:14486](https://github.com/camunda/orchestration-cl url: "/resources/{resourceKey}/deletion"; ``` -Defined in: [gen/types.gen.ts:14487](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14487) +Defined in: [gen/types.gen.ts:13769](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13769) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceError.md index e4291460e57..caa71f9c7b2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceError.md @@ -11,4 +11,4 @@ mdx: type DeleteResourceError = DeleteResourceErrors[keyof DeleteResourceErrors]; ``` -Defined in: [gen/types.gen.ts:14510](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14510) +Defined in: [gen/types.gen.ts:13792](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13792) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceErrors.md index 5af1d7417a0..ea96893aaa9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteResourceErrors = object; ``` -Defined in: [gen/types.gen.ts:14490](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14490) +Defined in: [gen/types.gen.ts:13772](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13772) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14490](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14494](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14494) +Defined in: [gen/types.gen.ts:13776](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13776) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14498](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14498) +Defined in: [gen/types.gen.ts:13780](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13780) The resource is not found. @@ -45,7 +45,7 @@ The resource is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14502](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14502) +Defined in: [gen/types.gen.ts:13784](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13784) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14507](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14507) +Defined in: [gen/types.gen.ts:13789](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13789) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceRequest.md index 9d8b04fca2c..17dfdef693c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceRequest.md @@ -14,7 +14,7 @@ type DeleteResourceRequest = { } | null; ``` -Defined in: [gen/types.gen.ts:2135](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2135) +Defined in: [gen/types.gen.ts:2238](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2238) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponse.md index bffcf21732c..b36d58a7cf5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponse.md @@ -11,23 +11,23 @@ mdx: type DeleteResourceResponse = object; ``` -Defined in: [gen/types.gen.ts:2150](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2150) +Defined in: [gen/types.gen.ts:2253](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2253) ## Properties -### batchOperation? +### batchOperation ```ts -optional batchOperation: BatchOperationCreatedResult; +batchOperation: BatchOperationCreatedResult | null; ``` -Defined in: [gen/types.gen.ts:2163](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2163) +Defined in: [gen/types.gen.ts:2266](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2266) 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 not be present in the response. +this field will be `null`. --- @@ -37,6 +37,6 @@ this field will not be present in the response. resourceKey: ResourceKey; ``` -Defined in: [gen/types.gen.ts:2154](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2154) +Defined in: [gen/types.gen.ts:2257](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2257) The system-assigned key for this resource, requested to be deleted. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponse2.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponse2.md index c6428b13d7c..46c7a37e542 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponse2.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponse2.md @@ -12,4 +12,4 @@ type DeleteResourceResponse2 = DeleteResourceResponses[keyof DeleteResourceResponses]; ``` -Defined in: [gen/types.gen.ts:14519](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14519) +Defined in: [gen/types.gen.ts:13801](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13801) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponses.md index aae494926f6..7ed1c69d0ac 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteResourceResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteResourceResponses = object; ``` -Defined in: [gen/types.gen.ts:14512](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14512) +Defined in: [gen/types.gen.ts:13794](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13794) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14512](https://github.com/camunda/orchestration-cl 200: DeleteResourceResponse; ``` -Defined in: [gen/types.gen.ts:14516](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14516) +Defined in: [gen/types.gen.ts:13798](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13798) The resource is deleted. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleData.md index 2c011f81439..92d0457dbe5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleData.md @@ -11,7 +11,7 @@ mdx: type DeleteRoleData = object; ``` -Defined in: [gen/types.gen.ts:14600](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14600) +Defined in: [gen/types.gen.ts:13882](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13882) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14600](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14601](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14601) +Defined in: [gen/types.gen.ts:13883](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13883) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14601](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14602](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14602) +Defined in: [gen/types.gen.ts:13884](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13884) #### roleId @@ -49,7 +49,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:14608](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14608) +Defined in: [gen/types.gen.ts:13890](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13890) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:14608](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}"; ``` -Defined in: [gen/types.gen.ts:14609](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14609) +Defined in: [gen/types.gen.ts:13891](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13891) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleError.md index 3dbbedd46d8..f183225069a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleError.md @@ -11,4 +11,4 @@ mdx: type DeleteRoleError = DeleteRoleErrors[keyof DeleteRoleErrors]; ``` -Defined in: [gen/types.gen.ts:14632](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14632) +Defined in: [gen/types.gen.ts:13914](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13914) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleErrors.md index b069379c6b2..91d931ae49f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteRoleErrors = object; ``` -Defined in: [gen/types.gen.ts:14612](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14612) +Defined in: [gen/types.gen.ts:13894](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13894) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14612](https://github.com/camunda/orchestration-cl 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14616](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14616) +Defined in: [gen/types.gen.ts:13898](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13898) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14620](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14620) +Defined in: [gen/types.gen.ts:13902](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13902) The role with the ID was not found. @@ -45,7 +45,7 @@ The role with the ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14624](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14624) +Defined in: [gen/types.gen.ts:13906](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13906) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14629](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14629) +Defined in: [gen/types.gen.ts:13911](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13911) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleResponse.md index 516d7324138..4da1ca93044 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleResponse.md @@ -11,4 +11,4 @@ mdx: type DeleteRoleResponse = DeleteRoleResponses[keyof DeleteRoleResponses]; ``` -Defined in: [gen/types.gen.ts:14641](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14641) +Defined in: [gen/types.gen.ts:13923](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13923) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleResponses.md index 4d63ae6ee03..089269f8b5b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteRoleResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteRoleResponses = object; ``` -Defined in: [gen/types.gen.ts:14634](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14634) +Defined in: [gen/types.gen.ts:13916](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13916) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14634](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:14638](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14638) +Defined in: [gen/types.gen.ts:13920](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13920) The role was deleted successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableData.md index e6bab6c6ec3..ccc7c9fdd24 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableData.md @@ -11,7 +11,7 @@ mdx: type DeleteTenantClusterVariableData = object; ``` -Defined in: [gen/types.gen.ts:8909](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8909) +Defined in: [gen/types.gen.ts:9366](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9366) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8909](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:8910](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8910) +Defined in: [gen/types.gen.ts:9367](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9367) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8910](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8911](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8911) +Defined in: [gen/types.gen.ts:9368](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9368) #### name @@ -57,7 +57,7 @@ The tenant ID optional query: never; ``` -Defined in: [gen/types.gen.ts:8921](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8921) +Defined in: [gen/types.gen.ts:9378](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9378) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:8921](https://github.com/camunda/orchestration-clu url: "/cluster-variables/tenants/{tenantId}/{name}"; ``` -Defined in: [gen/types.gen.ts:8922](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8922) +Defined in: [gen/types.gen.ts:9379](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9379) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableError.md index cf88132f898..5b522a6c680 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableError.md @@ -12,4 +12,4 @@ type DeleteTenantClusterVariableError = DeleteTenantClusterVariableErrors[keyof DeleteTenantClusterVariableErrors]; ``` -Defined in: [gen/types.gen.ts:8948](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8948) +Defined in: [gen/types.gen.ts:9405](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9405) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableErrors.md index 3de1d54cae8..496ff953167 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteTenantClusterVariableErrors = object; ``` -Defined in: [gen/types.gen.ts:8925](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8925) +Defined in: [gen/types.gen.ts:9382](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9382) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8925](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8929](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8929) +Defined in: [gen/types.gen.ts:9386](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9386) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8933](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8933) +Defined in: [gen/types.gen.ts:9390](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9390) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8937](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8937) +Defined in: [gen/types.gen.ts:9394](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9394) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8941](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8941) +Defined in: [gen/types.gen.ts:9398](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9398) Cluster variable not found @@ -69,6 +69,6 @@ Cluster variable not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8945](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8945) +Defined in: [gen/types.gen.ts:9402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9402) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableResponse.md index c3f40db79d9..c3c310f9204 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableResponse.md @@ -12,4 +12,4 @@ type DeleteTenantClusterVariableResponse = DeleteTenantClusterVariableResponses[keyof DeleteTenantClusterVariableResponses]; ``` -Defined in: [gen/types.gen.ts:8957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8957) +Defined in: [gen/types.gen.ts:9414](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9414) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableResponses.md index 411e7914734..b03f1d46292 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantClusterVariableResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteTenantClusterVariableResponses = object; ``` -Defined in: [gen/types.gen.ts:8950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8950) +Defined in: [gen/types.gen.ts:9407](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9407) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8950](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:8954](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8954) +Defined in: [gen/types.gen.ts:9411](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9411) Cluster variable deleted successfully diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantData.md index 1e423f7b33d..2a051572ceb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantData.md @@ -11,7 +11,7 @@ mdx: type DeleteTenantData = object; ``` -Defined in: [gen/types.gen.ts:15631](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15631) +Defined in: [gen/types.gen.ts:14935](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14935) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15631](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15632](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15632) +Defined in: [gen/types.gen.ts:14936](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14936) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15632](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15633](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15633) +Defined in: [gen/types.gen.ts:14937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14937) #### tenantId @@ -49,7 +49,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:15639](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15639) +Defined in: [gen/types.gen.ts:14943](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14943) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:15639](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}"; ``` -Defined in: [gen/types.gen.ts:15640](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15640) +Defined in: [gen/types.gen.ts:14944](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14944) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantError.md index f6ed05390b9..7cc11cf467a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantError.md @@ -11,4 +11,4 @@ mdx: type DeleteTenantError = DeleteTenantErrors[keyof DeleteTenantErrors]; ``` -Defined in: [gen/types.gen.ts:15667](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15667) +Defined in: [gen/types.gen.ts:14971](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14971) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantErrors.md index 3f07a4ac511..b8f3abd00eb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:15643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15643) +Defined in: [gen/types.gen.ts:14947](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14947) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15643](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15647](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15647) +Defined in: [gen/types.gen.ts:14951](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14951) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15651](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15651) +Defined in: [gen/types.gen.ts:14955](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14955) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15655](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15655) +Defined in: [gen/types.gen.ts:14959](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14959) Not found. The tenant was not found. @@ -57,7 +57,7 @@ Not found. The tenant was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15659](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15659) +Defined in: [gen/types.gen.ts:14963](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14963) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15664](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15664) +Defined in: [gen/types.gen.ts:14968](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14968) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantResponse.md index 0dec8be0245..1e345cfd5ba 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantResponse.md @@ -11,4 +11,4 @@ mdx: type DeleteTenantResponse = DeleteTenantResponses[keyof DeleteTenantResponses]; ``` -Defined in: [gen/types.gen.ts:15676](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15676) +Defined in: [gen/types.gen.ts:14980](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14980) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantResponses.md index f969306db80..caaccf1ae21 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteTenantResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:15669](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15669) +Defined in: [gen/types.gen.ts:14973](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14973) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15669](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15673](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15673) +Defined in: [gen/types.gen.ts:14977](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14977) The tenant was deleted successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserData.md index 18604100ba4..daab655f03f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserData.md @@ -11,7 +11,7 @@ mdx: type DeleteUserData = object; ``` -Defined in: [gen/types.gen.ts:16546](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16546) +Defined in: [gen/types.gen.ts:15866](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15866) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16546](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16547](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16547) +Defined in: [gen/types.gen.ts:15867](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15867) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16547](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16548](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16548) +Defined in: [gen/types.gen.ts:15868](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15868) #### username @@ -49,7 +49,7 @@ The username of the user to delete. optional query: never; ``` -Defined in: [gen/types.gen.ts:16554](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16554) +Defined in: [gen/types.gen.ts:15874](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15874) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:16554](https://github.com/camunda/orchestration-cl url: "/users/{username}"; ``` -Defined in: [gen/types.gen.ts:16555](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16555) +Defined in: [gen/types.gen.ts:15875](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15875) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserError.md index cf7ad39a03a..d6609f9c074 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserError.md @@ -11,4 +11,4 @@ mdx: type DeleteUserError = DeleteUserErrors[keyof DeleteUserErrors]; ``` -Defined in: [gen/types.gen.ts:16578](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16578) +Defined in: [gen/types.gen.ts:15898](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15898) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserErrors.md index 971c96e183f..4df2b320234 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserErrors.md @@ -11,7 +11,7 @@ mdx: type DeleteUserErrors = object; ``` -Defined in: [gen/types.gen.ts:16558](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16558) +Defined in: [gen/types.gen.ts:15878](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15878) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16558](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16562](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16562) +Defined in: [gen/types.gen.ts:15882](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15882) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16566](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16566) +Defined in: [gen/types.gen.ts:15886](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15886) The user is not found. @@ -45,7 +45,7 @@ The user is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16570](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16570) +Defined in: [gen/types.gen.ts:15890](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15890) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16575](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16575) +Defined in: [gen/types.gen.ts:15895](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15895) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserResponse.md index 9fce624703e..1401ed197db 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserResponse.md @@ -11,4 +11,4 @@ mdx: type DeleteUserResponse = DeleteUserResponses[keyof DeleteUserResponses]; ``` -Defined in: [gen/types.gen.ts:16587](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16587) +Defined in: [gen/types.gen.ts:15907](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15907) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserResponses.md index e3903632d6c..72916984f97 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeleteUserResponses.md @@ -11,7 +11,7 @@ mdx: type DeleteUserResponses = object; ``` -Defined in: [gen/types.gen.ts:16580](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16580) +Defined in: [gen/types.gen.ts:15900](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15900) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16580](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:16584](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16584) +Defined in: [gen/types.gen.ts:15904](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15904) The user was deleted successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentDecisionRequirementsResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentDecisionRequirementsResult.md index 60a71a34e86..84c7879b6ea 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentDecisionRequirementsResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentDecisionRequirementsResult.md @@ -11,70 +11,78 @@ mdx: type DeploymentDecisionRequirementsResult = object; ``` -Defined in: [gen/types.gen.ts:2086](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2086) +Defined in: [gen/types.gen.ts:2162](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2162) Deployed decision requirements. ## Properties -### decisionRequirementsId? +### decisionRequirementsId ```ts -optional decisionRequirementsId: string; +decisionRequirementsId: string; ``` -Defined in: [gen/types.gen.ts:2087](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2087) +Defined in: [gen/types.gen.ts:2166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2166) + +The id of the deployed decision requirements. --- -### decisionRequirementsKey? +### decisionRequirementsKey ```ts -optional decisionRequirementsKey: DecisionRequirementsKey; +decisionRequirementsKey: DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:2099](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2099) +Defined in: [gen/types.gen.ts:2187](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2187) The assigned decision requirements key, which acts as a unique identifier for this decision requirements. --- -### decisionRequirementsName? +### decisionRequirementsName ```ts -optional decisionRequirementsName: string; +decisionRequirementsName: string; ``` -Defined in: [gen/types.gen.ts:2088](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2088) +Defined in: [gen/types.gen.ts:2170](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2170) + +The name of the deployed decision requirements. --- -### resourceName? +### resourceName ```ts -optional resourceName: string; +resourceName: string; ``` -Defined in: [gen/types.gen.ts:2090](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2090) +Defined in: [gen/types.gen.ts:2178](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2178) + +The name of the resource. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2094](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2094) +Defined in: [gen/types.gen.ts:2182](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2182) The tenant ID of the deployed decision requirements. --- -### version? +### version ```ts -optional version: number; +version: number; ``` -Defined in: [gen/types.gen.ts:2089](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2089) +Defined in: [gen/types.gen.ts:2174](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2174) + +The version of the deployed decision requirements. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentDecisionResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentDecisionResult.md index 7cfeb1252de..b0e64f2f7fd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentDecisionResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentDecisionResult.md @@ -11,91 +11,91 @@ mdx: type DeploymentDecisionResult = object; ``` -Defined in: [gen/types.gen.ts:2047](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2047) +Defined in: [gen/types.gen.ts:2123](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2123) A deployed decision. ## Properties -### decisionDefinitionId? +### decisionDefinitionId ```ts -optional decisionDefinitionId: DecisionDefinitionId; +decisionDefinitionId: DecisionDefinitionId; ``` -Defined in: [gen/types.gen.ts:2053](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2053) +Defined in: [gen/types.gen.ts:2129](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2129) The dmn decision ID, as parsed during deployment, together with the version forms a unique identifier for a specific decision. --- -### decisionDefinitionKey? +### decisionDefinitionKey ```ts -optional decisionDefinitionKey: DecisionDefinitionKey; +decisionDefinitionKey: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:2075](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2075) +Defined in: [gen/types.gen.ts:2151](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2151) The assigned decision key, which acts as a unique identifier for this decision. --- -### decisionRequirementsId? +### decisionRequirementsId ```ts -optional decisionRequirementsId: string; +decisionRequirementsId: string; ``` -Defined in: [gen/types.gen.ts:2070](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2070) +Defined in: [gen/types.gen.ts:2146](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2146) The dmn ID of the decision requirements graph that this decision is part of, as parsed during deployment. --- -### decisionRequirementsKey? +### decisionRequirementsKey ```ts -optional decisionRequirementsKey: DecisionRequirementsKey; +decisionRequirementsKey: DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:2080](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2080) +Defined in: [gen/types.gen.ts:2156](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2156) The assigned key of the decision requirements graph that this decision is part of. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:2061](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2061) +Defined in: [gen/types.gen.ts:2137](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2137) The DMN name of the decision, as parsed during deployment. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2065](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2065) +Defined in: [gen/types.gen.ts:2141](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2141) The tenant ID of the deployed decision. --- -### version? +### version ```ts -optional version: number; +version: number; ``` -Defined in: [gen/types.gen.ts:2057](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2057) +Defined in: [gen/types.gen.ts:2133](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2133) The assigned decision version. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentFormResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentFormResult.md index 2c777613ace..4bda5524d11 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentFormResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentFormResult.md @@ -11,61 +11,65 @@ mdx: type DeploymentFormResult = object; ``` -Defined in: [gen/types.gen.ts:2105](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2105) +Defined in: [gen/types.gen.ts:2193](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2193) A deployed form. ## Properties -### formId? +### formId ```ts -optional formId: FormId; +formId: FormId; ``` -Defined in: [gen/types.gen.ts:2111](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2111) +Defined in: [gen/types.gen.ts:2199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2199) The form ID, as parsed during deployment, together with the version forms a unique identifier for a specific form. --- -### formKey? +### formKey ```ts -optional formKey: FormKey; +formKey: FormKey; ``` -Defined in: [gen/types.gen.ts:2118](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2118) +Defined in: [gen/types.gen.ts:2212](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2212) The assigned key, which acts as a unique identifier for this form. --- -### resourceName? +### resourceName ```ts -optional resourceName: string; +resourceName: string; ``` -Defined in: [gen/types.gen.ts:2113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2113) +Defined in: [gen/types.gen.ts:2207](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2207) + +The name of the resource. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2114](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2114) +Defined in: [gen/types.gen.ts:2208](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2208) --- -### version? +### version ```ts -optional version: number; +version: number; ``` -Defined in: [gen/types.gen.ts:2112](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2112) +Defined in: [gen/types.gen.ts:2203](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2203) + +The version of the deployed form. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKey.md index df04ee37852..e969f44c701 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKey.md @@ -11,6 +11,6 @@ mdx: type DeploymentKey = CamundaKey<"DeploymentKey">; ``` -Defined in: [gen/types.gen.ts:2196](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2196) +Defined in: [gen/types.gen.ts:2299](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2299) Key for a deployment. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKeyExactMatch.md index f5cc00348b4..36c9bc5d2cf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type DeploymentKeyExactMatch = DeploymentKey; ``` -Defined in: [gen/types.gen.ts:7479](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7479) +Defined in: [gen/types.gen.ts:8311](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8311) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKeyFilterProperty.md index 1f781508dbd..3895c1d4771 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentKeyFilterProperty.md @@ -13,6 +13,6 @@ type DeploymentKeyFilterProperty = | AdvancedDeploymentKeyFilter; ``` -Defined in: [gen/types.gen.ts:2206](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2206) +Defined in: [gen/types.gen.ts:2309](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2309) DeploymentKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentMetadataResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentMetadataResult.md index 98039a3143f..b3ad70d507e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentMetadataResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentMetadataResult.md @@ -11,54 +11,66 @@ mdx: type DeploymentMetadataResult = object; ``` -Defined in: [gen/types.gen.ts:2008](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2008) +Defined in: [gen/types.gen.ts:2069](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2069) ## Properties -### decisionDefinition? +### decisionDefinition ```ts -optional decisionDefinition: DeploymentDecisionResult; +decisionDefinition: DeploymentDecisionResult | null; ``` -Defined in: [gen/types.gen.ts:2010](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2010) +Defined in: [gen/types.gen.ts:2077](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2077) + +Deployed decision. --- -### decisionRequirements? +### decisionRequirements ```ts -optional decisionRequirements: DeploymentDecisionRequirementsResult; +decisionRequirements: + | DeploymentDecisionRequirementsResult + | null; ``` -Defined in: [gen/types.gen.ts:2011](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2011) +Defined in: [gen/types.gen.ts:2081](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2081) + +Deployed decision requirement definition. --- -### form? +### form ```ts -optional form: DeploymentFormResult; +form: DeploymentFormResult | null; ``` -Defined in: [gen/types.gen.ts:2012](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2012) +Defined in: [gen/types.gen.ts:2085](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2085) + +Deployed form. --- -### processDefinition? +### processDefinition ```ts -optional processDefinition: DeploymentProcessResult; +processDefinition: DeploymentProcessResult | null; ``` -Defined in: [gen/types.gen.ts:2009](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2009) +Defined in: [gen/types.gen.ts:2073](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2073) + +Deployed process. --- -### resource? +### resource ```ts -optional resource: DeploymentResourceResult; +resource: DeploymentResourceResult | null; ``` -Defined in: [gen/types.gen.ts:2013](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2013) +Defined in: [gen/types.gen.ts:2089](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2089) + +Deployed resource. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentProcessResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentProcessResult.md index b04853b3109..2835a35f334 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentProcessResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentProcessResult.md @@ -11,7 +11,7 @@ mdx: type DeploymentProcessResult = object; ``` -Defined in: [gen/types.gen.ts:2019](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2019) +Defined in: [gen/types.gen.ts:2095](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2095) A deployed process. @@ -23,7 +23,7 @@ A deployed process. processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:2025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2025) +Defined in: [gen/types.gen.ts:2101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2101) The bpmn process ID, as parsed during deployment, together with the version forms a unique identifier for a specific process definition. @@ -36,7 +36,7 @@ unique identifier for a specific process definition. processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:2041](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2041) +Defined in: [gen/types.gen.ts:2117](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2117) The assigned key, which acts as a unique identifier for this process. @@ -48,7 +48,7 @@ The assigned key, which acts as a unique identifier for this process. processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:2029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2029) +Defined in: [gen/types.gen.ts:2105](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2105) The assigned process version. @@ -60,7 +60,7 @@ The assigned process version. resourceName: string; ``` -Defined in: [gen/types.gen.ts:2033](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2033) +Defined in: [gen/types.gen.ts:2109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2109) The resource name from which this process was parsed. @@ -72,6 +72,6 @@ The resource name from which this process was parsed. tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2037](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2037) +Defined in: [gen/types.gen.ts:2113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2113) The tenant ID of the deployed process. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentResourceResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentResourceResult.md index 945615bf2f1..11c9bd504ae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentResourceResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentResourceResult.md @@ -11,58 +11,64 @@ mdx: type DeploymentResourceResult = object; ``` -Defined in: [gen/types.gen.ts:2124](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2124) +Defined in: [gen/types.gen.ts:2218](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2218) A deployed Resource. ## Properties -### resourceId? +### resourceId ```ts -optional resourceId: string; +resourceId: string; ``` -Defined in: [gen/types.gen.ts:2125](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2125) +Defined in: [gen/types.gen.ts:2222](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2222) + +The resource id of the deployed resource. --- -### resourceKey? +### resourceKey ```ts -optional resourceKey: ResourceKey; +resourceKey: ResourceKey; ``` -Defined in: [gen/types.gen.ts:2132](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2132) +Defined in: [gen/types.gen.ts:2235](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2235) The assigned key, which acts as a unique identifier for this Resource. --- -### resourceName? +### resourceName ```ts -optional resourceName: string; +resourceName: string; ``` -Defined in: [gen/types.gen.ts:2126](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2126) +Defined in: [gen/types.gen.ts:2226](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2226) + +The name of the deployed resource. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2128](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2128) +Defined in: [gen/types.gen.ts:2231](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2231) --- -### version? +### version ```ts -optional version: number; +version: number; ``` -Defined in: [gen/types.gen.ts:2127](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2127) +Defined in: [gen/types.gen.ts:2230](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2230) + +The description of the deployed resource. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentResult.md index ae8896f3fae..1118a68b685 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DeploymentResult.md @@ -11,7 +11,7 @@ mdx: type DeploymentResult = object; ``` -Defined in: [gen/types.gen.ts:1993](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1993) +Defined in: [gen/types.gen.ts:2054](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2054) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:1993](https://github.com/camunda/orchestration-clu deploymentKey: DeploymentKey; ``` -Defined in: [gen/types.gen.ts:1997](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1997) +Defined in: [gen/types.gen.ts:2058](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2058) The unique key identifying the deployment. @@ -33,7 +33,7 @@ The unique key identifying the deployment. deployments: DeploymentMetadataResult[]; ``` -Defined in: [gen/types.gen.ts:2005](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2005) +Defined in: [gen/types.gen.ts:2066](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2066) Items deployed by the request. @@ -45,6 +45,6 @@ Items deployed by the request. tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2001](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2001) +Defined in: [gen/types.gen.ts:2062](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2062) The tenant ID associated with the deployment. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DirectAncestorKeyInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DirectAncestorKeyInstruction.md index 3142732cbc8..41a40f8f1d5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DirectAncestorKeyInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DirectAncestorKeyInstruction.md @@ -11,7 +11,7 @@ mdx: type DirectAncestorKeyInstruction = object; ``` -Defined in: [gen/types.gen.ts:6091](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6091) +Defined in: [gen/types.gen.ts:6804](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6804) Provides a concrete key to use as ancestor scope for the created element instance. @@ -20,10 +20,10 @@ Provides a concrete key to use as ancestor scope for the created element instanc ### ancestorElementInstanceKey ```ts -ancestorElementInstanceKey: string | ElementInstanceKey; +ancestorElementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:6103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6103) +Defined in: [gen/types.gen.ts:6816](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6816) 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 @@ -38,6 +38,6 @@ specifically with this property by providing its key. ancestorScopeType: string; ``` -Defined in: [gen/types.gen.ts:6095](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6095) +Defined in: [gen/types.gen.ts:6808](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6808) The type of ancestor scope instruction. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentCreationBatchResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentCreationBatchResponse.md index a7d921861cb..e05f425164c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentCreationBatchResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentCreationBatchResponse.md @@ -11,28 +11,28 @@ mdx: type DocumentCreationBatchResponse = object; ``` -Defined in: [gen/types.gen.ts:2308](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2308) +Defined in: [gen/types.gen.ts:2411](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2411) ## Properties -### createdDocuments? +### createdDocuments ```ts -optional createdDocuments: DocumentReference[]; +createdDocuments: DocumentReference[]; ``` -Defined in: [gen/types.gen.ts:2316](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2316) +Defined in: [gen/types.gen.ts:2419](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2419) Documents that failed creation. --- -### failedDocuments? +### failedDocuments ```ts -optional failedDocuments: DocumentCreationFailureDetail[]; +failedDocuments: DocumentCreationFailureDetail[]; ``` -Defined in: [gen/types.gen.ts:2312](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2312) +Defined in: [gen/types.gen.ts:2415](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2415) Documents that were successfully created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentCreationFailureDetail.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentCreationFailureDetail.md index d00095f16a9..507d2111ca9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentCreationFailureDetail.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentCreationFailureDetail.md @@ -11,52 +11,52 @@ mdx: type DocumentCreationFailureDetail = object; ``` -Defined in: [gen/types.gen.ts:2289](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2289) +Defined in: [gen/types.gen.ts:2392](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2392) ## Properties -### detail? +### detail ```ts -optional detail: string; +detail: string; ``` -Defined in: [gen/types.gen.ts:2305](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2305) +Defined in: [gen/types.gen.ts:2408](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2408) A human-readable explanation specific to this occurrence of the problem. --- -### fileName? +### fileName ```ts -optional fileName: string; +fileName: string; ``` -Defined in: [gen/types.gen.ts:2293](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2293) +Defined in: [gen/types.gen.ts:2396](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2396) The name of the file that failed to upload. --- -### status? +### status ```ts -optional status: number; +status: number; ``` -Defined in: [gen/types.gen.ts:2297](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2297) +Defined in: [gen/types.gen.ts:2400](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2400) The HTTP status code of the failure. --- -### title? +### title ```ts -optional title: string; +title: string; ``` -Defined in: [gen/types.gen.ts:2301](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2301) +Defined in: [gen/types.gen.ts:2404](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2404) A short, human-readable summary of the problem type. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentId.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentId.md index 4b821d29aca..f9f7b467b7a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentId.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentId.md @@ -11,6 +11,6 @@ mdx: type DocumentId = CamundaKey<"DocumentId">; ``` -Defined in: [gen/types.gen.ts:2376](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2376) +Defined in: [gen/types.gen.ts:2515](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2515) Document Id that uniquely identifies a document. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentLink.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentLink.md index 98bdbe39858..2d271c5c26a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentLink.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentLink.md @@ -11,28 +11,28 @@ mdx: type DocumentLink = object; ``` -Defined in: [gen/types.gen.ts:2362](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2362) +Defined in: [gen/types.gen.ts:2501](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2501) ## Properties -### expiresAt? +### expiresAt ```ts -optional expiresAt: string; +expiresAt: string; ``` -Defined in: [gen/types.gen.ts:2370](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2370) +Defined in: [gen/types.gen.ts:2509](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2509) The date and time when the link expires. --- -### url? +### url ```ts -optional url: string; +url: string; ``` -Defined in: [gen/types.gen.ts:2366](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2366) +Defined in: [gen/types.gen.ts:2505](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2505) The link to the document. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentLinkRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentLinkRequest.md index 774a82bb62a..3b9ddc321b3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentLinkRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentLinkRequest.md @@ -11,7 +11,7 @@ mdx: type DocumentLinkRequest = object; ``` -Defined in: [gen/types.gen.ts:2355](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2355) +Defined in: [gen/types.gen.ts:2494](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2494) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:2355](https://github.com/camunda/orchestration-clu optional timeToLive: number; ``` -Defined in: [gen/types.gen.ts:2359](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2359) +Defined in: [gen/types.gen.ts:2498](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2498) The time-to-live of the document link in ms. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentMetadata.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentMetadata.md index 5870b2a035e..12e84736434 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentMetadata.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentMetadata.md @@ -11,7 +11,7 @@ mdx: type DocumentMetadata = object; ``` -Defined in: [gen/types.gen.ts:2322](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2322) +Defined in: [gen/types.gen.ts:2425](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2425) Information about the document. @@ -23,7 +23,7 @@ Information about the document. optional contentType: string; ``` -Defined in: [gen/types.gen.ts:2326](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2326) +Defined in: [gen/types.gen.ts:2429](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2429) The content type of the document. @@ -35,7 +35,7 @@ The content type of the document. optional customProperties: object; ``` -Defined in: [gen/types.gen.ts:2350](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2350) +Defined in: [gen/types.gen.ts:2453](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2453) Custom properties of the document. @@ -53,7 +53,7 @@ Custom properties of the document. optional expiresAt: string; ``` -Defined in: [gen/types.gen.ts:2334](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2334) +Defined in: [gen/types.gen.ts:2437](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2437) The date and time when the document expires. @@ -65,7 +65,7 @@ The date and time when the document expires. optional fileName: string; ``` -Defined in: [gen/types.gen.ts:2330](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2330) +Defined in: [gen/types.gen.ts:2433](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2433) The name of the file. @@ -77,7 +77,7 @@ The name of the file. optional processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:2342](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2342) +Defined in: [gen/types.gen.ts:2445](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2445) The ID of the process definition that created the document. @@ -89,7 +89,7 @@ The ID of the process definition that created the document. optional processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:2346](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2346) +Defined in: [gen/types.gen.ts:2449](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2449) The key of the process instance that created the document. @@ -101,6 +101,6 @@ The key of the process instance that created the document. optional size: number; ``` -Defined in: [gen/types.gen.ts:2338](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2338) +Defined in: [gen/types.gen.ts:2441](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2441) The size of the document in bytes. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentMetadataResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentMetadataResponse.md new file mode 100644 index 00000000000..1b1404c6474 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentMetadataResponse.md @@ -0,0 +1,106 @@ +--- +title: "Type Alias: DocumentMetadataResponse" +sidebar_label: "DocumentMetadataResponse" +mdx: + format: md +--- + +# Type Alias: DocumentMetadataResponse + +```ts +type DocumentMetadataResponse = object; +``` + +Defined in: [gen/types.gen.ts:2461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2461) + +Information about the document that is returned in responses. + +## Properties + +### contentType + +```ts +contentType: string; +``` + +Defined in: [gen/types.gen.ts:2465](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2465) + +The content type of the document. + +--- + +### customProperties + +```ts +customProperties: object; +``` + +Defined in: [gen/types.gen.ts:2489](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2489) + +Custom properties of the document. + +#### Index Signature + +```ts +[key: string]: unknown +``` + +--- + +### expiresAt + +```ts +expiresAt: string | null; +``` + +Defined in: [gen/types.gen.ts:2473](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2473) + +The date and time when the document expires. + +--- + +### fileName + +```ts +fileName: string; +``` + +Defined in: [gen/types.gen.ts:2469](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2469) + +The name of the file. + +--- + +### processDefinitionId + +```ts +processDefinitionId: ProcessDefinitionId | null; +``` + +Defined in: [gen/types.gen.ts:2481](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2481) + +The ID of the process definition that created the document. + +--- + +### processInstanceKey + +```ts +processInstanceKey: ProcessInstanceKey | null; +``` + +Defined in: [gen/types.gen.ts:2485](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2485) + +The key of the process instance that created the document. + +--- + +### size + +```ts +size: number; +``` + +Defined in: [gen/types.gen.ts:2477](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2477) + +The size of the document in bytes. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentReference.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentReference.md index c97c4be7a45..22a0928719b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentReference.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/DocumentReference.md @@ -11,62 +11,62 @@ mdx: type DocumentReference = object; ``` -Defined in: [gen/types.gen.ts:2269](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2269) +Defined in: [gen/types.gen.ts:2372](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2372) ## Properties -### camunda.document.type? +### camunda.document.type ```ts -optional camunda.document.type: "camunda"; +camunda.document.type: "camunda"; ``` -Defined in: [gen/types.gen.ts:2273](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2273) +Defined in: [gen/types.gen.ts:2376](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2376) Document discriminator. Always set to "camunda". --- -### contentHash? +### contentHash ```ts -optional contentHash: string; +contentHash: string | null; ``` -Defined in: [gen/types.gen.ts:2285](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2285) +Defined in: [gen/types.gen.ts:2388](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2388) The hash of the document. --- -### documentId? +### documentId ```ts -optional documentId: DocumentId; +documentId: DocumentId; ``` -Defined in: [gen/types.gen.ts:2281](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2281) +Defined in: [gen/types.gen.ts:2384](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2384) The ID of the document. --- -### metadata? +### metadata ```ts -optional metadata: DocumentMetadata; +metadata: DocumentMetadataResponse; ``` -Defined in: [gen/types.gen.ts:2286](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2286) +Defined in: [gen/types.gen.ts:2389](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2389) --- -### storeId? +### storeId ```ts -optional storeId: string; +storeId: string; ``` -Defined in: [gen/types.gen.ts:2277](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2277) +Defined in: [gen/types.gen.ts:2380](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2380) The ID of the document store. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/Either.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/Either.md index ad7bfe404be..a06af3f946a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/Either.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/Either.md @@ -11,7 +11,7 @@ mdx: type Either = Left | Right; ``` -Defined in: [fp-ts.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/fp-ts.ts#L11) +Defined in: [fp-ts.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/fp-ts.ts#L11) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementId.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementId.md index b64c6bb6a61..fab053f3f21 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementId.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementId.md @@ -11,6 +11,6 @@ mdx: type ElementId = CamundaKey<"ElementId">; ``` -Defined in: [gen/types.gen.ts:2967](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2967) +Defined in: [gen/types.gen.ts:3314](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3314) The model-defined id of an element. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceFilter.md index 3b87a0ac399..1cf8acfc3f7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceFilter.md @@ -11,7 +11,7 @@ mdx: type ElementInstanceFilter = object; ``` -Defined in: [gen/types.gen.ts:2403](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2403) +Defined in: [gen/types.gen.ts:2542](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2542) Element instance filter. @@ -23,7 +23,7 @@ Element instance filter. optional elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:2419](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2419) +Defined in: [gen/types.gen.ts:2558](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2558) The element ID for this element instance. @@ -35,7 +35,7 @@ The element ID for this element instance. optional elementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:2433](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2433) +Defined in: [gen/types.gen.ts:2572](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2572) The assigned key, which acts as a unique identifier for this element instance. @@ -49,7 +49,7 @@ optional elementInstanceScopeKey: | ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:2458](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2458) +Defined in: [gen/types.gen.ts:2597](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2597) 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. @@ -61,7 +61,7 @@ The scope key of this element instance. If provided with a process instance key optional elementName: string; ``` -Defined in: [gen/types.gen.ts:2424](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2424) +Defined in: [gen/types.gen.ts:2563](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2563) 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. @@ -73,7 +73,7 @@ The element name. This only works for data created with 8.8 and onwards. Instanc optional endDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:2453](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2453) +Defined in: [gen/types.gen.ts:2592](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2592) The end date of this element instance. @@ -85,7 +85,7 @@ The end date of this element instance. optional hasIncident: boolean; ``` -Defined in: [gen/types.gen.ts:2428](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2428) +Defined in: [gen/types.gen.ts:2567](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2567) Shows whether this element instance has an incident related to. @@ -97,7 +97,7 @@ Shows whether this element instance has an incident related to. optional incidentKey: IncidentKey; ``` -Defined in: [gen/types.gen.ts:2445](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2445) +Defined in: [gen/types.gen.ts:2584](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2584) The key of incident if field incident is true. @@ -109,7 +109,7 @@ The key of incident if field incident is true. optional processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:2407](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2407) +Defined in: [gen/types.gen.ts:2546](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2546) The process definition ID associated to this element instance. @@ -121,7 +121,7 @@ The process definition ID associated to this element instance. optional processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:2441](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2441) +Defined in: [gen/types.gen.ts:2580](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2580) The process definition key associated to this element instance. @@ -133,7 +133,7 @@ The process definition key associated to this element instance. optional processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:2437](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2437) +Defined in: [gen/types.gen.ts:2576](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2576) The process instance key associated to this element instance. @@ -145,7 +145,7 @@ The process instance key associated to this element instance. optional startDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:2449](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2449) +Defined in: [gen/types.gen.ts:2588](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2588) The start date of this element instance. @@ -157,7 +157,7 @@ The start date of this element instance. optional state: ElementInstanceStateFilterProperty; ``` -Defined in: [gen/types.gen.ts:2411](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2411) +Defined in: [gen/types.gen.ts:2550](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2550) State of element instance as defined set of values. @@ -169,7 +169,7 @@ State of element instance as defined set of values. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2429](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2429) +Defined in: [gen/types.gen.ts:2568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2568) --- @@ -206,6 +206,6 @@ optional type: | "UNKNOWN"; ``` -Defined in: [gen/types.gen.ts:2415](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2415) +Defined in: [gen/types.gen.ts:2554](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2554) Type of element as defined set of values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKey.md index c976c4613a1..855777f53db 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKey.md @@ -11,6 +11,6 @@ mdx: type ElementInstanceKey = CamundaKey<"ElementInstanceKey">; ``` -Defined in: [gen/types.gen.ts:4029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4029) +Defined in: [gen/types.gen.ts:4666](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4666) System-generated key for a element instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKeyExactMatch.md index 0b811aa57c5..f38d5b31716 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type ElementInstanceKeyExactMatch = ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:7549](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7549) +Defined in: [gen/types.gen.ts:8395](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8395) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKeyFilterProperty.md index 9c9155b0fec..b2937c682e9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceKeyFilterProperty.md @@ -13,6 +13,6 @@ type ElementInstanceKeyFilterProperty = | AdvancedElementInstanceKeyFilter; ``` -Defined in: [gen/types.gen.ts:4172](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4172) +Defined in: [gen/types.gen.ts:4811](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4811) ElementInstanceKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceResult.md index 51ec8c55f4e..039b265a593 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceResult.md @@ -11,7 +11,7 @@ mdx: type ElementInstanceResult = object; ``` -Defined in: [gen/types.gen.ts:2498](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2498) +Defined in: [gen/types.gen.ts:2637](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2637) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2498](https://github.com/camunda/orchestration-clu elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:2514](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2514) +Defined in: [gen/types.gen.ts:2653](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2653) The element ID for this element instance. @@ -33,7 +33,7 @@ The element ID for this element instance. elementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:2538](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2538) +Defined in: [gen/types.gen.ts:2677](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2677) The assigned key, which acts as a unique identifier for this element instance. @@ -45,19 +45,19 @@ The assigned key, which acts as a unique identifier for this element instance. elementName: string; ``` -Defined in: [gen/types.gen.ts:2518](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2518) +Defined in: [gen/types.gen.ts:2657](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2657) The element name for this element instance. --- -### endDate? +### endDate ```ts -optional endDate: string; +endDate: string | null; ``` -Defined in: [gen/types.gen.ts:2510](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2510) +Defined in: [gen/types.gen.ts:2649](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2649) Date when element instance finished. @@ -69,19 +69,19 @@ Date when element instance finished. hasIncident: boolean; ``` -Defined in: [gen/types.gen.ts:2530](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2530) +Defined in: [gen/types.gen.ts:2669](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2669) Shows whether this element instance has an incident. If true also an incidentKey is provided. --- -### incidentKey? +### incidentKey ```ts -optional incidentKey: IncidentKey; +incidentKey: IncidentKey | null; ``` -Defined in: [gen/types.gen.ts:2551](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2551) +Defined in: [gen/types.gen.ts:2696](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2696) Incident key associated with this element instance. @@ -93,7 +93,7 @@ Incident key associated with this element instance. processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:2502](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2502) +Defined in: [gen/types.gen.ts:2641](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2641) The process definition ID associated to this element instance. @@ -105,7 +105,7 @@ The process definition ID associated to this element instance. processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:2547](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2547) +Defined in: [gen/types.gen.ts:2692](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2692) The process definition key associated to this element instance. @@ -117,19 +117,23 @@ The process definition key associated to this element instance. processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:2542](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2542) +Defined in: [gen/types.gen.ts:2681](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2681) The process instance key associated to this element instance. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:2543](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2543) +Defined in: [gen/types.gen.ts:2688](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2688) + +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. --- @@ -139,7 +143,7 @@ Defined in: [gen/types.gen.ts:2543](https://github.com/camunda/orchestration-clu startDate: string; ``` -Defined in: [gen/types.gen.ts:2506](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2506) +Defined in: [gen/types.gen.ts:2645](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2645) Date when element instance started. @@ -151,7 +155,7 @@ Date when element instance started. state: ElementInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:2526](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2526) +Defined in: [gen/types.gen.ts:2665](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2665) State of element instance as defined set of values. @@ -163,7 +167,7 @@ State of element instance as defined set of values. tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2534](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2534) +Defined in: [gen/types.gen.ts:2673](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2673) The tenant ID of the incident. @@ -202,6 +206,6 @@ type: | "UNKNOWN"; ``` -Defined in: [gen/types.gen.ts:2522](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2522) +Defined in: [gen/types.gen.ts:2661](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2661) Type of element as defined set of values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQuery.md index 515f7192a0d..d58279d84e7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQuery.md @@ -11,7 +11,7 @@ mdx: type ElementInstanceSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:2389](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2389) +Defined in: [gen/types.gen.ts:2528](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2528) Element instance search request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQueryResult.md index 7ed11968587..3f0210f5e5f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQueryResult.md @@ -11,14 +11,14 @@ mdx: type ElementInstanceSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:2491](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2491) +Defined in: [gen/types.gen.ts:2630](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2630) ## Type Declaration -### items? +### items ```ts -optional items: ElementInstanceResult[]; +items: ElementInstanceResult[]; ``` The matching element instances. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQuerySortRequest.md index e816f36378c..929074df75c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type ElementInstanceSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:2378](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2378) +Defined in: [gen/types.gen.ts:2517](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2517) ## Properties @@ -33,7 +33,7 @@ field: | "tenantId"; ``` -Defined in: [gen/types.gen.ts:2382](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2382) +Defined in: [gen/types.gen.ts:2521](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2521) The field to sort by. @@ -45,4 +45,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:2383](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2383) +Defined in: [gen/types.gen.ts:2522](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2522) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateEnum.md index d64111e7e80..26bcf4b69b7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateEnum.md @@ -11,6 +11,6 @@ mdx: type ElementInstanceStateEnum = "ACTIVE" | "COMPLETED" | "TERMINATED"; ``` -Defined in: [gen/types.gen.ts:2557](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2557) +Defined in: [gen/types.gen.ts:2702](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2702) Element states diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateExactMatch.md index b65f9a9038c..6eb38d4f872 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateExactMatch.md @@ -11,7 +11,7 @@ mdx: type ElementInstanceStateExactMatch = ElementInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:7493](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7493) +Defined in: [gen/types.gen.ts:8325](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8325) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateFilterProperty.md index f0e613bb3c9..20a0248df34 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ElementInstanceStateFilterProperty.md @@ -13,6 +13,6 @@ type ElementInstanceStateFilterProperty = | AdvancedElementInstanceStateFilter; ``` -Defined in: [gen/types.gen.ts:2464](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2464) +Defined in: [gen/types.gen.ts:2603](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2603) ElementInstanceStateEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EndCursor.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EndCursor.md index 17b9e81a58c..e6035182e04 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EndCursor.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EndCursor.md @@ -11,6 +11,6 @@ mdx: type EndCursor = CamundaKey<"EndCursor">; ``` -Defined in: [gen/types.gen.ts:1398](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1398) +Defined in: [gen/types.gen.ts:1429](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1429) The end cursor in a search query result set. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EntityTypeExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EntityTypeExactMatch.md index 6e10213ea9a..2ede13240e6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EntityTypeExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EntityTypeExactMatch.md @@ -11,7 +11,7 @@ mdx: type EntityTypeExactMatch = AuditLogEntityTypeEnum; ``` -Defined in: [gen/types.gen.ts:7409](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7409) +Defined in: [gen/types.gen.ts:8241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8241) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EntityTypeFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EntityTypeFilterProperty.md index 586f6d59808..6a702ab8b8d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EntityTypeFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EntityTypeFilterProperty.md @@ -11,6 +11,6 @@ mdx: type EntityTypeFilterProperty = EntityTypeExactMatch | AdvancedEntityTypeFilter; ``` -Defined in: [gen/types.gen.ts:341](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L341) +Defined in: [gen/types.gen.ts:354](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L354) AuditLogEntityTypeEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalResult.md index d9ff05bc108..f45e2b14772 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalResult.md @@ -11,7 +11,7 @@ mdx: type EvaluateConditionalResult = object; ``` -Defined in: [gen/types.gen.ts:1359](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1359) +Defined in: [gen/types.gen.ts:1390](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1390) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:1359](https://github.com/camunda/orchestration-clu conditionalEvaluationKey: ConditionalEvaluationKey; ``` -Defined in: [gen/types.gen.ts:1363](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1363) +Defined in: [gen/types.gen.ts:1394](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1394) The unique key of the conditional evaluation operation. @@ -33,7 +33,7 @@ The unique key of the conditional evaluation operation. processInstances: ProcessInstanceReference[]; ``` -Defined in: [gen/types.gen.ts:1371](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1371) +Defined in: [gen/types.gen.ts:1402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1402) List of process instances created. If no root-level conditional start events evaluated to true, the list will be empty. @@ -45,6 +45,6 @@ List of process instances created. If no root-level conditional start events eva tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1367](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1367) +Defined in: [gen/types.gen.ts:1398](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1398) The tenant ID of the conditional evaluation operation. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsData.md index 4658d078fc7..29064f5902f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsData.md @@ -11,7 +11,7 @@ mdx: type EvaluateConditionalsData = object; ``` -Defined in: [gen/types.gen.ts:9059](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9059) +Defined in: [gen/types.gen.ts:9516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9516) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9059](https://github.com/camunda/orchestration-clu body: ConditionalEvaluationInstruction; ``` -Defined in: [gen/types.gen.ts:9060](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9060) +Defined in: [gen/types.gen.ts:9517](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9517) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9060](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:9061](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9061) +Defined in: [gen/types.gen.ts:9518](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9518) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:9061](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:9062](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9062) +Defined in: [gen/types.gen.ts:9519](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9519) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:9062](https://github.com/camunda/orchestration-clu url: "/conditionals/evaluation"; ``` -Defined in: [gen/types.gen.ts:9063](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9063) +Defined in: [gen/types.gen.ts:9520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9520) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsError.md index 4aacdef5c5c..6a10a7d0d09 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsError.md @@ -12,4 +12,4 @@ type EvaluateConditionalsError = EvaluateConditionalsErrors[keyof EvaluateConditionalsErrors]; ``` -Defined in: [gen/types.gen.ts:9093](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9093) +Defined in: [gen/types.gen.ts:9550](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9550) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsErrors.md index c4e9d6f703d..cbb5ee4291e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsErrors.md @@ -11,7 +11,7 @@ mdx: type EvaluateConditionalsErrors = object; ``` -Defined in: [gen/types.gen.ts:9066](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9066) +Defined in: [gen/types.gen.ts:9523](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9523) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9066](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9070](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9070) +Defined in: [gen/types.gen.ts:9527](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9527) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9077](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9077) +Defined in: [gen/types.gen.ts:9534](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9534) 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 @@ -47,7 +47,7 @@ to start process instances for at least one of the matched process definitions. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9081](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9081) +Defined in: [gen/types.gen.ts:9538](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9538) The process definition was not found for the given processDefinitionKey. @@ -59,7 +59,7 @@ The process definition was not found for the given processDefinitionKey. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9085](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9085) +Defined in: [gen/types.gen.ts:9542](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9542) An internal error occurred while processing the request. @@ -71,6 +71,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9090](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9090) +Defined in: [gen/types.gen.ts:9547](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9547) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsResponse.md index be74788c703..650e3dea2d5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsResponse.md @@ -12,4 +12,4 @@ type EvaluateConditionalsResponse = EvaluateConditionalsResponses[keyof EvaluateConditionalsResponses]; ``` -Defined in: [gen/types.gen.ts:9102](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9102) +Defined in: [gen/types.gen.ts:9559](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9559) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsResponses.md index a960a90893d..fd14e055664 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateConditionalsResponses.md @@ -11,7 +11,7 @@ mdx: type EvaluateConditionalsResponses = object; ``` -Defined in: [gen/types.gen.ts:9095](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9095) +Defined in: [gen/types.gen.ts:9552](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9552) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9095](https://github.com/camunda/orchestration-clu 200: EvaluateConditionalResult; ``` -Defined in: [gen/types.gen.ts:9099](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9099) +Defined in: [gen/types.gen.ts:9556](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9556) Successfully evaluated root-level conditional start events. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionData.md index cf989007bc7..2402418019f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionData.md @@ -11,7 +11,7 @@ mdx: type EvaluateDecisionData = object; ``` -Defined in: [gen/types.gen.ts:9196](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9196) +Defined in: [gen/types.gen.ts:9598](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9598) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9196](https://github.com/camunda/orchestration-clu body: DecisionEvaluationInstruction; ``` -Defined in: [gen/types.gen.ts:9197](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9197) +Defined in: [gen/types.gen.ts:9599](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9599) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9197](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:9198](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9198) +Defined in: [gen/types.gen.ts:9600](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9600) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:9198](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:9199](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9199) +Defined in: [gen/types.gen.ts:9601](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9601) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:9199](https://github.com/camunda/orchestration-clu url: "/decision-definitions/evaluation"; ``` -Defined in: [gen/types.gen.ts:9200](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9200) +Defined in: [gen/types.gen.ts:9602](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9602) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionError.md index 21729db5c89..24593652feb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionError.md @@ -12,4 +12,4 @@ type EvaluateDecisionError = EvaluateDecisionErrors[keyof EvaluateDecisionErrors]; ``` -Defined in: [gen/types.gen.ts:9223](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9223) +Defined in: [gen/types.gen.ts:9625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9625) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionErrors.md index 08a9e882d9c..1452f0b256f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionErrors.md @@ -11,7 +11,7 @@ mdx: type EvaluateDecisionErrors = object; ``` -Defined in: [gen/types.gen.ts:9203](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9203) +Defined in: [gen/types.gen.ts:9605](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9605) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9203](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9207](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9207) +Defined in: [gen/types.gen.ts:9609](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9609) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9211](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9211) +Defined in: [gen/types.gen.ts:9613](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9613) The decision is not found. @@ -45,7 +45,7 @@ The decision is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9215](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9215) +Defined in: [gen/types.gen.ts:9617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9617) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9220](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9220) +Defined in: [gen/types.gen.ts:9622](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9622) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResponse.md index 690a3b3b029..64e58fa4554 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResponse.md @@ -12,4 +12,4 @@ type EvaluateDecisionResponse = EvaluateDecisionResponses[keyof EvaluateDecisionResponses]; ``` -Defined in: [gen/types.gen.ts:9232](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9232) +Defined in: [gen/types.gen.ts:9634](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9634) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResponses.md index 15544357e77..1c718c7b050 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResponses.md @@ -11,7 +11,7 @@ mdx: type EvaluateDecisionResponses = object; ``` -Defined in: [gen/types.gen.ts:9225](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9225) +Defined in: [gen/types.gen.ts:9627](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9627) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9225](https://github.com/camunda/orchestration-clu 200: EvaluateDecisionResult; ``` -Defined in: [gen/types.gen.ts:9229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9229) +Defined in: [gen/types.gen.ts:9631](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9631) The decision was evaluated. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResult.md index 9c68ae3e286..437a3ffd28d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateDecisionResult.md @@ -11,7 +11,7 @@ mdx: type EvaluateDecisionResult = object; ``` -Defined in: [gen/types.gen.ts:1556](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1556) +Defined in: [gen/types.gen.ts:1587](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1587) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:1556](https://github.com/camunda/orchestration-clu decisionDefinitionId: DecisionDefinitionId; ``` -Defined in: [gen/types.gen.ts:1560](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1560) +Defined in: [gen/types.gen.ts:1591](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1591) The ID of the decision which was evaluated. @@ -33,7 +33,7 @@ The ID of the decision which was evaluated. decisionDefinitionKey: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1593](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1593) +Defined in: [gen/types.gen.ts:1595](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1595) The unique key identifying the decision which was evaluated. @@ -45,7 +45,7 @@ The unique key identifying the decision which was evaluated. decisionDefinitionName: string; ``` -Defined in: [gen/types.gen.ts:1564](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1564) +Defined in: [gen/types.gen.ts:1599](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1599) The name of the decision which was evaluated. @@ -57,7 +57,7 @@ The name of the decision which was evaluated. decisionDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:1568](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1568) +Defined in: [gen/types.gen.ts:1603](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1603) The version of the decision which was evaluated. @@ -69,19 +69,19 @@ The version of the decision which was evaluated. decisionEvaluationKey: DecisionEvaluationKey; ``` -Defined in: [gen/types.gen.ts:1607](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1607) +Defined in: [gen/types.gen.ts:1607](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1607) The unique key identifying this decision evaluation. --- -### ~~decisionInstanceKey?~~ +### ~~decisionInstanceKey~~ ```ts -optional decisionInstanceKey: DecisionInstanceKey; +decisionInstanceKey: DecisionInstanceKey; ``` -Defined in: [gen/types.gen.ts:1603](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1603) +Defined in: [gen/types.gen.ts:1613](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1613) Deprecated, please refer to `decisionEvaluationKey`. @@ -95,7 +95,7 @@ Deprecated, please refer to `decisionEvaluationKey`. decisionRequirementsId: string; ``` -Defined in: [gen/types.gen.ts:1572](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1572) +Defined in: [gen/types.gen.ts:1617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1617) The ID of the decision requirements graph that the decision which was evaluated is part of. @@ -107,7 +107,7 @@ The ID of the decision requirements graph that the decision which was evaluated decisionRequirementsKey: DecisionRequirementsKey; ``` -Defined in: [gen/types.gen.ts:1597](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1597) +Defined in: [gen/types.gen.ts:1621](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1621) The unique key identifying the decision requirements graph that the decision which was evaluated is part of. @@ -119,7 +119,7 @@ The unique key identifying the decision requirements graph that the decision whi evaluatedDecisions: EvaluatedDecisionResult[]; ``` -Defined in: [gen/types.gen.ts:1611](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1611) +Defined in: [gen/types.gen.ts:1625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1625) Decisions that were evaluated within the requested decision evaluation. @@ -128,10 +128,10 @@ Decisions that were evaluated within the requested decision evaluation. ### failedDecisionDefinitionId ```ts -failedDecisionDefinitionId: DecisionDefinitionId; +failedDecisionDefinitionId: DecisionDefinitionId | null; ``` -Defined in: [gen/types.gen.ts:1581](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1581) +Defined in: [gen/types.gen.ts:1629](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1629) The ID of the decision which failed during evaluation. @@ -140,10 +140,10 @@ The ID of the decision which failed during evaluation. ### failureMessage ```ts -failureMessage: string; +failureMessage: string | null; ``` -Defined in: [gen/types.gen.ts:1585](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1585) +Defined in: [gen/types.gen.ts:1633](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1633) Message describing why the decision which was evaluated failed. @@ -155,7 +155,7 @@ Message describing why the decision which was evaluated failed. output: string; ``` -Defined in: [gen/types.gen.ts:1577](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1577) +Defined in: [gen/types.gen.ts:1638](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1638) JSON document that will instantiate the result of the decision which was evaluated. @@ -167,6 +167,6 @@ JSON document that will instantiate the result of the decision which was evaluat tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1589](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1589) +Defined in: [gen/types.gen.ts:1642](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1642) The tenant ID of the evaluated decision. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionData.md index d4a51cab4ec..c0a1133f97f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionData.md @@ -11,7 +11,7 @@ mdx: type EvaluateExpressionData = object; ``` -Defined in: [gen/types.gen.ts:10612](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10612) +Defined in: [gen/types.gen.ts:10553](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10553) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10612](https://github.com/camunda/orchestration-cl body: ExpressionEvaluationRequest; ``` -Defined in: [gen/types.gen.ts:10613](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10613) +Defined in: [gen/types.gen.ts:10554](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10554) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10613](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:10614](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10614) +Defined in: [gen/types.gen.ts:10555](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10555) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:10614](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:10615](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10615) +Defined in: [gen/types.gen.ts:10556](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10556) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:10615](https://github.com/camunda/orchestration-cl url: "/expression/evaluation"; ``` -Defined in: [gen/types.gen.ts:10616](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10616) +Defined in: [gen/types.gen.ts:10557](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10557) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionError.md index 90eab89deb7..30cda34a264 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionError.md @@ -12,4 +12,4 @@ type EvaluateExpressionError = EvaluateExpressionErrors[keyof EvaluateExpressionErrors]; ``` -Defined in: [gen/types.gen.ts:10638](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10638) +Defined in: [gen/types.gen.ts:10579](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10579) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionErrors.md index e280d2412f6..99b03c6bf3e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionErrors.md @@ -11,7 +11,7 @@ mdx: type EvaluateExpressionErrors = object; ``` -Defined in: [gen/types.gen.ts:10619](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10619) +Defined in: [gen/types.gen.ts:10560](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10560) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10619](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10623](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10623) +Defined in: [gen/types.gen.ts:10564](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10564) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10627](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10627) +Defined in: [gen/types.gen.ts:10568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10568) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10631](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10631) +Defined in: [gen/types.gen.ts:10572](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10572) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10635](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10635) +Defined in: [gen/types.gen.ts:10576](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10576) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionResponse.md index 280044f5cdc..fa11681b5f1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionResponse.md @@ -12,4 +12,4 @@ type EvaluateExpressionResponse = EvaluateExpressionResponses[keyof EvaluateExpressionResponses]; ``` -Defined in: [gen/types.gen.ts:10647](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10647) +Defined in: [gen/types.gen.ts:10588](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10588) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionResponses.md index ed3fd73cb1d..ac6b64e251b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluateExpressionResponses.md @@ -11,7 +11,7 @@ mdx: type EvaluateExpressionResponses = object; ``` -Defined in: [gen/types.gen.ts:10640](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10640) +Defined in: [gen/types.gen.ts:10581](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10581) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10640](https://github.com/camunda/orchestration-cl 200: ExpressionEvaluationResult; ``` -Defined in: [gen/types.gen.ts:10644](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10644) +Defined in: [gen/types.gen.ts:10585](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10585) Expression evaluated successfully diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionInputItem.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionInputItem.md index b9d0bde1dc3..73e866b754d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionInputItem.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionInputItem.md @@ -11,36 +11,42 @@ mdx: type EvaluatedDecisionInputItem = object; ``` -Defined in: [gen/types.gen.ts:1834](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1834) +Defined in: [gen/types.gen.ts:1871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1871) A decision input that was evaluated within this decision evaluation. ## Properties -### inputId? +### inputId ```ts -optional inputId: string; +inputId: string; ``` -Defined in: [gen/types.gen.ts:1835](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1835) +Defined in: [gen/types.gen.ts:1875](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1875) + +The identifier of the decision input. --- -### inputName? +### inputName ```ts -optional inputName: string; +inputName: string; ``` -Defined in: [gen/types.gen.ts:1836](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1836) +Defined in: [gen/types.gen.ts:1879](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1879) + +The name of the decision input. --- -### inputValue? +### inputValue ```ts -optional inputValue: string; +inputValue: string; ``` -Defined in: [gen/types.gen.ts:1837](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1837) +Defined in: [gen/types.gen.ts:1883](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1883) + +The value of the decision input. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionOutputItem.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionOutputItem.md index f756cafe251..4302447a5b0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionOutputItem.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionOutputItem.md @@ -11,56 +11,66 @@ mdx: type EvaluatedDecisionOutputItem = object; ``` -Defined in: [gen/types.gen.ts:1843](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1843) +Defined in: [gen/types.gen.ts:1889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1889) The evaluated decision outputs. ## Properties -### outputId? +### outputId ```ts -optional outputId: string; +outputId: string; ``` -Defined in: [gen/types.gen.ts:1844](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1844) +Defined in: [gen/types.gen.ts:1893](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1893) + +The ID of the evaluated decison output item. --- -### outputName? +### outputName ```ts -optional outputName: string; +outputName: string; ``` -Defined in: [gen/types.gen.ts:1845](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1845) +Defined in: [gen/types.gen.ts:1897](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1897) + +The name of the of the evaluated decison output item. --- -### outputValue? +### outputValue ```ts -optional outputValue: string; +outputValue: string; ``` -Defined in: [gen/types.gen.ts:1846](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1846) +Defined in: [gen/types.gen.ts:1901](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1901) + +The value of the evaluated decison output item. --- -### ruleId? +### ruleId ```ts -optional ruleId: string; +ruleId: string | null; ``` -Defined in: [gen/types.gen.ts:1847](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1847) +Defined in: [gen/types.gen.ts:1905](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1905) + +The ID of the matched rule. --- -### ruleIndex? +### ruleIndex ```ts -optional ruleIndex: number; +ruleIndex: number | null; ``` -Defined in: [gen/types.gen.ts:1848](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1848) +Defined in: [gen/types.gen.ts:1909](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1909) + +The index of the matched rule. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionResult.md index f9130412822..86603232d82 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/EvaluatedDecisionResult.md @@ -11,126 +11,126 @@ mdx: type EvaluatedDecisionResult = object; ``` -Defined in: [gen/types.gen.ts:1617](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1617) +Defined in: [gen/types.gen.ts:1648](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1648) A decision that was evaluated. ## Properties -### decisionDefinitionId? +### decisionDefinitionId ```ts -optional decisionDefinitionId: DecisionDefinitionId; +decisionDefinitionId: DecisionDefinitionId; ``` -Defined in: [gen/types.gen.ts:1621](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1621) +Defined in: [gen/types.gen.ts:1652](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1652) The ID of the decision which was evaluated. --- -### decisionDefinitionKey? +### decisionDefinitionKey ```ts -optional decisionDefinitionKey: DecisionDefinitionKey; +decisionDefinitionKey: DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1654](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1654) +Defined in: [gen/types.gen.ts:1685](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1685) The unique key identifying the decision which was evaluate. --- -### decisionDefinitionName? +### decisionDefinitionName ```ts -optional decisionDefinitionName: string; +decisionDefinitionName: string; ``` -Defined in: [gen/types.gen.ts:1625](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1625) +Defined in: [gen/types.gen.ts:1656](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1656) The name of the decision which was evaluated. --- -### decisionDefinitionType? +### decisionDefinitionType ```ts -optional decisionDefinitionType: string; +decisionDefinitionType: string; ``` -Defined in: [gen/types.gen.ts:1633](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1633) +Defined in: [gen/types.gen.ts:1664](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1664) The type of the decision which was evaluated. --- -### decisionDefinitionVersion? +### decisionDefinitionVersion ```ts -optional decisionDefinitionVersion: number; +decisionDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:1629](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1629) +Defined in: [gen/types.gen.ts:1660](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1660) The version of the decision which was evaluated. --- -### decisionEvaluationInstanceKey? +### decisionEvaluationInstanceKey ```ts -optional decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey; +decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey; ``` -Defined in: [gen/types.gen.ts:1658](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1658) +Defined in: [gen/types.gen.ts:1689](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1689) The unique key identifying this decision evaluation instance. --- -### evaluatedInputs? +### evaluatedInputs ```ts -optional evaluatedInputs: EvaluatedDecisionInputItem[]; +evaluatedInputs: EvaluatedDecisionInputItem[]; ``` -Defined in: [gen/types.gen.ts:1650](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1650) +Defined in: [gen/types.gen.ts:1681](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1681) The decision inputs that were evaluated within this decision evaluation. --- -### matchedRules? +### matchedRules ```ts -optional matchedRules: MatchedDecisionRuleItem[]; +matchedRules: MatchedDecisionRuleItem[]; ``` -Defined in: [gen/types.gen.ts:1646](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1646) +Defined in: [gen/types.gen.ts:1677](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1677) The decision rules that matched within this decision evaluation. --- -### output? +### output ```ts -optional output: string; +output: string; ``` -Defined in: [gen/types.gen.ts:1638](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1638) +Defined in: [gen/types.gen.ts:1669](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1669) JSON document that will instantiate the result of the decision which was evaluated. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:1642](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1642) +Defined in: [gen/types.gen.ts:1673](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1673) The tenant ID of the evaluated decision. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationRequest.md index 34aeca78450..cf2f72ac09e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationRequest.md @@ -11,7 +11,7 @@ mdx: type ExpressionEvaluationRequest = object; ``` -Defined in: [gen/types.gen.ts:2583](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2583) +Defined in: [gen/types.gen.ts:2728](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2728) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2583](https://github.com/camunda/orchestration-clu expression: string; ``` -Defined in: [gen/types.gen.ts:2587](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2587) +Defined in: [gen/types.gen.ts:2732](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2732) The expression to evaluate (e.g., "=x + y") @@ -33,6 +33,22 @@ The expression to evaluate (e.g., "=x + y") optional tenantId: string; ``` -Defined in: [gen/types.gen.ts:2591](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2591) +Defined in: [gen/types.gen.ts:2736](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2736) Required when the expression references tenant-scoped cluster variables + +--- + +### variables? + +```ts +optional variables: + | { +[key: string]: unknown; +} + | null; +``` + +Defined in: [gen/types.gen.ts:2740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2740) + +Optional variables for expression evaluation. These variables are only used for the current evaluation and do not persist beyond it. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationResult.md index b284b899c4f..45dade34df0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationResult.md @@ -11,7 +11,7 @@ mdx: type ExpressionEvaluationResult = object; ``` -Defined in: [gen/types.gen.ts:2594](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2594) +Defined in: [gen/types.gen.ts:2745](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2745) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2594](https://github.com/camunda/orchestration-clu expression: string; ``` -Defined in: [gen/types.gen.ts:2598](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2598) +Defined in: [gen/types.gen.ts:2749](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2749) The evaluated expression @@ -33,7 +33,7 @@ The evaluated expression result: unknown; ``` -Defined in: [gen/types.gen.ts:2602](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2602) +Defined in: [gen/types.gen.ts:2753](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2753) The result value. Its type can vary. @@ -42,9 +42,9 @@ The result value. Its type can vary. ### warnings ```ts -warnings: string[]; +warnings: ExpressionEvaluationWarningItem[]; ``` -Defined in: [gen/types.gen.ts:2606](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2606) +Defined in: [gen/types.gen.ts:2757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2757) List of warnings generated during expression evaluation diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationWarningItem.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationWarningItem.md new file mode 100644 index 00000000000..dcc8acb853c --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ExpressionEvaluationWarningItem.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: ExpressionEvaluationWarningItem" +sidebar_label: "ExpressionEvaluationWarningItem" +mdx: + format: md +--- + +# Type Alias: ExpressionEvaluationWarningItem + +```ts +type ExpressionEvaluationWarningItem = object; +``` + +Defined in: [gen/types.gen.ts:2760](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2760) + +## Properties + +### message + +```ts +message: string; +``` + +Defined in: [gen/types.gen.ts:2764](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2764) + +The warning message diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobData.md index ab4245ec862..43dcabb995c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobData.md @@ -11,7 +11,7 @@ mdx: type FailJobData = object; ``` -Defined in: [gen/types.gen.ts:12083](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12083) +Defined in: [gen/types.gen.ts:12009](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12009) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12083](https://github.com/camunda/orchestration-cl optional body: JobFailRequest; ``` -Defined in: [gen/types.gen.ts:12084](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12084) +Defined in: [gen/types.gen.ts:12010](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12010) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12084](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:12085](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12085) +Defined in: [gen/types.gen.ts:12011](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12011) #### jobKey @@ -49,7 +49,7 @@ The key of the job to fail. optional query: never; ``` -Defined in: [gen/types.gen.ts:12091](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12091) +Defined in: [gen/types.gen.ts:12017](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12017) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:12091](https://github.com/camunda/orchestration-cl url: "/jobs/{jobKey}/failure"; ``` -Defined in: [gen/types.gen.ts:12092](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12092) +Defined in: [gen/types.gen.ts:12018](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12018) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobError.md index 1ee05811e5b..ae8e7518895 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobError.md @@ -11,4 +11,4 @@ mdx: type FailJobError = FailJobErrors[keyof FailJobErrors]; ``` -Defined in: [gen/types.gen.ts:12121](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12121) +Defined in: [gen/types.gen.ts:12047](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12047) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobErrors.md index 6537f3afbfc..db64cf57b00 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobErrors.md @@ -11,7 +11,7 @@ mdx: type FailJobErrors = object; ``` -Defined in: [gen/types.gen.ts:12095](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12095) +Defined in: [gen/types.gen.ts:12021](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12021) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12095](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12099](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12099) +Defined in: [gen/types.gen.ts:12025](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12025) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12104](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12104) +Defined in: [gen/types.gen.ts:12030](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12030) The job with the given jobKey is not found. It was completed by another worker, or the process instance itself was canceled. @@ -45,7 +45,7 @@ The job with the given jobKey is not found. It was completed by another worker, 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12109](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12109) +Defined in: [gen/types.gen.ts:12035](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12035) 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. @@ -57,7 +57,7 @@ The job with the given key is in the wrong state (i.e: not ACTIVATED or ACTIVATA 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12113) +Defined in: [gen/types.gen.ts:12039](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12039) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12118](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12118) +Defined in: [gen/types.gen.ts:12044](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12044) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobResponse.md index c0f304aaec0..7d0a8afce4a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobResponse.md @@ -11,4 +11,4 @@ mdx: type FailJobResponse = FailJobResponses[keyof FailJobResponses]; ``` -Defined in: [gen/types.gen.ts:12130](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12130) +Defined in: [gen/types.gen.ts:12056](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12056) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobResponses.md index d6b2118e485..f2acf2d7d51 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FailJobResponses.md @@ -11,7 +11,7 @@ mdx: type FailJobResponses = object; ``` -Defined in: [gen/types.gen.ts:12123](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12123) +Defined in: [gen/types.gen.ts:12049](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12049) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12123](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:12127](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12127) +Defined in: [gen/types.gen.ts:12053](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12053) The job is failed. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormId.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormId.md index ae428b5064f..fc3a85425a8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormId.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormId.md @@ -11,6 +11,6 @@ mdx: type FormId = CamundaKey<"FormId">; ``` -Defined in: [gen/types.gen.ts:2972](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2972) +Defined in: [gen/types.gen.ts:3319](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3319) The user-defined id for the form diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKey.md index 3f9b90c6c49..1ae357170e5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKey.md @@ -11,6 +11,6 @@ mdx: type FormKey = CamundaKey<"FormKey">; ``` -Defined in: [gen/types.gen.ts:4039](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4039) +Defined in: [gen/types.gen.ts:4676](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4676) System-generated key for a deployed form. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKeyExactMatch.md index b3af13e285b..29c54bb0405 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type FormKeyExactMatch = FormKey; ``` -Defined in: [gen/types.gen.ts:7598](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7598) +Defined in: [gen/types.gen.ts:8444](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8444) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKeyFilterProperty.md index 2f1d983b02f..529391a00ad 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormKeyFilterProperty.md @@ -11,6 +11,6 @@ mdx: type FormKeyFilterProperty = FormKeyExactMatch | AdvancedFormKeyFilter; ``` -Defined in: [gen/types.gen.ts:4403](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4403) +Defined in: [gen/types.gen.ts:5044](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5044) FormKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormResult.md index 4f4f342e196..512c095aee8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/FormResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/FormResult.md @@ -11,70 +11,64 @@ mdx: type FormResult = object; ``` -Defined in: [gen/types.gen.ts:2759](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2759) +Defined in: [gen/types.gen.ts:2917](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2917) ## Properties -### formId? +### formId ```ts -optional formId: FormId; +formId: FormId; ``` -Defined in: [gen/types.gen.ts:2767](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2767) +Defined in: [gen/types.gen.ts:2925](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2925) The user-provided identifier of the form. --- -### formKey? +### formKey ```ts -optional formKey: FormKey; +formKey: FormKey; ``` -Defined in: [gen/types.gen.ts:2781](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2781) +Defined in: [gen/types.gen.ts:2937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2937) The assigned key, which acts as a unique identifier for this form. --- -### schema? +### schema ```ts -optional schema: object; +schema: string; ``` -Defined in: [gen/types.gen.ts:2771](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2771) +Defined in: [gen/types.gen.ts:2929](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2929) -The form content. - -#### Index Signature - -```ts -[key: string]: unknown -``` +The form schema as a JSON document serialized as a string. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2763](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2763) +Defined in: [gen/types.gen.ts:2921](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2921) The tenant ID of the form. --- -### version? +### version ```ts -optional version: number; +version: number; ``` -Defined in: [gen/types.gen.ts:2777](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2777) +Defined in: [gen/types.gen.ts:2933](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2933) The version of the the deployed form. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogData.md index bda5e108992..0d6ec3b4c80 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogData.md @@ -11,7 +11,7 @@ mdx: type GetAuditLogData = object; ``` -Defined in: [gen/types.gen.ts:7794](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7794) +Defined in: [gen/types.gen.ts:8525](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8525) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7794](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:7795](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7795) +Defined in: [gen/types.gen.ts:8526](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8526) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:7795](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:7796](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7796) +Defined in: [gen/types.gen.ts:8527](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8527) #### auditLogKey @@ -49,7 +49,7 @@ The audit log key. optional query: never; ``` -Defined in: [gen/types.gen.ts:7802](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7802) +Defined in: [gen/types.gen.ts:8533](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8533) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:7802](https://github.com/camunda/orchestration-clu url: "/audit-logs/{auditLogKey}"; ``` -Defined in: [gen/types.gen.ts:7803](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7803) +Defined in: [gen/types.gen.ts:8534](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8534) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogError.md index 66b34a65d0b..d3ecb801e1e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogError.md @@ -11,4 +11,4 @@ mdx: type GetAuditLogError = GetAuditLogErrors[keyof GetAuditLogErrors]; ``` -Defined in: [gen/types.gen.ts:7825](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7825) +Defined in: [gen/types.gen.ts:8556](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8556) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogErrors.md index 97d7fee1745..f4ba23eaa41 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogErrors.md @@ -11,7 +11,7 @@ mdx: type GetAuditLogErrors = object; ``` -Defined in: [gen/types.gen.ts:7806](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7806) +Defined in: [gen/types.gen.ts:8537](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8537) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7806](https://github.com/camunda/orchestration-clu 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7810](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7810) +Defined in: [gen/types.gen.ts:8541](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8541) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7814](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7814) +Defined in: [gen/types.gen.ts:8545](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8545) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7818](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7818) +Defined in: [gen/types.gen.ts:8549](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8549) The audit log with the given key was not found. @@ -57,6 +57,6 @@ The audit log with the given key was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7822](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7822) +Defined in: [gen/types.gen.ts:8553](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8553) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogResponse.md index 972d03d7a65..100dfbb7a5f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogResponse.md @@ -11,4 +11,4 @@ mdx: type GetAuditLogResponse = GetAuditLogResponses[keyof GetAuditLogResponses]; ``` -Defined in: [gen/types.gen.ts:7944](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7944) +Defined in: [gen/types.gen.ts:8565](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8565) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogResponses.md index 90999e910d5..40c0d2e5d49 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuditLogResponses.md @@ -11,253 +11,16 @@ mdx: type GetAuditLogResponses = object; ``` -Defined in: [gen/types.gen.ts:7827](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7827) +Defined in: [gen/types.gen.ts:8558](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8558) ## Properties ### 200 ```ts -200: object; +200: AuditLogResult; ``` -Defined in: [gen/types.gen.ts:7831](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7831) +Defined in: [gen/types.gen.ts:8562](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8562) -Audit log item. - -#### actorId? - -```ts -optional actorId: string; -``` - -The ID of the actor who performed the operation. - -#### actorType? - -```ts -optional actorType: AuditLogActorTypeEnum; -``` - -#### annotation? - -```ts -optional annotation: string; -``` - -Additional notes about the operation. - -#### auditLogKey? - -```ts -optional auditLogKey: AuditLogKey; -``` - -The unique key of the audit log entry. - -#### batchOperationKey? - -```ts -optional batchOperationKey: BatchOperationKey; -``` - -Key of the batch operation. - -#### batchOperationType? - -```ts -optional batchOperationType: BatchOperationTypeEnum; -``` - -The type of batch operation performed, if this is part of a batch. - -#### category? - -```ts -optional category: AuditLogCategoryEnum; -``` - -#### decisionDefinitionId? - -```ts -optional decisionDefinitionId: DecisionDefinitionId; -``` - -The decision definition ID. - -#### decisionDefinitionKey? - -```ts -optional decisionDefinitionKey: DecisionDefinitionKey; -``` - -The key of the decision definition. - -#### decisionEvaluationKey? - -```ts -optional decisionEvaluationKey: DecisionEvaluationKey; -``` - -The key of the decision evaluation. - -#### decisionRequirementsId? - -```ts -optional decisionRequirementsId: string; -``` - -The decision requirements ID. - -#### decisionRequirementsKey? - -```ts -optional decisionRequirementsKey: DecisionRequirementsKey; -``` - -The assigned key of the decision requirements. - -#### deploymentKey? - -```ts -optional deploymentKey: DeploymentKey; -``` - -The key of the deployment. - -#### elementInstanceKey? - -```ts -optional elementInstanceKey: ElementInstanceKey; -``` - -The key of the element instance. - -#### entityDescription? - -```ts -optional entityDescription: string; -``` - -Additional description of the entity affected by the operation. -For example, for variable operations, this will contain the variable name. - -#### entityKey? - -```ts -optional entityKey: AuditLogEntityKey; -``` - -#### entityType? - -```ts -optional entityType: AuditLogEntityTypeEnum; -``` - -#### formKey? - -```ts -optional formKey: FormKey; -``` - -The key of the form. - -#### jobKey? - -```ts -optional jobKey: JobKey; -``` - -The key of the job. - -#### operationType? - -```ts -optional operationType: AuditLogOperationTypeEnum; -``` - -#### processDefinitionId? - -```ts -optional processDefinitionId: ProcessDefinitionId; -``` - -The process definition ID. - -#### processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKey; -``` - -The key of the process definition. - -#### processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKey; -``` - -The key of the process instance. - -#### relatedEntityKey? - -```ts -optional relatedEntityKey: AuditLogEntityKey; -``` - -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. - -#### relatedEntityType? - -```ts -optional relatedEntityType: AuditLogEntityTypeEnum; -``` - -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. - -#### resourceKey? - -```ts -optional resourceKey: ResourceKey; -``` - -The system-assigned key for this resource. - -#### result? - -```ts -optional result: AuditLogResultEnum; -``` - -#### rootProcessInstanceKey? - -```ts -optional rootProcessInstanceKey: ProcessInstanceKey; -``` - -#### tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant ID of the audit log. - -#### timestamp? - -```ts -optional timestamp: string; -``` - -The timestamp when the operation occurred. - -#### userTaskKey? - -```ts -optional userTaskKey: UserTaskKey; -``` - -The key of the user task. +The audit log entry is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationData.md index e6aae7c441d..dd7947fb98f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationData.md @@ -11,7 +11,7 @@ mdx: type GetAuthenticationData = object; ``` -Defined in: [gen/types.gen.ts:7946](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7946) +Defined in: [gen/types.gen.ts:8567](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8567) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7946](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:7947](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7947) +Defined in: [gen/types.gen.ts:8568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8568) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:7947](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:7948](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7948) +Defined in: [gen/types.gen.ts:8569](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8569) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:7948](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:7949](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7949) +Defined in: [gen/types.gen.ts:8570](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8570) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:7949](https://github.com/camunda/orchestration-clu url: "/authentication/me"; ``` -Defined in: [gen/types.gen.ts:7950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7950) +Defined in: [gen/types.gen.ts:8571](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8571) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationError.md index 5dd0fce6fe5..fc875202a54 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationError.md @@ -12,4 +12,4 @@ type GetAuthenticationError = GetAuthenticationErrors[keyof GetAuthenticationErrors]; ``` -Defined in: [gen/types.gen.ts:7968](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7968) +Defined in: [gen/types.gen.ts:8589](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8589) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationErrors.md index 9a3e12297f4..59f5ae36cd9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationErrors.md @@ -11,7 +11,7 @@ mdx: type GetAuthenticationErrors = object; ``` -Defined in: [gen/types.gen.ts:7953](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7953) +Defined in: [gen/types.gen.ts:8574](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8574) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7953](https://github.com/camunda/orchestration-clu 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7957) +Defined in: [gen/types.gen.ts:8578](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8578) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7961](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7961) +Defined in: [gen/types.gen.ts:8582](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8582) Forbidden. The request is not allowed. @@ -45,6 +45,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7965](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7965) +Defined in: [gen/types.gen.ts:8586](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8586) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationResponse.md index 886be678bb3..7e52cb76dda 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationResponse.md @@ -12,4 +12,4 @@ type GetAuthenticationResponse = GetAuthenticationResponses[keyof GetAuthenticationResponses]; ``` -Defined in: [gen/types.gen.ts:7977](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7977) +Defined in: [gen/types.gen.ts:8598](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8598) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationResponses.md index 3f1e9f2d4bd..a2b5fa116b6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthenticationResponses.md @@ -11,7 +11,7 @@ mdx: type GetAuthenticationResponses = object; ``` -Defined in: [gen/types.gen.ts:7970](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7970) +Defined in: [gen/types.gen.ts:8591](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8591) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:7970](https://github.com/camunda/orchestration-clu 200: CamundaUserResult; ``` -Defined in: [gen/types.gen.ts:7974](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7974) +Defined in: [gen/types.gen.ts:8595](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8595) The current user is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationData.md index 68a89a9a2ad..0980892cd1b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationData.md @@ -11,7 +11,7 @@ mdx: type GetAuthorizationData = object; ``` -Defined in: [gen/types.gen.ts:8105](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8105) +Defined in: [gen/types.gen.ts:8726](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8726) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8105](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:8106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8106) +Defined in: [gen/types.gen.ts:8727](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8727) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8106](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8107](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8107) +Defined in: [gen/types.gen.ts:8728](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8728) #### authorizationKey @@ -49,7 +49,7 @@ The key of the authorization to get. optional query: never; ``` -Defined in: [gen/types.gen.ts:8113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8113) +Defined in: [gen/types.gen.ts:8734](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8734) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8113](https://github.com/camunda/orchestration-clu url: "/authorizations/{authorizationKey}"; ``` -Defined in: [gen/types.gen.ts:8114](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8114) +Defined in: [gen/types.gen.ts:8735](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8735) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationError.md index 06737e2d8ee..18cbaed56c6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationError.md @@ -12,4 +12,4 @@ type GetAuthorizationError = GetAuthorizationErrors[keyof GetAuthorizationErrors]; ``` -Defined in: [gen/types.gen.ts:8136](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8136) +Defined in: [gen/types.gen.ts:8757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8757) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationErrors.md index f7c0392f30c..850a0e8c19c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationErrors.md @@ -11,7 +11,7 @@ mdx: type GetAuthorizationErrors = object; ``` -Defined in: [gen/types.gen.ts:8117](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8117) +Defined in: [gen/types.gen.ts:8738](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8738) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8117](https://github.com/camunda/orchestration-clu 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8121](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8121) +Defined in: [gen/types.gen.ts:8742](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8742) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8125](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8125) +Defined in: [gen/types.gen.ts:8746](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8746) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8129](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8129) +Defined in: [gen/types.gen.ts:8750](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8750) The authorization with the given key was not found. @@ -57,6 +57,6 @@ The authorization with the given key was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8133](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8133) +Defined in: [gen/types.gen.ts:8754](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8754) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationResponse.md index c101aa33679..40cb10f4655 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationResponse.md @@ -12,4 +12,4 @@ type GetAuthorizationResponse = GetAuthorizationResponses[keyof GetAuthorizationResponses]; ``` -Defined in: [gen/types.gen.ts:8145](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8145) +Defined in: [gen/types.gen.ts:8766](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8766) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationResponses.md index 4d9d56dbbb6..d063ddcc0aa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetAuthorizationResponses.md @@ -11,7 +11,7 @@ mdx: type GetAuthorizationResponses = object; ``` -Defined in: [gen/types.gen.ts:8138](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8138) +Defined in: [gen/types.gen.ts:8759](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8759) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8138](https://github.com/camunda/orchestration-clu 200: AuthorizationResult; ``` -Defined in: [gen/types.gen.ts:8142](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8142) +Defined in: [gen/types.gen.ts:8763](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8763) The authorization was successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationData.md index c69c1394474..80a873016f9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationData.md @@ -11,7 +11,7 @@ mdx: type GetBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:8346](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8346) +Defined in: [gen/types.gen.ts:8869](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8869) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8346](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:8347](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8347) +Defined in: [gen/types.gen.ts:8870](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8870) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8347](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8348](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8348) +Defined in: [gen/types.gen.ts:8871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8871) #### batchOperationKey @@ -49,7 +49,7 @@ The key (or operate legacy ID) of the batch operation. optional query: never; ``` -Defined in: [gen/types.gen.ts:8354](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8354) +Defined in: [gen/types.gen.ts:8877](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8877) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8354](https://github.com/camunda/orchestration-clu url: "/batch-operations/{batchOperationKey}"; ``` -Defined in: [gen/types.gen.ts:8355](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8355) +Defined in: [gen/types.gen.ts:8878](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8878) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationError.md index b25fd999286..c272a188529 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationError.md @@ -12,4 +12,4 @@ type GetBatchOperationError = GetBatchOperationErrors[keyof GetBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:8373](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8373) +Defined in: [gen/types.gen.ts:8896](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8896) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationErrors.md index b153ae5a532..87a626dee6b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type GetBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:8358](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8358) +Defined in: [gen/types.gen.ts:8881](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8881) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8358](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8362](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8362) +Defined in: [gen/types.gen.ts:8885](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8885) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8366](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8366) +Defined in: [gen/types.gen.ts:8889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8889) The batch operation is not found. @@ -45,6 +45,6 @@ The batch operation is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8370](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8370) +Defined in: [gen/types.gen.ts:8893](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8893) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationResponse.md index ec964a6d6ce..da494e77d04 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationResponse.md @@ -12,4 +12,4 @@ type GetBatchOperationResponse = GetBatchOperationResponses[keyof GetBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:8382](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8382) +Defined in: [gen/types.gen.ts:8905](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8905) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationResponses.md index d0ec261a96d..2d586f3268e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type GetBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:8375](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8375) +Defined in: [gen/types.gen.ts:8898](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8898) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8375](https://github.com/camunda/orchestration-clu 200: BatchOperationResponse; ``` -Defined in: [gen/types.gen.ts:8379](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8379) +Defined in: [gen/types.gen.ts:8902](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8902) The batch operation was found. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionData.md index 7a5f9a0452b..8aea2d2f736 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionData.md @@ -11,7 +11,7 @@ mdx: type GetDecisionDefinitionData = object; ``` -Defined in: [gen/types.gen.ts:9271](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9271) +Defined in: [gen/types.gen.ts:9673](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9673) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9271](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:9272](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9272) +Defined in: [gen/types.gen.ts:9674](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9674) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9272](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:9273](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9273) +Defined in: [gen/types.gen.ts:9675](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9675) #### decisionDefinitionKey @@ -49,7 +49,7 @@ The assigned key of the decision definition, which acts as a unique identifier f optional query: never; ``` -Defined in: [gen/types.gen.ts:9279](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9279) +Defined in: [gen/types.gen.ts:9681](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9681) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:9279](https://github.com/camunda/orchestration-clu url: "/decision-definitions/{decisionDefinitionKey}"; ``` -Defined in: [gen/types.gen.ts:9280](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9280) +Defined in: [gen/types.gen.ts:9682](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9682) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionError.md index 86c8a14ad43..db868381770 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionError.md @@ -12,4 +12,4 @@ type GetDecisionDefinitionError = GetDecisionDefinitionErrors[keyof GetDecisionDefinitionErrors]; ``` -Defined in: [gen/types.gen.ts:9307](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9307) +Defined in: [gen/types.gen.ts:9709](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9709) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionErrors.md index bdd77948678..c4f47f513c9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionErrors.md @@ -11,7 +11,7 @@ mdx: type GetDecisionDefinitionErrors = object; ``` -Defined in: [gen/types.gen.ts:9283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9283) +Defined in: [gen/types.gen.ts:9685](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9685) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9283](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9287](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9287) +Defined in: [gen/types.gen.ts:9689](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9689) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9291](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9291) +Defined in: [gen/types.gen.ts:9693](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9693) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9295](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9295) +Defined in: [gen/types.gen.ts:9697](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9697) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9300](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9300) +Defined in: [gen/types.gen.ts:9702](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9702) The decision definition with the given key was not found. More details are provided in the response body. @@ -69,6 +69,6 @@ The decision definition with the given key was not found. More details are provi 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9304](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9304) +Defined in: [gen/types.gen.ts:9706](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9706) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionResponse.md index 334b3a87b0c..5acf82c42b2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionResponse.md @@ -12,4 +12,4 @@ type GetDecisionDefinitionResponse = GetDecisionDefinitionResponses[keyof GetDecisionDefinitionResponses]; ``` -Defined in: [gen/types.gen.ts:9316](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9316) +Defined in: [gen/types.gen.ts:9718](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9718) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionResponses.md index afbcdbb64cc..b6e25119025 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionResponses.md @@ -11,7 +11,7 @@ mdx: type GetDecisionDefinitionResponses = object; ``` -Defined in: [gen/types.gen.ts:9309](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9309) +Defined in: [gen/types.gen.ts:9711](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9711) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9309](https://github.com/camunda/orchestration-clu 200: DecisionDefinitionResult; ``` -Defined in: [gen/types.gen.ts:9313](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9313) +Defined in: [gen/types.gen.ts:9715](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9715) The decision definition is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlData.md index 29da6968bac..00de928530d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlData.md @@ -11,7 +11,7 @@ mdx: type GetDecisionDefinitionXmlData = object; ``` -Defined in: [gen/types.gen.ts:9318](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9318) +Defined in: [gen/types.gen.ts:9720](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9720) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9318](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:9319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9319) +Defined in: [gen/types.gen.ts:9721](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9721) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9319](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:9320](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9320) +Defined in: [gen/types.gen.ts:9722](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9722) #### decisionDefinitionKey @@ -49,7 +49,7 @@ The assigned key of the decision definition, which acts as a unique identifier f optional query: never; ``` -Defined in: [gen/types.gen.ts:9326](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9326) +Defined in: [gen/types.gen.ts:9728](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9728) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:9326](https://github.com/camunda/orchestration-clu url: "/decision-definitions/{decisionDefinitionKey}/xml"; ``` -Defined in: [gen/types.gen.ts:9327](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9327) +Defined in: [gen/types.gen.ts:9729](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9729) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlError.md index 273f0bbd8d5..7ae5441eaf3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlError.md @@ -12,4 +12,4 @@ type GetDecisionDefinitionXmlError = GetDecisionDefinitionXmlErrors[keyof GetDecisionDefinitionXmlErrors]; ``` -Defined in: [gen/types.gen.ts:9354](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9354) +Defined in: [gen/types.gen.ts:9756](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9756) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlErrors.md index c5a6a1018c0..17d63e69655 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlErrors.md @@ -11,7 +11,7 @@ mdx: type GetDecisionDefinitionXmlErrors = object; ``` -Defined in: [gen/types.gen.ts:9330](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9330) +Defined in: [gen/types.gen.ts:9732](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9732) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9330](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9334](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9334) +Defined in: [gen/types.gen.ts:9736](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9736) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9338](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9338) +Defined in: [gen/types.gen.ts:9740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9740) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9342](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9342) +Defined in: [gen/types.gen.ts:9744](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9744) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9347](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9347) +Defined in: [gen/types.gen.ts:9749](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9749) The decision definition with the given key was not found. More details are provided in the response body. @@ -69,6 +69,6 @@ The decision definition with the given key was not found. More details are provi 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9351](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9351) +Defined in: [gen/types.gen.ts:9753](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9753) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlResponse.md index 152a3a46fa8..cec25c2eb03 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlResponse.md @@ -12,4 +12,4 @@ type GetDecisionDefinitionXmlResponse = GetDecisionDefinitionXmlResponses[keyof GetDecisionDefinitionXmlResponses]; ``` -Defined in: [gen/types.gen.ts:9363](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9363) +Defined in: [gen/types.gen.ts:9765](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9765) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlResponses.md index baf00be2810..85d14ff384f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionDefinitionXmlResponses.md @@ -11,7 +11,7 @@ mdx: type GetDecisionDefinitionXmlResponses = object; ``` -Defined in: [gen/types.gen.ts:9356](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9356) +Defined in: [gen/types.gen.ts:9758](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9758) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9356](https://github.com/camunda/orchestration-clu 200: string; ``` -Defined in: [gen/types.gen.ts:9360](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9360) +Defined in: [gen/types.gen.ts:9762](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9762) The XML of the decision definition is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceData.md index a94755f048e..ba43ee453df 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceData.md @@ -11,7 +11,7 @@ mdx: type GetDecisionInstanceData = object; ``` -Defined in: [gen/types.gen.ts:9536](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9536) +Defined in: [gen/types.gen.ts:9804](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9804) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9536](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:9537](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9537) +Defined in: [gen/types.gen.ts:9805](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9805) --- @@ -31,12 +31,12 @@ Defined in: [gen/types.gen.ts:9537](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:9538](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9538) +Defined in: [gen/types.gen.ts:9806](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9806) #### decisionEvaluationInstanceKey ```ts -decisionEvaluationInstanceKey: DecisionInstanceKey; +decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey; ``` The assigned key of the decision instance, which acts as a unique identifier for this decision instance. @@ -49,7 +49,7 @@ The assigned key of the decision instance, which acts as a unique identifier for optional query: never; ``` -Defined in: [gen/types.gen.ts:9544](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9544) +Defined in: [gen/types.gen.ts:9812](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9812) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:9544](https://github.com/camunda/orchestration-clu url: "/decision-instances/{decisionEvaluationInstanceKey}"; ``` -Defined in: [gen/types.gen.ts:9545](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9545) +Defined in: [gen/types.gen.ts:9813](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9813) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceError.md index 843e69439d6..e4414cba7f2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceError.md @@ -12,4 +12,4 @@ type GetDecisionInstanceError = GetDecisionInstanceErrors[keyof GetDecisionInstanceErrors]; ``` -Defined in: [gen/types.gen.ts:9572](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9572) +Defined in: [gen/types.gen.ts:9840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9840) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceErrors.md index 971151f2500..defe07edd9b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceErrors.md @@ -11,7 +11,7 @@ mdx: type GetDecisionInstanceErrors = object; ``` -Defined in: [gen/types.gen.ts:9548](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9548) +Defined in: [gen/types.gen.ts:9816](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9816) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9548](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9552](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9552) +Defined in: [gen/types.gen.ts:9820](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9820) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9556](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9556) +Defined in: [gen/types.gen.ts:9824](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9824) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9560](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9560) +Defined in: [gen/types.gen.ts:9828](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9828) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9565](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9565) +Defined in: [gen/types.gen.ts:9833](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9833) The decision instance with the given key was not found. More details are provided in the response body. @@ -69,6 +69,6 @@ The decision instance with the given key was not found. More details are provide 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9569](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9569) +Defined in: [gen/types.gen.ts:9837](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9837) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceResponse.md index 8560e7ebcff..be02bc18a93 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceResponse.md @@ -12,4 +12,4 @@ type GetDecisionInstanceResponse = GetDecisionInstanceResponses[keyof GetDecisionInstanceResponses]; ``` -Defined in: [gen/types.gen.ts:9649](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9649) +Defined in: [gen/types.gen.ts:9849](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9849) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceResponses.md index 3a9ff99d1ec..0e2d0a860b5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionInstanceResponses.md @@ -11,164 +11,16 @@ mdx: type GetDecisionInstanceResponses = object; ``` -Defined in: [gen/types.gen.ts:9574](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9574) +Defined in: [gen/types.gen.ts:9842](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9842) ## Properties ### 200 ```ts -200: object & object; +200: DecisionInstanceGetQueryResult; ``` -Defined in: [gen/types.gen.ts:9578](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9578) +Defined in: [gen/types.gen.ts:9846](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9846) The decision instance is successfully returned. - -#### Type Declaration - -##### decisionDefinitionId? - -```ts -optional decisionDefinitionId: DecisionDefinitionId; -``` - -The ID of the DMN decision. - -##### decisionDefinitionKey? - -```ts -optional decisionDefinitionKey: DecisionDefinitionKey; -``` - -The key of the decision. - -##### decisionDefinitionName? - -```ts -optional decisionDefinitionName: string; -``` - -The name of the DMN decision. - -##### decisionDefinitionType? - -```ts -optional decisionDefinitionType: DecisionDefinitionTypeEnum; -``` - -##### decisionDefinitionVersion? - -```ts -optional decisionDefinitionVersion: number; -``` - -The version of the decision. - -##### decisionEvaluationInstanceKey? - -```ts -optional decisionEvaluationInstanceKey: DecisionEvaluationInstanceKey; -``` - -##### decisionEvaluationKey? - -```ts -optional decisionEvaluationKey: DecisionEvaluationKey; -``` - -The key of the decision evaluation where this instance was created. - -##### elementInstanceKey? - -```ts -optional elementInstanceKey: ElementInstanceKey; -``` - -The key of the element instance this decision instance is linked to. - -##### evaluationDate? - -```ts -optional evaluationDate: string; -``` - -The evaluation date of the decision instance. - -##### evaluationFailure? - -```ts -optional evaluationFailure: string; -``` - -The evaluation failure of the decision instance. - -##### processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKey; -``` - -The key of the process definition. - -##### processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKey; -``` - -The key of the process instance. - -##### result? - -```ts -optional result: string; -``` - -The result of the decision instance. - -##### rootDecisionDefinitionKey? - -```ts -optional rootDecisionDefinitionKey: DecisionDefinitionKey; -``` - -The key of the root decision definition. - -##### rootProcessInstanceKey? - -```ts -optional rootProcessInstanceKey: ProcessInstanceKey; -``` - -##### state? - -```ts -optional state: DecisionInstanceStateEnum; -``` - -##### tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant ID of the decision instance. - -#### Type Declaration - -##### evaluatedInputs? - -```ts -optional evaluatedInputs: EvaluatedDecisionInputItem[]; -``` - -The evaluated inputs of the decision instance. - -##### matchedRules? - -```ts -optional matchedRules: MatchedDecisionRuleItem[]; -``` - -The matched rules of the decision instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsData.md index d3e34350177..51d0da680b3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsData.md @@ -11,7 +11,7 @@ mdx: type GetDecisionRequirementsData = object; ``` -Defined in: [gen/types.gen.ts:9845](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9845) +Defined in: [gen/types.gen.ts:9975](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9975) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9845](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:9846](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9846) +Defined in: [gen/types.gen.ts:9976](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9976) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9846](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:9847](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9847) +Defined in: [gen/types.gen.ts:9977](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9977) #### decisionRequirementsKey @@ -49,7 +49,7 @@ The assigned key of the decision requirements, which acts as a unique identifier optional query: never; ``` -Defined in: [gen/types.gen.ts:9853](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9853) +Defined in: [gen/types.gen.ts:9983](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9983) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:9853](https://github.com/camunda/orchestration-clu url: "/decision-requirements/{decisionRequirementsKey}"; ``` -Defined in: [gen/types.gen.ts:9854](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9854) +Defined in: [gen/types.gen.ts:9984](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9984) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsError.md index ff1a4330afb..7d19187969b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsError.md @@ -12,4 +12,4 @@ type GetDecisionRequirementsError = GetDecisionRequirementsErrors[keyof GetDecisionRequirementsErrors]; ``` -Defined in: [gen/types.gen.ts:9881](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9881) +Defined in: [gen/types.gen.ts:10011](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10011) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsErrors.md index c6ef3b877d6..b212f2b71cd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsErrors.md @@ -11,7 +11,7 @@ mdx: type GetDecisionRequirementsErrors = object; ``` -Defined in: [gen/types.gen.ts:9857](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9857) +Defined in: [gen/types.gen.ts:9987](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9987) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9857](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9861](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9861) +Defined in: [gen/types.gen.ts:9991](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9991) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9865](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9865) +Defined in: [gen/types.gen.ts:9995](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9995) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9869](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9869) +Defined in: [gen/types.gen.ts:9999](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9999) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9874](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9874) +Defined in: [gen/types.gen.ts:10004](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10004) The decision requirements with the given key was not found. More details are provided in the response body. @@ -69,6 +69,6 @@ The decision requirements with the given key was not found. More details are pro 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9878](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9878) +Defined in: [gen/types.gen.ts:10008](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10008) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsResponse.md index 953d6d51a78..b5e79350f1e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsResponse.md @@ -12,4 +12,4 @@ type GetDecisionRequirementsResponse = GetDecisionRequirementsResponses[keyof GetDecisionRequirementsResponses]; ``` -Defined in: [gen/types.gen.ts:9890](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9890) +Defined in: [gen/types.gen.ts:10020](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10020) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsResponses.md index afb1bbc5834..5f373b1ebbe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsResponses.md @@ -11,7 +11,7 @@ mdx: type GetDecisionRequirementsResponses = object; ``` -Defined in: [gen/types.gen.ts:9883](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9883) +Defined in: [gen/types.gen.ts:10013](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10013) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9883](https://github.com/camunda/orchestration-clu 200: DecisionRequirementsResult; ``` -Defined in: [gen/types.gen.ts:9887](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9887) +Defined in: [gen/types.gen.ts:10017](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10017) The decision requirements is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlData.md index 652e465fa6c..36ba755582e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlData.md @@ -11,7 +11,7 @@ mdx: type GetDecisionRequirementsXmlData = object; ``` -Defined in: [gen/types.gen.ts:9892](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9892) +Defined in: [gen/types.gen.ts:10022](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10022) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9892](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:9893](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9893) +Defined in: [gen/types.gen.ts:10023](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10023) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9893](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:9894](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9894) +Defined in: [gen/types.gen.ts:10024](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10024) #### decisionRequirementsKey @@ -49,7 +49,7 @@ The assigned key of the decision requirements, which acts as a unique identifier optional query: never; ``` -Defined in: [gen/types.gen.ts:9900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9900) +Defined in: [gen/types.gen.ts:10030](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10030) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:9900](https://github.com/camunda/orchestration-clu url: "/decision-requirements/{decisionRequirementsKey}/xml"; ``` -Defined in: [gen/types.gen.ts:9901](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9901) +Defined in: [gen/types.gen.ts:10031](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10031) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlError.md index 899c6b41917..75e441d5ec4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlError.md @@ -12,4 +12,4 @@ type GetDecisionRequirementsXmlError = GetDecisionRequirementsXmlErrors[keyof GetDecisionRequirementsXmlErrors]; ``` -Defined in: [gen/types.gen.ts:9928](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9928) +Defined in: [gen/types.gen.ts:10058](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10058) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlErrors.md index 023b4cea425..117f242bf77 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlErrors.md @@ -11,7 +11,7 @@ mdx: type GetDecisionRequirementsXmlErrors = object; ``` -Defined in: [gen/types.gen.ts:9904](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9904) +Defined in: [gen/types.gen.ts:10034](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10034) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9904](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9908](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9908) +Defined in: [gen/types.gen.ts:10038](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10038) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9912](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9912) +Defined in: [gen/types.gen.ts:10042](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10042) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9916](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9916) +Defined in: [gen/types.gen.ts:10046](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10046) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9921](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9921) +Defined in: [gen/types.gen.ts:10051](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10051) The decision requirements with the given key was not found. More details are provided in the response body. @@ -69,6 +69,6 @@ The decision requirements with the given key was not found. More details are pro 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9925](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9925) +Defined in: [gen/types.gen.ts:10055](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10055) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlResponse.md index a5ec28fe30c..e45415d0e2a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlResponse.md @@ -12,4 +12,4 @@ type GetDecisionRequirementsXmlResponse = GetDecisionRequirementsXmlResponses[keyof GetDecisionRequirementsXmlResponses]; ``` -Defined in: [gen/types.gen.ts:9937](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9937) +Defined in: [gen/types.gen.ts:10067](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10067) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlResponses.md index b198cb93a77..45d57ed114d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDecisionRequirementsXmlResponses.md @@ -11,7 +11,7 @@ mdx: type GetDecisionRequirementsXmlResponses = object; ``` -Defined in: [gen/types.gen.ts:9930](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9930) +Defined in: [gen/types.gen.ts:10060](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10060) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9930](https://github.com/camunda/orchestration-clu 200: string; ``` -Defined in: [gen/types.gen.ts:9934](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9934) +Defined in: [gen/types.gen.ts:10064](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10064) The XML of the decision requirements is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentData.md index 5d32b22797a..a9da6ce9911 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentData.md @@ -11,7 +11,7 @@ mdx: type GetDocumentData = object; ``` -Defined in: [gen/types.gen.ts:10145](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10145) +Defined in: [gen/types.gen.ts:10239](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10239) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10145](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:10146](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10146) +Defined in: [gen/types.gen.ts:10240](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10240) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10146](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10147](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10147) +Defined in: [gen/types.gen.ts:10241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10241) #### documentId @@ -49,7 +49,7 @@ The ID of the document to download. optional query: object; ``` -Defined in: [gen/types.gen.ts:10153](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10153) +Defined in: [gen/types.gen.ts:10247](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10247) #### contentHash? @@ -75,4 +75,4 @@ The ID of the document store to download the document from. url: "/documents/{documentId}"; ``` -Defined in: [gen/types.gen.ts:10164](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10164) +Defined in: [gen/types.gen.ts:10258](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10258) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentError.md index 55a46aebafe..cfbc9bed02d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentError.md @@ -11,4 +11,4 @@ mdx: type GetDocumentError = GetDocumentErrors[keyof GetDocumentErrors]; ``` -Defined in: [gen/types.gen.ts:10178](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10178) +Defined in: [gen/types.gen.ts:10272](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10272) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentErrors.md index 26ee755fa97..909534fc3b7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentErrors.md @@ -11,7 +11,7 @@ mdx: type GetDocumentErrors = object; ``` -Defined in: [gen/types.gen.ts:10167](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10167) +Defined in: [gen/types.gen.ts:10261](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10261) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10167](https://github.com/camunda/orchestration-cl 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10171](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10171) +Defined in: [gen/types.gen.ts:10265](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10265) The document with the given ID was not found. @@ -33,6 +33,6 @@ The document with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10175](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10175) +Defined in: [gen/types.gen.ts:10269](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10269) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentResponse.md index 964b4d5211e..89e13271531 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentResponse.md @@ -11,4 +11,4 @@ mdx: type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses]; ``` -Defined in: [gen/types.gen.ts:10187](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10187) +Defined in: [gen/types.gen.ts:10281](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10281) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentResponses.md index df60b6f01aa..54027cff018 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetDocumentResponses.md @@ -11,7 +11,7 @@ mdx: type GetDocumentResponses = object; ``` -Defined in: [gen/types.gen.ts:10180](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10180) +Defined in: [gen/types.gen.ts:10274](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10274) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10180](https://github.com/camunda/orchestration-cl 200: Blob | File; ``` -Defined in: [gen/types.gen.ts:10184](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10184) +Defined in: [gen/types.gen.ts:10278](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10278) The document was downloaded successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceData.md index 3324141c3c4..bf2c42b14a7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceData.md @@ -11,7 +11,7 @@ mdx: type GetElementInstanceData = object; ``` -Defined in: [gen/types.gen.ts:10376](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10376) +Defined in: [gen/types.gen.ts:10411](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10411) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10376](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:10377](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10377) +Defined in: [gen/types.gen.ts:10412](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10412) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10377](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10378](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10378) +Defined in: [gen/types.gen.ts:10413](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10413) #### elementInstanceKey @@ -49,7 +49,7 @@ The assigned key of the element instance, which acts as a unique identifier for optional query: never; ``` -Defined in: [gen/types.gen.ts:10384](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10384) +Defined in: [gen/types.gen.ts:10419](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10419) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:10384](https://github.com/camunda/orchestration-cl url: "/element-instances/{elementInstanceKey}"; ``` -Defined in: [gen/types.gen.ts:10385](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10385) +Defined in: [gen/types.gen.ts:10420](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10420) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceError.md index 838d73cb4cb..03d47e23d5a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceError.md @@ -12,4 +12,4 @@ type GetElementInstanceError = GetElementInstanceErrors[keyof GetElementInstanceErrors]; ``` -Defined in: [gen/types.gen.ts:10413](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10413) +Defined in: [gen/types.gen.ts:10448](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10448) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceErrors.md index eaa2edb4c97..f8cc60e34b9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceErrors.md @@ -11,7 +11,7 @@ mdx: type GetElementInstanceErrors = object; ``` -Defined in: [gen/types.gen.ts:10388](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10388) +Defined in: [gen/types.gen.ts:10423](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10423) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10388](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10392](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10392) +Defined in: [gen/types.gen.ts:10427](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10427) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10396](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10396) +Defined in: [gen/types.gen.ts:10431](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10431) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10400](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10400) +Defined in: [gen/types.gen.ts:10435](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10435) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10406](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10406) +Defined in: [gen/types.gen.ts:10441](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10441) The element instance with the given key was not found. More details are provided in the response body. @@ -70,6 +70,6 @@ More details are provided in the response body. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10410](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10410) +Defined in: [gen/types.gen.ts:10445](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10445) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceResponse.md index 39b230ebee9..a517b4b2c1a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceResponse.md @@ -12,4 +12,4 @@ type GetElementInstanceResponse = GetElementInstanceResponses[keyof GetElementInstanceResponses]; ``` -Defined in: [gen/types.gen.ts:10476](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10476) +Defined in: [gen/types.gen.ts:10457](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10457) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceResponses.md index 9f319683968..e8618afaafc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetElementInstanceResponses.md @@ -11,153 +11,16 @@ mdx: type GetElementInstanceResponses = object; ``` -Defined in: [gen/types.gen.ts:10415](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10415) +Defined in: [gen/types.gen.ts:10450](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10450) ## Properties ### 200 ```ts -200: object; +200: ElementInstanceResult; ``` -Defined in: [gen/types.gen.ts:10419](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10419) +Defined in: [gen/types.gen.ts:10454](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10454) The element instance is successfully returned. - -#### elementId - -```ts -elementId: ElementId; -``` - -The element ID for this element instance. - -#### elementInstanceKey - -```ts -elementInstanceKey: ElementInstanceKey; -``` - -The assigned key, which acts as a unique identifier for this element instance. - -#### elementName - -```ts -elementName: string; -``` - -The element name for this element instance. - -#### endDate? - -```ts -optional endDate: string; -``` - -Date when element instance finished. - -#### hasIncident - -```ts -hasIncident: boolean; -``` - -Shows whether this element instance has an incident. If true also an incidentKey is provided. - -#### incidentKey? - -```ts -optional incidentKey: IncidentKey; -``` - -Incident key associated with this element instance. - -#### processDefinitionId - -```ts -processDefinitionId: ProcessDefinitionId; -``` - -The process definition ID associated to this element instance. - -#### processDefinitionKey - -```ts -processDefinitionKey: ProcessDefinitionKey; -``` - -The process definition key associated to this element instance. - -#### processInstanceKey - -```ts -processInstanceKey: ProcessInstanceKey; -``` - -The process instance key associated to this element instance. - -#### rootProcessInstanceKey? - -```ts -optional rootProcessInstanceKey: ProcessInstanceKey; -``` - -#### startDate - -```ts -startDate: string; -``` - -Date when element instance started. - -#### state - -```ts -state: ElementInstanceStateEnum; -``` - -State of element instance as defined set of values. - -#### tenantId - -```ts -tenantId: TenantId; -``` - -The tenant ID of the incident. - -#### type - -```ts -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"; -``` - -Type of element as defined set of values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableData.md index e7121d97e52..f09a6cbd029 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableData.md @@ -11,7 +11,7 @@ mdx: type GetGlobalClusterVariableData = object; ``` -Defined in: [gen/types.gen.ts:8667](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8667) +Defined in: [gen/types.gen.ts:9190](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9190) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8667](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:8668](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8668) +Defined in: [gen/types.gen.ts:9191](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9191) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8668](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8669](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8669) +Defined in: [gen/types.gen.ts:9192](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9192) #### name @@ -49,7 +49,7 @@ The name of the cluster variable optional query: never; ``` -Defined in: [gen/types.gen.ts:8675](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8675) +Defined in: [gen/types.gen.ts:9198](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9198) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8675](https://github.com/camunda/orchestration-clu url: "/cluster-variables/global/{name}"; ``` -Defined in: [gen/types.gen.ts:8676](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8676) +Defined in: [gen/types.gen.ts:9199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9199) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableError.md index 1295a73fc47..5409b5aaaeb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableError.md @@ -12,4 +12,4 @@ type GetGlobalClusterVariableError = GetGlobalClusterVariableErrors[keyof GetGlobalClusterVariableErrors]; ``` -Defined in: [gen/types.gen.ts:8702](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8702) +Defined in: [gen/types.gen.ts:9225](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9225) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableErrors.md index 1279f683bce..344d6d074de 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableErrors.md @@ -11,7 +11,7 @@ mdx: type GetGlobalClusterVariableErrors = object; ``` -Defined in: [gen/types.gen.ts:8679](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8679) +Defined in: [gen/types.gen.ts:9202](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9202) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8679](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8683](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8683) +Defined in: [gen/types.gen.ts:9206](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9206) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8687](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8687) +Defined in: [gen/types.gen.ts:9210](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9210) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8691](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8691) +Defined in: [gen/types.gen.ts:9214](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9214) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8695](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8695) +Defined in: [gen/types.gen.ts:9218](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9218) Cluster variable not found @@ -69,6 +69,6 @@ Cluster variable not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8699](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8699) +Defined in: [gen/types.gen.ts:9222](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9222) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableResponse.md index 74d104bf538..f6642c675a4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableResponse.md @@ -12,4 +12,4 @@ type GetGlobalClusterVariableResponse = GetGlobalClusterVariableResponses[keyof GetGlobalClusterVariableResponses]; ``` -Defined in: [gen/types.gen.ts:8711](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8711) +Defined in: [gen/types.gen.ts:9234](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9234) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableResponses.md index d92cc68568e..634eabc6a00 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalClusterVariableResponses.md @@ -11,7 +11,7 @@ mdx: type GetGlobalClusterVariableResponses = object; ``` -Defined in: [gen/types.gen.ts:8704](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8704) +Defined in: [gen/types.gen.ts:9227](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9227) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8704](https://github.com/camunda/orchestration-clu 200: ClusterVariableResult; ``` -Defined in: [gen/types.gen.ts:8708](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8708) +Defined in: [gen/types.gen.ts:9231](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9231) Cluster variable found diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsData.md index 6818b0fe91e..e9861fabab1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsData.md @@ -11,7 +11,7 @@ mdx: type GetGlobalJobStatisticsData = object; ``` -Defined in: [gen/types.gen.ts:12132](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12132) +Defined in: [gen/types.gen.ts:12058](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12058) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12132](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:12133](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12133) +Defined in: [gen/types.gen.ts:12059](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12059) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12133](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:12134](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12134) +Defined in: [gen/types.gen.ts:12060](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12060) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:12134](https://github.com/camunda/orchestration-cl query: object; ``` -Defined in: [gen/types.gen.ts:12135](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12135) +Defined in: [gen/types.gen.ts:12061](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12061) #### from @@ -75,4 +75,4 @@ End of the time window to filter metrics. ISO 8601 date-time format. url: "/jobs/statistics/global"; ``` -Defined in: [gen/types.gen.ts:12151](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12151) +Defined in: [gen/types.gen.ts:12077](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12077) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsError.md index 792c9058bc2..97778b38b5d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsError.md @@ -12,4 +12,4 @@ type GetGlobalJobStatisticsError = GetGlobalJobStatisticsErrors[keyof GetGlobalJobStatisticsErrors]; ``` -Defined in: [gen/types.gen.ts:12173](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12173) +Defined in: [gen/types.gen.ts:12099](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12099) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsErrors.md index c163d354fe8..03c39cfeb37 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsErrors.md @@ -11,7 +11,7 @@ mdx: type GetGlobalJobStatisticsErrors = object; ``` -Defined in: [gen/types.gen.ts:12154](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12154) +Defined in: [gen/types.gen.ts:12080](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12080) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12154](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12158](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12158) +Defined in: [gen/types.gen.ts:12084](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12084) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12162](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12162) +Defined in: [gen/types.gen.ts:12088](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12088) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12166](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12166) +Defined in: [gen/types.gen.ts:12092](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12092) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12170](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12170) +Defined in: [gen/types.gen.ts:12096](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12096) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsResponse.md index 2ee11200b8a..b98c21250bd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsResponse.md @@ -12,4 +12,4 @@ type GetGlobalJobStatisticsResponse = GetGlobalJobStatisticsResponses[keyof GetGlobalJobStatisticsResponses]; ``` -Defined in: [gen/types.gen.ts:12182](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12182) +Defined in: [gen/types.gen.ts:12108](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12108) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsResponses.md index 2d661efe52a..80aa6fe3653 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalJobStatisticsResponses.md @@ -11,7 +11,7 @@ mdx: type GetGlobalJobStatisticsResponses = object; ``` -Defined in: [gen/types.gen.ts:12175](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12175) +Defined in: [gen/types.gen.ts:12101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12101) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12175](https://github.com/camunda/orchestration-cl 200: GlobalJobStatisticsQueryResult; ``` -Defined in: [gen/types.gen.ts:12179](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12179) +Defined in: [gen/types.gen.ts:12105](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12105) Global job metrics diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerData.md new file mode 100644 index 00000000000..2394f5fb2b7 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerData.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: GetGlobalTaskListenerData" +sidebar_label: "GetGlobalTaskListenerData" +mdx: + format: md +--- + +# Type Alias: GetGlobalTaskListenerData + +```ts +type GetGlobalTaskListenerData = object; +``` + +Defined in: [gen/types.gen.ts:10687](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10687) + +## Properties + +### body? + +```ts +optional body: never; +``` + +Defined in: [gen/types.gen.ts:10688](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10688) + +--- + +### path + +```ts +path: object; +``` + +Defined in: [gen/types.gen.ts:10689](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10689) + +#### id + +```ts +id: GlobalListenerId; +``` + +The id of the global user task listener. + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:10695](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10695) + +--- + +### url + +```ts +url: "/global-task-listeners/{id}"; +``` + +Defined in: [gen/types.gen.ts:10696](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10696) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerError.md new file mode 100644 index 00000000000..ae2d5a80d38 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetGlobalTaskListenerError" +sidebar_label: "GetGlobalTaskListenerError" +mdx: + format: md +--- + +# Type Alias: GetGlobalTaskListenerError + +```ts +type GetGlobalTaskListenerError = + GetGlobalTaskListenerErrors[keyof GetGlobalTaskListenerErrors]; +``` + +Defined in: [gen/types.gen.ts:10718](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10718) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerErrors.md new file mode 100644 index 00000000000..27d9f41761d --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerErrors.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: GetGlobalTaskListenerErrors" +sidebar_label: "GetGlobalTaskListenerErrors" +mdx: + format: md +--- + +# Type Alias: GetGlobalTaskListenerErrors + +```ts +type GetGlobalTaskListenerErrors = object; +``` + +Defined in: [gen/types.gen.ts:10699](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10699) + +## Properties + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10703](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10703) + +The request lacks valid authentication credentials. + +--- + +### 403 + +```ts +403: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10707](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10707) + +Forbidden. The request is not allowed. + +--- + +### 404 + +```ts +404: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10711](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10711) + +The global user task listener with the given id was not found. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10715](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10715) + +An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerResponse.md new file mode 100644 index 00000000000..924ce18d052 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetGlobalTaskListenerResponse" +sidebar_label: "GetGlobalTaskListenerResponse" +mdx: + format: md +--- + +# Type Alias: GetGlobalTaskListenerResponse + +```ts +type GetGlobalTaskListenerResponse = + GetGlobalTaskListenerResponses[keyof GetGlobalTaskListenerResponses]; +``` + +Defined in: [gen/types.gen.ts:10727](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10727) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerResponses.md new file mode 100644 index 00000000000..5aae7a4df2e --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGlobalTaskListenerResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: GetGlobalTaskListenerResponses" +sidebar_label: "GetGlobalTaskListenerResponses" +mdx: + format: md +--- + +# Type Alias: GetGlobalTaskListenerResponses + +```ts +type GetGlobalTaskListenerResponses = object; +``` + +Defined in: [gen/types.gen.ts:10720](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10720) + +## Properties + +### 200 + +```ts +200: GlobalTaskListenerResult; +``` + +Defined in: [gen/types.gen.ts:10724](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10724) + +The global user task listener is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupData.md index dc2edc8b52c..05b17e1a8bc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupData.md @@ -11,7 +11,7 @@ mdx: type GetGroupData = object; ``` -Defined in: [gen/types.gen.ts:10771](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10771) +Defined in: [gen/types.gen.ts:10939](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10939) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10771](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:10772](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10772) +Defined in: [gen/types.gen.ts:10940](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10940) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10772](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10773](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10773) +Defined in: [gen/types.gen.ts:10941](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10941) #### groupId @@ -49,7 +49,7 @@ The group ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:10779](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10779) +Defined in: [gen/types.gen.ts:10947](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10947) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:10779](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}"; ``` -Defined in: [gen/types.gen.ts:10780](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10780) +Defined in: [gen/types.gen.ts:10948](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10948) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupError.md index 469dc145e36..1d23d7670e9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupError.md @@ -11,4 +11,4 @@ mdx: type GetGroupError = GetGroupErrors[keyof GetGroupErrors]; ``` -Defined in: [gen/types.gen.ts:10802](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10802) +Defined in: [gen/types.gen.ts:10970](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10970) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupErrors.md index ef0488a335a..15aa4f207c4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupErrors.md @@ -11,7 +11,7 @@ mdx: type GetGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:10783](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10783) +Defined in: [gen/types.gen.ts:10951](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10951) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10783](https://github.com/camunda/orchestration-cl 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10787](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10787) +Defined in: [gen/types.gen.ts:10955](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10955) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10791](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10791) +Defined in: [gen/types.gen.ts:10959](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10959) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10795](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10795) +Defined in: [gen/types.gen.ts:10963](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10963) The group with the given ID was not found. @@ -57,6 +57,6 @@ The group with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10799](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10799) +Defined in: [gen/types.gen.ts:10967](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10967) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupResponse.md index 917a3a1b7e3..5d7f3cb271f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupResponse.md @@ -11,4 +11,4 @@ mdx: type GetGroupResponse = GetGroupResponses[keyof GetGroupResponses]; ``` -Defined in: [gen/types.gen.ts:10811](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10811) +Defined in: [gen/types.gen.ts:10979](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10979) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupResponses.md index 7e2652118c1..170aa93501c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetGroupResponses.md @@ -11,7 +11,7 @@ mdx: type GetGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:10804](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10804) +Defined in: [gen/types.gen.ts:10972](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10972) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10804](https://github.com/camunda/orchestration-cl 200: GroupResult; ``` -Defined in: [gen/types.gen.ts:10808](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10808) +Defined in: [gen/types.gen.ts:10976](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10976) The group is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentData.md index 7d2fdee8392..291869bfa09 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentData.md @@ -11,7 +11,7 @@ mdx: type GetIncidentData = object; ``` -Defined in: [gen/types.gen.ts:11455](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11455) +Defined in: [gen/types.gen.ts:11616](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11616) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11455](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:11456](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11456) +Defined in: [gen/types.gen.ts:11617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11617) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11456](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11457](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11457) +Defined in: [gen/types.gen.ts:11618](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11618) #### incidentKey @@ -49,7 +49,7 @@ The assigned key of the incident, which acts as a unique identifier for this inc optional query: never; ``` -Defined in: [gen/types.gen.ts:11463](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11463) +Defined in: [gen/types.gen.ts:11624](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11624) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:11463](https://github.com/camunda/orchestration-cl url: "/incidents/{incidentKey}"; ``` -Defined in: [gen/types.gen.ts:11464](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11464) +Defined in: [gen/types.gen.ts:11625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11625) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentError.md index cb63ba1fa1a..7c8d89cb9f3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentError.md @@ -11,4 +11,4 @@ mdx: type GetIncidentError = GetIncidentErrors[keyof GetIncidentErrors]; ``` -Defined in: [gen/types.gen.ts:11490](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11490) +Defined in: [gen/types.gen.ts:11651](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11651) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentErrors.md index 316890ced8b..444f9609553 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentErrors.md @@ -11,7 +11,7 @@ mdx: type GetIncidentErrors = object; ``` -Defined in: [gen/types.gen.ts:11467](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11467) +Defined in: [gen/types.gen.ts:11628](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11628) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11467](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11471](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11471) +Defined in: [gen/types.gen.ts:11632](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11632) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11475](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11475) +Defined in: [gen/types.gen.ts:11636](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11636) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11479](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11479) +Defined in: [gen/types.gen.ts:11640](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11640) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11483](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11483) +Defined in: [gen/types.gen.ts:11644](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11644) The incident with the given key was not found. @@ -69,6 +69,6 @@ The incident with the given key was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11487](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11487) +Defined in: [gen/types.gen.ts:11648](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11648) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentResponse.md index 53a4cf54e84..d7b9a206310 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentResponse.md @@ -11,4 +11,4 @@ mdx: type GetIncidentResponse = GetIncidentResponses[keyof GetIncidentResponses]; ``` -Defined in: [gen/types.gen.ts:11540](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11540) +Defined in: [gen/types.gen.ts:11660](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11660) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentResponses.md index 632ff61ab4f..eccdb52461f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetIncidentResponses.md @@ -11,112 +11,16 @@ mdx: type GetIncidentResponses = object; ``` -Defined in: [gen/types.gen.ts:11492](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11492) +Defined in: [gen/types.gen.ts:11653](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11653) ## Properties ### 200 ```ts -200: object; +200: IncidentResult; ``` -Defined in: [gen/types.gen.ts:11496](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11496) +Defined in: [gen/types.gen.ts:11657](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11657) The incident is successfully returned. - -#### creationTime? - -```ts -optional creationTime: string; -``` - -#### elementId? - -```ts -optional elementId: ElementId; -``` - -The element ID associated to this incident. - -#### elementInstanceKey? - -```ts -optional elementInstanceKey: ElementInstanceKey; -``` - -The element instance key associated to this incident. - -#### errorMessage? - -```ts -optional errorMessage: string; -``` - -Error message which describes the error in more detail. - -#### errorType? - -```ts -optional errorType: IncidentErrorTypeEnum; -``` - -#### incidentKey? - -```ts -optional incidentKey: IncidentKey; -``` - -The assigned key, which acts as a unique identifier for this incident. - -#### jobKey? - -```ts -optional jobKey: JobKey; -``` - -The job key, if exists, associated with this incident. - -#### processDefinitionId? - -```ts -optional processDefinitionId: ProcessDefinitionId; -``` - -The process definition ID associated to this incident. - -#### processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKey; -``` - -The process definition key associated to this incident. - -#### processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKey; -``` - -The process instance key associated to this incident. - -#### rootProcessInstanceKey? - -```ts -optional rootProcessInstanceKey: ProcessInstanceKey; -``` - -#### state? - -```ts -optional state: IncidentStateEnum; -``` - -#### tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant ID of the incident. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsData.md new file mode 100644 index 00000000000..8e85e4128d2 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsData.md @@ -0,0 +1,54 @@ +--- +title: "Type Alias: GetJobErrorStatisticsData" +sidebar_label: "GetJobErrorStatisticsData" +mdx: + format: md +--- + +# Type Alias: GetJobErrorStatisticsData + +```ts +type GetJobErrorStatisticsData = object; +``` + +Defined in: [gen/types.gen.ts:12221](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12221) + +## Properties + +### body + +```ts +body: JobErrorStatisticsQuery; +``` + +Defined in: [gen/types.gen.ts:12222](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12222) + +--- + +### path? + +```ts +optional path: never; +``` + +Defined in: [gen/types.gen.ts:12223](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12223) + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:12224](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12224) + +--- + +### url + +```ts +url: "/jobs/statistics/errors"; +``` + +Defined in: [gen/types.gen.ts:12225](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12225) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsError.md new file mode 100644 index 00000000000..df6176f8c7c --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetJobErrorStatisticsError" +sidebar_label: "GetJobErrorStatisticsError" +mdx: + format: md +--- + +# Type Alias: GetJobErrorStatisticsError + +```ts +type GetJobErrorStatisticsError = + GetJobErrorStatisticsErrors[keyof GetJobErrorStatisticsErrors]; +``` + +Defined in: [gen/types.gen.ts:12247](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12247) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsErrors.md new file mode 100644 index 00000000000..876cad356db --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsErrors.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: GetJobErrorStatisticsErrors" +sidebar_label: "GetJobErrorStatisticsErrors" +mdx: + format: md +--- + +# Type Alias: GetJobErrorStatisticsErrors + +```ts +type GetJobErrorStatisticsErrors = object; +``` + +Defined in: [gen/types.gen.ts:12228](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12228) + +## Properties + +### 400 + +```ts +400: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12232](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12232) + +The provided data is not valid. + +--- + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12236](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12236) + +The request lacks valid authentication credentials. + +--- + +### 403 + +```ts +403: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12240](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12240) + +Forbidden. The request is not allowed. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12244](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12244) + +An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsResponse.md new file mode 100644 index 00000000000..5aad7b4497c --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetJobErrorStatisticsResponse" +sidebar_label: "GetJobErrorStatisticsResponse" +mdx: + format: md +--- + +# Type Alias: GetJobErrorStatisticsResponse + +```ts +type GetJobErrorStatisticsResponse = + GetJobErrorStatisticsResponses[keyof GetJobErrorStatisticsResponses]; +``` + +Defined in: [gen/types.gen.ts:12256](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12256) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsResponses.md new file mode 100644 index 00000000000..a8295203a91 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobErrorStatisticsResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: GetJobErrorStatisticsResponses" +sidebar_label: "GetJobErrorStatisticsResponses" +mdx: + format: md +--- + +# Type Alias: GetJobErrorStatisticsResponses + +```ts +type GetJobErrorStatisticsResponses = object; +``` + +Defined in: [gen/types.gen.ts:12249](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12249) + +## Properties + +### 200 + +```ts +200: JobErrorStatisticsQueryResult; +``` + +Defined in: [gen/types.gen.ts:12253](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12253) + +The job error statistics result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsData.md new file mode 100644 index 00000000000..e638804f1fc --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsData.md @@ -0,0 +1,54 @@ +--- +title: "Type Alias: GetJobTimeSeriesStatisticsData" +sidebar_label: "GetJobTimeSeriesStatisticsData" +mdx: + format: md +--- + +# Type Alias: GetJobTimeSeriesStatisticsData + +```ts +type GetJobTimeSeriesStatisticsData = object; +``` + +Defined in: [gen/types.gen.ts:12184](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12184) + +## Properties + +### body + +```ts +body: JobTimeSeriesStatisticsQuery; +``` + +Defined in: [gen/types.gen.ts:12185](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12185) + +--- + +### path? + +```ts +optional path: never; +``` + +Defined in: [gen/types.gen.ts:12186](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12186) + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:12187](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12187) + +--- + +### url + +```ts +url: "/jobs/statistics/time-series"; +``` + +Defined in: [gen/types.gen.ts:12188](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12188) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsError.md new file mode 100644 index 00000000000..d9ddd31ef2e --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetJobTimeSeriesStatisticsError" +sidebar_label: "GetJobTimeSeriesStatisticsError" +mdx: + format: md +--- + +# Type Alias: GetJobTimeSeriesStatisticsError + +```ts +type GetJobTimeSeriesStatisticsError = + GetJobTimeSeriesStatisticsErrors[keyof GetJobTimeSeriesStatisticsErrors]; +``` + +Defined in: [gen/types.gen.ts:12210](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12210) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsErrors.md new file mode 100644 index 00000000000..1994bf410f6 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsErrors.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: GetJobTimeSeriesStatisticsErrors" +sidebar_label: "GetJobTimeSeriesStatisticsErrors" +mdx: + format: md +--- + +# Type Alias: GetJobTimeSeriesStatisticsErrors + +```ts +type GetJobTimeSeriesStatisticsErrors = object; +``` + +Defined in: [gen/types.gen.ts:12191](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12191) + +## Properties + +### 400 + +```ts +400: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12195](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12195) + +The provided data is not valid. + +--- + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12199) + +The request lacks valid authentication credentials. + +--- + +### 403 + +```ts +403: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12203](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12203) + +Forbidden. The request is not allowed. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12207](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12207) + +An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsResponse.md new file mode 100644 index 00000000000..72d28be71ed --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetJobTimeSeriesStatisticsResponse" +sidebar_label: "GetJobTimeSeriesStatisticsResponse" +mdx: + format: md +--- + +# Type Alias: GetJobTimeSeriesStatisticsResponse + +```ts +type GetJobTimeSeriesStatisticsResponse = + GetJobTimeSeriesStatisticsResponses[keyof GetJobTimeSeriesStatisticsResponses]; +``` + +Defined in: [gen/types.gen.ts:12219](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12219) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsResponses.md new file mode 100644 index 00000000000..a0483ed609b --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTimeSeriesStatisticsResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: GetJobTimeSeriesStatisticsResponses" +sidebar_label: "GetJobTimeSeriesStatisticsResponses" +mdx: + format: md +--- + +# Type Alias: GetJobTimeSeriesStatisticsResponses + +```ts +type GetJobTimeSeriesStatisticsResponses = object; +``` + +Defined in: [gen/types.gen.ts:12212](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12212) + +## Properties + +### 200 + +```ts +200: JobTimeSeriesStatisticsQueryResult; +``` + +Defined in: [gen/types.gen.ts:12216](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12216) + +The job time-series statistics result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsData.md new file mode 100644 index 00000000000..71e9cac7c2e --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsData.md @@ -0,0 +1,54 @@ +--- +title: "Type Alias: GetJobTypeStatisticsData" +sidebar_label: "GetJobTypeStatisticsData" +mdx: + format: md +--- + +# Type Alias: GetJobTypeStatisticsData + +```ts +type GetJobTypeStatisticsData = object; +``` + +Defined in: [gen/types.gen.ts:12110](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12110) + +## Properties + +### body + +```ts +body: JobTypeStatisticsQuery; +``` + +Defined in: [gen/types.gen.ts:12111](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12111) + +--- + +### path? + +```ts +optional path: never; +``` + +Defined in: [gen/types.gen.ts:12112](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12112) + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:12113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12113) + +--- + +### url + +```ts +url: "/jobs/statistics/by-types"; +``` + +Defined in: [gen/types.gen.ts:12114](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12114) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsError.md new file mode 100644 index 00000000000..cd1472dfb1a --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetJobTypeStatisticsError" +sidebar_label: "GetJobTypeStatisticsError" +mdx: + format: md +--- + +# Type Alias: GetJobTypeStatisticsError + +```ts +type GetJobTypeStatisticsError = + GetJobTypeStatisticsErrors[keyof GetJobTypeStatisticsErrors]; +``` + +Defined in: [gen/types.gen.ts:12136](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12136) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsErrors.md new file mode 100644 index 00000000000..ae934ce2df4 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsErrors.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: GetJobTypeStatisticsErrors" +sidebar_label: "GetJobTypeStatisticsErrors" +mdx: + format: md +--- + +# Type Alias: GetJobTypeStatisticsErrors + +```ts +type GetJobTypeStatisticsErrors = object; +``` + +Defined in: [gen/types.gen.ts:12117](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12117) + +## Properties + +### 400 + +```ts +400: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12121](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12121) + +The provided data is not valid. + +--- + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12125](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12125) + +The request lacks valid authentication credentials. + +--- + +### 403 + +```ts +403: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12129](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12129) + +Forbidden. The request is not allowed. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12133](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12133) + +An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsResponse.md new file mode 100644 index 00000000000..85c6b24f675 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetJobTypeStatisticsResponse" +sidebar_label: "GetJobTypeStatisticsResponse" +mdx: + format: md +--- + +# Type Alias: GetJobTypeStatisticsResponse + +```ts +type GetJobTypeStatisticsResponse = + GetJobTypeStatisticsResponses[keyof GetJobTypeStatisticsResponses]; +``` + +Defined in: [gen/types.gen.ts:12145](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12145) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsResponses.md new file mode 100644 index 00000000000..4a9cf738e25 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobTypeStatisticsResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: GetJobTypeStatisticsResponses" +sidebar_label: "GetJobTypeStatisticsResponses" +mdx: + format: md +--- + +# Type Alias: GetJobTypeStatisticsResponses + +```ts +type GetJobTypeStatisticsResponses = object; +``` + +Defined in: [gen/types.gen.ts:12138](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12138) + +## Properties + +### 200 + +```ts +200: JobTypeStatisticsQueryResult; +``` + +Defined in: [gen/types.gen.ts:12142](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12142) + +The job type statistics result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsData.md new file mode 100644 index 00000000000..8613e2fa4e6 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsData.md @@ -0,0 +1,54 @@ +--- +title: "Type Alias: GetJobWorkerStatisticsData" +sidebar_label: "GetJobWorkerStatisticsData" +mdx: + format: md +--- + +# Type Alias: GetJobWorkerStatisticsData + +```ts +type GetJobWorkerStatisticsData = object; +``` + +Defined in: [gen/types.gen.ts:12147](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12147) + +## Properties + +### body + +```ts +body: JobWorkerStatisticsQuery; +``` + +Defined in: [gen/types.gen.ts:12148](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12148) + +--- + +### path? + +```ts +optional path: never; +``` + +Defined in: [gen/types.gen.ts:12149](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12149) + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:12150](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12150) + +--- + +### url + +```ts +url: "/jobs/statistics/by-workers"; +``` + +Defined in: [gen/types.gen.ts:12151](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12151) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsError.md new file mode 100644 index 00000000000..36da3d81621 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetJobWorkerStatisticsError" +sidebar_label: "GetJobWorkerStatisticsError" +mdx: + format: md +--- + +# Type Alias: GetJobWorkerStatisticsError + +```ts +type GetJobWorkerStatisticsError = + GetJobWorkerStatisticsErrors[keyof GetJobWorkerStatisticsErrors]; +``` + +Defined in: [gen/types.gen.ts:12173](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12173) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsErrors.md new file mode 100644 index 00000000000..b1aaa728eb2 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsErrors.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: GetJobWorkerStatisticsErrors" +sidebar_label: "GetJobWorkerStatisticsErrors" +mdx: + format: md +--- + +# Type Alias: GetJobWorkerStatisticsErrors + +```ts +type GetJobWorkerStatisticsErrors = object; +``` + +Defined in: [gen/types.gen.ts:12154](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12154) + +## Properties + +### 400 + +```ts +400: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12158](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12158) + +The provided data is not valid. + +--- + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12162](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12162) + +The request lacks valid authentication credentials. + +--- + +### 403 + +```ts +403: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12166) + +Forbidden. The request is not allowed. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:12170](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12170) + +An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsResponse.md new file mode 100644 index 00000000000..67ab70abcca --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetJobWorkerStatisticsResponse" +sidebar_label: "GetJobWorkerStatisticsResponse" +mdx: + format: md +--- + +# Type Alias: GetJobWorkerStatisticsResponse + +```ts +type GetJobWorkerStatisticsResponse = + GetJobWorkerStatisticsResponses[keyof GetJobWorkerStatisticsResponses]; +``` + +Defined in: [gen/types.gen.ts:12182](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12182) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsResponses.md new file mode 100644 index 00000000000..41b7f4ff1d4 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetJobWorkerStatisticsResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: GetJobWorkerStatisticsResponses" +sidebar_label: "GetJobWorkerStatisticsResponses" +mdx: + format: md +--- + +# Type Alias: GetJobWorkerStatisticsResponses + +```ts +type GetJobWorkerStatisticsResponses = object; +``` + +Defined in: [gen/types.gen.ts:12175](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12175) + +## Properties + +### 200 + +```ts +200: JobWorkerStatisticsQueryResult; +``` + +Defined in: [gen/types.gen.ts:12179](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12179) + +The job worker statistics result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseData.md index e7fdcbb8fc3..2532b46ca48 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseData.md @@ -11,7 +11,7 @@ mdx: type GetLicenseData = object; ``` -Defined in: [gen/types.gen.ts:12184](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12184) +Defined in: [gen/types.gen.ts:12258](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12258) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12184](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:12185](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12185) +Defined in: [gen/types.gen.ts:12259](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12259) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12185](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:12186](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12186) +Defined in: [gen/types.gen.ts:12260](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12260) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:12186](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:12187](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12187) +Defined in: [gen/types.gen.ts:12261](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12261) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:12187](https://github.com/camunda/orchestration-cl url: "/license"; ``` -Defined in: [gen/types.gen.ts:12188](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12188) +Defined in: [gen/types.gen.ts:12262](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12262) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseError.md index 93e1e982026..c8770224929 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseError.md @@ -11,4 +11,4 @@ mdx: type GetLicenseError = GetLicenseErrors[keyof GetLicenseErrors]; ``` -Defined in: [gen/types.gen.ts:12198](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12198) +Defined in: [gen/types.gen.ts:12272](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12272) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseErrors.md index 4718e3e97ce..defd443d95f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseErrors.md @@ -11,7 +11,7 @@ mdx: type GetLicenseErrors = object; ``` -Defined in: [gen/types.gen.ts:12191](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12191) +Defined in: [gen/types.gen.ts:12265](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12265) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12191](https://github.com/camunda/orchestration-cl 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12195](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12195) +Defined in: [gen/types.gen.ts:12269](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12269) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseResponse.md index 0c2125a1978..550c8b1f25f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseResponse.md @@ -11,4 +11,4 @@ mdx: type GetLicenseResponse = GetLicenseResponses[keyof GetLicenseResponses]; ``` -Defined in: [gen/types.gen.ts:12207](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12207) +Defined in: [gen/types.gen.ts:12281](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12281) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseResponses.md index 19c08451257..d7eba0e6766 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetLicenseResponses.md @@ -11,7 +11,7 @@ mdx: type GetLicenseResponses = object; ``` -Defined in: [gen/types.gen.ts:12200](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12200) +Defined in: [gen/types.gen.ts:12274](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12274) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12200](https://github.com/camunda/orchestration-cl 200: LicenseResponse; ``` -Defined in: [gen/types.gen.ts:12204](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12204) +Defined in: [gen/types.gen.ts:12278](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12278) Obtains the current status of the Camunda license. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleData.md index 3d6334eeae6..64deb816336 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleData.md @@ -11,7 +11,7 @@ mdx: type GetMappingRuleData = object; ``` -Defined in: [gen/types.gen.ts:12328](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12328) +Defined in: [gen/types.gen.ts:12407](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12407) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12328](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:12329](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12329) +Defined in: [gen/types.gen.ts:12408](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12408) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12329](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:12330](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12330) +Defined in: [gen/types.gen.ts:12409](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12409) #### mappingRuleId @@ -49,7 +49,7 @@ The ID of the mapping rule to get. optional query: never; ``` -Defined in: [gen/types.gen.ts:12336](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12336) +Defined in: [gen/types.gen.ts:12415](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12415) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:12336](https://github.com/camunda/orchestration-cl url: "/mapping-rules/{mappingRuleId}"; ``` -Defined in: [gen/types.gen.ts:12337](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12337) +Defined in: [gen/types.gen.ts:12416](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12416) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleError.md index eed155b48ae..a8fe1c9ae05 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleError.md @@ -11,4 +11,4 @@ mdx: type GetMappingRuleError = GetMappingRuleErrors[keyof GetMappingRuleErrors]; ``` -Defined in: [gen/types.gen.ts:12355](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12355) +Defined in: [gen/types.gen.ts:12434](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12434) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleErrors.md index 1206cf71396..45b006a40b8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleErrors.md @@ -11,7 +11,7 @@ mdx: type GetMappingRuleErrors = object; ``` -Defined in: [gen/types.gen.ts:12340](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12340) +Defined in: [gen/types.gen.ts:12419](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12419) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12340](https://github.com/camunda/orchestration-cl 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12344](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12344) +Defined in: [gen/types.gen.ts:12423](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12423) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12348](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12348) +Defined in: [gen/types.gen.ts:12427](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12427) The mapping rule with the mappingRuleId was not found. @@ -45,6 +45,6 @@ The mapping rule with the mappingRuleId was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12352](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12352) +Defined in: [gen/types.gen.ts:12431](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12431) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleResponse.md index d20e6f925d8..2c5df134c23 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleResponse.md @@ -12,4 +12,4 @@ type GetMappingRuleResponse = GetMappingRuleResponses[keyof GetMappingRuleResponses]; ``` -Defined in: [gen/types.gen.ts:12364](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12364) +Defined in: [gen/types.gen.ts:12443](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12443) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleResponses.md index ba0da196f8d..7fc7252bb52 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetMappingRuleResponses.md @@ -11,7 +11,7 @@ mdx: type GetMappingRuleResponses = object; ``` -Defined in: [gen/types.gen.ts:12357](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12357) +Defined in: [gen/types.gen.ts:12436](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12436) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12357](https://github.com/camunda/orchestration-cl 200: MappingRuleResult; ``` -Defined in: [gen/types.gen.ts:12361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12361) +Defined in: [gen/types.gen.ts:12440](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12440) The mapping rule was returned successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionData.md index 1ba07b055b1..d7f6a4a502a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionData.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionData = object; ``` -Defined in: [gen/types.gen.ts:12831](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12831) +Defined in: [gen/types.gen.ts:12718](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12718) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12831](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:12832](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12832) +Defined in: [gen/types.gen.ts:12719](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12719) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12832](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:12833](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12833) +Defined in: [gen/types.gen.ts:12720](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12720) #### processDefinitionKey @@ -49,7 +49,7 @@ The assigned key of the process definition, which acts as a unique identifier fo optional query: never; ``` -Defined in: [gen/types.gen.ts:12840](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12840) +Defined in: [gen/types.gen.ts:12727](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12727) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:12840](https://github.com/camunda/orchestration-cl url: "/process-definitions/{processDefinitionKey}"; ``` -Defined in: [gen/types.gen.ts:12841](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12841) +Defined in: [gen/types.gen.ts:12728](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12728) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionError.md index 97e29c3ac25..46cec76e3c3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionError.md @@ -12,4 +12,4 @@ type GetProcessDefinitionError = GetProcessDefinitionErrors[keyof GetProcessDefinitionErrors]; ``` -Defined in: [gen/types.gen.ts:12868](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12868) +Defined in: [gen/types.gen.ts:12755](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12755) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionErrors.md index 0ea5d59ce5e..e229c2490a9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionErrors = object; ``` -Defined in: [gen/types.gen.ts:12844](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12844) +Defined in: [gen/types.gen.ts:12731](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12731) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12844](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12848](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12848) +Defined in: [gen/types.gen.ts:12735](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12735) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12852](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12852) +Defined in: [gen/types.gen.ts:12739](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12739) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12856](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12856) +Defined in: [gen/types.gen.ts:12743](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12743) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12861](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12861) +Defined in: [gen/types.gen.ts:12748](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12748) The process definition with the given key was not found. More details are provided in the response body. @@ -69,6 +69,6 @@ The process definition with the given key was not found. More details are provid 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12865](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12865) +Defined in: [gen/types.gen.ts:12752](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12752) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsData.md index e62e68c95fd..a877ac9be73 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsData.md @@ -11,31 +11,17 @@ mdx: type GetProcessDefinitionInstanceStatisticsData = object; ``` -Defined in: [gen/types.gen.ts:12782](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12782) +Defined in: [gen/types.gen.ts:12681](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12681) ## Properties ### body? ```ts -optional body: object; +optional body: ProcessDefinitionInstanceStatisticsQuery; ``` -Defined in: [gen/types.gen.ts:12783](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12783) - -#### page? - -```ts -optional page: OffsetPagination; -``` - -#### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:12682](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12682) --- @@ -45,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:12796](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12796) +Defined in: [gen/types.gen.ts:12683](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12683) --- @@ -55,7 +41,7 @@ Defined in: [gen/types.gen.ts:12796](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:12797](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12797) +Defined in: [gen/types.gen.ts:12684](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12684) --- @@ -65,4 +51,4 @@ Defined in: [gen/types.gen.ts:12797](https://github.com/camunda/orchestration-cl url: "/process-definitions/statistics/process-instances"; ``` -Defined in: [gen/types.gen.ts:12798](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12798) +Defined in: [gen/types.gen.ts:12685](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12685) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsError.md index 87476b444bc..ca152e73956 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsError.md @@ -12,4 +12,4 @@ type GetProcessDefinitionInstanceStatisticsError = GetProcessDefinitionInstanceStatisticsErrors[keyof GetProcessDefinitionInstanceStatisticsErrors]; ``` -Defined in: [gen/types.gen.ts:12820](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12820) +Defined in: [gen/types.gen.ts:12707](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12707) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsErrors.md index 0c2953a5f06..4ee92d4345c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionInstanceStatisticsErrors = object; ``` -Defined in: [gen/types.gen.ts:12801](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12801) +Defined in: [gen/types.gen.ts:12688](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12688) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12801](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12805](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12805) +Defined in: [gen/types.gen.ts:12692](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12692) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12809](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12809) +Defined in: [gen/types.gen.ts:12696](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12696) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12813](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12813) +Defined in: [gen/types.gen.ts:12700](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12700) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12817](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12817) +Defined in: [gen/types.gen.ts:12704](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12704) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsResponse.md index 1093ace4379..4608ccf6a16 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsResponse.md @@ -12,4 +12,4 @@ type GetProcessDefinitionInstanceStatisticsResponse = GetProcessDefinitionInstanceStatisticsResponses[keyof GetProcessDefinitionInstanceStatisticsResponses]; ``` -Defined in: [gen/types.gen.ts:12829](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12829) +Defined in: [gen/types.gen.ts:12716](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12716) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsResponses.md index 086d2dedc54..503446cef33 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceStatisticsResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionInstanceStatisticsResponses = object; ``` -Defined in: [gen/types.gen.ts:12822](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12822) +Defined in: [gen/types.gen.ts:12709](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12709) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12822](https://github.com/camunda/orchestration-cl 200: ProcessDefinitionInstanceStatisticsQueryResult; ``` -Defined in: [gen/types.gen.ts:12826](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12826) +Defined in: [gen/types.gen.ts:12713](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12713) The process definition instance statistic result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsData.md index 586c8132610..02f0e1a463e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsData.md @@ -11,41 +11,17 @@ mdx: type GetProcessDefinitionInstanceVersionStatisticsData = object; ``` -Defined in: [gen/types.gen.ts:13156](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13156) +Defined in: [gen/types.gen.ts:12911](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12911) ## Properties ### body ```ts -body: object; +body: ProcessDefinitionInstanceVersionStatisticsQuery; ``` -Defined in: [gen/types.gen.ts:13157](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13157) - -#### filter - -```ts -filter: ProcessDefinitionInstanceVersionStatisticsFilter; -``` - -The process definition instance version statistics search filters. - -#### page? - -```ts -optional page: OffsetPagination; -``` - -Pagination criteria. - -#### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:12912](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12912) --- @@ -55,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:13177](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13177) +Defined in: [gen/types.gen.ts:12913](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12913) --- @@ -65,7 +41,7 @@ Defined in: [gen/types.gen.ts:13177](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:13178](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13178) +Defined in: [gen/types.gen.ts:12914](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12914) --- @@ -75,4 +51,4 @@ Defined in: [gen/types.gen.ts:13178](https://github.com/camunda/orchestration-cl url: "/process-definitions/statistics/process-instances-by-version"; ``` -Defined in: [gen/types.gen.ts:13179](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13179) +Defined in: [gen/types.gen.ts:12915](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12915) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsError.md index 1e99e272919..4bd294884f9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsError.md @@ -12,4 +12,4 @@ type GetProcessDefinitionInstanceVersionStatisticsError = GetProcessDefinitionInstanceVersionStatisticsErrors[keyof GetProcessDefinitionInstanceVersionStatisticsErrors]; ``` -Defined in: [gen/types.gen.ts:13201](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13201) +Defined in: [gen/types.gen.ts:12937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12937) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsErrors.md index 1dcde1d518c..61615311c9c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionInstanceVersionStatisticsErrors = object; ``` -Defined in: [gen/types.gen.ts:13182](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13182) +Defined in: [gen/types.gen.ts:12918](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12918) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13182](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13186](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13186) +Defined in: [gen/types.gen.ts:12922](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12922) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13190) +Defined in: [gen/types.gen.ts:12926](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12926) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13194](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13194) +Defined in: [gen/types.gen.ts:12930](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12930) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13198](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13198) +Defined in: [gen/types.gen.ts:12934](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12934) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsResponse.md index f87fcb18c0b..13bc09334fd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsResponse.md @@ -12,4 +12,4 @@ type GetProcessDefinitionInstanceVersionStatisticsResponse = GetProcessDefinitionInstanceVersionStatisticsResponses[keyof GetProcessDefinitionInstanceVersionStatisticsResponses]; ``` -Defined in: [gen/types.gen.ts:13210](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13210) +Defined in: [gen/types.gen.ts:12946](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12946) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsResponses.md index a1443dd2a48..0497530498a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionInstanceVersionStatisticsResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionInstanceVersionStatisticsResponses = object; ``` -Defined in: [gen/types.gen.ts:13203](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13203) +Defined in: [gen/types.gen.ts:12939](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12939) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13203](https://github.com/camunda/orchestration-cl 200: ProcessDefinitionInstanceVersionStatisticsQueryResult; ``` -Defined in: [gen/types.gen.ts:13207](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13207) +Defined in: [gen/types.gen.ts:12943](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12943) The process definition instance version statistic result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsData.md index e167e3678b6..7b361d3fdef 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsData.md @@ -11,119 +11,17 @@ mdx: type GetProcessDefinitionMessageSubscriptionStatisticsData = object; ``` -Defined in: [gen/types.gen.ts:12694](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12694) +Defined in: [gen/types.gen.ts:12644](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12644) ## Properties ### body? ```ts -optional body: object; +optional body: ProcessDefinitionMessageSubscriptionStatisticsQuery; ``` -Defined in: [gen/types.gen.ts:12695](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12695) - -#### filter? - -```ts -optional filter: object; -``` - -Message subscription search filter. - -##### filter.correlationKey? - -```ts -optional correlationKey: StringFilterProperty; -``` - -The correlation key of the message subscription. - -##### filter.elementId? - -```ts -optional elementId: StringFilterProperty; -``` - -The element ID associated with this message subscription. - -##### filter.elementInstanceKey? - -```ts -optional elementInstanceKey: ElementInstanceKeyFilterProperty; -``` - -The element instance key associated with this message subscription. - -##### filter.lastUpdatedDate? - -```ts -optional lastUpdatedDate: DateTimeFilterProperty; -``` - -The last updated date of the message subscription. - -##### filter.messageName? - -```ts -optional messageName: StringFilterProperty; -``` - -The name of the message associated with the message subscription. - -##### filter.messageSubscriptionKey? - -```ts -optional messageSubscriptionKey: MessageSubscriptionKeyFilterProperty; -``` - -The message subscription key associated with this message subscription. - -##### filter.messageSubscriptionState? - -```ts -optional messageSubscriptionState: MessageSubscriptionStateFilterProperty; -``` - -The message subscription state. - -##### filter.processDefinitionId? - -```ts -optional processDefinitionId: StringFilterProperty; -``` - -The process definition ID associated with this message subscription. - -##### filter.processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKeyFilterProperty; -``` - -The process definition key associated with this correlated message subscription. This only works for data created with 8.9 and later. - -##### filter.processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKeyFilterProperty; -``` - -The process instance key associated with this message subscription. - -##### filter.tenantId? - -```ts -optional tenantId: StringFilterProperty; -``` - -The unique external tenant ID. - -#### page? - -```ts -optional page: CursorForwardPagination; -``` +Defined in: [gen/types.gen.ts:12645](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12645) --- @@ -133,7 +31,7 @@ optional page: CursorForwardPagination; optional path: never; ``` -Defined in: [gen/types.gen.ts:12747](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12747) +Defined in: [gen/types.gen.ts:12646](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12646) --- @@ -143,7 +41,7 @@ Defined in: [gen/types.gen.ts:12747](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:12748](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12748) +Defined in: [gen/types.gen.ts:12647](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12647) --- @@ -153,4 +51,4 @@ Defined in: [gen/types.gen.ts:12748](https://github.com/camunda/orchestration-cl url: "/process-definitions/statistics/message-subscriptions"; ``` -Defined in: [gen/types.gen.ts:12749](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12749) +Defined in: [gen/types.gen.ts:12648](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12648) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsError.md index 6b74203d8d5..135e774cf3e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsError.md @@ -12,4 +12,4 @@ type GetProcessDefinitionMessageSubscriptionStatisticsError = GetProcessDefinitionMessageSubscriptionStatisticsErrors[keyof GetProcessDefinitionMessageSubscriptionStatisticsErrors]; ``` -Defined in: [gen/types.gen.ts:12771](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12771) +Defined in: [gen/types.gen.ts:12670](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12670) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsErrors.md index 23622075f3e..a3af5d0503f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionMessageSubscriptionStatisticsErrors = object; ``` -Defined in: [gen/types.gen.ts:12752](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12752) +Defined in: [gen/types.gen.ts:12651](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12651) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12752](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12756](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12756) +Defined in: [gen/types.gen.ts:12655](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12655) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12760](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12760) +Defined in: [gen/types.gen.ts:12659](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12659) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12764](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12764) +Defined in: [gen/types.gen.ts:12663](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12663) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12768](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12768) +Defined in: [gen/types.gen.ts:12667](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12667) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsResponse.md index 984dc129244..16e7857c8ee 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsResponse.md @@ -12,4 +12,4 @@ type GetProcessDefinitionMessageSubscriptionStatisticsResponse = GetProcessDefinitionMessageSubscriptionStatisticsResponses[keyof GetProcessDefinitionMessageSubscriptionStatisticsResponses]; ``` -Defined in: [gen/types.gen.ts:12780](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12780) +Defined in: [gen/types.gen.ts:12679](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12679) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsResponses.md index 2d74c7ebc70..467e9d06b46 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionMessageSubscriptionStatisticsResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionMessageSubscriptionStatisticsResponses = object; ``` -Defined in: [gen/types.gen.ts:12773](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12773) +Defined in: [gen/types.gen.ts:12672](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12672) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12773](https://github.com/camunda/orchestration-cl 200: ProcessDefinitionMessageSubscriptionStatisticsQueryResult; ``` -Defined in: [gen/types.gen.ts:12777](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12777) +Defined in: [gen/types.gen.ts:12676](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12676) The process definition message subscription statistics result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionResponse.md index 5e936a2c86b..7437ae9d9b9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionResponse.md @@ -12,4 +12,4 @@ type GetProcessDefinitionResponse = GetProcessDefinitionResponses[keyof GetProcessDefinitionResponses]; ``` -Defined in: [gen/types.gen.ts:12877](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12877) +Defined in: [gen/types.gen.ts:12764](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12764) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionResponses.md index e0c5ec14f54..22a5c7706b7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionResponses = object; ``` -Defined in: [gen/types.gen.ts:12870](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12870) +Defined in: [gen/types.gen.ts:12757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12757) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12870](https://github.com/camunda/orchestration-cl 200: ProcessDefinitionResult; ``` -Defined in: [gen/types.gen.ts:12874](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12874) +Defined in: [gen/types.gen.ts:12761](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12761) The process definition is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsData.md index 04d37106b56..680a9ed6931 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsData.md @@ -11,199 +11,17 @@ mdx: type GetProcessDefinitionStatisticsData = object; ``` -Defined in: [gen/types.gen.ts:12952](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12952) +Defined in: [gen/types.gen.ts:12816](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12816) ## Properties ### body? ```ts -optional body: object; +optional body: ProcessDefinitionElementStatisticsQuery; ``` -Defined in: [gen/types.gen.ts:12956](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12956) - -Process definition element statistics request. - -#### filter? - -```ts -optional filter: object & object; -``` - -Process definition statistics search filter. - -##### Type Declaration - -###### batchOperationId? - -```ts -optional batchOperationId: StringFilterProperty; -``` - -The batch operation id. - -###### elementId? - -```ts -optional elementId: StringFilterProperty; -``` - -The element id associated with the process instance. - -###### elementInstanceState? - -```ts -optional elementInstanceState: ElementInstanceStateFilterProperty; -``` - -The state of the element instances associated with the process instance. - -###### endDate? - -```ts -optional endDate: DateTimeFilterProperty; -``` - -The end date. - -###### errorMessage? - -```ts -optional errorMessage: StringFilterProperty; -``` - -The error message related to the process. - -###### hasElementInstanceIncident? - -```ts -optional hasElementInstanceIncident: boolean; -``` - -Whether the element instance has an incident or not. - -###### hasIncident? - -```ts -optional hasIncident: boolean; -``` - -Whether this process instance has a related incident or not. - -###### hasRetriesLeft? - -```ts -optional hasRetriesLeft: boolean; -``` - -Whether the process has failed jobs with retries left. - -###### incidentErrorHashCode? - -```ts -optional incidentErrorHashCode: IntegerFilterProperty; -``` - -The incident error hash code, associated with this process. - -###### parentElementInstanceKey? - -```ts -optional parentElementInstanceKey: ElementInstanceKeyFilterProperty; -``` - -The parent element instance key. - -###### parentProcessInstanceKey? - -```ts -optional parentProcessInstanceKey: ProcessInstanceKeyFilterProperty; -``` - -The parent process instance key. - -###### processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKeyFilterProperty; -``` - -The key of this process instance. - -###### startDate? - -```ts -optional startDate: DateTimeFilterProperty; -``` - -The start date. - -###### state? - -```ts -optional state: ProcessInstanceStateFilterProperty; -``` - -The process instance state. - -###### tags? - -```ts -optional tags: TagSet; -``` - -###### tenantId? - -```ts -optional tenantId: StringFilterProperty; -``` - -The tenant id. - -###### variables? - -```ts -optional variables: VariableValueFilterProperty[]; -``` - -The process instance variables. - -##### Type Declaration - -###### $or? - -```ts -optional $or: 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. +Defined in: [gen/types.gen.ts:12817](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12817) --- @@ -213,7 +31,7 @@ Note: Using complex `$or` conditions may impact performance, use with caution in path: object; ``` -Defined in: [gen/types.gen.ts:13063](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13063) +Defined in: [gen/types.gen.ts:12818](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12818) #### processDefinitionKey @@ -231,7 +49,7 @@ The assigned key of the process definition, which acts as a unique identifier fo optional query: never; ``` -Defined in: [gen/types.gen.ts:13069](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13069) +Defined in: [gen/types.gen.ts:12824](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12824) --- @@ -241,4 +59,4 @@ Defined in: [gen/types.gen.ts:13069](https://github.com/camunda/orchestration-cl url: "/process-definitions/{processDefinitionKey}/statistics/element-instances"; ``` -Defined in: [gen/types.gen.ts:13070](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13070) +Defined in: [gen/types.gen.ts:12825](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12825) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsError.md index 3ecbd07a2d0..d29b89b8cf0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsError.md @@ -12,4 +12,4 @@ type GetProcessDefinitionStatisticsError = GetProcessDefinitionStatisticsErrors[keyof GetProcessDefinitionStatisticsErrors]; ``` -Defined in: [gen/types.gen.ts:13092](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13092) +Defined in: [gen/types.gen.ts:12847](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12847) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsErrors.md index 289f7bb2af6..f1ea5db91ca 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionStatisticsErrors = object; ``` -Defined in: [gen/types.gen.ts:13073](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13073) +Defined in: [gen/types.gen.ts:12828](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12828) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13073](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13077](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13077) +Defined in: [gen/types.gen.ts:12832](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12832) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13081](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13081) +Defined in: [gen/types.gen.ts:12836](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12836) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13085](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13085) +Defined in: [gen/types.gen.ts:12840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12840) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13089](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13089) +Defined in: [gen/types.gen.ts:12844](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12844) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsResponse.md index f44991b81d3..76fa6479c19 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsResponse.md @@ -12,4 +12,4 @@ type GetProcessDefinitionStatisticsResponse = GetProcessDefinitionStatisticsResponses[keyof GetProcessDefinitionStatisticsResponses]; ``` -Defined in: [gen/types.gen.ts:13101](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13101) +Defined in: [gen/types.gen.ts:12856](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12856) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsResponses.md index abd2c3c618b..a12b146bfa9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionStatisticsResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionStatisticsResponses = object; ``` -Defined in: [gen/types.gen.ts:13094](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13094) +Defined in: [gen/types.gen.ts:12849](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12849) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13094](https://github.com/camunda/orchestration-cl 200: ProcessDefinitionElementStatisticsQueryResult; ``` -Defined in: [gen/types.gen.ts:13098](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13098) +Defined in: [gen/types.gen.ts:12853](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12853) The process definition statistics result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlData.md index 3bceeb588d3..9b10d8d46a5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlData.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionXmlData = object; ``` -Defined in: [gen/types.gen.ts:13103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13103) +Defined in: [gen/types.gen.ts:12858](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12858) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13103](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:13104](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13104) +Defined in: [gen/types.gen.ts:12859](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12859) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:13104](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:13105](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13105) +Defined in: [gen/types.gen.ts:12860](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12860) #### processDefinitionKey @@ -49,7 +49,7 @@ The assigned key of the process definition, which acts as a unique identifier fo optional query: never; ``` -Defined in: [gen/types.gen.ts:13112](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13112) +Defined in: [gen/types.gen.ts:12867](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12867) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:13112](https://github.com/camunda/orchestration-cl url: "/process-definitions/{processDefinitionKey}/xml"; ``` -Defined in: [gen/types.gen.ts:13113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13113) +Defined in: [gen/types.gen.ts:12868](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12868) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlError.md index 77c9fc64314..3ec415594e6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlError.md @@ -12,4 +12,4 @@ type GetProcessDefinitionXmlError = GetProcessDefinitionXmlErrors[keyof GetProcessDefinitionXmlErrors]; ``` -Defined in: [gen/types.gen.ts:13141](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13141) +Defined in: [gen/types.gen.ts:12896](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12896) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlErrors.md index 41304b863d3..1553d0897dd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionXmlErrors = object; ``` -Defined in: [gen/types.gen.ts:13116](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13116) +Defined in: [gen/types.gen.ts:12871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12871) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13116](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13120](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13120) +Defined in: [gen/types.gen.ts:12875](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12875) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13124](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13124) +Defined in: [gen/types.gen.ts:12879](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12879) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13128](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13128) +Defined in: [gen/types.gen.ts:12883](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12883) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13134](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13134) +Defined in: [gen/types.gen.ts:12889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12889) The process definition with the given key was not found. More details are provided in the response body. @@ -70,6 +70,6 @@ More details are provided in the response body. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13138](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13138) +Defined in: [gen/types.gen.ts:12893](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12893) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlResponse.md index c8a0a10483f..ffc979377d5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlResponse.md @@ -12,4 +12,4 @@ type GetProcessDefinitionXmlResponse = GetProcessDefinitionXmlResponses[keyof GetProcessDefinitionXmlResponses]; ``` -Defined in: [gen/types.gen.ts:13154](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13154) +Defined in: [gen/types.gen.ts:12909](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12909) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlResponses.md index 4dab8468dca..6bdde837a17 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessDefinitionXmlResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessDefinitionXmlResponses = object; ``` -Defined in: [gen/types.gen.ts:13143](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13143) +Defined in: [gen/types.gen.ts:12898](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12898) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13143](https://github.com/camunda/orchestration-cl 200: string; ``` -Defined in: [gen/types.gen.ts:13147](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13147) +Defined in: [gen/types.gen.ts:12902](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12902) The XML of the process definition is successfully returned. @@ -33,6 +33,6 @@ The XML of the process definition is successfully returned. 204: string; ``` -Defined in: [gen/types.gen.ts:13151](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13151) +Defined in: [gen/types.gen.ts:12906](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12906) The process definition was found but does not have XML. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyData.md index a0c579a2b5a..44194e8c4a1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyData.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceCallHierarchyData = object; ``` -Defined in: [gen/types.gen.ts:13880](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13880) +Defined in: [gen/types.gen.ts:13271](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13271) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13880](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:13881](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13881) +Defined in: [gen/types.gen.ts:13272](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13272) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:13881](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:13882](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13882) +Defined in: [gen/types.gen.ts:13273](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13273) #### processInstanceKey @@ -49,7 +49,7 @@ The key of the process instance to fetch the hierarchy for. optional query: never; ``` -Defined in: [gen/types.gen.ts:13888](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13888) +Defined in: [gen/types.gen.ts:13279](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13279) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:13888](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}/call-hierarchy"; ``` -Defined in: [gen/types.gen.ts:13889](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13889) +Defined in: [gen/types.gen.ts:13280](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13280) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyError.md index b8536b21b4a..d6228dfc15b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyError.md @@ -12,4 +12,4 @@ type GetProcessInstanceCallHierarchyError = GetProcessInstanceCallHierarchyErrors[keyof GetProcessInstanceCallHierarchyErrors]; ``` -Defined in: [gen/types.gen.ts:13915](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13915) +Defined in: [gen/types.gen.ts:13306](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13306) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyErrors.md index 5f3486730ac..32cbd040d76 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceCallHierarchyErrors = object; ``` -Defined in: [gen/types.gen.ts:13892](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13892) +Defined in: [gen/types.gen.ts:13283](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13283) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13892](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13896](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13896) +Defined in: [gen/types.gen.ts:13287](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13287) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13900) +Defined in: [gen/types.gen.ts:13291](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13291) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13904](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13904) +Defined in: [gen/types.gen.ts:13295](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13295) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13908](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13908) +Defined in: [gen/types.gen.ts:13299](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13299) The process instance is not found. @@ -69,6 +69,6 @@ The process instance is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13912](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13912) +Defined in: [gen/types.gen.ts:13303](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13303) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyResponse.md index e7c692c76d1..2e7365f27b9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyResponse.md @@ -12,4 +12,4 @@ type GetProcessInstanceCallHierarchyResponse = GetProcessInstanceCallHierarchyResponses[keyof GetProcessInstanceCallHierarchyResponses]; ``` -Defined in: [gen/types.gen.ts:13924](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13924) +Defined in: [gen/types.gen.ts:13315](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13315) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyResponses.md index 3a9546a4388..119c0c74232 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceCallHierarchyResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceCallHierarchyResponses = object; ``` -Defined in: [gen/types.gen.ts:13917](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13917) +Defined in: [gen/types.gen.ts:13308](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13308) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13917](https://github.com/camunda/orchestration-cl 200: ProcessInstanceCallHierarchyEntry[]; ``` -Defined in: [gen/types.gen.ts:13921](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13921) +Defined in: [gen/types.gen.ts:13312](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13312) The call hierarchy is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceData.md index 27521fe8fe3..07e898fe965 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceData.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceData = object; ``` -Defined in: [gen/types.gen.ts:13797](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13797) +Defined in: [gen/types.gen.ts:13225](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13225) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13797](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:13798](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13798) +Defined in: [gen/types.gen.ts:13226](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13226) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:13798](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:13799](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13799) +Defined in: [gen/types.gen.ts:13227](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13227) #### processInstanceKey @@ -49,7 +49,7 @@ The process instance key. optional query: never; ``` -Defined in: [gen/types.gen.ts:13805](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13805) +Defined in: [gen/types.gen.ts:13233](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13233) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:13805](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}"; ``` -Defined in: [gen/types.gen.ts:13806](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13806) +Defined in: [gen/types.gen.ts:13234](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13234) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceError.md index b443f43b3b0..b30f9061761 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceError.md @@ -12,4 +12,4 @@ type GetProcessInstanceError = GetProcessInstanceErrors[keyof GetProcessInstanceErrors]; ``` -Defined in: [gen/types.gen.ts:13832](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13832) +Defined in: [gen/types.gen.ts:13260](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13260) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceErrors.md index b23a09875ee..fbb74323a16 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceErrors = object; ``` -Defined in: [gen/types.gen.ts:13809](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13809) +Defined in: [gen/types.gen.ts:13237](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13237) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13809](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13813](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13813) +Defined in: [gen/types.gen.ts:13241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13241) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13817](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13817) +Defined in: [gen/types.gen.ts:13245](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13245) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13821](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13821) +Defined in: [gen/types.gen.ts:13249](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13249) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13825](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13825) +Defined in: [gen/types.gen.ts:13253](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13253) The process instance with the given key was not found. @@ -69,6 +69,6 @@ The process instance with the given key was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13829](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13829) +Defined in: [gen/types.gen.ts:13257](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13257) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceResponse.md index 1a8cb92c88d..0e0d0e1fde4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceResponse.md @@ -12,4 +12,4 @@ type GetProcessInstanceResponse = GetProcessInstanceResponses[keyof GetProcessInstanceResponses]; ``` -Defined in: [gen/types.gen.ts:13878](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13878) +Defined in: [gen/types.gen.ts:13269](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13269) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceResponses.md index 5e258a64603..c32da5d1daf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceResponses.md @@ -11,120 +11,16 @@ mdx: type GetProcessInstanceResponses = object; ``` -Defined in: [gen/types.gen.ts:13834](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13834) +Defined in: [gen/types.gen.ts:13262](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13262) ## Properties ### 200 ```ts -200: object; +200: ProcessInstanceResult; ``` -Defined in: [gen/types.gen.ts:13838](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13838) +Defined in: [gen/types.gen.ts:13266](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13266) -Process instance search response item. - -#### endDate? - -```ts -optional endDate: string; -``` - -#### hasIncident - -```ts -hasIncident: boolean; -``` - -Whether this process instance has a related incident or not. - -#### parentElementInstanceKey? - -```ts -optional parentElementInstanceKey: ElementInstanceKey; -``` - -The parent element instance key. - -#### parentProcessInstanceKey? - -```ts -optional parentProcessInstanceKey: ProcessInstanceKey; -``` - -The parent process instance key. - -#### processDefinitionId - -```ts -processDefinitionId: ProcessDefinitionId; -``` - -#### processDefinitionKey - -```ts -processDefinitionKey: ProcessDefinitionKey; -``` - -The process definition key. - -#### processDefinitionName - -```ts -processDefinitionName: string; -``` - -The process definition name. - -#### processDefinitionVersion - -```ts -processDefinitionVersion: number; -``` - -#### processDefinitionVersionTag? - -```ts -optional processDefinitionVersionTag: string; -``` - -The process definition version tag. - -#### processInstanceKey - -```ts -processInstanceKey: ProcessInstanceKey; -``` - -The key of this process instance. - -#### rootProcessInstanceKey? - -```ts -optional rootProcessInstanceKey: ProcessInstanceKey; -``` - -#### startDate - -```ts -startDate: string; -``` - -#### state - -```ts -state: ProcessInstanceStateEnum; -``` - -#### tags? - -```ts -optional tags: TagSet; -``` - -#### tenantId - -```ts -tenantId: TenantId; -``` +The process instance is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsData.md index 71108b13478..201348f847d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsData.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceSequenceFlowsData = object; ``` -Defined in: [gen/types.gen.ts:14282](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14282) +Defined in: [gen/types.gen.ts:13605](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13605) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14282](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14283) +Defined in: [gen/types.gen.ts:13606](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13606) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14283](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14284](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14284) +Defined in: [gen/types.gen.ts:13607](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13607) #### processInstanceKey @@ -49,7 +49,7 @@ The assigned key of the process instance, which acts as a unique identifier for optional query: never; ``` -Defined in: [gen/types.gen.ts:14290](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14290) +Defined in: [gen/types.gen.ts:13613](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13613) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:14290](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}/sequence-flows"; ``` -Defined in: [gen/types.gen.ts:14291](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14291) +Defined in: [gen/types.gen.ts:13614](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13614) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsError.md index 065dd9eeeab..232035a7be9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsError.md @@ -12,4 +12,4 @@ type GetProcessInstanceSequenceFlowsError = GetProcessInstanceSequenceFlowsErrors[keyof GetProcessInstanceSequenceFlowsErrors]; ``` -Defined in: [gen/types.gen.ts:14313](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14313) +Defined in: [gen/types.gen.ts:13636](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13636) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsErrors.md index 700b10eddff..655ea8ee95c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceSequenceFlowsErrors = object; ``` -Defined in: [gen/types.gen.ts:14294](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14294) +Defined in: [gen/types.gen.ts:13617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13617) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14294](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14298](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14298) +Defined in: [gen/types.gen.ts:13621](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13621) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14302](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14302) +Defined in: [gen/types.gen.ts:13625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13625) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14306](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14306) +Defined in: [gen/types.gen.ts:13629](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13629) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14310](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14310) +Defined in: [gen/types.gen.ts:13633](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13633) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsResponse.md index 26ab446d6c5..c40fc5b626f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsResponse.md @@ -12,4 +12,4 @@ type GetProcessInstanceSequenceFlowsResponse = GetProcessInstanceSequenceFlowsResponses[keyof GetProcessInstanceSequenceFlowsResponses]; ``` -Defined in: [gen/types.gen.ts:14350](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14350) +Defined in: [gen/types.gen.ts:13645](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13645) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsResponses.md index f17aef11016..e703a80f3a3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceSequenceFlowsResponses.md @@ -11,24 +11,16 @@ mdx: type GetProcessInstanceSequenceFlowsResponses = object; ``` -Defined in: [gen/types.gen.ts:14315](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14315) +Defined in: [gen/types.gen.ts:13638](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13638) ## Properties ### 200 ```ts -200: object; +200: ProcessInstanceSequenceFlowsQueryResult; ``` -Defined in: [gen/types.gen.ts:14319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14319) +Defined in: [gen/types.gen.ts:13642](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13642) -Process instance sequence flows query response. - -#### items? - -```ts -optional items: object[]; -``` - -The sequence flows. +The process instance sequence flows result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionData.md index aec15612325..5e850ad2e49 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionData.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceStatisticsByDefinitionData = object; ``` -Defined in: [gen/types.gen.ts:11585](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11585) +Defined in: [gen/types.gen.ts:11711](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11711) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11585](https://github.com/camunda/orchestration-cl body: IncidentProcessInstanceStatisticsByDefinitionQuery; ``` -Defined in: [gen/types.gen.ts:11586](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11586) +Defined in: [gen/types.gen.ts:11712](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11712) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11586](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:11587](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11587) +Defined in: [gen/types.gen.ts:11713](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11713) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:11587](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:11588](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11588) +Defined in: [gen/types.gen.ts:11714](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11714) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:11588](https://github.com/camunda/orchestration-cl url: "/incidents/statistics/process-instances-by-definition"; ``` -Defined in: [gen/types.gen.ts:11589](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11589) +Defined in: [gen/types.gen.ts:11715](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11715) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionError.md index b2022d88b9a..db12c9bdeab 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionError.md @@ -12,4 +12,4 @@ type GetProcessInstanceStatisticsByDefinitionError = GetProcessInstanceStatisticsByDefinitionErrors[keyof GetProcessInstanceStatisticsByDefinitionErrors]; ``` -Defined in: [gen/types.gen.ts:11611](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11611) +Defined in: [gen/types.gen.ts:11737](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11737) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionErrors.md index b7395ad6acf..4e1fbb9f5ba 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceStatisticsByDefinitionErrors = object; ``` -Defined in: [gen/types.gen.ts:11592](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11592) +Defined in: [gen/types.gen.ts:11718](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11718) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11592](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11596](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11596) +Defined in: [gen/types.gen.ts:11722](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11722) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11600](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11600) +Defined in: [gen/types.gen.ts:11726](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11726) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11604](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11604) +Defined in: [gen/types.gen.ts:11730](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11730) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11608](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11608) +Defined in: [gen/types.gen.ts:11734](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11734) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionResponse.md index 0a607cf431f..f97c1462c31 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionResponse.md @@ -12,4 +12,4 @@ type GetProcessInstanceStatisticsByDefinitionResponse = GetProcessInstanceStatisticsByDefinitionResponses[keyof GetProcessInstanceStatisticsByDefinitionResponses]; ``` -Defined in: [gen/types.gen.ts:11622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11622) +Defined in: [gen/types.gen.ts:11748](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11748) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionResponses.md index 9438414f266..1658bf4619d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByDefinitionResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceStatisticsByDefinitionResponses = object; ``` -Defined in: [gen/types.gen.ts:11613](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11613) +Defined in: [gen/types.gen.ts:11739](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11739) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11613](https://github.com/camunda/orchestration-cl 200: IncidentProcessInstanceStatisticsByDefinitionQueryResult; ``` -Defined in: [gen/types.gen.ts:11619](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11619) +Defined in: [gen/types.gen.ts:11745](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11745) The process instance incident statistics grouped by process definition are successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorData.md index ed275c3663e..7bf7d39fb24 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorData.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceStatisticsByErrorData = object; ``` -Defined in: [gen/types.gen.ts:11624](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11624) +Defined in: [gen/types.gen.ts:11750](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11750) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11624](https://github.com/camunda/orchestration-cl optional body: IncidentProcessInstanceStatisticsByErrorQuery; ``` -Defined in: [gen/types.gen.ts:11625](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11625) +Defined in: [gen/types.gen.ts:11751](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11751) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11625](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:11626](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11626) +Defined in: [gen/types.gen.ts:11752](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11752) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:11626](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:11627](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11627) +Defined in: [gen/types.gen.ts:11753](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11753) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:11627](https://github.com/camunda/orchestration-cl url: "/incidents/statistics/process-instances-by-error"; ``` -Defined in: [gen/types.gen.ts:11628](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11628) +Defined in: [gen/types.gen.ts:11754](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11754) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorError.md index 62e72156f76..155d63ca64e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorError.md @@ -12,4 +12,4 @@ type GetProcessInstanceStatisticsByErrorError = GetProcessInstanceStatisticsByErrorErrors[keyof GetProcessInstanceStatisticsByErrorErrors]; ``` -Defined in: [gen/types.gen.ts:11650](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11650) +Defined in: [gen/types.gen.ts:11776](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11776) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorErrors.md index 5ef3aae1077..967d52171b1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceStatisticsByErrorErrors = object; ``` -Defined in: [gen/types.gen.ts:11631](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11631) +Defined in: [gen/types.gen.ts:11757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11757) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11631](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11635](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11635) +Defined in: [gen/types.gen.ts:11761](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11761) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11639](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11639) +Defined in: [gen/types.gen.ts:11765](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11765) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11643) +Defined in: [gen/types.gen.ts:11769](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11769) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11647](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11647) +Defined in: [gen/types.gen.ts:11773](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11773) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorResponse.md index 7e2d87238ad..f2472d21bd7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorResponse.md @@ -12,4 +12,4 @@ type GetProcessInstanceStatisticsByErrorResponse = GetProcessInstanceStatisticsByErrorResponses[keyof GetProcessInstanceStatisticsByErrorResponses]; ``` -Defined in: [gen/types.gen.ts:11661](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11661) +Defined in: [gen/types.gen.ts:11787](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11787) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorResponses.md index 0700f717848..6f827897efa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsByErrorResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceStatisticsByErrorResponses = object; ``` -Defined in: [gen/types.gen.ts:11652](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11652) +Defined in: [gen/types.gen.ts:11778](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11778) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11652](https://github.com/camunda/orchestration-cl 200: IncidentProcessInstanceStatisticsByErrorQueryResult; ``` -Defined in: [gen/types.gen.ts:11658](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11658) +Defined in: [gen/types.gen.ts:11784](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11784) The statistics about process instances with incident, grouped by error hash code are successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsData.md index 24ece29ba59..bbb82bb1db0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsData.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceStatisticsData = object; ``` -Defined in: [gen/types.gen.ts:14352](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14352) +Defined in: [gen/types.gen.ts:13647](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13647) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14352](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14353](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14353) +Defined in: [gen/types.gen.ts:13648](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13648) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14353](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14354](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14354) +Defined in: [gen/types.gen.ts:13649](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13649) #### processInstanceKey @@ -49,7 +49,7 @@ The assigned key of the process instance, which acts as a unique identifier for optional query: never; ``` -Defined in: [gen/types.gen.ts:14360](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14360) +Defined in: [gen/types.gen.ts:13655](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13655) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:14360](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}/statistics/element-instances"; ``` -Defined in: [gen/types.gen.ts:14361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14361) +Defined in: [gen/types.gen.ts:13656](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13656) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsError.md index 056fcd48f74..e08bf003026 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsError.md @@ -12,4 +12,4 @@ type GetProcessInstanceStatisticsError = GetProcessInstanceStatisticsErrors[keyof GetProcessInstanceStatisticsErrors]; ``` -Defined in: [gen/types.gen.ts:14383](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14383) +Defined in: [gen/types.gen.ts:13678](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13678) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsErrors.md index 1d4eab7527f..cac6ce880ef 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsErrors.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceStatisticsErrors = object; ``` -Defined in: [gen/types.gen.ts:14364](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14364) +Defined in: [gen/types.gen.ts:13659](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13659) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14364](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14368](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14368) +Defined in: [gen/types.gen.ts:13663](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13663) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14372](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14372) +Defined in: [gen/types.gen.ts:13667](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13667) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14376](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14376) +Defined in: [gen/types.gen.ts:13671](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13671) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14380](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14380) +Defined in: [gen/types.gen.ts:13675](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13675) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsResponse.md index 2b7d05cb7d3..d15b03441ee 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsResponse.md @@ -12,4 +12,4 @@ type GetProcessInstanceStatisticsResponse = GetProcessInstanceStatisticsResponses[keyof GetProcessInstanceStatisticsResponses]; ``` -Defined in: [gen/types.gen.ts:14392](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14392) +Defined in: [gen/types.gen.ts:13687](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13687) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsResponses.md index 81dbdf27be9..7271a46b93d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetProcessInstanceStatisticsResponses.md @@ -11,7 +11,7 @@ mdx: type GetProcessInstanceStatisticsResponses = object; ``` -Defined in: [gen/types.gen.ts:14385](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14385) +Defined in: [gen/types.gen.ts:13680](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13680) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14385](https://github.com/camunda/orchestration-cl 200: ProcessInstanceElementStatisticsQueryResult; ``` -Defined in: [gen/types.gen.ts:14389](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14389) +Defined in: [gen/types.gen.ts:13684](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13684) The process instance statistics result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentData.md index 2f235f83be6..0576769e4bc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentData.md @@ -11,7 +11,7 @@ mdx: type GetResourceContentData = object; ``` -Defined in: [gen/types.gen.ts:14428](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14428) +Defined in: [gen/types.gen.ts:13723](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13723) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14428](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14429](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14429) +Defined in: [gen/types.gen.ts:13724](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13724) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14429](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14430](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14430) +Defined in: [gen/types.gen.ts:13725](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13725) #### resourceKey @@ -49,7 +49,7 @@ The unique key identifying the resource. optional query: never; ``` -Defined in: [gen/types.gen.ts:14436](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14436) +Defined in: [gen/types.gen.ts:13731](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13731) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:14436](https://github.com/camunda/orchestration-cl url: "/resources/{resourceKey}/content"; ``` -Defined in: [gen/types.gen.ts:14437](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14437) +Defined in: [gen/types.gen.ts:13732](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13732) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentError.md index 67341359c47..f6632961727 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentError.md @@ -12,4 +12,4 @@ type GetResourceContentError = GetResourceContentErrors[keyof GetResourceContentErrors]; ``` -Defined in: [gen/types.gen.ts:14451](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14451) +Defined in: [gen/types.gen.ts:13746](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13746) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentErrors.md index 29143d32101..eab0f174507 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentErrors.md @@ -11,7 +11,7 @@ mdx: type GetResourceContentErrors = object; ``` -Defined in: [gen/types.gen.ts:14440](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14440) +Defined in: [gen/types.gen.ts:13735](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13735) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14440](https://github.com/camunda/orchestration-cl 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14444](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14444) +Defined in: [gen/types.gen.ts:13739](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13739) A resource with the given key was not found. @@ -33,6 +33,6 @@ A resource with the given key was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14448](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14448) +Defined in: [gen/types.gen.ts:13743](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13743) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentResponse.md index 1edb83e3661..5b512b04d83 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentResponse.md @@ -12,4 +12,4 @@ type GetResourceContentResponse = GetResourceContentResponses[keyof GetResourceContentResponses]; ``` -Defined in: [gen/types.gen.ts:14460](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14460) +Defined in: [gen/types.gen.ts:13755](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13755) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentResponses.md index bddcdffc40b..2c6cfa505da 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceContentResponses.md @@ -11,16 +11,16 @@ mdx: type GetResourceContentResponses = object; ``` -Defined in: [gen/types.gen.ts:14453](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14453) +Defined in: [gen/types.gen.ts:13748](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13748) ## Properties ### 200 ```ts -200: Blob | File; +200: string; ``` -Defined in: [gen/types.gen.ts:14457](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14457) +Defined in: [gen/types.gen.ts:13752](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13752) The resource content is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceData.md index 8c512274354..20777c7b20f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceData.md @@ -11,7 +11,7 @@ mdx: type GetResourceData = object; ``` -Defined in: [gen/types.gen.ts:14394](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14394) +Defined in: [gen/types.gen.ts:13689](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13689) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14394](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14395](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14395) +Defined in: [gen/types.gen.ts:13690](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13690) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14395](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14396](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14396) +Defined in: [gen/types.gen.ts:13691](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13691) #### resourceKey @@ -49,7 +49,7 @@ The unique key identifying the resource. optional query: never; ``` -Defined in: [gen/types.gen.ts:14402](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14402) +Defined in: [gen/types.gen.ts:13697](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13697) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:14402](https://github.com/camunda/orchestration-cl url: "/resources/{resourceKey}"; ``` -Defined in: [gen/types.gen.ts:14403](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14403) +Defined in: [gen/types.gen.ts:13698](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13698) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceError.md index 592b1c086fe..ca5630c8261 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceError.md @@ -11,4 +11,4 @@ mdx: type GetResourceError = GetResourceErrors[keyof GetResourceErrors]; ``` -Defined in: [gen/types.gen.ts:14417](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14417) +Defined in: [gen/types.gen.ts:13712](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13712) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceErrors.md index b8c64928773..774cbe8f3c7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceErrors.md @@ -11,7 +11,7 @@ mdx: type GetResourceErrors = object; ``` -Defined in: [gen/types.gen.ts:14406](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14406) +Defined in: [gen/types.gen.ts:13701](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13701) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14406](https://github.com/camunda/orchestration-cl 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14410](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14410) +Defined in: [gen/types.gen.ts:13705](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13705) A resource with the given key was not found. @@ -33,6 +33,6 @@ A resource with the given key was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14414](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14414) +Defined in: [gen/types.gen.ts:13709](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13709) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceResponse.md index 1e8433b304a..3b3da4eeaf8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceResponse.md @@ -11,4 +11,4 @@ mdx: type GetResourceResponse = GetResourceResponses[keyof GetResourceResponses]; ``` -Defined in: [gen/types.gen.ts:14426](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14426) +Defined in: [gen/types.gen.ts:13721](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13721) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceResponses.md index 6d2541a0d4c..16393f03abc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetResourceResponses.md @@ -11,7 +11,7 @@ mdx: type GetResourceResponses = object; ``` -Defined in: [gen/types.gen.ts:14419](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14419) +Defined in: [gen/types.gen.ts:13714](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13714) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14419](https://github.com/camunda/orchestration-cl 200: ResourceResult; ``` -Defined in: [gen/types.gen.ts:14423](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14423) +Defined in: [gen/types.gen.ts:13718](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13718) The resource is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleData.md index 9f1d7954ba0..e83a35838c1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleData.md @@ -11,7 +11,7 @@ mdx: type GetRoleData = object; ``` -Defined in: [gen/types.gen.ts:14643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14643) +Defined in: [gen/types.gen.ts:13925](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13925) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14643](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14644](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14644) +Defined in: [gen/types.gen.ts:13926](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13926) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14644](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14645](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14645) +Defined in: [gen/types.gen.ts:13927](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13927) #### roleId @@ -49,7 +49,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:14651](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14651) +Defined in: [gen/types.gen.ts:13933](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13933) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:14651](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}"; ``` -Defined in: [gen/types.gen.ts:14652](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14652) +Defined in: [gen/types.gen.ts:13934](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13934) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleError.md index 426ce8ad129..db5f704159c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleError.md @@ -11,4 +11,4 @@ mdx: type GetRoleError = GetRoleErrors[keyof GetRoleErrors]; ``` -Defined in: [gen/types.gen.ts:14674](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14674) +Defined in: [gen/types.gen.ts:13956](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13956) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleErrors.md index c1282378eb6..baef193a577 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleErrors.md @@ -11,7 +11,7 @@ mdx: type GetRoleErrors = object; ``` -Defined in: [gen/types.gen.ts:14655](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14655) +Defined in: [gen/types.gen.ts:13937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13937) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14655](https://github.com/camunda/orchestration-cl 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14659](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14659) +Defined in: [gen/types.gen.ts:13941](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13941) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14663](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14663) +Defined in: [gen/types.gen.ts:13945](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13945) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14667](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14667) +Defined in: [gen/types.gen.ts:13949](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13949) The role with the given ID was not found. @@ -57,6 +57,6 @@ The role with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14671](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14671) +Defined in: [gen/types.gen.ts:13953](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13953) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleResponse.md index 361c660e992..00176ff8249 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleResponse.md @@ -11,4 +11,4 @@ mdx: type GetRoleResponse = GetRoleResponses[keyof GetRoleResponses]; ``` -Defined in: [gen/types.gen.ts:14683](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14683) +Defined in: [gen/types.gen.ts:13965](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13965) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleResponses.md index 39cf97a48ea..8e0cbbb34c2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetRoleResponses.md @@ -11,7 +11,7 @@ mdx: type GetRoleResponses = object; ``` -Defined in: [gen/types.gen.ts:14676](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14676) +Defined in: [gen/types.gen.ts:13958](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13958) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14676](https://github.com/camunda/orchestration-cl 200: RoleResult; ``` -Defined in: [gen/types.gen.ts:14680](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14680) +Defined in: [gen/types.gen.ts:13962](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13962) The role is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormData.md index 50bd1840129..b08b380b4df 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormData.md @@ -11,7 +11,7 @@ mdx: type GetStartProcessFormData = object; ``` -Defined in: [gen/types.gen.ts:12879](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12879) +Defined in: [gen/types.gen.ts:12766](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12766) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12879](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:12880](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12880) +Defined in: [gen/types.gen.ts:12767](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12767) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12880](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:12881](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12881) +Defined in: [gen/types.gen.ts:12768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12768) #### processDefinitionKey @@ -49,7 +49,7 @@ The process key. optional query: never; ``` -Defined in: [gen/types.gen.ts:12887](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12887) +Defined in: [gen/types.gen.ts:12774](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12774) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:12887](https://github.com/camunda/orchestration-cl url: "/process-definitions/{processDefinitionKey}/form"; ``` -Defined in: [gen/types.gen.ts:12888](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12888) +Defined in: [gen/types.gen.ts:12775](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12775) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormError.md index 85d2492c228..f47c9f2405b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormError.md @@ -12,4 +12,4 @@ type GetStartProcessFormError = GetStartProcessFormErrors[keyof GetStartProcessFormErrors]; ``` -Defined in: [gen/types.gen.ts:12914](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12914) +Defined in: [gen/types.gen.ts:12801](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12801) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormErrors.md index 49a412d3718..675d8a8f6aa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormErrors.md @@ -11,7 +11,7 @@ mdx: type GetStartProcessFormErrors = object; ``` -Defined in: [gen/types.gen.ts:12891](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12891) +Defined in: [gen/types.gen.ts:12778](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12778) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12891](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12895](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12895) +Defined in: [gen/types.gen.ts:12782](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12782) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12899](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12899) +Defined in: [gen/types.gen.ts:12786](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12786) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12903](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12903) +Defined in: [gen/types.gen.ts:12790](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12790) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12907](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12907) +Defined in: [gen/types.gen.ts:12794](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12794) Not found @@ -69,6 +69,6 @@ Not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12911](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12911) +Defined in: [gen/types.gen.ts:12798](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12798) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormResponse.md index 18cdb96bd1a..04d801d988f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormResponse.md @@ -12,4 +12,4 @@ type GetStartProcessFormResponse = GetStartProcessFormResponses[keyof GetStartProcessFormResponses]; ``` -Defined in: [gen/types.gen.ts:12950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12950) +Defined in: [gen/types.gen.ts:12814](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12814) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormResponses.md index 49a4268f5b7..957f5ee455c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStartProcessFormResponses.md @@ -11,66 +11,20 @@ mdx: type GetStartProcessFormResponses = object; ``` -Defined in: [gen/types.gen.ts:12916](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12916) +Defined in: [gen/types.gen.ts:12803](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12803) ## Properties ### 200 ```ts -200: object; +200: FormResult; ``` -Defined in: [gen/types.gen.ts:12920](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12920) +Defined in: [gen/types.gen.ts:12807](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12807) The form is successfully returned. -#### formId? - -```ts -optional formId: FormId; -``` - -The user-provided identifier of the form. - -#### formKey? - -```ts -optional formKey: FormKey; -``` - -The assigned key, which acts as a unique identifier for this form. - -#### schema? - -```ts -optional schema: object; -``` - -The form content. - -##### Index Signature - -```ts -[key: string]: unknown -``` - -#### tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant ID of the form. - -#### version? - -```ts -optional version: number; -``` - -The version of the the deployed form. - --- ### 204 @@ -79,6 +33,6 @@ The version of the the deployed form. 204: void; ``` -Defined in: [gen/types.gen.ts:12947](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12947) +Defined in: [gen/types.gen.ts:12811](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12811) The process was found, but no form is associated with it. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusData.md index fbc95a0c95b..81331265531 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusData.md @@ -11,7 +11,7 @@ mdx: type GetStatusData = object; ``` -Defined in: [gen/types.gen.ts:15449](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15449) +Defined in: [gen/types.gen.ts:14742](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14742) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15449](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15450](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15450) +Defined in: [gen/types.gen.ts:14743](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14743) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15450](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:15451](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15451) +Defined in: [gen/types.gen.ts:14744](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14744) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:15451](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:15452](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15452) +Defined in: [gen/types.gen.ts:14745](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14745) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:15452](https://github.com/camunda/orchestration-cl url: "/status"; ``` -Defined in: [gen/types.gen.ts:15453](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15453) +Defined in: [gen/types.gen.ts:14746](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14746) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusErrors.md index 45c2ab11e15..134b7e7009a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusErrors.md @@ -11,7 +11,7 @@ mdx: type GetStatusErrors = object; ``` -Defined in: [gen/types.gen.ts:15456](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15456) +Defined in: [gen/types.gen.ts:14749](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14749) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15456](https://github.com/camunda/orchestration-cl 503: unknown; ``` -Defined in: [gen/types.gen.ts:15460](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15460) +Defined in: [gen/types.gen.ts:14753](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14753) The cluster is DOWN and does not have any partition with a healthy leader. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusResponse.md index 56cc2c9f193..f8ab1b8f579 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusResponse.md @@ -11,4 +11,4 @@ mdx: type GetStatusResponse = GetStatusResponses[keyof GetStatusResponses]; ``` -Defined in: [gen/types.gen.ts:15470](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15470) +Defined in: [gen/types.gen.ts:14763](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14763) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusResponses.md index 70dc0918e7d..f1f6f9a3c42 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetStatusResponses.md @@ -11,7 +11,7 @@ mdx: type GetStatusResponses = object; ``` -Defined in: [gen/types.gen.ts:15463](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15463) +Defined in: [gen/types.gen.ts:14756](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14756) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15463](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15467](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15467) +Defined in: [gen/types.gen.ts:14760](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14760) The cluster is UP and has at least one partition with a healthy leader. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationData.md new file mode 100644 index 00000000000..e59f87f1d63 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationData.md @@ -0,0 +1,54 @@ +--- +title: "Type Alias: GetSystemConfigurationData" +sidebar_label: "GetSystemConfigurationData" +mdx: + format: md +--- + +# Type Alias: GetSystemConfigurationData + +```ts +type GetSystemConfigurationData = object; +``` + +Defined in: [gen/types.gen.ts:14819](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14819) + +## Properties + +### body? + +```ts +optional body: never; +``` + +Defined in: [gen/types.gen.ts:14820](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14820) + +--- + +### path? + +```ts +optional path: never; +``` + +Defined in: [gen/types.gen.ts:14821](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14821) + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:14822](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14822) + +--- + +### url + +```ts +url: "/system/configuration"; +``` + +Defined in: [gen/types.gen.ts:14823](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14823) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationError.md new file mode 100644 index 00000000000..9612c2fe3ed --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetSystemConfigurationError" +sidebar_label: "GetSystemConfigurationError" +mdx: + format: md +--- + +# Type Alias: GetSystemConfigurationError + +```ts +type GetSystemConfigurationError = + GetSystemConfigurationErrors[keyof GetSystemConfigurationErrors]; +``` + +Defined in: [gen/types.gen.ts:14837](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14837) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationErrors.md new file mode 100644 index 00000000000..5938bde7d48 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationErrors.md @@ -0,0 +1,38 @@ +--- +title: "Type Alias: GetSystemConfigurationErrors" +sidebar_label: "GetSystemConfigurationErrors" +mdx: + format: md +--- + +# Type Alias: GetSystemConfigurationErrors + +```ts +type GetSystemConfigurationErrors = object; +``` + +Defined in: [gen/types.gen.ts:14826](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14826) + +## Properties + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:14830](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14830) + +The request lacks valid authentication credentials. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:14834](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14834) + +An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationResponse.md new file mode 100644 index 00000000000..e59c7abeab0 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: GetSystemConfigurationResponse" +sidebar_label: "GetSystemConfigurationResponse" +mdx: + format: md +--- + +# Type Alias: GetSystemConfigurationResponse + +```ts +type GetSystemConfigurationResponse = + GetSystemConfigurationResponses[keyof GetSystemConfigurationResponses]; +``` + +Defined in: [gen/types.gen.ts:14846](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14846) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationResponses.md new file mode 100644 index 00000000000..a0f02abdbba --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetSystemConfigurationResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: GetSystemConfigurationResponses" +sidebar_label: "GetSystemConfigurationResponses" +mdx: + format: md +--- + +# Type Alias: GetSystemConfigurationResponses + +```ts +type GetSystemConfigurationResponses = object; +``` + +Defined in: [gen/types.gen.ts:14839](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14839) + +## Properties + +### 200 + +```ts +200: SystemConfigurationResponse; +``` + +Defined in: [gen/types.gen.ts:14843](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14843) + +Current system configuration grouped by feature area. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableData.md index 8f6a03e1e76..2bcff83fb94 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableData.md @@ -11,7 +11,7 @@ mdx: type GetTenantClusterVariableData = object; ``` -Defined in: [gen/types.gen.ts:8959](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8959) +Defined in: [gen/types.gen.ts:9416](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9416) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8959](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:8960](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8960) +Defined in: [gen/types.gen.ts:9417](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9417) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8960](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8961](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8961) +Defined in: [gen/types.gen.ts:9418](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9418) #### name @@ -57,7 +57,7 @@ The tenant ID optional query: never; ``` -Defined in: [gen/types.gen.ts:8971](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8971) +Defined in: [gen/types.gen.ts:9428](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9428) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:8971](https://github.com/camunda/orchestration-clu url: "/cluster-variables/tenants/{tenantId}/{name}"; ``` -Defined in: [gen/types.gen.ts:8972](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8972) +Defined in: [gen/types.gen.ts:9429](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9429) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableError.md index b58663d2c9f..e5bd1b102df 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableError.md @@ -12,4 +12,4 @@ type GetTenantClusterVariableError = GetTenantClusterVariableErrors[keyof GetTenantClusterVariableErrors]; ``` -Defined in: [gen/types.gen.ts:8998](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8998) +Defined in: [gen/types.gen.ts:9455](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9455) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableErrors.md index c2fd90bc37e..f154dbd7aab 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableErrors.md @@ -11,7 +11,7 @@ mdx: type GetTenantClusterVariableErrors = object; ``` -Defined in: [gen/types.gen.ts:8975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8975) +Defined in: [gen/types.gen.ts:9432](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9432) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8975](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8979](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8979) +Defined in: [gen/types.gen.ts:9436](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9436) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8983](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8983) +Defined in: [gen/types.gen.ts:9440](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9440) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8987](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8987) +Defined in: [gen/types.gen.ts:9444](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9444) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8991](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8991) +Defined in: [gen/types.gen.ts:9448](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9448) Cluster variable not found @@ -69,6 +69,6 @@ Cluster variable not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8995](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8995) +Defined in: [gen/types.gen.ts:9452](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9452) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableResponse.md index 6e82b2187a1..098ab67f5ae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableResponse.md @@ -12,4 +12,4 @@ type GetTenantClusterVariableResponse = GetTenantClusterVariableResponses[keyof GetTenantClusterVariableResponses]; ``` -Defined in: [gen/types.gen.ts:9007](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9007) +Defined in: [gen/types.gen.ts:9464](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9464) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableResponses.md index 52181d33efc..59d4c84d091 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantClusterVariableResponses.md @@ -11,7 +11,7 @@ mdx: type GetTenantClusterVariableResponses = object; ``` -Defined in: [gen/types.gen.ts:9000](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9000) +Defined in: [gen/types.gen.ts:9457](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9457) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9000](https://github.com/camunda/orchestration-clu 200: ClusterVariableResult; ``` -Defined in: [gen/types.gen.ts:9004](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9004) +Defined in: [gen/types.gen.ts:9461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9461) Cluster variable found diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantData.md index f52afab370e..3dcdc97d572 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantData.md @@ -11,7 +11,7 @@ mdx: type GetTenantData = object; ``` -Defined in: [gen/types.gen.ts:15678](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15678) +Defined in: [gen/types.gen.ts:14982](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14982) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15678](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15679](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15679) +Defined in: [gen/types.gen.ts:14983](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14983) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15679](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15680](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15680) +Defined in: [gen/types.gen.ts:14984](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14984) #### tenantId @@ -49,7 +49,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:15686](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15686) +Defined in: [gen/types.gen.ts:14990](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14990) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:15686](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}"; ``` -Defined in: [gen/types.gen.ts:15687](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15687) +Defined in: [gen/types.gen.ts:14991](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14991) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantError.md index df18bc17151..8f1df6bd61c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantError.md @@ -11,4 +11,4 @@ mdx: type GetTenantError = GetTenantErrors[keyof GetTenantErrors]; ``` -Defined in: [gen/types.gen.ts:15713](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15713) +Defined in: [gen/types.gen.ts:15017](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15017) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantErrors.md index b9c492e40da..cc07e683b6a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantErrors.md @@ -11,7 +11,7 @@ mdx: type GetTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:15690](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15690) +Defined in: [gen/types.gen.ts:14994](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14994) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15690](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15694](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15694) +Defined in: [gen/types.gen.ts:14998](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14998) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15698](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15698) +Defined in: [gen/types.gen.ts:15002](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15002) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15702](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15702) +Defined in: [gen/types.gen.ts:15006](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15006) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15706](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15706) +Defined in: [gen/types.gen.ts:15010](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15010) Tenant not found. @@ -69,6 +69,6 @@ Tenant not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15710](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15710) +Defined in: [gen/types.gen.ts:15014](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15014) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantResponse.md index 7eb363239e2..1e570a29acf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantResponse.md @@ -11,4 +11,4 @@ mdx: type GetTenantResponse = GetTenantResponses[keyof GetTenantResponses]; ``` -Defined in: [gen/types.gen.ts:15722](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15722) +Defined in: [gen/types.gen.ts:15026](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15026) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantResponses.md index 4f8333916fb..c34f9fc6d5f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTenantResponses.md @@ -11,7 +11,7 @@ mdx: type GetTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:15715](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15715) +Defined in: [gen/types.gen.ts:15019](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15019) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15715](https://github.com/camunda/orchestration-cl 200: TenantResult; ``` -Defined in: [gen/types.gen.ts:15719](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15719) +Defined in: [gen/types.gen.ts:15023](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15023) The tenant was retrieved successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyData.md index 2e1c1cdb389..d637b8d0d9d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyData.md @@ -11,7 +11,7 @@ mdx: type GetTopologyData = object; ``` -Defined in: [gen/types.gen.ts:16419](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16419) +Defined in: [gen/types.gen.ts:15739](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15739) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16419](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16420](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16420) +Defined in: [gen/types.gen.ts:15740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15740) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16420](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:16421](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16421) +Defined in: [gen/types.gen.ts:15741](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15741) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:16421](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:16422](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16422) +Defined in: [gen/types.gen.ts:15742](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15742) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:16422](https://github.com/camunda/orchestration-cl url: "/topology"; ``` -Defined in: [gen/types.gen.ts:16423](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16423) +Defined in: [gen/types.gen.ts:15743](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15743) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyError.md index 0c97df548b5..c9aebd9185e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyError.md @@ -11,4 +11,4 @@ mdx: type GetTopologyError = GetTopologyErrors[keyof GetTopologyErrors]; ``` -Defined in: [gen/types.gen.ts:16437](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16437) +Defined in: [gen/types.gen.ts:15757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15757) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyErrors.md index e81748ca289..8882ee369a1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyErrors.md @@ -11,7 +11,7 @@ mdx: type GetTopologyErrors = object; ``` -Defined in: [gen/types.gen.ts:16426](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16426) +Defined in: [gen/types.gen.ts:15746](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15746) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16426](https://github.com/camunda/orchestration-cl 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16430](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16430) +Defined in: [gen/types.gen.ts:15750](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15750) The request lacks valid authentication credentials. @@ -33,6 +33,6 @@ The request lacks valid authentication credentials. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16434](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16434) +Defined in: [gen/types.gen.ts:15754](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15754) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyResponse.md index 83197e7b6cf..ea5b6ef8f2a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyResponse.md @@ -11,4 +11,4 @@ mdx: type GetTopologyResponse = GetTopologyResponses[keyof GetTopologyResponses]; ``` -Defined in: [gen/types.gen.ts:16446](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16446) +Defined in: [gen/types.gen.ts:15766](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15766) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyResponses.md index e9fbc63d02a..96a859d89d6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetTopologyResponses.md @@ -11,7 +11,7 @@ mdx: type GetTopologyResponses = object; ``` -Defined in: [gen/types.gen.ts:16439](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16439) +Defined in: [gen/types.gen.ts:15759](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15759) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16439](https://github.com/camunda/orchestration-cl 200: TopologyResponse; ``` -Defined in: [gen/types.gen.ts:16443](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16443) +Defined in: [gen/types.gen.ts:15763](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15763) Obtains the current topology of the cluster the gateway is part of. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsData.md index 34b4e25eef1..9f979620491 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsData.md @@ -11,7 +11,7 @@ mdx: type GetUsageMetricsData = object; ``` -Defined in: [gen/types.gen.ts:15472](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15472) +Defined in: [gen/types.gen.ts:14765](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14765) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15472](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15473](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15473) +Defined in: [gen/types.gen.ts:14766](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14766) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15473](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:15474](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15474) +Defined in: [gen/types.gen.ts:14767](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14767) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:15474](https://github.com/camunda/orchestration-cl query: object; ``` -Defined in: [gen/types.gen.ts:15475](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15475) +Defined in: [gen/types.gen.ts:14768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14768) #### endTime @@ -83,4 +83,4 @@ Whether to return tenant metrics in addition to the total metrics or not. Defaul url: "/system/usage-metrics"; ``` -Defined in: [gen/types.gen.ts:15493](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15493) +Defined in: [gen/types.gen.ts:14786](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14786) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsError.md index 73bddbb0473..dfb1c07428f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsError.md @@ -11,4 +11,4 @@ mdx: type GetUsageMetricsError = GetUsageMetricsErrors[keyof GetUsageMetricsErrors]; ``` -Defined in: [gen/types.gen.ts:15515](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15515) +Defined in: [gen/types.gen.ts:14808](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14808) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsErrors.md index dfd6d073778..5bf12e39e9a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsErrors.md @@ -11,7 +11,7 @@ mdx: type GetUsageMetricsErrors = object; ``` -Defined in: [gen/types.gen.ts:15496](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15496) +Defined in: [gen/types.gen.ts:14789](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14789) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15496](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15500](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15500) +Defined in: [gen/types.gen.ts:14793](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14793) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15504](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15504) +Defined in: [gen/types.gen.ts:14797](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14797) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15508](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15508) +Defined in: [gen/types.gen.ts:14801](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14801) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15512](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15512) +Defined in: [gen/types.gen.ts:14805](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14805) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsResponse.md index 2f3de0ccecc..05627f38202 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsResponse.md @@ -12,4 +12,4 @@ type GetUsageMetricsResponse = GetUsageMetricsResponses[keyof GetUsageMetricsResponses]; ``` -Defined in: [gen/types.gen.ts:15524](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15524) +Defined in: [gen/types.gen.ts:14817](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14817) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsResponses.md index fc5eb1b8f5e..c93574d4c15 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUsageMetricsResponses.md @@ -11,7 +11,7 @@ mdx: type GetUsageMetricsResponses = object; ``` -Defined in: [gen/types.gen.ts:15517](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15517) +Defined in: [gen/types.gen.ts:14810](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14810) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15517](https://github.com/camunda/orchestration-cl 200: UsageMetricsResponse; ``` -Defined in: [gen/types.gen.ts:15521](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15521) +Defined in: [gen/types.gen.ts:14814](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14814) The usage metrics search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserData.md index 0f25aa11f18..f70e8825ac4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserData.md @@ -11,7 +11,7 @@ mdx: type GetUserData = object; ``` -Defined in: [gen/types.gen.ts:16589](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16589) +Defined in: [gen/types.gen.ts:15909](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15909) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16589](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16590](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16590) +Defined in: [gen/types.gen.ts:15910](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15910) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16590](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16591](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16591) +Defined in: [gen/types.gen.ts:15911](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15911) #### username @@ -49,7 +49,7 @@ The username of the user. optional query: never; ``` -Defined in: [gen/types.gen.ts:16597](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16597) +Defined in: [gen/types.gen.ts:15917](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15917) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:16597](https://github.com/camunda/orchestration-cl url: "/users/{username}"; ``` -Defined in: [gen/types.gen.ts:16598](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16598) +Defined in: [gen/types.gen.ts:15918](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15918) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserError.md index 509f54dd9dc..7cbf3c4c7e6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserError.md @@ -11,4 +11,4 @@ mdx: type GetUserError = GetUserErrors[keyof GetUserErrors]; ``` -Defined in: [gen/types.gen.ts:16620](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16620) +Defined in: [gen/types.gen.ts:15940](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15940) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserErrors.md index 9f7d21f6f3d..0a46f67b48b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserErrors.md @@ -11,7 +11,7 @@ mdx: type GetUserErrors = object; ``` -Defined in: [gen/types.gen.ts:16601](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16601) +Defined in: [gen/types.gen.ts:15921](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15921) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16601](https://github.com/camunda/orchestration-cl 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16605](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16605) +Defined in: [gen/types.gen.ts:15925](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15925) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16609](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16609) +Defined in: [gen/types.gen.ts:15929](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15929) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16613](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16613) +Defined in: [gen/types.gen.ts:15933](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15933) The user with the given username was not found. @@ -57,6 +57,6 @@ The user with the given username was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16617](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16617) +Defined in: [gen/types.gen.ts:15937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15937) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserResponse.md index 1f2fba3a1cd..6b876a32cfb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserResponse.md @@ -11,4 +11,4 @@ mdx: type GetUserResponse = GetUserResponses[keyof GetUserResponses]; ``` -Defined in: [gen/types.gen.ts:16629](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16629) +Defined in: [gen/types.gen.ts:15959](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15959) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserResponses.md index dac9c742aec..a1f36f1bd3e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserResponses.md @@ -11,16 +11,38 @@ mdx: type GetUserResponses = object; ``` -Defined in: [gen/types.gen.ts:16622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16622) +Defined in: [gen/types.gen.ts:15942](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15942) ## Properties ### 200 ```ts -200: UserResult; +200: object; ``` -Defined in: [gen/types.gen.ts:16626](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16626) +Defined in: [gen/types.gen.ts:15946](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15946) The user is successfully returned. + +#### email + +```ts +email: string | null; +``` + +The email of the user. + +#### name + +```ts +name: string | null; +``` + +The name of the user. + +#### username + +```ts +username: Username; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskData.md index eede49a150e..cac587bd89b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskData.md @@ -11,7 +11,7 @@ mdx: type GetUserTaskData = object; ``` -Defined in: [gen/types.gen.ts:16898](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16898) +Defined in: [gen/types.gen.ts:16055](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16055) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16898](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16899](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16899) +Defined in: [gen/types.gen.ts:16056](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16056) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16899](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16900) +Defined in: [gen/types.gen.ts:16057](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16057) #### userTaskKey @@ -49,7 +49,7 @@ The user task key. optional query: never; ``` -Defined in: [gen/types.gen.ts:16906](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16906) +Defined in: [gen/types.gen.ts:16063](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16063) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:16906](https://github.com/camunda/orchestration-cl url: "/user-tasks/{userTaskKey}"; ``` -Defined in: [gen/types.gen.ts:16907](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16907) +Defined in: [gen/types.gen.ts:16064](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16064) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskError.md index 2fad452ce87..e853b53a05f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskError.md @@ -11,4 +11,4 @@ mdx: type GetUserTaskError = GetUserTaskErrors[keyof GetUserTaskErrors]; ``` -Defined in: [gen/types.gen.ts:16933](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16933) +Defined in: [gen/types.gen.ts:16090](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16090) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskErrors.md index 1199a6e6944..618b0000d3e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskErrors.md @@ -11,7 +11,7 @@ mdx: type GetUserTaskErrors = object; ``` -Defined in: [gen/types.gen.ts:16910](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16910) +Defined in: [gen/types.gen.ts:16067](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16067) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16910](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16914](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16914) +Defined in: [gen/types.gen.ts:16071](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16071) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16918](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16918) +Defined in: [gen/types.gen.ts:16075](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16075) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16922](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16922) +Defined in: [gen/types.gen.ts:16079](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16079) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16926](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16926) +Defined in: [gen/types.gen.ts:16083](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16083) The user task with the given key was not found. @@ -69,6 +69,6 @@ The user task with the given key was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16930](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16930) +Defined in: [gen/types.gen.ts:16087](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16087) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormData.md index 7ba80609e42..b723fc59b90 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormData.md @@ -11,7 +11,7 @@ mdx: type GetUserTaskFormData = object; ``` -Defined in: [gen/types.gen.ts:17381](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17381) +Defined in: [gen/types.gen.ts:16413](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16413) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17381](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:17382](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17382) +Defined in: [gen/types.gen.ts:16414](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16414) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:17382](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:17383](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17383) +Defined in: [gen/types.gen.ts:16415](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16415) #### userTaskKey @@ -49,7 +49,7 @@ The user task key. optional query: never; ``` -Defined in: [gen/types.gen.ts:17389](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17389) +Defined in: [gen/types.gen.ts:16421](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16421) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:17389](https://github.com/camunda/orchestration-cl url: "/user-tasks/{userTaskKey}/form"; ``` -Defined in: [gen/types.gen.ts:17390](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17390) +Defined in: [gen/types.gen.ts:16422](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16422) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormError.md index ae5af53ccbb..7182fbc1d14 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormError.md @@ -11,4 +11,4 @@ mdx: type GetUserTaskFormError = GetUserTaskFormErrors[keyof GetUserTaskFormErrors]; ``` -Defined in: [gen/types.gen.ts:17416](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17416) +Defined in: [gen/types.gen.ts:16448](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16448) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormErrors.md index ced82b85654..411f7c17c15 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormErrors.md @@ -11,7 +11,7 @@ mdx: type GetUserTaskFormErrors = object; ``` -Defined in: [gen/types.gen.ts:17393](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17393) +Defined in: [gen/types.gen.ts:16425](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16425) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17393](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17397](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17397) +Defined in: [gen/types.gen.ts:16429](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16429) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17401](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17401) +Defined in: [gen/types.gen.ts:16433](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16433) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17405](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17405) +Defined in: [gen/types.gen.ts:16437](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16437) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17409](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17409) +Defined in: [gen/types.gen.ts:16441](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16441) Not found @@ -69,6 +69,6 @@ Not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17413](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17413) +Defined in: [gen/types.gen.ts:16445](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16445) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormResponse.md index 94bd636ee56..bbd2b56f1f1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormResponse.md @@ -12,4 +12,4 @@ type GetUserTaskFormResponse = GetUserTaskFormResponses[keyof GetUserTaskFormResponses]; ``` -Defined in: [gen/types.gen.ts:17452](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17452) +Defined in: [gen/types.gen.ts:16461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16461) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormResponses.md index 4e8068e8fc8..5fc48f14065 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskFormResponses.md @@ -11,66 +11,20 @@ mdx: type GetUserTaskFormResponses = object; ``` -Defined in: [gen/types.gen.ts:17418](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17418) +Defined in: [gen/types.gen.ts:16450](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16450) ## Properties ### 200 ```ts -200: object; +200: FormResult; ``` -Defined in: [gen/types.gen.ts:17422](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17422) +Defined in: [gen/types.gen.ts:16454](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16454) The form is successfully returned. -#### formId? - -```ts -optional formId: FormId; -``` - -The user-provided identifier of the form. - -#### formKey? - -```ts -optional formKey: FormKey; -``` - -The assigned key, which acts as a unique identifier for this form. - -#### schema? - -```ts -optional schema: object; -``` - -The form content. - -##### Index Signature - -```ts -[key: string]: unknown -``` - -#### tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant ID of the form. - -#### version? - -```ts -optional version: number; -``` - -The version of the the deployed form. - --- ### 204 @@ -79,6 +33,6 @@ The version of the the deployed form. 204: void; ``` -Defined in: [gen/types.gen.ts:17449](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17449) +Defined in: [gen/types.gen.ts:16458](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16458) The user task was found, but no form is associated with it. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskResponse.md index 4b6aa6eaf49..d2ae784ae05 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskResponse.md @@ -11,4 +11,4 @@ mdx: type GetUserTaskResponse = GetUserTaskResponses[keyof GetUserTaskResponses]; ``` -Defined in: [gen/types.gen.ts:17029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17029) +Defined in: [gen/types.gen.ts:16099](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16099) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskResponses.md index 0e843ee5a20..8dba5bf7b54 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetUserTaskResponses.md @@ -11,206 +11,16 @@ mdx: type GetUserTaskResponses = object; ``` -Defined in: [gen/types.gen.ts:16935](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16935) +Defined in: [gen/types.gen.ts:16092](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16092) ## Properties ### 200 ```ts -200: object; +200: UserTaskResult; ``` -Defined in: [gen/types.gen.ts:16939](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16939) +Defined in: [gen/types.gen.ts:16096](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16096) The user task is successfully returned. - -#### assignee? - -```ts -optional assignee: string; -``` - -The assignee of the user task. - -#### candidateGroups? - -```ts -optional candidateGroups: string[]; -``` - -The candidate groups for this user task. - -#### candidateUsers? - -```ts -optional candidateUsers: string[]; -``` - -The candidate users for this user task. - -#### completionDate? - -```ts -optional completionDate: string; -``` - -The completion date of a user task. - -#### creationDate? - -```ts -optional creationDate: string; -``` - -The creation date of a user task. - -#### customHeaders? - -```ts -optional customHeaders: object; -``` - -Custom headers for the user task. - -##### Index Signature - -```ts -[key: string]: string -``` - -#### dueDate? - -```ts -optional dueDate: string; -``` - -The due date of a user task. - -#### elementId? - -```ts -optional elementId: ElementId; -``` - -The element ID of the user task. - -#### elementInstanceKey? - -```ts -optional elementInstanceKey: ElementInstanceKey; -``` - -The key of the element instance. - -#### externalFormReference? - -```ts -optional externalFormReference: string; -``` - -The external form reference. - -#### followUpDate? - -```ts -optional followUpDate: string; -``` - -The follow date of a user task. - -#### formKey? - -```ts -optional formKey: FormKey; -``` - -The key of the form. - -#### name? - -```ts -optional name: string; -``` - -The name for this user task. - -#### priority? - -```ts -optional priority: number; -``` - -The priority of a user task. The higher the value the higher the priority. - -#### processDefinitionId? - -```ts -optional processDefinitionId: ProcessDefinitionId; -``` - -The ID of the process definition. - -#### processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKey; -``` - -The key of the process definition. - -#### processDefinitionVersion? - -```ts -optional processDefinitionVersion: number; -``` - -The version of the process definition. - -#### processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKey; -``` - -The key of the process instance. - -#### processName? - -```ts -optional processName: string; -``` - -The name of the process definition. - -#### rootProcessInstanceKey? - -```ts -optional rootProcessInstanceKey: ProcessInstanceKey; -``` - -#### state? - -```ts -optional state: UserTaskStateEnum; -``` - -#### tags? - -```ts -optional tags: TagSet; -``` - -#### tenantId? - -```ts -optional tenantId: TenantId; -``` - -#### userTaskKey? - -```ts -optional userTaskKey: UserTaskKey; -``` - -The key of the user task. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableData.md index bd33d371c5f..2cff719afca 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableData.md @@ -11,7 +11,7 @@ mdx: type GetVariableData = object; ``` -Defined in: [gen/types.gen.ts:17677](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17677) +Defined in: [gen/types.gen.ts:16580](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16580) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17677](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:17678](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17678) +Defined in: [gen/types.gen.ts:16581](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16581) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:17678](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:17679](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17679) +Defined in: [gen/types.gen.ts:16582](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16582) #### variableKey @@ -49,7 +49,7 @@ The variable key. optional query: never; ``` -Defined in: [gen/types.gen.ts:17685](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17685) +Defined in: [gen/types.gen.ts:16588](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16588) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:17685](https://github.com/camunda/orchestration-cl url: "/variables/{variableKey}"; ``` -Defined in: [gen/types.gen.ts:17686](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17686) +Defined in: [gen/types.gen.ts:16589](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16589) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableError.md index e1be0a5af8a..73a5b6fc320 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableError.md @@ -11,4 +11,4 @@ mdx: type GetVariableError = GetVariableErrors[keyof GetVariableErrors]; ``` -Defined in: [gen/types.gen.ts:17712](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17712) +Defined in: [gen/types.gen.ts:16615](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16615) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableErrors.md index b6e8b2ffcf0..cc4f9871ca9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableErrors.md @@ -11,7 +11,7 @@ mdx: type GetVariableErrors = object; ``` -Defined in: [gen/types.gen.ts:17689](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17689) +Defined in: [gen/types.gen.ts:16592](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16592) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17689](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17693](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17693) +Defined in: [gen/types.gen.ts:16596](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16596) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17697](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17697) +Defined in: [gen/types.gen.ts:16600](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16600) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17701](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17701) +Defined in: [gen/types.gen.ts:16604](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16604) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17705](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17705) +Defined in: [gen/types.gen.ts:16608](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16608) Not found @@ -69,6 +69,6 @@ Not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17709](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17709) +Defined in: [gen/types.gen.ts:16612](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16612) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableResponse.md index d19c584fffd..447bc001881 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableResponse.md @@ -11,4 +11,4 @@ mdx: type GetVariableResponse = GetVariableResponses[keyof GetVariableResponses]; ``` -Defined in: [gen/types.gen.ts:17748](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17748) +Defined in: [gen/types.gen.ts:16624](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16624) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableResponses.md index 92fdf25ed69..6d233bcbf40 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GetVariableResponses.md @@ -11,74 +11,16 @@ mdx: type GetVariableResponses = object; ``` -Defined in: [gen/types.gen.ts:17714](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17714) +Defined in: [gen/types.gen.ts:16617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16617) ## Properties ### 200 ```ts -200: object & object; +200: VariableResult; ``` -Defined in: [gen/types.gen.ts:17718](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17718) +Defined in: [gen/types.gen.ts:16621](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16621) -Variable search response item. - -#### Type Declaration - -##### name? - -```ts -optional name: string; -``` - -Name of this variable. - -##### processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKey; -``` - -The key of the process instance of this variable. - -##### rootProcessInstanceKey? - -```ts -optional rootProcessInstanceKey: ProcessInstanceKey; -``` - -##### scopeKey? - -```ts -optional scopeKey: ScopeKey; -``` - -The key of the scope of this variable. - -##### tenantId? - -```ts -optional tenantId: TenantId; -``` - -Tenant ID of this variable. - -##### variableKey? - -```ts -optional variableKey: VariableKey; -``` - -The key for this variable. - -#### Type Declaration - -##### value? - -```ts -optional value: string; -``` - -Full value of this variable. +The variable is successfully returned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalJobStatisticsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalJobStatisticsQueryResult.md index 122c5c2d77e..5e93d512084 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalJobStatisticsQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalJobStatisticsQueryResult.md @@ -11,7 +11,7 @@ mdx: type GlobalJobStatisticsQueryResult = object; ``` -Defined in: [gen/types.gen.ts:3314](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3314) +Defined in: [gen/types.gen.ts:3691](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3691) Global job statistics query result. @@ -23,7 +23,7 @@ Global job statistics query result. completed: StatusMetric; ``` -Defined in: [gen/types.gen.ts:3316](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3316) +Defined in: [gen/types.gen.ts:3693](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3693) --- @@ -33,7 +33,7 @@ Defined in: [gen/types.gen.ts:3316](https://github.com/camunda/orchestration-clu created: StatusMetric; ``` -Defined in: [gen/types.gen.ts:3315](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3315) +Defined in: [gen/types.gen.ts:3692](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3692) --- @@ -43,7 +43,7 @@ Defined in: [gen/types.gen.ts:3315](https://github.com/camunda/orchestration-clu failed: StatusMetric; ``` -Defined in: [gen/types.gen.ts:3317](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3317) +Defined in: [gen/types.gen.ts:3694](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3694) --- @@ -53,6 +53,6 @@ Defined in: [gen/types.gen.ts:3317](https://github.com/camunda/orchestration-clu isIncomplete: boolean; ``` -Defined in: [gen/types.gen.ts:3321](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3321) +Defined in: [gen/types.gen.ts:3698](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3698) True if some data is missing because internal limits were reached and some metrics were not recorded. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerBase.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerBase.md new file mode 100644 index 00000000000..cbe5681ee7a --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerBase.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: GlobalListenerBase" +sidebar_label: "GlobalListenerBase" +mdx: + format: md +--- + +# Type Alias: GlobalListenerBase + +```ts +type GlobalListenerBase = object; +``` + +Defined in: [gen/types.gen.ts:2950](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2950) + +## Properties + +### afterNonGlobal? + +```ts +optional afterNonGlobal: boolean; +``` + +Defined in: [gen/types.gen.ts:2962](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2962) + +Whether the listener should run after model-level listeners. + +--- + +### priority? + +```ts +optional priority: number; +``` + +Defined in: [gen/types.gen.ts:2966](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2966) + +The priority of the listener. Higher priority listeners are executed before lower priority ones. + +--- + +### retries? + +```ts +optional retries: number; +``` + +Defined in: [gen/types.gen.ts:2958](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2958) + +Number of retries for the listener job. + +--- + +### type? + +```ts +optional type: string; +``` + +Defined in: [gen/types.gen.ts:2954](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2954) + +The name of the job type, used as a reference to specify which job workers request the respective listener job. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerId.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerId.md new file mode 100644 index 00000000000..852b8af397c --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerId.md @@ -0,0 +1,16 @@ +--- +title: "Type Alias: GlobalListenerId" +sidebar_label: "GlobalListenerId" +mdx: + format: md +--- + +# Type Alias: GlobalListenerId + +```ts +type GlobalListenerId = CamundaKey<"GlobalListenerId">; +``` + +Defined in: [gen/types.gen.ts:3329](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3329) + +The user-defined id for the global listener diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerSourceEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerSourceEnum.md new file mode 100644 index 00000000000..f3f8f8044ac --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerSourceEnum.md @@ -0,0 +1,16 @@ +--- +title: "Type Alias: GlobalListenerSourceEnum" +sidebar_label: "GlobalListenerSourceEnum" +mdx: + format: md +--- + +# Type Alias: GlobalListenerSourceEnum + +```ts +type GlobalListenerSourceEnum = "CONFIGURATION" | "API"; +``` + +Defined in: [gen/types.gen.ts:2943](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2943) + +How the global listener was defined. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerSourceExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerSourceExactMatch.md new file mode 100644 index 00000000000..e1d3efffb9f --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerSourceExactMatch.md @@ -0,0 +1,18 @@ +--- +title: "Type Alias: GlobalListenerSourceExactMatch" +sidebar_label: "GlobalListenerSourceExactMatch" +mdx: + format: md +--- + +# Type Alias: GlobalListenerSourceExactMatch + +```ts +type GlobalListenerSourceExactMatch = GlobalListenerSourceEnum; +``` + +Defined in: [gen/types.gen.ts:8332](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8332) + +Exact match + +Matches the value exactly. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerSourceFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerSourceFilterProperty.md new file mode 100644 index 00000000000..6bdd673f2f7 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalListenerSourceFilterProperty.md @@ -0,0 +1,18 @@ +--- +title: "Type Alias: GlobalListenerSourceFilterProperty" +sidebar_label: "GlobalListenerSourceFilterProperty" +mdx: + format: md +--- + +# Type Alias: GlobalListenerSourceFilterProperty + +```ts +type GlobalListenerSourceFilterProperty = + | GlobalListenerSourceExactMatch + | AdvancedGlobalListenerSourceFilter; +``` + +Defined in: [gen/types.gen.ts:3050](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3050) + +Global listener source property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerBase.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerBase.md new file mode 100644 index 00000000000..4f338878d4e --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerBase.md @@ -0,0 +1,22 @@ +--- +title: "Type Alias: GlobalTaskListenerBase" +sidebar_label: "GlobalTaskListenerBase" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerBase + +```ts +type GlobalTaskListenerBase = GlobalListenerBase & object; +``` + +Defined in: [gen/types.gen.ts:2969](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2969) + +## Type Declaration + +### eventTypes? + +```ts +optional eventTypes: GlobalTaskListenerEventTypes; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypeEnum.md new file mode 100644 index 00000000000..6c1c43125a0 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypeEnum.md @@ -0,0 +1,22 @@ +--- +title: "Type Alias: GlobalTaskListenerEventTypeEnum" +sidebar_label: "GlobalTaskListenerEventTypeEnum" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerEventTypeEnum + +```ts +type GlobalTaskListenerEventTypeEnum = + | "all" + | "creating" + | "assigning" + | "updating" + | "completing" + | "canceling"; +``` + +Defined in: [gen/types.gen.ts:2948](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2948) + +The event type that triggers the user task listener. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypeExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypeExactMatch.md new file mode 100644 index 00000000000..c4bcb7e3c1f --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypeExactMatch.md @@ -0,0 +1,18 @@ +--- +title: "Type Alias: GlobalTaskListenerEventTypeExactMatch" +sidebar_label: "GlobalTaskListenerEventTypeExactMatch" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerEventTypeExactMatch + +```ts +type GlobalTaskListenerEventTypeExactMatch = GlobalTaskListenerEventTypeEnum; +``` + +Defined in: [gen/types.gen.ts:8339](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8339) + +Exact match + +Matches the value exactly. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypeFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypeFilterProperty.md new file mode 100644 index 00000000000..7e65dee5dae --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypeFilterProperty.md @@ -0,0 +1,18 @@ +--- +title: "Type Alias: GlobalTaskListenerEventTypeFilterProperty" +sidebar_label: "GlobalTaskListenerEventTypeFilterProperty" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerEventTypeFilterProperty + +```ts +type GlobalTaskListenerEventTypeFilterProperty = + | GlobalTaskListenerEventTypeExactMatch + | AdvancedGlobalTaskListenerEventTypeFilter; +``` + +Defined in: [gen/types.gen.ts:3080](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3080) + +Global listener event type property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypes.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypes.md new file mode 100644 index 00000000000..d9de4e536a4 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerEventTypes.md @@ -0,0 +1,16 @@ +--- +title: "Type Alias: GlobalTaskListenerEventTypes" +sidebar_label: "GlobalTaskListenerEventTypes" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerEventTypes + +```ts +type GlobalTaskListenerEventTypes = GlobalTaskListenerEventTypeEnum[]; +``` + +Defined in: [gen/types.gen.ts:2976](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2976) + +List of user task event types that trigger the listener. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerResult.md new file mode 100644 index 00000000000..f6ec5d226b9 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerResult.md @@ -0,0 +1,34 @@ +--- +title: "Type Alias: GlobalTaskListenerResult" +sidebar_label: "GlobalTaskListenerResult" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerResult + +```ts +type GlobalTaskListenerResult = GlobalTaskListenerBase & object; +``` + +Defined in: [gen/types.gen.ts:2985](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2985) + +## Type Declaration + +### eventTypes + +```ts +eventTypes: GlobalTaskListenerEventTypes; +``` + +### id + +```ts +id: GlobalListenerId; +``` + +### source + +```ts +source: GlobalListenerSourceEnum; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQueryFilterRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQueryFilterRequest.md new file mode 100644 index 00000000000..01a45a14194 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQueryFilterRequest.md @@ -0,0 +1,100 @@ +--- +title: "Type Alias: GlobalTaskListenerSearchQueryFilterRequest" +sidebar_label: "GlobalTaskListenerSearchQueryFilterRequest" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerSearchQueryFilterRequest + +```ts +type GlobalTaskListenerSearchQueryFilterRequest = object; +``` + +Defined in: [gen/types.gen.ts:3016](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3016) + +Global listener filter request. + +## Properties + +### afterNonGlobal? + +```ts +optional afterNonGlobal: boolean; +``` + +Defined in: [gen/types.gen.ts:3036](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3036) + +Whether the listener runs after model-level listeners. + +--- + +### eventTypes? + +```ts +optional eventTypes: GlobalTaskListenerEventTypeFilterProperty[]; +``` + +Defined in: [gen/types.gen.ts:3032](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3032) + +Event types of the global listener. + +--- + +### id? + +```ts +optional id: StringFilterProperty; +``` + +Defined in: [gen/types.gen.ts:3020](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3020) + +Id of the global listener. + +--- + +### priority? + +```ts +optional priority: IntegerFilterProperty; +``` + +Defined in: [gen/types.gen.ts:3040](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3040) + +Priority of the global listener. + +--- + +### retries? + +```ts +optional retries: IntegerFilterProperty; +``` + +Defined in: [gen/types.gen.ts:3028](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3028) + +Number of retries of the global listener. + +--- + +### source? + +```ts +optional source: GlobalListenerSourceFilterProperty; +``` + +Defined in: [gen/types.gen.ts:3044](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3044) + +How the global listener was defined. + +--- + +### type? + +```ts +optional type: StringFilterProperty; +``` + +Defined in: [gen/types.gen.ts:3024](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3024) + +Job type of the global listener. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQueryRequest.md new file mode 100644 index 00000000000..cc1669b1e95 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQueryRequest.md @@ -0,0 +1,34 @@ +--- +title: "Type Alias: GlobalTaskListenerSearchQueryRequest" +sidebar_label: "GlobalTaskListenerSearchQueryRequest" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerSearchQueryRequest + +```ts +type GlobalTaskListenerSearchQueryRequest = SearchQueryRequest & object; +``` + +Defined in: [gen/types.gen.ts:2994](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2994) + +Global listener search query request. + +## Type Declaration + +### filter? + +```ts +optional filter: GlobalTaskListenerSearchQueryFilterRequest; +``` + +The global listener search filters. + +### sort? + +```ts +optional sort: GlobalTaskListenerSearchQuerySortRequest[]; +``` + +Sort field criteria. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQueryResult.md new file mode 100644 index 00000000000..f1db51f8b83 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQueryResult.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: GlobalTaskListenerSearchQueryResult" +sidebar_label: "GlobalTaskListenerSearchQueryResult" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerSearchQueryResult + +```ts +type GlobalTaskListenerSearchQueryResult = SearchQueryResponse & object; +``` + +Defined in: [gen/types.gen.ts:3110](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3110) + +Global listener search query response. + +## Type Declaration + +### items + +```ts +items: GlobalTaskListenerResult[]; +``` + +The matching global listeners. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQuerySortRequest.md new file mode 100644 index 00000000000..d3dee7dfc8a --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GlobalTaskListenerSearchQuerySortRequest.md @@ -0,0 +1,36 @@ +--- +title: "Type Alias: GlobalTaskListenerSearchQuerySortRequest" +sidebar_label: "GlobalTaskListenerSearchQuerySortRequest" +mdx: + format: md +--- + +# Type Alias: GlobalTaskListenerSearchQuerySortRequest + +```ts +type GlobalTaskListenerSearchQuerySortRequest = object; +``` + +Defined in: [gen/types.gen.ts:3005](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3005) + +## Properties + +### field + +```ts +field: "id" | "type" | "afterNonGlobal" | "priority" | "source"; +``` + +Defined in: [gen/types.gen.ts:3009](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3009) + +The field to sort by. + +--- + +### order? + +```ts +optional order: SortOrderEnum; +``` + +Defined in: [gen/types.gen.ts:3010](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3010) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientResult.md index 49f7523bc22..ca1303edda1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientResult.md @@ -11,16 +11,16 @@ mdx: type GroupClientResult = object; ``` -Defined in: [gen/types.gen.ts:2930](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2930) +Defined in: [gen/types.gen.ts:3263](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3263) ## Properties -### clientId? +### clientId ```ts -optional clientId: string; +clientId: string; ``` -Defined in: [gen/types.gen.ts:2934](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2934) +Defined in: [gen/types.gen.ts:3267](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3267) The ID of the client. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchQueryRequest.md index ebbf40fe53d..bede1d8e1bc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type GroupClientSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:2944](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2944) +Defined in: [gen/types.gen.ts:3277](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3277) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchQuerySortRequest.md index 2ac266a6f3b..1fc0eb532de 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type GroupClientSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:2951](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2951) +Defined in: [gen/types.gen.ts:3298](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3298) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2951](https://github.com/camunda/orchestration-clu field: "clientId"; ``` -Defined in: [gen/types.gen.ts:2955](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2955) +Defined in: [gen/types.gen.ts:3302](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3302) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:2956](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2956) +Defined in: [gen/types.gen.ts:3303](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3303) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchResult.md index d4e99ab2a05..aa2d93ecc63 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupClientSearchResult.md @@ -11,14 +11,14 @@ mdx: type GroupClientSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:2937](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2937) +Defined in: [gen/types.gen.ts:3270](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3270) ## Type Declaration -### items? +### items ```ts -optional items: GroupClientResult[]; +items: GroupClientResult[]; ``` The matching client IDs. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupCreateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupCreateRequest.md index a0fe8ba2237..3e48da43420 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupCreateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupCreateRequest.md @@ -11,7 +11,7 @@ mdx: type GroupCreateRequest = object; ``` -Defined in: [gen/types.gen.ts:2784](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2784) +Defined in: [gen/types.gen.ts:3117](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3117) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2784](https://github.com/camunda/orchestration-clu optional description: string; ``` -Defined in: [gen/types.gen.ts:2796](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2796) +Defined in: [gen/types.gen.ts:3129](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3129) The description of the new group. @@ -33,7 +33,7 @@ The description of the new group. groupId: string; ``` -Defined in: [gen/types.gen.ts:2788](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2788) +Defined in: [gen/types.gen.ts:3121](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3121) The ID of the new group. @@ -45,6 +45,6 @@ The ID of the new group. name: string; ``` -Defined in: [gen/types.gen.ts:2792](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2792) +Defined in: [gen/types.gen.ts:3125](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3125) The display name of the new group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupCreateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupCreateResult.md index 1a191297a51..9a51edbb747 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupCreateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupCreateResult.md @@ -11,40 +11,40 @@ mdx: type GroupCreateResult = object; ``` -Defined in: [gen/types.gen.ts:2799](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2799) +Defined in: [gen/types.gen.ts:3132](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3132) ## Properties -### description? +### description ```ts -optional description: string; +description: string | null; ``` -Defined in: [gen/types.gen.ts:2811](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2811) +Defined in: [gen/types.gen.ts:3144](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3144) The description of the created group. --- -### groupId? +### groupId ```ts -optional groupId: string; +groupId: string; ``` -Defined in: [gen/types.gen.ts:2803](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2803) +Defined in: [gen/types.gen.ts:3136](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3136) The ID of the created group. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:2807](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2807) +Defined in: [gen/types.gen.ts:3140](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3140) The display name of the created group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupFilter.md index 5e1e1ffef87..ccb488050c1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupFilter.md @@ -11,7 +11,7 @@ mdx: type GroupFilter = object; ``` -Defined in: [gen/types.gen.ts:2883](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2883) +Defined in: [gen/types.gen.ts:3216](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3216) Group filter request @@ -23,7 +23,7 @@ Group filter request optional groupId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:2887](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2887) +Defined in: [gen/types.gen.ts:3220](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3220) The group ID search filters. @@ -35,6 +35,6 @@ The group ID search filters. optional name: string; ``` -Defined in: [gen/types.gen.ts:2891](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2891) +Defined in: [gen/types.gen.ts:3224](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3224) The group name search filters. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupMappingRuleSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupMappingRuleSearchResult.md new file mode 100644 index 00000000000..2bcd87b19a2 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupMappingRuleSearchResult.md @@ -0,0 +1,24 @@ +--- +title: "Type Alias: GroupMappingRuleSearchResult" +sidebar_label: "GroupMappingRuleSearchResult" +mdx: + format: md +--- + +# Type Alias: GroupMappingRuleSearchResult + +```ts +type GroupMappingRuleSearchResult = SearchQueryResponse & object; +``` + +Defined in: [gen/types.gen.ts:3284](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3284) + +## Type Declaration + +### items + +```ts +items: MappingRuleResult[]; +``` + +The matching mapping rules. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupResult.md index 9d2a9977c5c..86c17d19cfc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupResult.md @@ -11,42 +11,42 @@ mdx: type GroupResult = object; ``` -Defined in: [gen/types.gen.ts:2843](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2843) +Defined in: [gen/types.gen.ts:3176](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3176) Group search response item. ## Properties -### description? +### description ```ts -optional description: string; +description: string | null; ``` -Defined in: [gen/types.gen.ts:2855](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2855) +Defined in: [gen/types.gen.ts:3188](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3188) The group description. --- -### groupId? +### groupId ```ts -optional groupId: string; +groupId: string; ``` -Defined in: [gen/types.gen.ts:2851](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2851) +Defined in: [gen/types.gen.ts:3184](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3184) The group ID. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:2847](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2847) +Defined in: [gen/types.gen.ts:3180](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3180) The group name. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupRoleSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupRoleSearchResult.md new file mode 100644 index 00000000000..a7d155d55dc --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupRoleSearchResult.md @@ -0,0 +1,24 @@ +--- +title: "Type Alias: GroupRoleSearchResult" +sidebar_label: "GroupRoleSearchResult" +mdx: + format: md +--- + +# Type Alias: GroupRoleSearchResult + +```ts +type GroupRoleSearchResult = SearchQueryResponse & object; +``` + +Defined in: [gen/types.gen.ts:3291](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3291) + +## Type Declaration + +### items + +```ts +items: RoleResult[]; +``` + +The matching roles. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQueryRequest.md index 40261206a6e..96ff8d38d10 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type GroupSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:2869](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2869) +Defined in: [gen/types.gen.ts:3202](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3202) Group search request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQueryResult.md index 431b8a9f5b7..096e81c213b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQueryResult.md @@ -11,16 +11,16 @@ mdx: type GroupSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:2897](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2897) +Defined in: [gen/types.gen.ts:3230](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3230) Group search response. ## Type Declaration -### items? +### items ```ts -optional items: GroupResult[]; +items: GroupResult[]; ``` The matching groups. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQuerySortRequest.md index 83904c4e730..50a1c2e4750 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type GroupSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:2858](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2858) +Defined in: [gen/types.gen.ts:3191](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3191) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2858](https://github.com/camunda/orchestration-clu field: "name" | "groupId"; ``` -Defined in: [gen/types.gen.ts:2862](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2862) +Defined in: [gen/types.gen.ts:3195](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3195) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:2863](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2863) +Defined in: [gen/types.gen.ts:3196](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3196) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUpdateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUpdateRequest.md index e72fbd5dc93..a7c9c08a0cc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUpdateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUpdateRequest.md @@ -11,7 +11,7 @@ mdx: type GroupUpdateRequest = object; ``` -Defined in: [gen/types.gen.ts:2814](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2814) +Defined in: [gen/types.gen.ts:3147](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3147) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2814](https://github.com/camunda/orchestration-clu optional description: string; ``` -Defined in: [gen/types.gen.ts:2822](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2822) +Defined in: [gen/types.gen.ts:3155](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3155) The new description of the group. @@ -33,6 +33,6 @@ The new description of the group. name: string; ``` -Defined in: [gen/types.gen.ts:2818](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2818) +Defined in: [gen/types.gen.ts:3151](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3151) The new name of the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUpdateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUpdateResult.md index 58afb4b6515..6aa8d39809a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUpdateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUpdateResult.md @@ -11,40 +11,40 @@ mdx: type GroupUpdateResult = object; ``` -Defined in: [gen/types.gen.ts:2825](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2825) +Defined in: [gen/types.gen.ts:3158](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3158) ## Properties -### description? +### description ```ts -optional description: string; +description: string | null; ``` -Defined in: [gen/types.gen.ts:2837](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2837) +Defined in: [gen/types.gen.ts:3170](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3170) The description of the group. --- -### groupId? +### groupId ```ts -optional groupId: string; +groupId: string; ``` -Defined in: [gen/types.gen.ts:2829](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2829) +Defined in: [gen/types.gen.ts:3162](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3162) The unique external group ID. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:2833](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2833) +Defined in: [gen/types.gen.ts:3166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3166) The name of the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserResult.md index 026f82d7c4a..ea61e14d054 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserResult.md @@ -11,14 +11,14 @@ mdx: type GroupUserResult = object; ``` -Defined in: [gen/types.gen.ts:2904](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2904) +Defined in: [gen/types.gen.ts:3237](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3237) ## Properties -### username? +### username ```ts -optional username: Username; +username: Username; ``` -Defined in: [gen/types.gen.ts:2905](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2905) +Defined in: [gen/types.gen.ts:3238](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3238) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchQueryRequest.md index 5780c3ba873..f1d72e4b7d1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type GroupUserSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:2915](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2915) +Defined in: [gen/types.gen.ts:3248](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3248) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchQuerySortRequest.md index 0cd4ea1da05..284a71e454b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type GroupUserSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:2922](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2922) +Defined in: [gen/types.gen.ts:3255](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3255) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:2922](https://github.com/camunda/orchestration-clu field: "username"; ``` -Defined in: [gen/types.gen.ts:2926](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2926) +Defined in: [gen/types.gen.ts:3259](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3259) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:2927](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2927) +Defined in: [gen/types.gen.ts:3260](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3260) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchResult.md index 84539d2279a..57ca8ee1b88 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/GroupUserSearchResult.md @@ -11,14 +11,14 @@ mdx: type GroupUserSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:2908](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2908) +Defined in: [gen/types.gen.ts:3241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3241) ## Type Declaration -### items? +### items ```ts -optional items: GroupUserResult[]; +items: GroupUserResult[]; ``` The matching members. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeEnum.md index b62b2728540..8855ab955bb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeEnum.md @@ -27,6 +27,6 @@ type IncidentErrorTypeEnum = | "UNSPECIFIED"; ``` -Defined in: [gen/types.gen.ts:3101](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3101) +Defined in: [gen/types.gen.ts:3463](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3463) Incident error type with a defined set of values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeExactMatch.md index 77ca90b44b4..3310679d32e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeExactMatch.md @@ -11,7 +11,7 @@ mdx: type IncidentErrorTypeExactMatch = IncidentErrorTypeEnum; ``` -Defined in: [gen/types.gen.ts:7500](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7500) +Defined in: [gen/types.gen.ts:8346](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8346) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeFilterProperty.md index f07bcd48d03..f933db3d744 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentErrorTypeFilterProperty.md @@ -13,6 +13,6 @@ type IncidentErrorTypeFilterProperty = | AdvancedIncidentErrorTypeFilter; ``` -Defined in: [gen/types.gen.ts:3067](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3067) +Defined in: [gen/types.gen.ts:3429](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3429) IncidentErrorTypeEnum with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentFilter.md index fdf12308f1c..b2df582606c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentFilter.md @@ -11,7 +11,7 @@ mdx: type IncidentFilter = object; ``` -Defined in: [gen/types.gen.ts:3013](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3013) +Defined in: [gen/types.gen.ts:3375](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3375) Incident search filter. @@ -23,7 +23,7 @@ Incident search filter. optional creationTime: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:3033](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3033) +Defined in: [gen/types.gen.ts:3395](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3395) Date of incident creation. @@ -35,7 +35,7 @@ Date of incident creation. optional elementId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:3029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3029) +Defined in: [gen/types.gen.ts:3391](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3391) The element ID associated to this incident. @@ -47,7 +47,7 @@ The element ID associated to this incident. optional elementInstanceKey: ElementInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:3057](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3057) +Defined in: [gen/types.gen.ts:3419](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3419) The element instance key associated to this incident. @@ -59,7 +59,7 @@ The element instance key associated to this incident. optional errorMessage: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:3025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3025) +Defined in: [gen/types.gen.ts:3387](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3387) The error message of this incident. @@ -71,7 +71,7 @@ The error message of this incident. optional errorType: IncidentErrorTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:3021](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3021) +Defined in: [gen/types.gen.ts:3383](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3383) Incident error type with a defined set of values. @@ -83,7 +83,7 @@ Incident error type with a defined set of values. optional incidentKey: BasicStringFilterProperty; ``` -Defined in: [gen/types.gen.ts:3045](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3045) +Defined in: [gen/types.gen.ts:3407](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3407) The assigned key, which acts as a unique identifier for this incident. @@ -95,7 +95,7 @@ The assigned key, which acts as a unique identifier for this incident. optional jobKey: JobKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:3061](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3061) +Defined in: [gen/types.gen.ts:3423](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3423) The job key, if exists, associated with this incident. @@ -107,7 +107,7 @@ The job key, if exists, associated with this incident. optional processDefinitionId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:3017](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3017) +Defined in: [gen/types.gen.ts:3379](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3379) The process definition ID associated to this incident. @@ -119,7 +119,7 @@ The process definition ID associated to this incident. optional processDefinitionKey: ProcessDefinitionKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:3049](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3049) +Defined in: [gen/types.gen.ts:3411](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3411) The process definition key associated to this incident. @@ -131,7 +131,7 @@ The process definition key associated to this incident. optional processInstanceKey: ProcessInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:3053](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3053) +Defined in: [gen/types.gen.ts:3415](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3415) The process instance key associated to this incident. @@ -143,7 +143,7 @@ The process instance key associated to this incident. optional state: IncidentStateFilterProperty; ``` -Defined in: [gen/types.gen.ts:3037](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3037) +Defined in: [gen/types.gen.ts:3399](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3399) State of this incident with a defined set of values. @@ -155,6 +155,6 @@ State of this incident with a defined set of values. optional tenantId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:3041](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3041) +Defined in: [gen/types.gen.ts:3403](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3403) The tenant ID of the incident. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentKey.md index fa6fc3d7f8e..1b8f35e7e65 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentKey.md @@ -11,6 +11,6 @@ mdx: type IncidentKey = CamundaKey<"IncidentKey">; ``` -Defined in: [gen/types.gen.ts:4054](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4054) +Defined in: [gen/types.gen.ts:4693](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4693) System-generated key for a incident. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionFilter.md index 53a319d7631..65a9b6b7831 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionFilter.md @@ -11,7 +11,7 @@ mdx: type IncidentProcessInstanceStatisticsByDefinitionFilter = object; ``` -Defined in: [gen/types.gen.ts:3295](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3295) +Defined in: [gen/types.gen.ts:3672](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3672) Filter for the incident process instance statistics by definition query. @@ -23,6 +23,6 @@ Filter for the incident process instance statistics by definition query. errorHashCode: number; ``` -Defined in: [gen/types.gen.ts:3300](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3300) +Defined in: [gen/types.gen.ts:3677](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3677) The error hash code of the incidents to filter the process instance statistics by. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQuery.md index 93e0732a3ef..ad683b8f7ac 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQuery.md @@ -11,7 +11,7 @@ mdx: type IncidentProcessInstanceStatisticsByDefinitionQuery = object; ``` -Defined in: [gen/types.gen.ts:3248](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3248) +Defined in: [gen/types.gen.ts:3625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3625) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:3248](https://github.com/camunda/orchestration-clu filter: IncidentProcessInstanceStatisticsByDefinitionFilter; ``` -Defined in: [gen/types.gen.ts:3252](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3252) +Defined in: [gen/types.gen.ts:3629](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3629) Filter criteria for the aggregated process instance statistics. @@ -33,7 +33,7 @@ Filter criteria for the aggregated process instance statistics. optional page: OffsetPagination; ``` -Defined in: [gen/types.gen.ts:3256](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3256) +Defined in: [gen/types.gen.ts:3633](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3633) Pagination parameters for the aggregated process instance statistics. @@ -45,6 +45,6 @@ Pagination parameters for the aggregated process instance statistics. optional sort: IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest[]; ``` -Defined in: [gen/types.gen.ts:3260](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3260) +Defined in: [gen/types.gen.ts:3637](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3637) Sorting criteria for process instance statistics grouped by process definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQueryResult.md index b37ed8e5faf..c5b8e078d38 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQueryResult.md @@ -12,14 +12,14 @@ type IncidentProcessInstanceStatisticsByDefinitionQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:3263](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3263) +Defined in: [gen/types.gen.ts:3640](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3640) ## Type Declaration -### items? +### items ```ts -optional items: IncidentProcessInstanceStatisticsByDefinitionResult[]; +items: IncidentProcessInstanceStatisticsByDefinitionResult[]; ``` Statistics of active process instances with incidents, grouped by process diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest.md index 1c89838f79d..ab3d3b5b94d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type IncidentProcessInstanceStatisticsByDefinitionQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:3303](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3303) +Defined in: [gen/types.gen.ts:3680](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3680) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:3303](https://github.com/camunda/orchestration-clu field: "activeInstancesWithErrorCount" | "processDefinitionKey" | "tenantId"; ``` -Defined in: [gen/types.gen.ts:3307](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3307) +Defined in: [gen/types.gen.ts:3684](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3684) The aggregated field by which the process instance statistics are sorted. @@ -33,4 +33,4 @@ The aggregated field by which the process instance statistics are sorted. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:3308](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3308) +Defined in: [gen/types.gen.ts:3685](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3685) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionResult.md index 78009e2ddd7..0993030a58a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByDefinitionResult.md @@ -11,71 +11,71 @@ mdx: type IncidentProcessInstanceStatisticsByDefinitionResult = object; ``` -Defined in: [gen/types.gen.ts:3272](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3272) +Defined in: [gen/types.gen.ts:3649](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3649) ## Properties -### activeInstancesWithErrorCount? +### activeInstancesWithErrorCount ```ts -optional activeInstancesWithErrorCount: number; +activeInstancesWithErrorCount: number; ``` -Defined in: [gen/types.gen.ts:3289](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3289) +Defined in: [gen/types.gen.ts:3666](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3666) The number of active process instances that currently have an incident with the specified error hash code. --- -### processDefinitionId? +### processDefinitionId ```ts -optional processDefinitionId: ProcessDefinitionId; +processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:3273](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3273) +Defined in: [gen/types.gen.ts:3650](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3650) --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:3274](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3274) +Defined in: [gen/types.gen.ts:3651](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3651) --- -### processDefinitionName? +### processDefinitionName ```ts -optional processDefinitionName: string; +processDefinitionName: string; ``` -Defined in: [gen/types.gen.ts:3278](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3278) +Defined in: [gen/types.gen.ts:3655](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3655) The name of the process definition. --- -### processDefinitionVersion? +### processDefinitionVersion ```ts -optional processDefinitionVersion: number; +processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:3282](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3282) +Defined in: [gen/types.gen.ts:3659](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3659) The version of the process definition. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:3283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3283) +Defined in: [gen/types.gen.ts:3660](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3660) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQuery.md index 724fe1e01e7..eedd078de8f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQuery.md @@ -11,7 +11,7 @@ mdx: type IncidentProcessInstanceStatisticsByErrorQuery = object; ``` -Defined in: [gen/types.gen.ts:3204](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3204) +Defined in: [gen/types.gen.ts:3581](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3581) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:3204](https://github.com/camunda/orchestration-clu optional page: OffsetPagination; ``` -Defined in: [gen/types.gen.ts:3209](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3209) +Defined in: [gen/types.gen.ts:3586](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3586) Pagination parameters for process instance statistics grouped by incident error. @@ -33,6 +33,6 @@ Pagination parameters for process instance statistics grouped by incident error. optional sort: IncidentProcessInstanceStatisticsByErrorQuerySortRequest[]; ``` -Defined in: [gen/types.gen.ts:3213](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3213) +Defined in: [gen/types.gen.ts:3590](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3590) Sorting criteria for process instance statistics grouped by incident error. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQueryResult.md index 316c9683ef1..999d94dea68 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQueryResult.md @@ -12,14 +12,14 @@ type IncidentProcessInstanceStatisticsByErrorQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:3216](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3216) +Defined in: [gen/types.gen.ts:3593](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3593) ## Type Declaration -### items? +### items ```ts -optional items: IncidentProcessInstanceStatisticsByErrorResult[]; +items: IncidentProcessInstanceStatisticsByErrorResult[]; ``` Statistics of active process instances grouped by incident error. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQuerySortRequest.md index 3a47f207cee..823461136f7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type IncidentProcessInstanceStatisticsByErrorQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:3240](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3240) +Defined in: [gen/types.gen.ts:3617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3617) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:3240](https://github.com/camunda/orchestration-clu field: "errorMessage" | "activeInstancesWithErrorCount"; ``` -Defined in: [gen/types.gen.ts:3244](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3244) +Defined in: [gen/types.gen.ts:3621](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3621) The field to sort the incident error statistics by. @@ -33,4 +33,4 @@ The field to sort the incident error statistics by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:3245](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3245) +Defined in: [gen/types.gen.ts:3622](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3622) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorResult.md index a039a99ace6..f9f3f14bb43 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentProcessInstanceStatisticsByErrorResult.md @@ -11,40 +11,40 @@ mdx: type IncidentProcessInstanceStatisticsByErrorResult = object; ``` -Defined in: [gen/types.gen.ts:3224](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3224) +Defined in: [gen/types.gen.ts:3601](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3601) ## Properties -### activeInstancesWithErrorCount? +### activeInstancesWithErrorCount ```ts -optional activeInstancesWithErrorCount: number; +activeInstancesWithErrorCount: number; ``` -Defined in: [gen/types.gen.ts:3237](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3237) +Defined in: [gen/types.gen.ts:3614](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3614) The number of active process instances that currently have an active incident with this error. --- -### errorHashCode? +### errorHashCode ```ts -optional errorHashCode: number; +errorHashCode: number; ``` -Defined in: [gen/types.gen.ts:3228](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3228) +Defined in: [gen/types.gen.ts:3605](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3605) The hash code identifying a specific incident error.. --- -### errorMessage? +### errorMessage ```ts -optional errorMessage: string; +errorMessage: string; ``` -Defined in: [gen/types.gen.ts:3232](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3232) +Defined in: [gen/types.gen.ts:3609](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3609) The error message associated with the incident error hash code. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentResolutionRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentResolutionRequest.md index e87e44bc9ae..94f4ad4e4d5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentResolutionRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentResolutionRequest.md @@ -11,7 +11,7 @@ mdx: type IncidentResolutionRequest = object; ``` -Defined in: [gen/types.gen.ts:3200](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3200) +Defined in: [gen/types.gen.ts:3577](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3577) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/types.gen.ts:3200](https://github.com/camunda/orchestration-clu optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:3201](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3201) +Defined in: [gen/types.gen.ts:3578](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3578) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentResult.md index 443bbd26cd5..8c3c8cf1d30 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentResult.md @@ -11,152 +11,162 @@ mdx: type IncidentResult = object; ``` -Defined in: [gen/types.gen.ts:3157](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3157) +Defined in: [gen/types.gen.ts:3519](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3519) ## Properties -### creationTime? +### creationTime ```ts -optional creationTime: string; +creationTime: string; ``` -Defined in: [gen/types.gen.ts:3171](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3171) +Defined in: [gen/types.gen.ts:3539](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3539) + +The creation time of the incident. --- -### elementId? +### elementId ```ts -optional elementId: ElementId; +elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:3170](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3170) +Defined in: [gen/types.gen.ts:3535](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3535) The element ID associated to this incident. --- -### elementInstanceKey? +### elementInstanceKey ```ts -optional elementInstanceKey: ElementInstanceKey; +elementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:3193](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3193) +Defined in: [gen/types.gen.ts:3570](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3570) The element instance key associated to this incident. --- -### errorMessage? +### errorMessage ```ts -optional errorMessage: string; +errorMessage: string; ``` -Defined in: [gen/types.gen.ts:3166](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3166) +Defined in: [gen/types.gen.ts:3531](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3531) Error message which describes the error in more detail. --- -### errorType? +### errorType ```ts -optional errorType: IncidentErrorTypeEnum; +errorType: IncidentErrorTypeEnum; ``` -Defined in: [gen/types.gen.ts:3162](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3162) +Defined in: [gen/types.gen.ts:3527](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3527) + +The type of the incident error. --- -### incidentKey? +### incidentKey ```ts -optional incidentKey: IncidentKey; +incidentKey: IncidentKey; ``` -Defined in: [gen/types.gen.ts:3180](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3180) +Defined in: [gen/types.gen.ts:3551](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3551) The assigned key, which acts as a unique identifier for this incident. --- -### jobKey? +### jobKey ```ts -optional jobKey: JobKey; +jobKey: JobKey | null; ``` -Defined in: [gen/types.gen.ts:3197](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3197) +Defined in: [gen/types.gen.ts:3574](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3574) The job key, if exists, associated with this incident. --- -### processDefinitionId? +### processDefinitionId ```ts -optional processDefinitionId: ProcessDefinitionId; +processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:3161](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3161) +Defined in: [gen/types.gen.ts:3523](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3523) The process definition ID associated to this incident. --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:3184](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3184) +Defined in: [gen/types.gen.ts:3555](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3555) The process definition key associated to this incident. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:3188](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3188) +Defined in: [gen/types.gen.ts:3559](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3559) The process instance key associated to this incident. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:3189](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3189) +Defined in: [gen/types.gen.ts:3566](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3566) + +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. --- -### state? +### state ```ts -optional state: IncidentStateEnum; +state: IncidentStateEnum; ``` -Defined in: [gen/types.gen.ts:3172](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3172) +Defined in: [gen/types.gen.ts:3543](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3543) + +The incident state. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:3176](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3176) +Defined in: [gen/types.gen.ts:3547](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3547) The tenant ID of the incident. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQuery.md index 825701d8219..897686c7042 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQuery.md @@ -11,7 +11,7 @@ mdx: type IncidentSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:2999](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2999) +Defined in: [gen/types.gen.ts:3361](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3361) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQueryResult.md index d91a13da096..df5b3dd74b3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQueryResult.md @@ -11,14 +11,14 @@ mdx: type IncidentSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:3150](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3150) +Defined in: [gen/types.gen.ts:3512](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3512) ## Type Declaration -### items? +### items ```ts -optional items: IncidentResult[]; +items: IncidentResult[]; ``` The matching incidents. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQuerySortRequest.md index 0e06ad98147..27db125f0cd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type IncidentSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:3142](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3142) +Defined in: [gen/types.gen.ts:3504](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3504) ## Properties @@ -24,7 +24,6 @@ field: | "processDefinitionId" | "processInstanceKey" | "errorType" - | "errorMessage" | "elementId" | "elementInstanceKey" | "creationTime" @@ -33,7 +32,7 @@ field: | "tenantId"; ``` -Defined in: [gen/types.gen.ts:3146](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3146) +Defined in: [gen/types.gen.ts:3508](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3508) The field to sort by. @@ -45,4 +44,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:3147](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3147) +Defined in: [gen/types.gen.ts:3509](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3509) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateEnum.md index 1a35b8b3403..ebf9a3efafa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateEnum.md @@ -8,9 +8,14 @@ mdx: # Type Alias: IncidentStateEnum ```ts -type IncidentStateEnum = "ACTIVE" | "MIGRATED" | "PENDING" | "RESOLVED"; +type IncidentStateEnum = + | "ACTIVE" + | "MIGRATED" + | "PENDING" + | "RESOLVED" + | "UNKNOWN"; ``` -Defined in: [gen/types.gen.ts:3140](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3140) +Defined in: [gen/types.gen.ts:3502](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3502) Incident states with a defined set of values. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateExactMatch.md index 3bf83774cd8..8663a673258 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateExactMatch.md @@ -11,7 +11,7 @@ mdx: type IncidentStateExactMatch = IncidentStateEnum; ``` -Defined in: [gen/types.gen.ts:7507](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7507) +Defined in: [gen/types.gen.ts:8353](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8353) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateFilterProperty.md index d4b3b6f4f9f..ea262de4e12 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IncidentStateFilterProperty.md @@ -13,6 +13,6 @@ type IncidentStateFilterProperty = | AdvancedIncidentStateFilter; ``` -Defined in: [gen/types.gen.ts:3106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3106) +Defined in: [gen/types.gen.ts:3468](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3468) IncidentStateEnum with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/InferredAncestorKeyInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/InferredAncestorKeyInstruction.md index 627b046edd8..4732e5829d2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/InferredAncestorKeyInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/InferredAncestorKeyInstruction.md @@ -11,7 +11,7 @@ mdx: type InferredAncestorKeyInstruction = object; ``` -Defined in: [gen/types.gen.ts:6110](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6110) +Defined in: [gen/types.gen.ts:6823](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6823) 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. @@ -23,6 +23,6 @@ Instructs the engine to derive the ancestor scope key from the source element's ancestorScopeType: string; ``` -Defined in: [gen/types.gen.ts:6114](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6114) +Defined in: [gen/types.gen.ts:6827](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6827) The type of ancestor scope instruction. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/IntegerFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/IntegerFilterProperty.md index 43b1a7e856d..4a6b2a99ec1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/IntegerFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/IntegerFilterProperty.md @@ -11,6 +11,6 @@ mdx: type IntegerFilterProperty = number | AdvancedIntegerFilter; ``` -Defined in: [gen/types.gen.ts:2712](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2712) +Defined in: [gen/types.gen.ts:2870](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2870) Integer property with advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/Job.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/Job.md index 17ec3e34a7b..294aa498231 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/Job.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/Job.md @@ -11,7 +11,7 @@ mdx: type Job = EnrichedActivatedJob & object; ``` -Defined in: [runtime/jobWorker.ts:60](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L60) +Defined in: [runtime/jobWorker.ts:67](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L67) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActionReceipt-1.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActionReceipt-1.md index d473c1d44ee..2ca27320f5a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActionReceipt-1.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActionReceipt-1.md @@ -11,4 +11,4 @@ mdx: type JobActionReceipt = typeof JobActionReceipt; ``` -Defined in: [runtime/jobWorker.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L11) +Defined in: [runtime/jobWorker.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L11) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActionReceipt.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActionReceipt.md index ab04718aed0..53d975a091e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActionReceipt.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActionReceipt.md @@ -11,6 +11,6 @@ mdx: type JobActionReceipt = "JOB_ACTION_RECEIPT"; ``` -Defined in: [runtime/jobWorker.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/jobWorker.ts#L11) +Defined in: [runtime/jobWorker.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/jobWorker.ts#L11) Unique receipt symbol returned by job action methods. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActivationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActivationRequest.md index d3d80325757..db1000da3d3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActivationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobActivationRequest.md @@ -11,7 +11,7 @@ mdx: type JobActivationRequest = object; ``` -Defined in: [gen/types.gen.ts:3338](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3338) +Defined in: [gen/types.gen.ts:3960](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3960) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:3338](https://github.com/camunda/orchestration-clu optional fetchVariable: string[]; ``` -Defined in: [gen/types.gen.ts:3359](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3359) +Defined in: [gen/types.gen.ts:3981](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3981) 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. @@ -33,7 +33,7 @@ A list of variables to fetch as the job variables; if empty, all visible variabl maxJobsToActivate: number; ``` -Defined in: [gen/types.gen.ts:3355](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3355) +Defined in: [gen/types.gen.ts:3977](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3977) The maximum jobs to activate by this request. @@ -45,7 +45,7 @@ The maximum jobs to activate by this request. optional requestTimeout: number; ``` -Defined in: [gen/types.gen.ts:3364](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3364) +Defined in: [gen/types.gen.ts:3986](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3986) 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. @@ -57,7 +57,7 @@ The request will be completed when at least one job is activated or after the re optional tenantFilter: TenantFilterEnum; ``` -Defined in: [gen/types.gen.ts:3373](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3373) +Defined in: [gen/types.gen.ts:3995](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3995) The tenant filtering strategy - determines whether to use provided tenant IDs or assigned tenant IDs from the authenticated principal's authorized tenants. @@ -69,7 +69,7 @@ The tenant filtering strategy - determines whether to use provided tenant IDs or optional tenantIds: TenantId[]; ``` -Defined in: [gen/types.gen.ts:3368](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3368) +Defined in: [gen/types.gen.ts:3990](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3990) A list of IDs of tenants for which to activate jobs. @@ -81,7 +81,7 @@ A list of IDs of tenants for which to activate jobs. timeout: number; ``` -Defined in: [gen/types.gen.ts:3351](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3351) +Defined in: [gen/types.gen.ts:3973](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3973) A job returned after this call will not be activated by another call until the timeout (in ms) has been reached. @@ -93,7 +93,7 @@ A job returned after this call will not be activated by another call until the t type: string; ``` -Defined in: [gen/types.gen.ts:3342](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3342) +Defined in: [gen/types.gen.ts:3964](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3964) The job type, as defined in the BPMN process (e.g. ) @@ -105,6 +105,6 @@ The job type, as defined in the BPMN process (e.g. ; ``` -Defined in: [gen/types.gen.ts:4059](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4059) +Defined in: [gen/types.gen.ts:4698](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4698) System-generated key for a job. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKeyExactMatch.md index c9267b27ae8..b8826ec9882 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type JobKeyExactMatch = JobKey; ``` -Defined in: [gen/types.gen.ts:7556](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7556) +Defined in: [gen/types.gen.ts:8402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8402) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKeyFilterProperty.md index bf3102d9276..e3856c9de30 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKeyFilterProperty.md @@ -11,6 +11,6 @@ mdx: type JobKeyFilterProperty = JobKeyExactMatch | AdvancedJobKeyFilter; ``` -Defined in: [gen/types.gen.ts:4205](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4205) +Defined in: [gen/types.gen.ts:4844](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4844) JobKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindEnum.md index 6f36e0df22c..e111e8b7c49 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindEnum.md @@ -15,6 +15,6 @@ type JobKindEnum = | "AD_HOC_SUB_PROCESS"; ``` -Defined in: [gen/types.gen.ts:3906](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3906) +Defined in: [gen/types.gen.ts:4551](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4551) The job kind. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindExactMatch.md index 6bf996682bd..2d53903ebff 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindExactMatch.md @@ -11,7 +11,7 @@ mdx: type JobKindExactMatch = JobKindEnum; ``` -Defined in: [gen/types.gen.ts:7514](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7514) +Defined in: [gen/types.gen.ts:8360](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8360) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindFilterProperty.md index b64cca4503f..c0e12ca5a1e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobKindFilterProperty.md @@ -11,6 +11,6 @@ mdx: type JobKindFilterProperty = JobKindExactMatch | AdvancedJobKindFilter; ``` -Defined in: [gen/types.gen.ts:3916](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3916) +Defined in: [gen/types.gen.ts:4561](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4561) JobKindEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeEnum.md index 196a9939cbd..db0b82daa36 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeEnum.md @@ -19,6 +19,6 @@ type JobListenerEventTypeEnum = | "UPDATING"; ``` -Defined in: [gen/types.gen.ts:3911](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3911) +Defined in: [gen/types.gen.ts:4556](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4556) The listener event type of the job. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeExactMatch.md index 25b96003a8c..29f79e1c82c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeExactMatch.md @@ -11,7 +11,7 @@ mdx: type JobListenerEventTypeExactMatch = JobListenerEventTypeEnum; ``` -Defined in: [gen/types.gen.ts:7521](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7521) +Defined in: [gen/types.gen.ts:8367](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8367) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeFilterProperty.md index b08c166efa9..f41ea347fec 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobListenerEventTypeFilterProperty.md @@ -13,6 +13,6 @@ type JobListenerEventTypeFilterProperty = | AdvancedJobListenerEventTypeFilter; ``` -Defined in: [gen/types.gen.ts:3946](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3946) +Defined in: [gen/types.gen.ts:4591](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4591) JobListenerEventTypeEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobMetricsConfigurationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobMetricsConfigurationResponse.md new file mode 100644 index 00000000000..4af063be9f5 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobMetricsConfigurationResponse.md @@ -0,0 +1,88 @@ +--- +title: "Type Alias: JobMetricsConfigurationResponse" +sidebar_label: "JobMetricsConfigurationResponse" +mdx: + format: md +--- + +# Type Alias: JobMetricsConfigurationResponse + +```ts +type JobMetricsConfigurationResponse = object; +``` + +Defined in: [gen/types.gen.ts:7283](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7283) + +Configuration for job metrics collection and export. + +## Properties + +### enabled + +```ts +enabled: boolean; +``` + +Defined in: [gen/types.gen.ts:7287](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7287) + +Whether job metrics export is enabled. + +--- + +### exportInterval + +```ts +exportInterval: string; +``` + +Defined in: [gen/types.gen.ts:7291](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7291) + +The interval at which job metrics are exported, as an ISO 8601 duration. + +--- + +### maxJobTypeLength + +```ts +maxJobTypeLength: number; +``` + +Defined in: [gen/types.gen.ts:7299](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7299) + +The maximum length of the job type used in job metrics labels. + +--- + +### maxTenantIdLength + +```ts +maxTenantIdLength: number; +``` + +Defined in: [gen/types.gen.ts:7303](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7303) + +The maximum length of the tenant ID used in job metrics labels. + +--- + +### maxUniqueKeys + +```ts +maxUniqueKeys: number; +``` + +Defined in: [gen/types.gen.ts:7307](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7307) + +The maximum number of unique metric keys tracked for job metrics. + +--- + +### maxWorkerNameLength + +```ts +maxWorkerNameLength: number; +``` + +Defined in: [gen/types.gen.ts:7295](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7295) + +The maximum length of the worker name used in job metrics labels. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResult.md index 82950b0348d..328f65761ac 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResult.md @@ -13,6 +13,6 @@ type JobResult = | (object & JobResultAdHocSubProcess); ``` -Defined in: [gen/types.gen.ts:3764](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3764) +Defined in: [gen/types.gen.ts:4409](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4409) The result of the completed job as determined by the worker. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultActivateElement.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultActivateElement.md index 12dd2b2b747..d2d6cc942e3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultActivateElement.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultActivateElement.md @@ -11,7 +11,7 @@ mdx: type JobResultActivateElement = object; ``` -Defined in: [gen/types.gen.ts:3860](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3860) +Defined in: [gen/types.gen.ts:4505](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4505) Instruction to activate a single BPMN element within an ad‑hoc sub‑process, optionally providing variables scoped to that element. @@ -23,7 +23,7 @@ Instruction to activate a single BPMN element within an ad‑hoc sub‑process, optional elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:3864](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3864) +Defined in: [gen/types.gen.ts:4509](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4509) The element ID to activate. @@ -32,15 +32,13 @@ The element ID to activate. ### variables? ```ts -optional variables: object; +optional variables: + | { +[key: string]: unknown; +} + | null; ``` -Defined in: [gen/types.gen.ts:3868](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3868) +Defined in: [gen/types.gen.ts:4513](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4513) Variables for the element. - -#### Index Signature - -```ts -[key: string]: unknown -``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultAdHocSubProcess.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultAdHocSubProcess.md index 5ac8604d5c1..7b13aad61ff 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultAdHocSubProcess.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultAdHocSubProcess.md @@ -16,7 +16,7 @@ type JobResultAdHocSubProcess = { } | null; ``` -Defined in: [gen/types.gen.ts:3838](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3838) +Defined in: [gen/types.gen.ts:4483](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4483) Job result details for an ad‑hoc sub‑process, including elements to activate and flags indicating completion or cancellation behavior. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultCorrections.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultCorrections.md index 4b1c2060645..432cfc91aa2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultCorrections.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultCorrections.md @@ -18,7 +18,7 @@ type JobResultCorrections = { } | null; ``` -Defined in: [gen/types.gen.ts:3807](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3807) +Defined in: [gen/types.gen.ts:4452](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4452) JSON object with attributes that were corrected by the worker. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultUserTask.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultUserTask.md index 12c5903a342..dfb1992aa9a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultUserTask.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobResultUserTask.md @@ -16,7 +16,7 @@ type JobResultUserTask = { } | null; ``` -Defined in: [gen/types.gen.ts:3774](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3774) +Defined in: [gen/types.gen.ts:4419](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4419) Job result details for a user task completion, optionally including a denial reason and corrected task properties. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQuery.md index aff4f9ebb7e..a279b758602 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQuery.md @@ -11,7 +11,7 @@ mdx: type JobSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:3499](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3499) +Defined in: [gen/types.gen.ts:4136](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4136) Job search request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQueryResult.md index 229e32c901f..fde306ee92a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQueryResult.md @@ -11,16 +11,16 @@ mdx: type JobSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:3615](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3615) +Defined in: [gen/types.gen.ts:4252](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4252) Job search response. ## Type Declaration -### items? +### items ```ts -optional items: JobSearchResult[]; +items: JobSearchResult[]; ``` The matching jobs. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQuerySortRequest.md index fda96292369..9079d480477 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type JobSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:3510](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3510) +Defined in: [gen/types.gen.ts:4147](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4147) ## Properties @@ -41,7 +41,7 @@ field: | "worker"; ``` -Defined in: [gen/types.gen.ts:3514](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3514) +Defined in: [gen/types.gen.ts:4151](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4151) The field to sort by. @@ -53,4 +53,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:3515](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3515) +Defined in: [gen/types.gen.ts:4152](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4152) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchResult.md index 9ad0ec5d270..c2ceb5556aa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobSearchResult.md @@ -11,17 +11,17 @@ mdx: type JobSearchResult = object; ``` -Defined in: [gen/types.gen.ts:3622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3622) +Defined in: [gen/types.gen.ts:4259](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4259) ## Properties -### creationTime? +### creationTime ```ts -optional creationTime: string; +creationTime: string | null; ``` -Defined in: [gen/types.gen.ts:3701](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3701) +Defined in: [gen/types.gen.ts:4346](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4346) When the job was created. Field is present for jobs created after 8.9. @@ -33,7 +33,7 @@ When the job was created. Field is present for jobs created after 8.9. customHeaders: object; ``` -Defined in: [gen/types.gen.ts:3626](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3626) +Defined in: [gen/types.gen.ts:4263](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4263) A set of custom headers defined during modelling. @@ -45,25 +45,25 @@ A set of custom headers defined during modelling. --- -### deadline? +### deadline ```ts -optional deadline: string | null; +deadline: string | null; ``` -Defined in: [gen/types.gen.ts:3632](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3632) +Defined in: [gen/types.gen.ts:4269](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4269) If the job has been activated, when it will next be available to be activated. --- -### deniedReason? +### deniedReason ```ts -optional deniedReason: string | null; +deniedReason: string | null; ``` -Defined in: [gen/types.gen.ts:3636](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3636) +Defined in: [gen/types.gen.ts:4273](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4273) The reason provided by the user task listener for denying the work. @@ -72,12 +72,12 @@ The reason provided by the user task listener for denying the work. ### elementId ```ts -elementId: ElementId; +elementId: ElementId | null; ``` -Defined in: [gen/types.gen.ts:3640](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3640) +Defined in: [gen/types.gen.ts:4277](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4277) -The element ID associated with the job. +The element ID associated with the job. May be missing on job failure. --- @@ -87,43 +87,44 @@ The element ID associated with the job. elementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:3644](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3644) +Defined in: [gen/types.gen.ts:4281](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4281) The element instance key associated with the job. --- -### endTime? +### endTime ```ts -optional endTime: string; +endTime: string | null; ``` -Defined in: [gen/types.gen.ts:3648](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3648) +Defined in: [gen/types.gen.ts:4287](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4287) -When the job ended. +End date of the job. +This is `null` if the job is not in an end state yet. --- -### errorCode? +### errorCode ```ts -optional errorCode: string | null; +errorCode: string | null; ``` -Defined in: [gen/types.gen.ts:3652](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3652) +Defined in: [gen/types.gen.ts:4291](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4291) The error code provided for a failed job. --- -### errorMessage? +### errorMessage ```ts -optional errorMessage: string | null; +errorMessage: string | null; ``` -Defined in: [gen/types.gen.ts:3656](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3656) +Defined in: [gen/types.gen.ts:4295](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4295) The error message that provides additional context for a failed job. @@ -135,19 +136,19 @@ The error message that provides additional context for a failed job. hasFailedWithRetriesLeft: boolean; ``` -Defined in: [gen/types.gen.ts:3660](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3660) +Defined in: [gen/types.gen.ts:4299](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4299) Indicates whether the job has failed with retries left. --- -### isDenied? +### isDenied ```ts -optional isDenied: boolean | null; +isDenied: boolean | null; ``` -Defined in: [gen/types.gen.ts:3664](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3664) +Defined in: [gen/types.gen.ts:4303](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4303) Indicates whether the user task listener denies the work. @@ -159,7 +160,7 @@ Indicates whether the user task listener denies the work. jobKey: JobKey; ``` -Defined in: [gen/types.gen.ts:3668](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3668) +Defined in: [gen/types.gen.ts:4307](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4307) The key, a unique identifier for the job. @@ -171,17 +172,17 @@ The key, a unique identifier for the job. kind: JobKindEnum; ``` -Defined in: [gen/types.gen.ts:3669](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3669) +Defined in: [gen/types.gen.ts:4308](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4308) --- -### lastUpdateTime? +### lastUpdateTime ```ts -optional lastUpdateTime: string; +lastUpdateTime: string | null; ``` -Defined in: [gen/types.gen.ts:3705](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3705) +Defined in: [gen/types.gen.ts:4350](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4350) When the job was last updated. Field is present for jobs created after 8.9. @@ -193,7 +194,7 @@ When the job was last updated. Field is present for jobs created after 8.9. listenerEventType: JobListenerEventTypeEnum; ``` -Defined in: [gen/types.gen.ts:3670](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3670) +Defined in: [gen/types.gen.ts:4309](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4309) --- @@ -203,7 +204,7 @@ Defined in: [gen/types.gen.ts:3670](https://github.com/camunda/orchestration-clu processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:3674](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3674) +Defined in: [gen/types.gen.ts:4313](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4313) The process definition ID associated with the job. @@ -215,7 +216,7 @@ The process definition ID associated with the job. processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:3678](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3678) +Defined in: [gen/types.gen.ts:4317](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4317) The process definition key associated with the job. @@ -227,7 +228,7 @@ The process definition key associated with the job. processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:3682](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3682) +Defined in: [gen/types.gen.ts:4321](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4321) The process instance key associated with the job. @@ -239,19 +240,23 @@ The process instance key associated with the job. retries: number; ``` -Defined in: [gen/types.gen.ts:3687](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3687) +Defined in: [gen/types.gen.ts:4332](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4332) The amount of retries left to this job. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:3683](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3683) +Defined in: [gen/types.gen.ts:4328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4328) + +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. --- @@ -261,7 +266,7 @@ Defined in: [gen/types.gen.ts:3683](https://github.com/camunda/orchestration-clu state: JobStateEnum; ``` -Defined in: [gen/types.gen.ts:3688](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3688) +Defined in: [gen/types.gen.ts:4333](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4333) --- @@ -271,7 +276,7 @@ Defined in: [gen/types.gen.ts:3688](https://github.com/camunda/orchestration-clu tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:3689](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3689) +Defined in: [gen/types.gen.ts:4334](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4334) --- @@ -281,7 +286,7 @@ Defined in: [gen/types.gen.ts:3689](https://github.com/camunda/orchestration-clu type: string; ``` -Defined in: [gen/types.gen.ts:3693](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3693) +Defined in: [gen/types.gen.ts:4338](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4338) The type of the job. @@ -293,6 +298,6 @@ The type of the job. worker: string; ``` -Defined in: [gen/types.gen.ts:3697](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3697) +Defined in: [gen/types.gen.ts:4342](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4342) The name of the worker of this job. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateEnum.md index f423fc6efce..31c6cd8d117 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateEnum.md @@ -19,6 +19,6 @@ type JobStateEnum = | "TIMED_OUT"; ``` -Defined in: [gen/types.gen.ts:3901](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3901) +Defined in: [gen/types.gen.ts:4546](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4546) The state of the job. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateExactMatch.md index f65b3d8f1aa..2061917d378 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateExactMatch.md @@ -11,7 +11,7 @@ mdx: type JobStateExactMatch = JobStateEnum; ``` -Defined in: [gen/types.gen.ts:7528](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7528) +Defined in: [gen/types.gen.ts:8374](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8374) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateFilterProperty.md index abc84fd408a..2991f74cb4e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobStateFilterProperty.md @@ -11,6 +11,6 @@ mdx: type JobStateFilterProperty = JobStateExactMatch | AdvancedJobStateFilter; ``` -Defined in: [gen/types.gen.ts:3976](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3976) +Defined in: [gen/types.gen.ts:4621](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4621) JobStateEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsFilter.md new file mode 100644 index 00000000000..5bb08ef539d --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsFilter.md @@ -0,0 +1,65 @@ +--- +title: "Type Alias: JobTimeSeriesStatisticsFilter" +sidebar_label: "JobTimeSeriesStatisticsFilter" +mdx: + format: md +--- + +# Type Alias: JobTimeSeriesStatisticsFilter + +```ts +type JobTimeSeriesStatisticsFilter = object; +``` + +Defined in: [gen/types.gen.ts:3845](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3845) + +Job time-series statistics search filter. + +## Properties + +### from + +```ts +from: string; +``` + +Defined in: [gen/types.gen.ts:3850](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3850) + +Start of the time window to filter metrics. ISO 8601 date-time format. + +--- + +### jobType + +```ts +jobType: string; +``` + +Defined in: [gen/types.gen.ts:3859](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3859) + +Job type to return time-series metrics for. + +--- + +### resolution? + +```ts +optional resolution: string; +``` + +Defined in: [gen/types.gen.ts:3865](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3865) + +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. + +--- + +### to + +```ts +to: string; +``` + +Defined in: [gen/types.gen.ts:3855](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3855) + +End of the time window to filter metrics. ISO 8601 date-time format. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsItem.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsItem.md new file mode 100644 index 00000000000..54355f25355 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsItem.md @@ -0,0 +1,58 @@ +--- +title: "Type Alias: JobTimeSeriesStatisticsItem" +sidebar_label: "JobTimeSeriesStatisticsItem" +mdx: + format: md +--- + +# Type Alias: JobTimeSeriesStatisticsItem + +```ts +type JobTimeSeriesStatisticsItem = object; +``` + +Defined in: [gen/types.gen.ts:3882](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3882) + +Aggregated job metrics for a single time bucket. + +## Properties + +### completed + +```ts +completed: StatusMetric; +``` + +Defined in: [gen/types.gen.ts:3888](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3888) + +--- + +### created + +```ts +created: StatusMetric; +``` + +Defined in: [gen/types.gen.ts:3887](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3887) + +--- + +### failed + +```ts +failed: StatusMetric; +``` + +Defined in: [gen/types.gen.ts:3889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3889) + +--- + +### time + +```ts +time: string; +``` + +Defined in: [gen/types.gen.ts:3886](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3886) + +ISO 8601 timestamp representing the start of this time bucket. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsQuery.md new file mode 100644 index 00000000000..d74757d92b3 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsQuery.md @@ -0,0 +1,38 @@ +--- +title: "Type Alias: JobTimeSeriesStatisticsQuery" +sidebar_label: "JobTimeSeriesStatisticsQuery" +mdx: + format: md +--- + +# Type Alias: JobTimeSeriesStatisticsQuery + +```ts +type JobTimeSeriesStatisticsQuery = object; +``` + +Defined in: [gen/types.gen.ts:3834](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3834) + +Job time-series statistics query. + +## Properties + +### filter + +```ts +filter: JobTimeSeriesStatisticsFilter; +``` + +Defined in: [gen/types.gen.ts:3835](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3835) + +--- + +### page? + +```ts +optional page: CursorForwardPagination; +``` + +Defined in: [gen/types.gen.ts:3839](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3839) + +Search cursor pagination. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsQueryResult.md new file mode 100644 index 00000000000..af6302eb4d4 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTimeSeriesStatisticsQueryResult.md @@ -0,0 +1,32 @@ +--- +title: "Type Alias: JobTimeSeriesStatisticsQueryResult" +sidebar_label: "JobTimeSeriesStatisticsQueryResult" +mdx: + format: md +--- + +# Type Alias: JobTimeSeriesStatisticsQueryResult + +```ts +type JobTimeSeriesStatisticsQueryResult = SearchQueryResponse & object; +``` + +Defined in: [gen/types.gen.ts:3871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3871) + +Job time-series statistics query result. + +## Type Declaration + +### items + +```ts +items: JobTimeSeriesStatisticsItem[]; +``` + +The list of time-bucketed statistics items, ordered ascending by time. + +### page + +```ts +page: SearchQueryPageResponse; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsFilter.md new file mode 100644 index 00000000000..6b2913ae6ce --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsFilter.md @@ -0,0 +1,53 @@ +--- +title: "Type Alias: JobTypeStatisticsFilter" +sidebar_label: "JobTypeStatisticsFilter" +mdx: + format: md +--- + +# Type Alias: JobTypeStatisticsFilter + +```ts +type JobTypeStatisticsFilter = object; +``` + +Defined in: [gen/types.gen.ts:3729](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3729) + +Job type statistics search filter. + +## Properties + +### from + +```ts +from: string; +``` + +Defined in: [gen/types.gen.ts:3734](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3734) + +Start of the time window to filter metrics. ISO 8601 date-time format. + +--- + +### jobType? + +```ts +optional jobType: StringFilterProperty; +``` + +Defined in: [gen/types.gen.ts:3745](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3745) + +Optional job type filter with advanced search capabilities. +Supports exact match, pattern matching, and other operators. + +--- + +### to + +```ts +to: string; +``` + +Defined in: [gen/types.gen.ts:3739](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3739) + +End of the time window to filter metrics. ISO 8601 date-time format. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsItem.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsItem.md new file mode 100644 index 00000000000..da66fbee454 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsItem.md @@ -0,0 +1,70 @@ +--- +title: "Type Alias: JobTypeStatisticsItem" +sidebar_label: "JobTypeStatisticsItem" +mdx: + format: md +--- + +# Type Alias: JobTypeStatisticsItem + +```ts +type JobTypeStatisticsItem = object; +``` + +Defined in: [gen/types.gen.ts:3762](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3762) + +Statistics for a single job type. + +## Properties + +### completed + +```ts +completed: StatusMetric; +``` + +Defined in: [gen/types.gen.ts:3768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3768) + +--- + +### created + +```ts +created: StatusMetric; +``` + +Defined in: [gen/types.gen.ts:3767](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3767) + +--- + +### failed + +```ts +failed: StatusMetric; +``` + +Defined in: [gen/types.gen.ts:3769](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3769) + +--- + +### jobType + +```ts +jobType: string; +``` + +Defined in: [gen/types.gen.ts:3766](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3766) + +The job type identifier. + +--- + +### workers + +```ts +workers: number; +``` + +Defined in: [gen/types.gen.ts:3773](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3773) + +Number of distinct workers observed for this job type. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsQuery.md new file mode 100644 index 00000000000..c201f55f8ee --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsQuery.md @@ -0,0 +1,38 @@ +--- +title: "Type Alias: JobTypeStatisticsQuery" +sidebar_label: "JobTypeStatisticsQuery" +mdx: + format: md +--- + +# Type Alias: JobTypeStatisticsQuery + +```ts +type JobTypeStatisticsQuery = object; +``` + +Defined in: [gen/types.gen.ts:3718](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3718) + +Job type statistics query. + +## Properties + +### filter? + +```ts +optional filter: JobTypeStatisticsFilter; +``` + +Defined in: [gen/types.gen.ts:3719](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3719) + +--- + +### page? + +```ts +optional page: CursorForwardPagination; +``` + +Defined in: [gen/types.gen.ts:3723](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3723) + +Search cursor pagination. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsQueryResult.md new file mode 100644 index 00000000000..4c2178767cb --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobTypeStatisticsQueryResult.md @@ -0,0 +1,32 @@ +--- +title: "Type Alias: JobTypeStatisticsQueryResult" +sidebar_label: "JobTypeStatisticsQueryResult" +mdx: + format: md +--- + +# Type Alias: JobTypeStatisticsQueryResult + +```ts +type JobTypeStatisticsQueryResult = SearchQueryResponse & object; +``` + +Defined in: [gen/types.gen.ts:3751](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3751) + +Job type statistics query result. + +## Type Declaration + +### items + +```ts +items: JobTypeStatisticsItem[]; +``` + +The list of job type statistics items. + +### page + +```ts +page: SearchQueryPageResponse; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobUpdateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobUpdateRequest.md index b74b7316e6c..76cbb1e443e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobUpdateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobUpdateRequest.md @@ -11,7 +11,7 @@ mdx: type JobUpdateRequest = object; ``` -Defined in: [gen/types.gen.ts:3873](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3873) +Defined in: [gen/types.gen.ts:4518](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4518) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:3873](https://github.com/camunda/orchestration-clu changeset: JobChangeset; ``` -Defined in: [gen/types.gen.ts:3874](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3874) +Defined in: [gen/types.gen.ts:4519](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4519) --- @@ -31,4 +31,4 @@ Defined in: [gen/types.gen.ts:3874](https://github.com/camunda/orchestration-clu optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:3875](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3875) +Defined in: [gen/types.gen.ts:4520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4520) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsFilter.md new file mode 100644 index 00000000000..cdb031d0a12 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsFilter.md @@ -0,0 +1,52 @@ +--- +title: "Type Alias: JobWorkerStatisticsFilter" +sidebar_label: "JobWorkerStatisticsFilter" +mdx: + format: md +--- + +# Type Alias: JobWorkerStatisticsFilter + +```ts +type JobWorkerStatisticsFilter = object; +``` + +Defined in: [gen/types.gen.ts:3790](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3790) + +Job worker statistics search filter. + +## Properties + +### from + +```ts +from: string; +``` + +Defined in: [gen/types.gen.ts:3795](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3795) + +Start of the time window to filter metrics. ISO 8601 date-time format. + +--- + +### jobType + +```ts +jobType: string; +``` + +Defined in: [gen/types.gen.ts:3804](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3804) + +Job type to return worker metrics for. + +--- + +### to + +```ts +to: string; +``` + +Defined in: [gen/types.gen.ts:3800](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3800) + +End of the time window to filter metrics. ISO 8601 date-time format. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsItem.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsItem.md new file mode 100644 index 00000000000..f78f8c2fa35 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsItem.md @@ -0,0 +1,58 @@ +--- +title: "Type Alias: JobWorkerStatisticsItem" +sidebar_label: "JobWorkerStatisticsItem" +mdx: + format: md +--- + +# Type Alias: JobWorkerStatisticsItem + +```ts +type JobWorkerStatisticsItem = object; +``` + +Defined in: [gen/types.gen.ts:3821](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3821) + +Statistics for a single worker within a job type. + +## Properties + +### completed + +```ts +completed: StatusMetric; +``` + +Defined in: [gen/types.gen.ts:3827](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3827) + +--- + +### created + +```ts +created: StatusMetric; +``` + +Defined in: [gen/types.gen.ts:3826](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3826) + +--- + +### failed + +```ts +failed: StatusMetric; +``` + +Defined in: [gen/types.gen.ts:3828](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3828) + +--- + +### worker + +```ts +worker: string; +``` + +Defined in: [gen/types.gen.ts:3825](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3825) + +The name of the worker activating the jobs, mostly used for logging purposes. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsQuery.md new file mode 100644 index 00000000000..6dd6c02744f --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsQuery.md @@ -0,0 +1,38 @@ +--- +title: "Type Alias: JobWorkerStatisticsQuery" +sidebar_label: "JobWorkerStatisticsQuery" +mdx: + format: md +--- + +# Type Alias: JobWorkerStatisticsQuery + +```ts +type JobWorkerStatisticsQuery = object; +``` + +Defined in: [gen/types.gen.ts:3779](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3779) + +Job worker statistics query. + +## Properties + +### filter + +```ts +filter: JobWorkerStatisticsFilter; +``` + +Defined in: [gen/types.gen.ts:3780](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3780) + +--- + +### page? + +```ts +optional page: CursorForwardPagination; +``` + +Defined in: [gen/types.gen.ts:3784](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3784) + +Search cursor pagination. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsQueryResult.md new file mode 100644 index 00000000000..aa0e01a5139 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/JobWorkerStatisticsQueryResult.md @@ -0,0 +1,32 @@ +--- +title: "Type Alias: JobWorkerStatisticsQueryResult" +sidebar_label: "JobWorkerStatisticsQueryResult" +mdx: + format: md +--- + +# Type Alias: JobWorkerStatisticsQueryResult + +```ts +type JobWorkerStatisticsQueryResult = SearchQueryResponse & object; +``` + +Defined in: [gen/types.gen.ts:3810](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3810) + +Job worker statistics query result. + +## Type Declaration + +### items + +```ts +items: JobWorkerStatisticsItem[]; +``` + +The list of per-worker statistics items. + +### page + +```ts +page: SearchQueryPageResponse; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/LicenseResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/LicenseResponse.md index 9241699b092..160aa8119fa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/LicenseResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/LicenseResponse.md @@ -11,19 +11,19 @@ mdx: type LicenseResponse = object; ``` -Defined in: [gen/types.gen.ts:4502](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4502) +Defined in: [gen/types.gen.ts:5143](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5143) The response of a license request. ## Properties -### expiresAt? +### expiresAt ```ts -optional expiresAt: string | null; +expiresAt: string | null; ``` -Defined in: [gen/types.gen.ts:4518](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4518) +Defined in: [gen/types.gen.ts:5159](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5159) The date when the Camunda license expires @@ -35,7 +35,7 @@ The date when the Camunda license expires isCommercial: boolean; ``` -Defined in: [gen/types.gen.ts:4514](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4514) +Defined in: [gen/types.gen.ts:5155](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5155) Will be false when a license contains a non-commerical=true property @@ -47,7 +47,7 @@ Will be false when a license contains a non-commerical=true property licenseType: string; ``` -Defined in: [gen/types.gen.ts:4510](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4510) +Defined in: [gen/types.gen.ts:5151](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5151) Will return the license type property of the Camunda license @@ -59,6 +59,6 @@ Will return the license type property of the Camunda license validLicense: boolean; ``` -Defined in: [gen/types.gen.ts:4506](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4506) +Defined in: [gen/types.gen.ts:5147](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5147) True if the Camunda license is valid, false if otherwise diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/LikeFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/LikeFilter.md index 9d346716a02..a4942d8bcf1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/LikeFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/LikeFilter.md @@ -11,7 +11,7 @@ mdx: type LikeFilter = string; ``` -Defined in: [gen/types.gen.ts:2620](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2620) +Defined in: [gen/types.gen.ts:2778](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2778) Checks if the property matches the provided like value. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/LimitPagination.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/LimitPagination.md index 2f18c546c93..22daf319fda 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/LimitPagination.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/LimitPagination.md @@ -11,7 +11,7 @@ mdx: type LimitPagination = object; ``` -Defined in: [gen/types.gen.ts:6409](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6409) +Defined in: [gen/types.gen.ts:7129](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7129) Limit-based pagination @@ -23,6 +23,6 @@ Limit-based pagination optional limit: number; ``` -Defined in: [gen/types.gen.ts:6413](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6413) +Defined in: [gen/types.gen.ts:7133](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7133) The maximum number of items to return in one request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/LongKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/LongKey.md index 120b6d0b778..d8e5b71d286 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/LongKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/LongKey.md @@ -11,6 +11,6 @@ mdx: type LongKey = string; ``` -Defined in: [gen/types.gen.ts:4006](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4006) +Defined in: [gen/types.gen.ts:4651](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4651) Zeebe Engine resource key (Java long serialized as string) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/Loose.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/Loose.md index d7118937b79..2b8a2be63cd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/Loose.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/Loose.md @@ -11,7 +11,7 @@ mdx: type Loose = IsBrandedKey extends true ? string : T extends CancelablePromise ? CancelablePromise> : T extends Promise ? Promise> : T extends infer U[] ? Loose[] : T extends ReadonlyArray ? ReadonlyArray> : T extends (...a) => infer R ? (...a) => Loose : T extends object ? { [K in keyof T]: Loose } : T; ``` -Defined in: [loose.ts:14](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/loose.ts#L14) +Defined in: [loose.ts:14](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/loose.ts#L14) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateRequest.md index 2092001bef8..8a3bec1bbaa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateRequest.md @@ -11,7 +11,7 @@ mdx: type MappingRuleCreateRequest = MappingRuleCreateUpdateRequest & object; ``` -Defined in: [gen/types.gen.ts:4536](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4536) +Defined in: [gen/types.gen.ts:5177](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5177) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateResult.md index 3ee1e132356..7cad991aaaf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateResult.md @@ -11,4 +11,4 @@ mdx: type MappingRuleCreateResult = MappingRuleCreateUpdateResult; ``` -Defined in: [gen/types.gen.ts:4564](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4564) +Defined in: [gen/types.gen.ts:5205](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5205) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateUpdateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateUpdateRequest.md index 3a768658952..5ec3b70749c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateUpdateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateUpdateRequest.md @@ -11,7 +11,7 @@ mdx: type MappingRuleCreateUpdateRequest = object; ``` -Defined in: [gen/types.gen.ts:4521](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4521) +Defined in: [gen/types.gen.ts:5162](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5162) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:4521](https://github.com/camunda/orchestration-clu claimName: string; ``` -Defined in: [gen/types.gen.ts:4525](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4525) +Defined in: [gen/types.gen.ts:5166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5166) The name of the claim to map. @@ -33,7 +33,7 @@ The name of the claim to map. claimValue: string; ``` -Defined in: [gen/types.gen.ts:4529](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4529) +Defined in: [gen/types.gen.ts:5170](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5170) The value of the claim to map. @@ -45,6 +45,6 @@ The value of the claim to map. name: string; ``` -Defined in: [gen/types.gen.ts:4533](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4533) +Defined in: [gen/types.gen.ts:5174](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5174) The name of the mapping rule. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateUpdateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateUpdateResult.md index 98063e190f3..3bc7b9aacb9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateUpdateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleCreateUpdateResult.md @@ -11,52 +11,52 @@ mdx: type MappingRuleCreateUpdateResult = object; ``` -Defined in: [gen/types.gen.ts:4545](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4545) +Defined in: [gen/types.gen.ts:5186](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5186) ## Properties -### claimName? +### claimName ```ts -optional claimName: string; +claimName: string; ``` -Defined in: [gen/types.gen.ts:4549](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4549) +Defined in: [gen/types.gen.ts:5190](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5190) The name of the claim to map. --- -### claimValue? +### claimValue ```ts -optional claimValue: string; +claimValue: string; ``` -Defined in: [gen/types.gen.ts:4553](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4553) +Defined in: [gen/types.gen.ts:5194](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5194) The value of the claim to map. --- -### mappingRuleId? +### mappingRuleId ```ts -optional mappingRuleId: string; +mappingRuleId: string; ``` -Defined in: [gen/types.gen.ts:4561](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4561) +Defined in: [gen/types.gen.ts:5202](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5202) The unique ID of the mapping rule. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:4557](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4557) +Defined in: [gen/types.gen.ts:5198](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5198) The name of the mapping rule. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleFilter.md index d372c9bc174..4a6640dd7ad 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleFilter.md @@ -11,7 +11,7 @@ mdx: type MappingRuleFilter = object; ``` -Defined in: [gen/types.gen.ts:4616](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4616) +Defined in: [gen/types.gen.ts:5257](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5257) Mapping rule search filter. @@ -23,7 +23,7 @@ Mapping rule search filter. optional claimName: string; ``` -Defined in: [gen/types.gen.ts:4620](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4620) +Defined in: [gen/types.gen.ts:5261](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5261) The claim name to match against a token. @@ -35,7 +35,7 @@ The claim name to match against a token. optional claimValue: string; ``` -Defined in: [gen/types.gen.ts:4624](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4624) +Defined in: [gen/types.gen.ts:5265](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5265) The value of the claim to match. @@ -47,7 +47,7 @@ The value of the claim to match. optional mappingRuleId: string; ``` -Defined in: [gen/types.gen.ts:4632](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4632) +Defined in: [gen/types.gen.ts:5273](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5273) The ID of the mapping rule. @@ -59,6 +59,6 @@ The ID of the mapping rule. optional name: string; ``` -Defined in: [gen/types.gen.ts:4628](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4628) +Defined in: [gen/types.gen.ts:5269](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5269) The name of the mapping rule. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleResult.md index bbb9e17f341..d08676e2b48 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleResult.md @@ -11,52 +11,52 @@ mdx: type MappingRuleResult = object; ``` -Defined in: [gen/types.gen.ts:4575](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4575) +Defined in: [gen/types.gen.ts:5216](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5216) ## Properties -### claimName? +### claimName ```ts -optional claimName: string; +claimName: string; ``` -Defined in: [gen/types.gen.ts:4579](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4579) +Defined in: [gen/types.gen.ts:5220](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5220) The name of the claim to map. --- -### claimValue? +### claimValue ```ts -optional claimValue: string; +claimValue: string; ``` -Defined in: [gen/types.gen.ts:4583](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4583) +Defined in: [gen/types.gen.ts:5224](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5224) The value of the claim to map. --- -### mappingRuleId? +### mappingRuleId ```ts -optional mappingRuleId: string; +mappingRuleId: string; ``` -Defined in: [gen/types.gen.ts:4591](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4591) +Defined in: [gen/types.gen.ts:5232](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5232) The ID of the mapping rule. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:4587](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4587) +Defined in: [gen/types.gen.ts:5228](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5228) The name of the mapping rule. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQueryRequest.md index bc438a952cf..dfd822ca1fa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type MappingRuleSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:4602](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4602) +Defined in: [gen/types.gen.ts:5243](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5243) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQueryResult.md index 46823e07a1b..e8cbc9ddb27 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQueryResult.md @@ -11,14 +11,14 @@ mdx: type MappingRuleSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:4568](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4568) +Defined in: [gen/types.gen.ts:5209](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5209) ## Type Declaration -### items? +### items ```ts -optional items: MappingRuleResult[]; +items: MappingRuleResult[]; ``` The matching mapping rules. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQuerySortRequest.md index c2d2c56994a..c80822ed03c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type MappingRuleSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:4594](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4594) +Defined in: [gen/types.gen.ts:5235](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5235) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:4594](https://github.com/camunda/orchestration-clu field: "mappingRuleId" | "claimName" | "claimValue" | "name"; ``` -Defined in: [gen/types.gen.ts:4598](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4598) +Defined in: [gen/types.gen.ts:5239](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5239) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:4599](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4599) +Defined in: [gen/types.gen.ts:5240](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5240) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleUpdateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleUpdateRequest.md index 5895eb5fc70..51f19cfd24e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleUpdateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleUpdateRequest.md @@ -11,4 +11,4 @@ mdx: type MappingRuleUpdateRequest = MappingRuleCreateUpdateRequest; ``` -Defined in: [gen/types.gen.ts:4543](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4543) +Defined in: [gen/types.gen.ts:5184](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5184) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleUpdateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleUpdateResult.md index 15554da730b..4c828668a47 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleUpdateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MappingRuleUpdateResult.md @@ -11,4 +11,4 @@ mdx: type MappingRuleUpdateResult = MappingRuleCreateUpdateResult; ``` -Defined in: [gen/types.gen.ts:4566](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4566) +Defined in: [gen/types.gen.ts:5207](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5207) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MatchedDecisionRuleItem.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MatchedDecisionRuleItem.md index d45976a72e9..daea7788ae5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MatchedDecisionRuleItem.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MatchedDecisionRuleItem.md @@ -11,42 +11,42 @@ mdx: type MatchedDecisionRuleItem = object; ``` -Defined in: [gen/types.gen.ts:1854](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1854) +Defined in: [gen/types.gen.ts:1915](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1915) A decision rule that matched within this decision evaluation. ## Properties -### evaluatedOutputs? +### evaluatedOutputs ```ts -optional evaluatedOutputs: EvaluatedDecisionOutputItem[]; +evaluatedOutputs: EvaluatedDecisionOutputItem[]; ``` -Defined in: [gen/types.gen.ts:1866](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1866) +Defined in: [gen/types.gen.ts:1927](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1927) The evaluated decision outputs. --- -### ruleId? +### ruleId ```ts -optional ruleId: string; +ruleId: string; ``` -Defined in: [gen/types.gen.ts:1858](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1858) +Defined in: [gen/types.gen.ts:1919](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1919) The ID of the matched rule. --- -### ruleIndex? +### ruleIndex ```ts -optional ruleIndex: number; +ruleIndex: number; ``` -Defined in: [gen/types.gen.ts:1862](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1862) +Defined in: [gen/types.gen.ts:1923](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1923) The index of the matched rule. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageCorrelationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageCorrelationRequest.md index 0930af963de..cafd82a8067 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageCorrelationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageCorrelationRequest.md @@ -11,7 +11,7 @@ mdx: type MessageCorrelationRequest = object; ``` -Defined in: [gen/types.gen.ts:4635](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4635) +Defined in: [gen/types.gen.ts:5276](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5276) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:4635](https://github.com/camunda/orchestration-clu optional correlationKey: string; ``` -Defined in: [gen/types.gen.ts:4644](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4644) +Defined in: [gen/types.gen.ts:5285](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5285) The correlation key of the message. @@ -33,7 +33,7 @@ The correlation key of the message. name: string; ``` -Defined in: [gen/types.gen.ts:4640](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4640) +Defined in: [gen/types.gen.ts:5281](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5281) The message name as defined in the BPMN process @@ -45,7 +45,7 @@ The message name as defined in the BPMN process optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:4654](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4654) +Defined in: [gen/types.gen.ts:5295](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5295) the tenant for which the message is published @@ -57,7 +57,7 @@ the tenant for which the message is published optional variables: object; ``` -Defined in: [gen/types.gen.ts:4648](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4648) +Defined in: [gen/types.gen.ts:5289](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5289) The message variables as JSON document diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageCorrelationResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageCorrelationResult.md index 0ce4bfcb512..599d55b3ae5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageCorrelationResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageCorrelationResult.md @@ -11,43 +11,43 @@ mdx: type MessageCorrelationResult = object; ``` -Defined in: [gen/types.gen.ts:4662](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4662) +Defined in: [gen/types.gen.ts:5303](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5303) The message key of the correlated message, as well as the first process instance key it correlated with. ## Properties -### messageKey? +### messageKey ```ts -optional messageKey: MessageKey; +messageKey: MessageKey; ``` -Defined in: [gen/types.gen.ts:4670](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4670) +Defined in: [gen/types.gen.ts:5311](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5311) The key of the correlated message. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:4674](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4674) +Defined in: [gen/types.gen.ts:5315](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5315) The key of the first process instance the message correlated with --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:4666](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4666) +Defined in: [gen/types.gen.ts:5307](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5307) The tenant ID of the correlated message diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageKey.md index 0b5124e0001..cd4747a06a3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageKey.md @@ -11,6 +11,6 @@ mdx: type MessageKey = CamundaKey<"MessageKey">; ``` -Defined in: [gen/types.gen.ts:5048](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5048) +Defined in: [gen/types.gen.ts:5703](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5703) System-generated key for an message. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessagePublicationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessagePublicationRequest.md index 538c37a68f8..e5c98316ee1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessagePublicationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessagePublicationRequest.md @@ -11,7 +11,7 @@ mdx: type MessagePublicationRequest = object; ``` -Defined in: [gen/types.gen.ts:4677](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4677) +Defined in: [gen/types.gen.ts:5318](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5318) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:4677](https://github.com/camunda/orchestration-clu optional correlationKey: string; ``` -Defined in: [gen/types.gen.ts:4685](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4685) +Defined in: [gen/types.gen.ts:5326](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5326) The correlation key of the message. @@ -33,7 +33,7 @@ The correlation key of the message. optional messageId: string; ``` -Defined in: [gen/types.gen.ts:4695](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4695) +Defined in: [gen/types.gen.ts:5336](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5336) 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). @@ -46,7 +46,7 @@ will be published during the lifetime of the message (if `timeToLive` is set). name: string; ``` -Defined in: [gen/types.gen.ts:4681](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4681) +Defined in: [gen/types.gen.ts:5322](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5322) The name of the message. @@ -58,7 +58,7 @@ The name of the message. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:4705](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4705) +Defined in: [gen/types.gen.ts:5346](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5346) The tenant of the message sender. @@ -70,7 +70,7 @@ The tenant of the message sender. optional timeToLive: number; ``` -Defined in: [gen/types.gen.ts:4689](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4689) +Defined in: [gen/types.gen.ts:5330](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5330) Timespan (in ms) to buffer the message on the broker. @@ -82,7 +82,7 @@ Timespan (in ms) to buffer the message on the broker. optional variables: object; ``` -Defined in: [gen/types.gen.ts:4699](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4699) +Defined in: [gen/types.gen.ts:5340](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5340) The message variables as JSON document. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessagePublicationResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessagePublicationResult.md index 8afed453fc1..b3f69ba72cc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessagePublicationResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessagePublicationResult.md @@ -11,30 +11,30 @@ mdx: type MessagePublicationResult = object; ``` -Defined in: [gen/types.gen.ts:4711](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4711) +Defined in: [gen/types.gen.ts:5352](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5352) The message key of the published message. ## Properties -### messageKey? +### messageKey ```ts -optional messageKey: MessageKey; +messageKey: MessageKey; ``` -Defined in: [gen/types.gen.ts:4719](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4719) +Defined in: [gen/types.gen.ts:5360](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5360) The key of the published message. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:4715](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4715) +Defined in: [gen/types.gen.ts:5356](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5356) The tenant ID of the message. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionFilter.md index e7c8c436e79..577833f7842 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionFilter.md @@ -11,7 +11,7 @@ mdx: type MessageSubscriptionFilter = object; ``` -Defined in: [gen/types.gen.ts:4793](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4793) +Defined in: [gen/types.gen.ts:5440](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5440) Message subscription search filter. @@ -23,7 +23,7 @@ Message subscription search filter. optional correlationKey: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4833](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4833) +Defined in: [gen/types.gen.ts:5480](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5480) The correlation key of the message subscription. @@ -35,7 +35,7 @@ The correlation key of the message subscription. optional elementId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4813](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4813) +Defined in: [gen/types.gen.ts:5460](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5460) The element ID associated with this message subscription. @@ -47,7 +47,7 @@ The element ID associated with this message subscription. optional elementInstanceKey: ElementInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:4817](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4817) +Defined in: [gen/types.gen.ts:5464](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5464) The element instance key associated with this message subscription. @@ -59,7 +59,7 @@ The element instance key associated with this message subscription. optional lastUpdatedDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:4825](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4825) +Defined in: [gen/types.gen.ts:5472](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5472) The last updated date of the message subscription. @@ -71,7 +71,7 @@ The last updated date of the message subscription. optional messageName: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4829](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4829) +Defined in: [gen/types.gen.ts:5476](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5476) The name of the message associated with the message subscription. @@ -83,7 +83,7 @@ The name of the message associated with the message subscription. optional messageSubscriptionKey: MessageSubscriptionKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:4797](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4797) +Defined in: [gen/types.gen.ts:5444](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5444) The message subscription key associated with this message subscription. @@ -95,7 +95,7 @@ The message subscription key associated with this message subscription. optional messageSubscriptionState: MessageSubscriptionStateFilterProperty; ``` -Defined in: [gen/types.gen.ts:4821](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4821) +Defined in: [gen/types.gen.ts:5468](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5468) The message subscription state. @@ -107,7 +107,7 @@ The message subscription state. optional processDefinitionId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4805](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4805) +Defined in: [gen/types.gen.ts:5452](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5452) The process definition ID associated with this message subscription. @@ -119,7 +119,7 @@ The process definition ID associated with this message subscription. optional processDefinitionKey: ProcessDefinitionKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:4801](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4801) +Defined in: [gen/types.gen.ts:5448](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5448) The process definition key associated with this correlated message subscription. This only works for data created with 8.9 and later. @@ -131,7 +131,7 @@ The process definition key associated with this correlated message subscription. optional processInstanceKey: ProcessInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:4809](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4809) +Defined in: [gen/types.gen.ts:5456](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5456) The process instance key associated with this message subscription. @@ -143,6 +143,6 @@ The process instance key associated with this message subscription. optional tenantId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:4837](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4837) +Defined in: [gen/types.gen.ts:5484](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5484) The unique external tenant ID. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKey.md index d6cb6fb1291..e4d94909f02 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKey.md @@ -11,6 +11,6 @@ mdx: type MessageSubscriptionKey = CamundaKey<"MessageSubscriptionKey">; ``` -Defined in: [gen/types.gen.ts:5043](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5043) +Defined in: [gen/types.gen.ts:5698](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5698) System-generated key for a message subscription. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKeyExactMatch.md index e4356cbb074..2efdd519eb6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type MessageSubscriptionKeyExactMatch = MessageSubscriptionKey; ``` -Defined in: [gen/types.gen.ts:7626](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7626) +Defined in: [gen/types.gen.ts:8472](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8472) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKeyFilterProperty.md index 1a33f9554d4..0960d4ad92d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionKeyFilterProperty.md @@ -13,6 +13,6 @@ type MessageSubscriptionKeyFilterProperty = | AdvancedMessageSubscriptionKeyFilter; ``` -Defined in: [gen/types.gen.ts:5038](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5038) +Defined in: [gen/types.gen.ts:5693](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5693) MessageSubscriptionKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionResult.md index c4a4747862c..da2013dfbba 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionResult.md @@ -11,142 +11,146 @@ mdx: type MessageSubscriptionResult = object; ``` -Defined in: [gen/types.gen.ts:4729](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4729) +Defined in: [gen/types.gen.ts:5370](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5370) ## Properties -### correlationKey? +### correlationKey ```ts -optional correlationKey: string; +correlationKey: string | null; ``` -Defined in: [gen/types.gen.ts:4767](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4767) +Defined in: [gen/types.gen.ts:5414](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5414) The correlation key of the message subscription. --- -### elementId? +### elementId ```ts -optional elementId: ElementId; +elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:4750](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4750) +Defined in: [gen/types.gen.ts:5397](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5397) The element ID associated with this message subscription. --- -### elementInstanceKey? +### elementInstanceKey ```ts -optional elementInstanceKey: ElementInstanceKey; +elementInstanceKey: ElementInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:4754](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4754) +Defined in: [gen/types.gen.ts:5401](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5401) The element instance key associated with this message subscription. --- -### lastUpdatedDate? +### lastUpdatedDate ```ts -optional lastUpdatedDate: string; +lastUpdatedDate: string; ``` -Defined in: [gen/types.gen.ts:4759](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4759) +Defined in: [gen/types.gen.ts:5406](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5406) The last updated date of the message subscription. --- -### messageName? +### messageName ```ts -optional messageName: string; +messageName: string; ``` -Defined in: [gen/types.gen.ts:4763](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4763) +Defined in: [gen/types.gen.ts:5410](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5410) The name of the message associated with the message subscription. --- -### messageSubscriptionKey? +### messageSubscriptionKey ```ts -optional messageSubscriptionKey: MessageSubscriptionKey; +messageSubscriptionKey: MessageSubscriptionKey; ``` -Defined in: [gen/types.gen.ts:4733](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4733) +Defined in: [gen/types.gen.ts:5374](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5374) The message subscription key associated with this message subscription. --- -### messageSubscriptionState? +### messageSubscriptionState ```ts -optional messageSubscriptionState: MessageSubscriptionStateEnum; +messageSubscriptionState: MessageSubscriptionStateEnum; ``` -Defined in: [gen/types.gen.ts:4755](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4755) +Defined in: [gen/types.gen.ts:5402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5402) --- -### processDefinitionId? +### processDefinitionId ```ts -optional processDefinitionId: ProcessDefinitionId; +processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:4737](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4737) +Defined in: [gen/types.gen.ts:5378](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5378) The process definition ID associated with this message subscription. --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey | null; ``` -Defined in: [gen/types.gen.ts:4741](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4741) +Defined in: [gen/types.gen.ts:5382](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5382) The process definition key associated with this message subscription. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:4745](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4745) +Defined in: [gen/types.gen.ts:5386](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5386) The process instance key associated with this message subscription. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:4746](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4746) +Defined in: [gen/types.gen.ts:5393](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5393) + +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. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:4768](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4768) +Defined in: [gen/types.gen.ts:5415](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5415) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQuery.md index 39b15f3493e..5d5cb9335a6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQuery.md @@ -11,7 +11,7 @@ mdx: type MessageSubscriptionSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:4779](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4779) +Defined in: [gen/types.gen.ts:5426](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5426) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQueryResult.md index 7ed148cb1f1..fcf15a4504c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQueryResult.md @@ -11,14 +11,14 @@ mdx: type MessageSubscriptionSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:4722](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4722) +Defined in: [gen/types.gen.ts:5363](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5363) ## Type Declaration -### items? +### items ```ts -optional items: MessageSubscriptionResult[]; +items: MessageSubscriptionResult[]; ``` The matching message subscriptions. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQuerySortRequest.md index 7e78ec1407e..b200806f416 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type MessageSubscriptionSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:4771](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4771) +Defined in: [gen/types.gen.ts:5418](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5418) ## Properties @@ -31,7 +31,7 @@ field: | "tenantId"; ``` -Defined in: [gen/types.gen.ts:4775](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4775) +Defined in: [gen/types.gen.ts:5422](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5422) The field to sort by. @@ -43,4 +43,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:4776](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4776) +Defined in: [gen/types.gen.ts:5423](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5423) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateEnum.md index afe99a8a26e..fd003031168 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateEnum.md @@ -15,6 +15,6 @@ type MessageSubscriptionStateEnum = | "MIGRATED"; ``` -Defined in: [gen/types.gen.ts:4921](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4921) +Defined in: [gen/types.gen.ts:5576](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5576) The state of message subscription. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateExactMatch.md index f6ad0a5d9af..98c9bc647d0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateExactMatch.md @@ -11,7 +11,7 @@ mdx: type MessageSubscriptionStateExactMatch = MessageSubscriptionStateEnum; ``` -Defined in: [gen/types.gen.ts:7619](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7619) +Defined in: [gen/types.gen.ts:8465](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8465) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateFilterProperty.md index e928c1cae62..32a6bb7564f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MessageSubscriptionStateFilterProperty.md @@ -13,6 +13,6 @@ type MessageSubscriptionStateFilterProperty = | AdvancedMessageSubscriptionStateFilter; ``` -Defined in: [gen/types.gen.ts:4980](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4980) +Defined in: [gen/types.gen.ts:5635](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5635) MessageSubscriptionStateEnum with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceData.md index 9f605c08081..52f3dfe92c2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceData.md @@ -11,41 +11,17 @@ mdx: type MigrateProcessInstanceData = object; ``` -Defined in: [gen/types.gen.ts:14163](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14163) +Defined in: [gen/types.gen.ts:13514](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13514) ## Properties ### body ```ts -body: object; +body: ProcessInstanceMigrationInstruction; ``` -Defined in: [gen/types.gen.ts:14168](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14168) - -The migration instructions describe how to migrate a process instance from one process definition to another. - -#### mappingInstructions - -```ts -mappingInstructions: MigrateProcessInstanceMappingInstruction[]; -``` - -Element mappings from the source process instance to the target process instance. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` - -#### targetProcessDefinitionKey - -```ts -targetProcessDefinitionKey: ProcessDefinitionKey; -``` - -The key of process definition to migrate the process instance to. +Defined in: [gen/types.gen.ts:13515](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13515) --- @@ -55,7 +31,7 @@ The key of process definition to migrate the process instance to. path: object; ``` -Defined in: [gen/types.gen.ts:14179](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14179) +Defined in: [gen/types.gen.ts:13516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13516) #### processInstanceKey @@ -73,7 +49,7 @@ The key of the process instance that should be migrated. optional query: never; ``` -Defined in: [gen/types.gen.ts:14185](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14185) +Defined in: [gen/types.gen.ts:13522](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13522) --- @@ -83,4 +59,4 @@ Defined in: [gen/types.gen.ts:14185](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}/migration"; ``` -Defined in: [gen/types.gen.ts:14186](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14186) +Defined in: [gen/types.gen.ts:13523](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13523) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceError.md index 24e65ec1ab3..57d25b05030 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceError.md @@ -12,4 +12,4 @@ type MigrateProcessInstanceError = MigrateProcessInstanceErrors[keyof MigrateProcessInstanceErrors]; ``` -Defined in: [gen/types.gen.ts:14214](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14214) +Defined in: [gen/types.gen.ts:13551](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13551) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceErrors.md index d77938a9ad5..37cf05ce83a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceErrors.md @@ -11,7 +11,7 @@ mdx: type MigrateProcessInstanceErrors = object; ``` -Defined in: [gen/types.gen.ts:14189](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14189) +Defined in: [gen/types.gen.ts:13526](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13526) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14189](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14193](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14193) +Defined in: [gen/types.gen.ts:13530](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13530) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14197](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14197) +Defined in: [gen/types.gen.ts:13534](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13534) The process instance is not found. @@ -45,7 +45,7 @@ The process instance is not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14202](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14202) +Defined in: [gen/types.gen.ts:13539](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13539) The process instance migration failed. More details are provided in the response body. @@ -57,7 +57,7 @@ The process instance migration failed. More details are provided in the response 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14206](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14206) +Defined in: [gen/types.gen.ts:13543](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13543) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14211](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14211) +Defined in: [gen/types.gen.ts:13548](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13548) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceMappingInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceMappingInstruction.md index 32aa688105c..9511a53d317 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceMappingInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceMappingInstruction.md @@ -11,7 +11,7 @@ mdx: type MigrateProcessInstanceMappingInstruction = object; ``` -Defined in: [gen/types.gen.ts:5941](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5941) +Defined in: [gen/types.gen.ts:6654](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6654) The mapping instructions describe how to map elements from the source process definition to the target process definition. @@ -23,7 +23,7 @@ The mapping instructions describe how to map elements from the source process de sourceElementId: ElementId; ``` -Defined in: [gen/types.gen.ts:5945](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5945) +Defined in: [gen/types.gen.ts:6658](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6658) The element id to migrate from. @@ -35,6 +35,6 @@ The element id to migrate from. targetElementId: ElementId; ``` -Defined in: [gen/types.gen.ts:5949](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5949) +Defined in: [gen/types.gen.ts:6662](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6662) The element id to migrate into. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceResponse.md index cd1c99b1c54..5577aecbbe3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceResponse.md @@ -12,4 +12,4 @@ type MigrateProcessInstanceResponse = MigrateProcessInstanceResponses[keyof MigrateProcessInstanceResponses]; ``` -Defined in: [gen/types.gen.ts:14223](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14223) +Defined in: [gen/types.gen.ts:13560](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13560) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceResponses.md index 1a213c92492..2e795bd5950 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstanceResponses.md @@ -11,7 +11,7 @@ mdx: type MigrateProcessInstanceResponses = object; ``` -Defined in: [gen/types.gen.ts:14216](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14216) +Defined in: [gen/types.gen.ts:13553](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13553) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14216](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:14220](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14220) +Defined in: [gen/types.gen.ts:13557](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13557) The process instance is migrated. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationData.md index 2a0a1798353..6933f25a723 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationData.md @@ -11,39 +11,17 @@ mdx: type MigrateProcessInstancesBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:13522](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13522) +Defined in: [gen/types.gen.ts:13112](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13112) ## Properties ### body ```ts -body: object; +body: ProcessInstanceMigrationBatchOperationRequest; ``` -Defined in: [gen/types.gen.ts:13523](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13523) - -#### filter - -```ts -filter: ProcessInstanceFilter; -``` - -The process instance filter. - -#### migrationPlan - -```ts -migrationPlan: ProcessInstanceMigrationBatchOperationPlan; -``` - -The migration plan. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` +Defined in: [gen/types.gen.ts:13113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13113) --- @@ -53,7 +31,7 @@ optional operationReference: OperationReference; optional path: never; ``` -Defined in: [gen/types.gen.ts:13534](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13534) +Defined in: [gen/types.gen.ts:13114](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13114) --- @@ -63,7 +41,7 @@ Defined in: [gen/types.gen.ts:13534](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:13535](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13535) +Defined in: [gen/types.gen.ts:13115](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13115) --- @@ -73,4 +51,4 @@ Defined in: [gen/types.gen.ts:13535](https://github.com/camunda/orchestration-cl url: "/process-instances/migration"; ``` -Defined in: [gen/types.gen.ts:13536](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13536) +Defined in: [gen/types.gen.ts:13116](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13116) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationError.md index 75bed4b2cb9..0495f715ba8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationError.md @@ -12,4 +12,4 @@ type MigrateProcessInstancesBatchOperationError = MigrateProcessInstancesBatchOperationErrors[keyof MigrateProcessInstancesBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:13559](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13559) +Defined in: [gen/types.gen.ts:13139](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13139) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationErrors.md index 01104fbb8ac..2869c288322 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type MigrateProcessInstancesBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:13539](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13539) +Defined in: [gen/types.gen.ts:13119](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13119) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13539](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13544](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13544) +Defined in: [gen/types.gen.ts:13124](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13124) The process instance batch operation failed. More details are provided in the response body. @@ -33,7 +33,7 @@ The process instance batch operation failed. More details are provided in the re 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13548](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13548) +Defined in: [gen/types.gen.ts:13128](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13128) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13552](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13552) +Defined in: [gen/types.gen.ts:13132](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13132) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13556](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13556) +Defined in: [gen/types.gen.ts:13136](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13136) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationResponse.md index f9ba3a522df..a9b976fa8d1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationResponse.md @@ -12,4 +12,4 @@ type MigrateProcessInstancesBatchOperationResponse = MigrateProcessInstancesBatchOperationResponses[keyof MigrateProcessInstancesBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:13568](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13568) +Defined in: [gen/types.gen.ts:13148](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13148) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationResponses.md index b12405b2c8b..36552fde8b7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/MigrateProcessInstancesBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type MigrateProcessInstancesBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:13561](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13561) +Defined in: [gen/types.gen.ts:13141](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13141) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13561](https://github.com/camunda/orchestration-cl 200: BatchOperationCreatedResult; ``` -Defined in: [gen/types.gen.ts:13565](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13565) +Defined in: [gen/types.gen.ts:13145](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13145) The batch operation request was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceData.md index 01483e72e43..e32a46350ba 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceData.md @@ -11,47 +11,17 @@ mdx: type ModifyProcessInstanceData = object; ``` -Defined in: [gen/types.gen.ts:14225](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14225) +Defined in: [gen/types.gen.ts:13562](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13562) ## Properties ### body ```ts -body: object; +body: ProcessInstanceModificationInstruction; ``` -Defined in: [gen/types.gen.ts:14226](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14226) - -#### activateInstructions? - -```ts -optional activateInstructions: ProcessInstanceModificationActivateInstruction[]; -``` - -Instructions describing which elements to activate in which scopes and which variables to create or update. - -#### moveInstructions? - -```ts -optional moveInstructions: ProcessInstanceModificationMoveInstruction[]; -``` - -Instructions describing which elements to move from one scope to another. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` - -#### terminateInstructions? - -```ts -optional terminateInstructions: ProcessInstanceModificationTerminateInstruction[]; -``` - -Instructions describing which elements to terminate. +Defined in: [gen/types.gen.ts:13563](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13563) --- @@ -61,7 +31,7 @@ Instructions describing which elements to terminate. path: object; ``` -Defined in: [gen/types.gen.ts:14241](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14241) +Defined in: [gen/types.gen.ts:13564](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13564) #### processInstanceKey @@ -79,7 +49,7 @@ The key of the process instance that should be modified. optional query: never; ``` -Defined in: [gen/types.gen.ts:14247](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14247) +Defined in: [gen/types.gen.ts:13570](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13570) --- @@ -89,4 +59,4 @@ Defined in: [gen/types.gen.ts:14247](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}/modification"; ``` -Defined in: [gen/types.gen.ts:14248](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14248) +Defined in: [gen/types.gen.ts:13571](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13571) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceError.md index 28e3b4ceebe..790e043478e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceError.md @@ -12,4 +12,4 @@ type ModifyProcessInstanceError = ModifyProcessInstanceErrors[keyof ModifyProcessInstanceErrors]; ``` -Defined in: [gen/types.gen.ts:14271](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14271) +Defined in: [gen/types.gen.ts:13594](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13594) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceErrors.md index 1f0c3b78486..76819c515ed 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceErrors.md @@ -11,7 +11,7 @@ mdx: type ModifyProcessInstanceErrors = object; ``` -Defined in: [gen/types.gen.ts:14251](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14251) +Defined in: [gen/types.gen.ts:13574](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13574) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14251](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14255](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14255) +Defined in: [gen/types.gen.ts:13578](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13578) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14259](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14259) +Defined in: [gen/types.gen.ts:13582](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13582) The process instance is not found. @@ -45,7 +45,7 @@ The process instance is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14263](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14263) +Defined in: [gen/types.gen.ts:13586](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13586) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14268](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14268) +Defined in: [gen/types.gen.ts:13591](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13591) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceResponse.md index 40f8c896e3a..77fa4e596f6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceResponse.md @@ -12,4 +12,4 @@ type ModifyProcessInstanceResponse = ModifyProcessInstanceResponses[keyof ModifyProcessInstanceResponses]; ``` -Defined in: [gen/types.gen.ts:14280](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14280) +Defined in: [gen/types.gen.ts:13603](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13603) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceResponses.md index 10c7c5702d0..d7a19612a35 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceResponses.md @@ -11,7 +11,7 @@ mdx: type ModifyProcessInstanceResponses = object; ``` -Defined in: [gen/types.gen.ts:14273](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14273) +Defined in: [gen/types.gen.ts:13596](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13596) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14273](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:14277](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14277) +Defined in: [gen/types.gen.ts:13600](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13600) The process instance is modified. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceVariableInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceVariableInstruction.md index 716dffa31ae..2b647b47591 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceVariableInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstanceVariableInstruction.md @@ -11,7 +11,7 @@ mdx: type ModifyProcessInstanceVariableInstruction = object; ``` -Defined in: [gen/types.gen.ts:5993](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5993) +Defined in: [gen/types.gen.ts:6706](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6706) Instruction describing which variables to create or update. @@ -23,7 +23,7 @@ Instruction describing which variables to create or update. optional scopeId: string; ``` -Defined in: [gen/types.gen.ts:6007](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6007) +Defined in: [gen/types.gen.ts:6720](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6720) 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. @@ -36,7 +36,7 @@ Leave empty to create the variables in the global scope of the process instance. variables: object; ``` -Defined in: [gen/types.gen.ts:5999](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5999) +Defined in: [gen/types.gen.ts:6712](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6712) 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. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationData.md index f2bf9e359d8..13872860257 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationData.md @@ -11,42 +11,17 @@ mdx: type ModifyProcessInstancesBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:13570](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13570) +Defined in: [gen/types.gen.ts:13150](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13150) ## Properties ### body ```ts -body: object; +body: ProcessInstanceModificationBatchOperationRequest; ``` -Defined in: [gen/types.gen.ts:13576](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13576) - -The process instance filter to define on which process instances tokens should be moved, -and new element instances should be activated or terminated. - -#### filter - -```ts -filter: ProcessInstanceFilter; -``` - -The process instance filter. - -#### moveInstructions - -```ts -moveInstructions: ProcessInstanceModificationMoveBatchOperationInstruction[]; -``` - -Instructions for moving tokens between elements. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` +Defined in: [gen/types.gen.ts:13151](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13151) --- @@ -56,7 +31,7 @@ optional operationReference: OperationReference; optional path: never; ``` -Defined in: [gen/types.gen.ts:13587](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13587) +Defined in: [gen/types.gen.ts:13152](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13152) --- @@ -66,7 +41,7 @@ Defined in: [gen/types.gen.ts:13587](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:13588](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13588) +Defined in: [gen/types.gen.ts:13153](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13153) --- @@ -76,4 +51,4 @@ Defined in: [gen/types.gen.ts:13588](https://github.com/camunda/orchestration-cl url: "/process-instances/modification"; ``` -Defined in: [gen/types.gen.ts:13589](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13589) +Defined in: [gen/types.gen.ts:13154](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13154) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationError.md index 76a8150badc..99f5a28ed6c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationError.md @@ -12,4 +12,4 @@ type ModifyProcessInstancesBatchOperationError = ModifyProcessInstancesBatchOperationErrors[keyof ModifyProcessInstancesBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:13612](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13612) +Defined in: [gen/types.gen.ts:13177](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13177) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationErrors.md index 0737d40af1e..c350ea555c9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type ModifyProcessInstancesBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:13592](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13592) +Defined in: [gen/types.gen.ts:13157](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13157) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13592](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13597](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13597) +Defined in: [gen/types.gen.ts:13162](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13162) The process instance batch operation failed. More details are provided in the response body. @@ -33,7 +33,7 @@ The process instance batch operation failed. More details are provided in the re 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13601](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13601) +Defined in: [gen/types.gen.ts:13166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13166) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13605](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13605) +Defined in: [gen/types.gen.ts:13170](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13170) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13609](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13609) +Defined in: [gen/types.gen.ts:13174](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13174) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationResponse.md index 9bbe4b2eb0f..1d7c0f1ae4b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationResponse.md @@ -12,4 +12,4 @@ type ModifyProcessInstancesBatchOperationResponse = ModifyProcessInstancesBatchOperationResponses[keyof ModifyProcessInstancesBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:13621](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13621) +Defined in: [gen/types.gen.ts:13186](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13186) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationResponses.md index bdd07ad1452..a9ac9e774e0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ModifyProcessInstancesBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type ModifyProcessInstancesBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:13614](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13614) +Defined in: [gen/types.gen.ts:13179](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13179) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13614](https://github.com/camunda/orchestration-cl 200: BatchOperationCreatedResult; ``` -Defined in: [gen/types.gen.ts:13618](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13618) +Defined in: [gen/types.gen.ts:13183](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13183) The batch operation request was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/OffsetPagination.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/OffsetPagination.md index af4aed60ca8..67e61ef04d3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/OffsetPagination.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/OffsetPagination.md @@ -11,7 +11,7 @@ mdx: type OffsetPagination = object; ``` -Defined in: [gen/types.gen.ts:6419](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6419) +Defined in: [gen/types.gen.ts:7139](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7139) Offset-based pagination @@ -23,7 +23,7 @@ Offset-based pagination optional from: number; ``` -Defined in: [gen/types.gen.ts:6423](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6423) +Defined in: [gen/types.gen.ts:7143](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7143) The index of items to start searching from. @@ -35,6 +35,6 @@ The index of items to start searching from. optional limit: number; ``` -Defined in: [gen/types.gen.ts:6427](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6427) +Defined in: [gen/types.gen.ts:7147](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7147) The maximum number of items to return in one request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationReference.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationReference.md index bdaa16537b5..9adaaaa8784 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationReference.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationReference.md @@ -11,7 +11,7 @@ mdx: type OperationReference = number; ``` -Defined in: [gen/types.gen.ts:4096](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4096) +Defined in: [gen/types.gen.ts:4735](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4735) A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationTypeExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationTypeExactMatch.md index c0eda6facb4..f98367b7c35 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationTypeExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationTypeExactMatch.md @@ -11,7 +11,7 @@ mdx: type OperationTypeExactMatch = AuditLogOperationTypeEnum; ``` -Defined in: [gen/types.gen.ts:7416](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7416) +Defined in: [gen/types.gen.ts:8248](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8248) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationTypeFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationTypeFilterProperty.md index a7f825279d7..2d2ff82d10e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationTypeFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/OperationTypeFilterProperty.md @@ -13,6 +13,6 @@ type OperationTypeFilterProperty = | AdvancedOperationTypeFilter; ``` -Defined in: [gen/types.gen.ts:371](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L371) +Defined in: [gen/types.gen.ts:384](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L384) AuditLogOperationTypeEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/OwnerTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/OwnerTypeEnum.md index 940adfedbe5..993251a6a07 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/OwnerTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/OwnerTypeEnum.md @@ -17,6 +17,6 @@ type OwnerTypeEnum = | "UNSPECIFIED"; ``` -Defined in: [gen/types.gen.ts:677](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L677) +Defined in: [gen/types.gen.ts:690](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L690) The type of the owner of permissions. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/Partition.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/Partition.md index f385287fb3a..d90e4bc7866 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/Partition.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/Partition.md @@ -11,7 +11,7 @@ mdx: type Partition = object; ``` -Defined in: [gen/types.gen.ts:1323](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1323) +Defined in: [gen/types.gen.ts:1354](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1354) Provides information on a partition within a broker node. @@ -23,7 +23,7 @@ Provides information on a partition within a broker node. health: "healthy" | "unhealthy" | "dead"; ``` -Defined in: [gen/types.gen.ts:1335](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1335) +Defined in: [gen/types.gen.ts:1366](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1366) Describes the current health of the partition. @@ -35,7 +35,7 @@ Describes the current health of the partition. partitionId: number; ``` -Defined in: [gen/types.gen.ts:1327](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1327) +Defined in: [gen/types.gen.ts:1358](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1358) The unique ID of this partition. @@ -47,6 +47,6 @@ The unique ID of this partition. role: "leader" | "follower" | "inactive"; ``` -Defined in: [gen/types.gen.ts:1331](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1331) +Defined in: [gen/types.gen.ts:1362](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1362) Describes the Raft role of the broker for a given partition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PermissionTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PermissionTypeEnum.md index 43c5cea0307..8f7696d5664 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PermissionTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PermissionTypeEnum.md @@ -12,7 +12,9 @@ type PermissionTypeEnum = | "ACCESS" | "CANCEL_PROCESS_INSTANCE" | "CLAIM" + | "CLAIM_USER_TASK" | "COMPLETE" + | "COMPLETE_USER_TASK" | "CREATE" | "CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE" | "CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION" @@ -50,6 +52,6 @@ type PermissionTypeEnum = | "UPDATE_TASK_LISTENER"; ``` -Defined in: [gen/types.gen.ts:667](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L667) +Defined in: [gen/types.gen.ts:680](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L680) Specifies the type of permissions. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockData.md index a040dcfb199..83fd5fdae93 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockData.md @@ -11,7 +11,7 @@ mdx: type PinClockData = object; ``` -Defined in: [gen/types.gen.ts:8520](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8520) +Defined in: [gen/types.gen.ts:9043](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9043) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8520](https://github.com/camunda/orchestration-clu body: ClockPinRequest; ``` -Defined in: [gen/types.gen.ts:8521](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8521) +Defined in: [gen/types.gen.ts:9044](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9044) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8521](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:8522](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8522) +Defined in: [gen/types.gen.ts:9045](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9045) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:8522](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:8523](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8523) +Defined in: [gen/types.gen.ts:9046](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9046) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:8523](https://github.com/camunda/orchestration-clu url: "/clock"; ``` -Defined in: [gen/types.gen.ts:8524](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8524) +Defined in: [gen/types.gen.ts:9047](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9047) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockError.md index f659574cfb7..55078163626 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockError.md @@ -11,4 +11,4 @@ mdx: type PinClockError = PinClockErrors[keyof PinClockErrors]; ``` -Defined in: [gen/types.gen.ts:8543](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8543) +Defined in: [gen/types.gen.ts:9066](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9066) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockErrors.md index 5a6a3451c81..d42718c69b5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockErrors.md @@ -11,7 +11,7 @@ mdx: type PinClockErrors = object; ``` -Defined in: [gen/types.gen.ts:8527](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8527) +Defined in: [gen/types.gen.ts:9050](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9050) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8527](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8531](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8531) +Defined in: [gen/types.gen.ts:9054](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9054) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8535](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8535) +Defined in: [gen/types.gen.ts:9058](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9058) An internal error occurred while processing the request. @@ -45,6 +45,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8540](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8540) +Defined in: [gen/types.gen.ts:9063](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9063) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockResponse.md index f9282066006..bd9c436b21c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockResponse.md @@ -11,4 +11,4 @@ mdx: type PinClockResponse = PinClockResponses[keyof PinClockResponses]; ``` -Defined in: [gen/types.gen.ts:8552](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8552) +Defined in: [gen/types.gen.ts:9075](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9075) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockResponses.md index 9caa08882b5..097adfb1e49 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PinClockResponses.md @@ -11,7 +11,7 @@ mdx: type PinClockResponses = object; ``` -Defined in: [gen/types.gen.ts:8545](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8545) +Defined in: [gen/types.gen.ts:9068](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9068) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8545](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:8549](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8549) +Defined in: [gen/types.gen.ts:9072](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9072) The clock was successfully pinned. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProblemDetail.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProblemDetail.md index 44639fb809d..aaf1baeef0e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProblemDetail.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProblemDetail.md @@ -11,66 +11,66 @@ mdx: type ProblemDetail = object; ``` -Defined in: [gen/types.gen.ts:5054](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5054) +Defined in: [gen/types.gen.ts:5709](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5709) 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. ## Properties -### detail? +### detail ```ts -optional detail: string; +detail: string; ``` -Defined in: [gen/types.gen.ts:5070](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5070) +Defined in: [gen/types.gen.ts:5725](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5725) An explanation of the problem in more detail. --- -### instance? +### instance ```ts -optional instance: string; +instance: string; ``` -Defined in: [gen/types.gen.ts:5074](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5074) +Defined in: [gen/types.gen.ts:5729](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5729) A URI path identifying the origin of the problem. --- -### status? +### status ```ts -optional status: number; +status: number; ``` -Defined in: [gen/types.gen.ts:5066](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5066) +Defined in: [gen/types.gen.ts:5721](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5721) The HTTP status code for this problem. --- -### title? +### title ```ts -optional title: string; +title: string; ``` -Defined in: [gen/types.gen.ts:5062](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5062) +Defined in: [gen/types.gen.ts:5717](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5717) A summary of the problem type. --- -### type? +### type ```ts -optional type: string; +type: string; ``` -Defined in: [gen/types.gen.ts:5058](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5058) +Defined in: [gen/types.gen.ts:5713](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5713) A URI identifying the problem type. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionElementStatisticsQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionElementStatisticsQuery.md index 6645ab5bb34..0913c91423d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionElementStatisticsQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionElementStatisticsQuery.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionElementStatisticsQuery = object; ``` -Defined in: [gen/types.gen.ts:5186](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5186) +Defined in: [gen/types.gen.ts:5842](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5842) Process definition element statistics request. @@ -23,6 +23,6 @@ Process definition element statistics request. optional filter: ProcessDefinitionStatisticsFilter; ``` -Defined in: [gen/types.gen.ts:5190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5190) +Defined in: [gen/types.gen.ts:5846](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5846) The process definition statistics search filters. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionElementStatisticsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionElementStatisticsQueryResult.md index d831e28b5d9..4873554ef12 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionElementStatisticsQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionElementStatisticsQueryResult.md @@ -11,18 +11,18 @@ mdx: type ProcessDefinitionElementStatisticsQueryResult = object; ``` -Defined in: [gen/types.gen.ts:5196](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5196) +Defined in: [gen/types.gen.ts:5852](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5852) Process definition element statistics query response. ## Properties -### items? +### items ```ts -optional items: ProcessElementStatisticsResult[]; +items: ProcessElementStatisticsResult[]; ``` -Defined in: [gen/types.gen.ts:5200](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5200) +Defined in: [gen/types.gen.ts:5856](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5856) The element statistics. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionFilter.md index 074c6ea1f96..0ae50d30895 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionFilter.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionFilter = object; ``` -Defined in: [gen/types.gen.ts:5099](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5099) +Defined in: [gen/types.gen.ts:5754](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5754) Process definition search filter. @@ -23,7 +23,7 @@ Process definition search filter. optional hasStartForm: boolean; ``` -Defined in: [gen/types.gen.ts:5138](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5138) +Defined in: [gen/types.gen.ts:5794](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5794) Indicates whether the start event of the process has an associated Form Key. @@ -35,11 +35,12 @@ Indicates whether the start event of the process has an associated Form Key. optional isLatestVersion: boolean; ``` -Defined in: [gen/types.gen.ts:5110](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5110) +Defined in: [gen/types.gen.ts:5766](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5766) 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. --- @@ -49,7 +50,7 @@ The response contains no `startCursor` in the `page`, and requests ignore the `f optional name: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:5103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5103) +Defined in: [gen/types.gen.ts:5758](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5758) Name of this process definition. @@ -61,7 +62,7 @@ Name of this process definition. optional processDefinitionId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:5126](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5126) +Defined in: [gen/types.gen.ts:5782](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5782) Process definition ID of this process definition. @@ -73,7 +74,7 @@ Process definition ID of this process definition. optional processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5134](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5134) +Defined in: [gen/types.gen.ts:5790](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5790) The key for this process definition. @@ -85,7 +86,7 @@ The key for this process definition. optional resourceName: string; ``` -Defined in: [gen/types.gen.ts:5114](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5114) +Defined in: [gen/types.gen.ts:5770](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5770) Resource name of this process definition. @@ -97,7 +98,7 @@ Resource name of this process definition. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5130](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5130) +Defined in: [gen/types.gen.ts:5786](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5786) Tenant ID of this process definition. @@ -109,7 +110,7 @@ Tenant ID of this process definition. optional version: number; ``` -Defined in: [gen/types.gen.ts:5118](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5118) +Defined in: [gen/types.gen.ts:5774](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5774) Version of this process definition. @@ -121,6 +122,6 @@ Version of this process definition. optional versionTag: string; ``` -Defined in: [gen/types.gen.ts:5122](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5122) +Defined in: [gen/types.gen.ts:5778](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5778) Version tag of this process definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionId.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionId.md index 0f8b80cec1b..e979f30838d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionId.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionId.md @@ -11,6 +11,6 @@ mdx: type ProcessDefinitionId = CamundaKey<"ProcessDefinitionId">; ``` -Defined in: [gen/types.gen.ts:2962](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2962) +Defined in: [gen/types.gen.ts:3309](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3309) Id of a process definition, from the model. Only ids of process definitions that are deployed are useful. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQuery.md index 5389f8e32ad..ee99bb63c15 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQuery.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionInstanceStatisticsQuery = object; ``` -Defined in: [gen/types.gen.ts:5267](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5267) +Defined in: [gen/types.gen.ts:5926](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5926) ## Properties @@ -21,7 +21,9 @@ Defined in: [gen/types.gen.ts:5267](https://github.com/camunda/orchestration-clu optional page: OffsetPagination; ``` -Defined in: [gen/types.gen.ts:5268](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5268) +Defined in: [gen/types.gen.ts:5930](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5930) + +Search cursor pagination. --- @@ -31,6 +33,6 @@ Defined in: [gen/types.gen.ts:5268](https://github.com/camunda/orchestration-clu optional sort: ProcessDefinitionInstanceStatisticsQuerySortRequest[]; ``` -Defined in: [gen/types.gen.ts:5272](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5272) +Defined in: [gen/types.gen.ts:5934](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5934) Sort field criteria. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQueryResult.md index 74b973276a7..0b34c3e9e81 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQueryResult.md @@ -12,14 +12,14 @@ type ProcessDefinitionInstanceStatisticsQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:5275](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5275) +Defined in: [gen/types.gen.ts:5937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5937) ## Type Declaration -### items? +### items ```ts -optional items: ProcessDefinitionInstanceStatisticsResult[]; +items: ProcessDefinitionInstanceStatisticsResult[]; ``` The process definition instance statistics result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQuerySortRequest.md index cc59208339c..6b7c7b1f551 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionInstanceStatisticsQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:5306](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5306) +Defined in: [gen/types.gen.ts:5968](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5968) ## Properties @@ -24,7 +24,7 @@ field: | "activeInstancesWithoutIncidentCount"; ``` -Defined in: [gen/types.gen.ts:5310](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5310) +Defined in: [gen/types.gen.ts:5972](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5972) The field to sort by. @@ -36,4 +36,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:5311](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5311) +Defined in: [gen/types.gen.ts:5973](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5973) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsResult.md index 93c812ac0c1..5bb929f2a27 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceStatisticsResult.md @@ -11,74 +11,74 @@ mdx: type ProcessDefinitionInstanceStatisticsResult = object; ``` -Defined in: [gen/types.gen.ts:5285](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5285) +Defined in: [gen/types.gen.ts:5947](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5947) Process definition instance statistics response. ## Properties -### activeInstancesWithIncidentCount? +### activeInstancesWithIncidentCount ```ts -optional activeInstancesWithIncidentCount: number; +activeInstancesWithIncidentCount: number; ``` -Defined in: [gen/types.gen.ts:5303](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5303) +Defined in: [gen/types.gen.ts:5965](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5965) Total number of currently active process instances of this definition that have at least one incident. --- -### activeInstancesWithoutIncidentCount? +### activeInstancesWithoutIncidentCount ```ts -optional activeInstancesWithoutIncidentCount: number; +activeInstancesWithoutIncidentCount: number; ``` -Defined in: [gen/types.gen.ts:5299](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5299) +Defined in: [gen/types.gen.ts:5961](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5961) Total number of currently active process instances of this definition that do not have incidents. --- -### hasMultipleVersions? +### hasMultipleVersions ```ts -optional hasMultipleVersions: boolean; +hasMultipleVersions: boolean; ``` -Defined in: [gen/types.gen.ts:5295](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5295) +Defined in: [gen/types.gen.ts:5957](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5957) Indicates whether multiple versions of this process definition instance are deployed. --- -### latestProcessDefinitionName? +### latestProcessDefinitionName ```ts -optional latestProcessDefinitionName: string; +latestProcessDefinitionName: string | null; ``` -Defined in: [gen/types.gen.ts:5291](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5291) +Defined in: [gen/types.gen.ts:5953](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5953) Name of the latest deployed process definition instance version. --- -### processDefinitionId? +### processDefinitionId ```ts -optional processDefinitionId: ProcessDefinitionId; +processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:5286](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5286) +Defined in: [gen/types.gen.ts:5948](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5948) --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5287](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5287) +Defined in: [gen/types.gen.ts:5949](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5949) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsFilter.md index 80382b05b3e..b6b40c50d29 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsFilter.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionInstanceVersionStatisticsFilter = object; ``` -Defined in: [gen/types.gen.ts:5332](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5332) +Defined in: [gen/types.gen.ts:5994](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5994) Process definition instance version statistics search filter. @@ -23,7 +23,7 @@ Process definition instance version statistics search filter. processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:5336](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5336) +Defined in: [gen/types.gen.ts:5998](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5998) The ID of the process definition to retrieve version statistics for. @@ -35,6 +35,6 @@ The ID of the process definition to retrieve version statistics for. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5340](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5340) +Defined in: [gen/types.gen.ts:6002](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6002) Tenant ID of this process definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQuery.md index 86138090e8b..3f04eb1773b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQuery.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionInstanceVersionStatisticsQuery = object; ``` -Defined in: [gen/types.gen.ts:5314](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5314) +Defined in: [gen/types.gen.ts:5976](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5976) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:5314](https://github.com/camunda/orchestration-clu filter: ProcessDefinitionInstanceVersionStatisticsFilter; ``` -Defined in: [gen/types.gen.ts:5326](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5326) +Defined in: [gen/types.gen.ts:5988](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5988) The process definition instance version statistics search filters. @@ -33,7 +33,7 @@ The process definition instance version statistics search filters. optional page: OffsetPagination; ``` -Defined in: [gen/types.gen.ts:5318](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5318) +Defined in: [gen/types.gen.ts:5980](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5980) Pagination criteria. @@ -45,6 +45,6 @@ Pagination criteria. optional sort: ProcessDefinitionInstanceVersionStatisticsQuerySortRequest[]; ``` -Defined in: [gen/types.gen.ts:5322](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5322) +Defined in: [gen/types.gen.ts:5984](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5984) Sort field criteria. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQueryResult.md index ff7f10eecbd..fe3c99ebeea 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQueryResult.md @@ -12,14 +12,14 @@ type ProcessDefinitionInstanceVersionStatisticsQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:5343](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5343) +Defined in: [gen/types.gen.ts:6005](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6005) ## Type Declaration -### items? +### items ```ts -optional items: ProcessDefinitionInstanceVersionStatisticsResult[]; +items: ProcessDefinitionInstanceVersionStatisticsResult[]; ``` The process definition instance version statistics result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQuerySortRequest.md index e098f61c0dd..d6cfcb80be8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionInstanceVersionStatisticsQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:5384](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5384) +Defined in: [gen/types.gen.ts:6046](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6046) ## Properties @@ -27,7 +27,7 @@ field: | "activeInstancesWithoutIncidentCount"; ``` -Defined in: [gen/types.gen.ts:5388](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5388) +Defined in: [gen/types.gen.ts:6050](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6050) The field to sort by. @@ -39,4 +39,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:5389](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5389) +Defined in: [gen/types.gen.ts:6051](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6051) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsResult.md index 25adc4e7b64..baa67c997fb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionInstanceVersionStatisticsResult.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionInstanceVersionStatisticsResult = object; ``` -Defined in: [gen/types.gen.ts:5353](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5353) +Defined in: [gen/types.gen.ts:6015](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6015) Process definition instance version statistics response. @@ -23,7 +23,7 @@ Process definition instance version statistics response. activeInstancesWithIncidentCount: number; ``` -Defined in: [gen/types.gen.ts:5377](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5377) +Defined in: [gen/types.gen.ts:6039](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6039) The number of active process instances for this version that currently have incidents. @@ -35,7 +35,7 @@ The number of active process instances for this version that currently have inci activeInstancesWithoutIncidentCount: number; ``` -Defined in: [gen/types.gen.ts:5381](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5381) +Defined in: [gen/types.gen.ts:6043](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6043) The number of active process instances for this version that do not have any incidents. @@ -47,7 +47,7 @@ The number of active process instances for this version that do not have any inc processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:5357](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5357) +Defined in: [gen/types.gen.ts:6019](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6019) The ID associated with the process definition. @@ -59,7 +59,7 @@ The ID associated with the process definition. processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5361) +Defined in: [gen/types.gen.ts:6023](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6023) The unique key of the process definition. @@ -68,10 +68,10 @@ The unique key of the process definition. ### processDefinitionName ```ts -processDefinitionName: string; +processDefinitionName: string | null; ``` -Defined in: [gen/types.gen.ts:5365](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5365) +Defined in: [gen/types.gen.ts:6027](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6027) The name of the process definition. @@ -83,7 +83,7 @@ The name of the process definition. processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:5373](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5373) +Defined in: [gen/types.gen.ts:6035](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6035) The version number of the process definition. @@ -95,6 +95,6 @@ The version number of the process definition. tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5369](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5369) +Defined in: [gen/types.gen.ts:6031](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6031) The tenant ID associated with the process definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKey.md index 6e4db718fcc..1a66384a26f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKey.md @@ -11,6 +11,6 @@ mdx: type ProcessDefinitionKey = CamundaKey<"ProcessDefinitionKey">; ``` -Defined in: [gen/types.gen.ts:4024](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4024) +Defined in: [gen/types.gen.ts:4661](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4661) System-generated key for a deployed process definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKeyExactMatch.md index e28752b8da2..004a7e47720 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionKeyExactMatch = ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:7535](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7535) +Defined in: [gen/types.gen.ts:8381](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8381) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKeyFilterProperty.md index 843c29dde87..0846f006c85 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionKeyFilterProperty.md @@ -13,6 +13,6 @@ type ProcessDefinitionKeyFilterProperty = | AdvancedProcessDefinitionKeyFilter; ``` -Defined in: [gen/types.gen.ts:4106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4106) +Defined in: [gen/types.gen.ts:4745](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4745) ProcessDefinitionKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQuery.md index f59d2f38ef7..a3602b23781 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQuery.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionMessageSubscriptionStatisticsQuery = object; ``` -Defined in: [gen/types.gen.ts:5229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5229) +Defined in: [gen/types.gen.ts:5885](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5885) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:5229](https://github.com/camunda/orchestration-clu optional filter: MessageSubscriptionFilter; ``` -Defined in: [gen/types.gen.ts:5234](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5234) +Defined in: [gen/types.gen.ts:5893](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5893) The message subscription filters. @@ -33,4 +33,6 @@ The message subscription filters. optional page: CursorForwardPagination; ``` -Defined in: [gen/types.gen.ts:5230](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5230) +Defined in: [gen/types.gen.ts:5889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5889) + +Search cursor pagination. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQueryResult.md index 105b84ca793..695dbe5cebb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsQueryResult.md @@ -12,14 +12,14 @@ type ProcessDefinitionMessageSubscriptionStatisticsQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:5237](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5237) +Defined in: [gen/types.gen.ts:5896](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5896) ## Type Declaration -### items? +### items ```ts -optional items: ProcessDefinitionMessageSubscriptionStatisticsResult[]; +items: ProcessDefinitionMessageSubscriptionStatisticsResult[]; ``` The matching process definition message subscription statistics. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsResult.md index 5cc0012b4e6..fe2011d076e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionMessageSubscriptionStatisticsResult.md @@ -11,64 +11,64 @@ mdx: type ProcessDefinitionMessageSubscriptionStatisticsResult = object; ``` -Defined in: [gen/types.gen.ts:5244](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5244) +Defined in: [gen/types.gen.ts:5903](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5903) ## Properties -### activeSubscriptions? +### activeSubscriptions ```ts -optional activeSubscriptions: number; +activeSubscriptions: number; ``` -Defined in: [gen/types.gen.ts:5264](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5264) +Defined in: [gen/types.gen.ts:5923](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5923) The total number of active message subscriptions for this process definition key. --- -### processDefinitionId? +### processDefinitionId ```ts -optional processDefinitionId: ProcessDefinitionId; +processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:5248](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5248) +Defined in: [gen/types.gen.ts:5907](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5907) The process definition ID associated with this message subscription. --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5256](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5256) +Defined in: [gen/types.gen.ts:5915](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5915) The process definition key associated with this message subscription. --- -### processInstancesWithActiveSubscriptions? +### processInstancesWithActiveSubscriptions ```ts -optional processInstancesWithActiveSubscriptions: number; +processInstancesWithActiveSubscriptions: number; ``` -Defined in: [gen/types.gen.ts:5260](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5260) +Defined in: [gen/types.gen.ts:5919](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5919) The number of process instances with active message subscriptions. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5252](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5252) +Defined in: [gen/types.gen.ts:5911](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5911) The tenant ID associated with this message subscription. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionResult.md index ab519e5baf2..a40dad5fa77 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionResult.md @@ -11,100 +11,100 @@ mdx: type ProcessDefinitionResult = object; ``` -Defined in: [gen/types.gen.ts:5148](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5148) +Defined in: [gen/types.gen.ts:5804](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5804) ## Properties -### hasStartForm? +### hasStartForm ```ts -optional hasStartForm: boolean; +hasStartForm: boolean; ``` -Defined in: [gen/types.gen.ts:5180](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5180) +Defined in: [gen/types.gen.ts:5836](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5836) Indicates whether the start event of the process has an associated Form Key. --- -### name? +### name ```ts -optional name: string; +name: string | null; ``` -Defined in: [gen/types.gen.ts:5152](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5152) +Defined in: [gen/types.gen.ts:5808](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5808) Name of this process definition. --- -### processDefinitionId? +### processDefinitionId ```ts -optional processDefinitionId: ProcessDefinitionId; +processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:5168](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5168) +Defined in: [gen/types.gen.ts:5824](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5824) Process definition ID of this process definition. --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5176](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5176) +Defined in: [gen/types.gen.ts:5832](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5832) The key for this process definition. --- -### resourceName? +### resourceName ```ts -optional resourceName: string; +resourceName: string; ``` -Defined in: [gen/types.gen.ts:5156](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5156) +Defined in: [gen/types.gen.ts:5812](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5812) Resource name for this process definition. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5172](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5172) +Defined in: [gen/types.gen.ts:5828](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5828) Tenant ID of this process definition. --- -### version? +### version ```ts -optional version: number; +version: number; ``` -Defined in: [gen/types.gen.ts:5160](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5160) +Defined in: [gen/types.gen.ts:5816](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5816) Version of this process definition. --- -### versionTag? +### versionTag ```ts -optional versionTag: string; +versionTag: string | null; ``` -Defined in: [gen/types.gen.ts:5164](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5164) +Defined in: [gen/types.gen.ts:5820](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5820) Version tag of this process definition. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQuery.md index 95bd4c24ba0..f6a48cc0525 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQuery.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:5085](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5085) +Defined in: [gen/types.gen.ts:5740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5740) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQueryResult.md index eb027fe9397..7ae81a054f2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQueryResult.md @@ -11,14 +11,14 @@ mdx: type ProcessDefinitionSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:5141](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5141) +Defined in: [gen/types.gen.ts:5797](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5797) ## Type Declaration -### items? +### items ```ts -optional items: ProcessDefinitionResult[]; +items: ProcessDefinitionResult[]; ``` The matching process definitions. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQuerySortRequest.md index 7c1e4efbf01..322f6c061c4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type ProcessDefinitionSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:5077](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5077) +Defined in: [gen/types.gen.ts:5732](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5732) ## Properties @@ -28,7 +28,7 @@ field: | "tenantId"; ``` -Defined in: [gen/types.gen.ts:5081](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5081) +Defined in: [gen/types.gen.ts:5736](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5736) The field to sort by. @@ -40,4 +40,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:5082](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5082) +Defined in: [gen/types.gen.ts:5737](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5737) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionStatisticsFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionStatisticsFilter.md index 654205b502d..fc490c2be62 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionStatisticsFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessDefinitionStatisticsFilter.md @@ -12,7 +12,7 @@ type ProcessDefinitionStatisticsFilter = BaseProcessInstanceFilterFields & object; ``` -Defined in: [gen/types.gen.ts:5695](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5695) +Defined in: [gen/types.gen.ts:6383](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6383) Process definition statistics search filter. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessElementStatisticsResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessElementStatisticsResult.md index 276e498bd0d..a6daed2d8fc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessElementStatisticsResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessElementStatisticsResult.md @@ -11,66 +11,66 @@ mdx: type ProcessElementStatisticsResult = object; ``` -Defined in: [gen/types.gen.ts:5206](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5206) +Defined in: [gen/types.gen.ts:5862](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5862) Process element statistics response. ## Properties -### active? +### active ```ts -optional active: number; +active: number; ``` -Defined in: [gen/types.gen.ts:5214](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5214) +Defined in: [gen/types.gen.ts:5870](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5870) The total number of active instances of the element. --- -### canceled? +### canceled ```ts -optional canceled: number; +canceled: number; ``` -Defined in: [gen/types.gen.ts:5218](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5218) +Defined in: [gen/types.gen.ts:5874](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5874) The total number of canceled instances of the element. --- -### completed? +### completed ```ts -optional completed: number; +completed: number; ``` -Defined in: [gen/types.gen.ts:5226](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5226) +Defined in: [gen/types.gen.ts:5882](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5882) The total number of completed instances of the element. --- -### elementId? +### elementId ```ts -optional elementId: ElementId; +elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:5210](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5210) +Defined in: [gen/types.gen.ts:5866](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5866) The element ID for which the results are aggregated. --- -### incidents? +### incidents ```ts -optional incidents: number; +incidents: number; ``` -Defined in: [gen/types.gen.ts:5222](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5222) +Defined in: [gen/types.gen.ts:5878](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L5878) The total number of incidents for the element. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCallHierarchyEntry.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCallHierarchyEntry.md index bb68ebe2316..3cf8d5a6e85 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCallHierarchyEntry.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCallHierarchyEntry.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceCallHierarchyEntry = object; ``` -Defined in: [gen/types.gen.ts:5858](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5858) +Defined in: [gen/types.gen.ts:6565](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6565) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:5858](https://github.com/camunda/orchestration-clu processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5866](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5866) +Defined in: [gen/types.gen.ts:6573](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6573) The key of the process definition. @@ -33,7 +33,7 @@ The key of the process definition. processDefinitionName: string; ``` -Defined in: [gen/types.gen.ts:5870](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5870) +Defined in: [gen/types.gen.ts:6577](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6577) The name of the process definition (fall backs to the process definition id if not available). @@ -45,6 +45,6 @@ The name of the process definition (fall backs to the process definition id if n processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:5862](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5862) +Defined in: [gen/types.gen.ts:6569](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6569) The key of the process instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCancellationBatchOperationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCancellationBatchOperationRequest.md index 5fb19bda1c5..3a40d6dfc2e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCancellationBatchOperationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCancellationBatchOperationRequest.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceCancellationBatchOperationRequest = object; ``` -Defined in: [gen/types.gen.ts:904](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L904) +Defined in: [gen/types.gen.ts:935](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L935) The process instance filter that defines which process instances should be canceled. @@ -23,7 +23,7 @@ The process instance filter that defines which process instances should be cance filter: ProcessInstanceFilter; ``` -Defined in: [gen/types.gen.ts:908](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L908) +Defined in: [gen/types.gen.ts:939](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L939) The process instance filter. @@ -35,4 +35,4 @@ The process instance filter. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:909](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L909) +Defined in: [gen/types.gen.ts:940](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L940) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstruction.md index 503c4f6a673..6e6878a5a00 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstruction.md @@ -9,11 +9,11 @@ mdx: ```ts type ProcessInstanceCreationInstruction = - | ProcessInstanceCreationInstructionById - | ProcessInstanceCreationInstructionByKey; + | ProcessInstanceCreationInstructionByKey + | ProcessInstanceCreationInstructionById; ``` -Defined in: [gen/types.gen.ts:5397](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5397) +Defined in: [gen/types.gen.ts:6059](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6059) Instructions for creating a process instance. The process definition can be specified either by id or by key. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstructionById.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstructionById.md index 85b665dd57f..730d9cc1a10 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstructionById.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstructionById.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceCreationInstructionById = object; ``` -Defined in: [gen/types.gen.ts:5402](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5402) +Defined in: [gen/types.gen.ts:6064](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6064) Process creation by id @@ -23,11 +23,22 @@ Process creation by id optional awaitCompletion: boolean; ``` -Defined in: [gen/types.gen.ts:5448](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5448) +Defined in: [gen/types.gen.ts:6114](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6114) -Wait for the process instance to complete. If the process instance completion does -not occur within the requestTimeout, the request will be closed. This can lead to a 504 -response status. Disabled by default. +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. + +--- + +### businessId? + +```ts +optional businessId: BusinessId; +``` + +Defined in: [gen/types.gen.ts:6128](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6128) --- @@ -37,7 +48,7 @@ response status. Disabled by default. optional fetchVariables: string[]; ``` -Defined in: [gen/types.gen.ts:5454](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5454) +Defined in: [gen/types.gen.ts:6120](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6120) 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. @@ -50,7 +61,7 @@ If empty, all visible variables in the root scope will be returned. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:5425](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5425) +Defined in: [gen/types.gen.ts:6090](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6090) --- @@ -60,7 +71,7 @@ Defined in: [gen/types.gen.ts:5425](https://github.com/camunda/orchestration-clu processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:5407](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5407) +Defined in: [gen/types.gen.ts:6069](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6069) The BPMN process id of the process definition to start an instance of. @@ -72,7 +83,7 @@ The BPMN process id of the process definition to start an instance of. optional processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:5412](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5412) +Defined in: [gen/types.gen.ts:6074](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6074) The version of the process. By default, the latest version of the process is used. @@ -84,7 +95,7 @@ The version of the process. By default, the latest version of the process is use optional requestTimeout: number; ``` -Defined in: [gen/types.gen.ts:5460](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5460) +Defined in: [gen/types.gen.ts:6126](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6126) 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. @@ -97,7 +108,7 @@ when set to 0, the generic request timeout configured in the cluster is applied. optional runtimeInstructions: ProcessInstanceCreationRuntimeInstruction[]; ``` -Defined in: [gen/types.gen.ts:5441](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5441) +Defined in: [gen/types.gen.ts:6106](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6106) Runtime instructions (alpha). List of instructions that affect the runtime behavior of the process instance. Refer to specific instruction types for more details. @@ -113,7 +124,7 @@ in future releases. optional startInstructions: ProcessInstanceCreationStartInstruction[]; ``` -Defined in: [gen/types.gen.ts:5432](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5432) +Defined in: [gen/types.gen.ts:6097](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6097) List of start instructions. By default, the process instance will start at the start event. If provided, the process instance will apply start instructions @@ -127,7 +138,7 @@ after it has been created. optional tags: TagSet; ``` -Defined in: [gen/types.gen.ts:5461](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5461) +Defined in: [gen/types.gen.ts:6127](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6127) --- @@ -137,9 +148,11 @@ Defined in: [gen/types.gen.ts:5461](https://github.com/camunda/orchestration-clu optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5424](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5424) +Defined in: [gen/types.gen.ts:6089](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6089) 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. --- @@ -149,7 +162,7 @@ The tenant id of the process definition. optional variables: object; ``` -Defined in: [gen/types.gen.ts:5418](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5418) +Defined in: [gen/types.gen.ts:6080](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6080) JSON object that will instantiate the variables for the root variable scope of the process instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstructionByKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstructionByKey.md index 25bfefe908d..e56e32aa85b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstructionByKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationInstructionByKey.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceCreationInstructionByKey = object; ``` -Defined in: [gen/types.gen.ts:5467](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5467) +Defined in: [gen/types.gen.ts:6134](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6134) Process creation by key @@ -23,11 +23,22 @@ Process creation by key optional awaitCompletion: boolean; ``` -Defined in: [gen/types.gen.ts:5515](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5515) +Defined in: [gen/types.gen.ts:6186](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6186) -Wait for the process instance to complete. If the process instance completion does -not occur within the requestTimeout, the request will be closed. This can lead to a 504 -response status. Disabled by default. +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. + +--- + +### businessId? + +```ts +optional businessId: BusinessId; +``` + +Defined in: [gen/types.gen.ts:6200](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6200) --- @@ -37,7 +48,7 @@ response status. Disabled by default. optional fetchVariables: string[]; ``` -Defined in: [gen/types.gen.ts:5527](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5527) +Defined in: [gen/types.gen.ts:6198](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6198) 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. @@ -50,7 +61,7 @@ If empty, all visible variables in the root scope will be returned. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:5508](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5508) +Defined in: [gen/types.gen.ts:6178](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6178) --- @@ -60,7 +71,7 @@ Defined in: [gen/types.gen.ts:5508](https://github.com/camunda/orchestration-clu processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5473](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5473) +Defined in: [gen/types.gen.ts:6140](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6140) The unique key identifying the process definition, for example, returned for a process in the deploy resources endpoint. @@ -73,7 +84,7 @@ deploy resources endpoint. optional processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:5479](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5479) +Defined in: [gen/types.gen.ts:6146](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6146) 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. @@ -86,7 +97,7 @@ It's here for backwards-compatibility only as previous releases accepted it in r optional requestTimeout: number; ``` -Defined in: [gen/types.gen.ts:5521](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5521) +Defined in: [gen/types.gen.ts:6192](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6192) 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. @@ -99,7 +110,7 @@ when set to 0, the generic request timeout configured in the cluster is applied. optional runtimeInstructions: ProcessInstanceCreationRuntimeInstruction[]; ``` -Defined in: [gen/types.gen.ts:5503](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5503) +Defined in: [gen/types.gen.ts:6170](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6170) Runtime instructions (alpha). List of instructions that affect the runtime behavior of the process instance. Refer to specific instruction types for more details. @@ -115,7 +126,7 @@ in future releases. optional startInstructions: ProcessInstanceCreationStartInstruction[]; ``` -Defined in: [gen/types.gen.ts:5494](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5494) +Defined in: [gen/types.gen.ts:6161](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6161) List of start instructions. By default, the process instance will start at the start event. If provided, the process instance will apply start instructions @@ -129,7 +140,7 @@ after it has been created. optional tags: TagSet; ``` -Defined in: [gen/types.gen.ts:5528](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5528) +Defined in: [gen/types.gen.ts:6199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6199) --- @@ -139,9 +150,11 @@ Defined in: [gen/types.gen.ts:5528](https://github.com/camunda/orchestration-clu optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5507](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5507) +Defined in: [gen/types.gen.ts:6177](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6177) 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. --- @@ -151,10 +164,10 @@ The tenant id of the process definition. optional variables: object; ``` -Defined in: [gen/types.gen.ts:5485](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5485) +Defined in: [gen/types.gen.ts:6152](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6152) -JSON object that will instantiate the variables for the root variable scope -of the process instance. +Set of variables as JSON object to instantiate in the root variable scope of the process +instance. Can include nested complex objects. #### Index Signature diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationRuntimeInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationRuntimeInstruction.md index cc6d86d51b5..b3e82cec0a5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationRuntimeInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationRuntimeInstruction.md @@ -12,7 +12,7 @@ type ProcessInstanceCreationRuntimeInstruction = object & ProcessInstanceCreationTerminateInstruction; ``` -Defined in: [gen/types.gen.ts:5543](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5543) +Defined in: [gen/types.gen.ts:6215](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6215) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationStartInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationStartInstruction.md index cc2467b186b..886bbf28c41 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationStartInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationStartInstruction.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceCreationStartInstruction = object; ``` -Defined in: [gen/types.gen.ts:5531](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5531) +Defined in: [gen/types.gen.ts:6203](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6203) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:5531](https://github.com/camunda/orchestration-clu elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:5540](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5540) +Defined in: [gen/types.gen.ts:6212](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6212) Future extensions might include: diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationTerminateInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationTerminateInstruction.md index 9a6b228217b..fe5b4e507d1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationTerminateInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceCreationTerminateInstruction.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceCreationTerminateInstruction = object; ``` -Defined in: [gen/types.gen.ts:5551](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5551) +Defined in: [gen/types.gen.ts:6223](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6223) Terminates the process instance after a specific BPMN element is completed or terminated. @@ -23,7 +23,7 @@ Terminates the process instance after a specific BPMN element is completed or te afterElementId: ElementId; ``` -Defined in: [gen/types.gen.ts:5560](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5560) +Defined in: [gen/types.gen.ts:6232](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6232) The id of the element that, once completed or terminated, will cause the process to be terminated. @@ -35,6 +35,6 @@ The id of the element that, once completed or terminated, will cause the process optional type: string; ``` -Defined in: [gen/types.gen.ts:5555](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5555) +Defined in: [gen/types.gen.ts:6227](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6227) The type of the runtime instruction diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceDeletionBatchOperationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceDeletionBatchOperationRequest.md index ebe092ce17b..a5546d1fedd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceDeletionBatchOperationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceDeletionBatchOperationRequest.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceDeletionBatchOperationRequest = object; ``` -Defined in: [gen/types.gen.ts:926](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L926) +Defined in: [gen/types.gen.ts:957](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L957) The process instance filter that defines which process instances should be deleted. @@ -23,7 +23,7 @@ The process instance filter that defines which process instances should be delet filter: ProcessInstanceFilter; ``` -Defined in: [gen/types.gen.ts:930](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L930) +Defined in: [gen/types.gen.ts:961](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L961) The process instance filter. @@ -35,4 +35,4 @@ The process instance filter. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:931](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L931) +Defined in: [gen/types.gen.ts:962](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L962) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceElementStatisticsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceElementStatisticsQueryResult.md index 081a8b46d8b..f63954e1cf7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceElementStatisticsQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceElementStatisticsQueryResult.md @@ -11,18 +11,18 @@ mdx: type ProcessInstanceElementStatisticsQueryResult = object; ``` -Defined in: [gen/types.gen.ts:5914](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5914) +Defined in: [gen/types.gen.ts:6627](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6627) Process instance element statistics query response. ## Properties -### items? +### items ```ts -optional items: ProcessElementStatisticsResult[]; +items: ProcessElementStatisticsResult[]; ``` -Defined in: [gen/types.gen.ts:5918](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5918) +Defined in: [gen/types.gen.ts:6631](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6631) The element statistics. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceFilter.md index 7bf34b176b3..6ec69efaab5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceFilter.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceFilter = ProcessInstanceFilterFields & object; ``` -Defined in: [gen/types.gen.ts:5761](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5761) +Defined in: [gen/types.gen.ts:6449](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6449) Process instance search filter. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceFilterFields.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceFilterFields.md index c10415c80f5..b1b23e5fe4f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceFilterFields.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceFilterFields.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceFilterFields = BaseProcessInstanceFilterFields & object; ``` -Defined in: [gen/types.gen.ts:5735](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5735) +Defined in: [gen/types.gen.ts:6423](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6423) Process instance search filter. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceIncidentResolutionBatchOperationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceIncidentResolutionBatchOperationRequest.md index ed17baa92da..812b8cbae54 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceIncidentResolutionBatchOperationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceIncidentResolutionBatchOperationRequest.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceIncidentResolutionBatchOperationRequest = object; ``` -Defined in: [gen/types.gen.ts:915](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L915) +Defined in: [gen/types.gen.ts:946](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L946) The process instance filter that defines which process instances should have their incidents resolved. @@ -23,7 +23,7 @@ The process instance filter that defines which process instances should have the filter: ProcessInstanceFilter; ``` -Defined in: [gen/types.gen.ts:919](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L919) +Defined in: [gen/types.gen.ts:950](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L950) The process instance filter. @@ -35,4 +35,4 @@ The process instance filter. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:920](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L920) +Defined in: [gen/types.gen.ts:951](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L951) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKey.md index be8d5d9764c..b1c28e609d8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKey.md @@ -11,6 +11,6 @@ mdx: type ProcessInstanceKey = CamundaKey<"ProcessInstanceKey">; ``` -Defined in: [gen/types.gen.ts:4011](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4011) +Defined in: [gen/types.gen.ts:4656](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4656) System-generated key for a process instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKeyExactMatch.md index 1bcde7d527f..c62d70600f1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceKeyExactMatch = ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:7542](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7542) +Defined in: [gen/types.gen.ts:8388](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8388) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKeyFilterProperty.md index 9a103e94b1a..aac99961798 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceKeyFilterProperty.md @@ -13,6 +13,6 @@ type ProcessInstanceKeyFilterProperty = | AdvancedProcessInstanceKeyFilter; ``` -Defined in: [gen/types.gen.ts:4139](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4139) +Defined in: [gen/types.gen.ts:4778](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4778) ProcessInstanceKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationBatchOperationPlan.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationBatchOperationPlan.md index 47fb9cf5ad8..5cc2eb37337 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationBatchOperationPlan.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationBatchOperationPlan.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceMigrationBatchOperationPlan = object; ``` -Defined in: [gen/types.gen.ts:950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L950) +Defined in: [gen/types.gen.ts:981](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L981) The migration instructions describe how to migrate a process instance from one process definition to another. @@ -23,7 +23,7 @@ The migration instructions describe how to migrate a process instance from one p mappingInstructions: MigrateProcessInstanceMappingInstruction[]; ``` -Defined in: [gen/types.gen.ts:958](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L958) +Defined in: [gen/types.gen.ts:989](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L989) The mapping instructions. @@ -35,6 +35,6 @@ The mapping instructions. targetProcessDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:954](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L954) +Defined in: [gen/types.gen.ts:985](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L985) The target process definition key. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationBatchOperationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationBatchOperationRequest.md index f71b19fa17b..ec7a3431610 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationBatchOperationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationBatchOperationRequest.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceMigrationBatchOperationRequest = object; ``` -Defined in: [gen/types.gen.ts:934](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L934) +Defined in: [gen/types.gen.ts:965](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L965) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:934](https://github.com/camunda/orchestration-clus filter: ProcessInstanceFilter; ``` -Defined in: [gen/types.gen.ts:938](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L938) +Defined in: [gen/types.gen.ts:969](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L969) The process instance filter. @@ -33,7 +33,7 @@ The process instance filter. migrationPlan: ProcessInstanceMigrationBatchOperationPlan; ``` -Defined in: [gen/types.gen.ts:942](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L942) +Defined in: [gen/types.gen.ts:973](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L973) The migration plan. @@ -45,4 +45,4 @@ The migration plan. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:943](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L943) +Defined in: [gen/types.gen.ts:974](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L974) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationInstruction.md index 05084450a68..78fa9caa2d2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceMigrationInstruction.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceMigrationInstruction = object; ``` -Defined in: [gen/types.gen.ts:5925](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5925) +Defined in: [gen/types.gen.ts:6638](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6638) The migration instructions describe how to migrate a process instance from one process definition to another. @@ -23,7 +23,7 @@ The migration instructions describe how to migrate a process instance from one p mappingInstructions: MigrateProcessInstanceMappingInstruction[]; ``` -Defined in: [gen/types.gen.ts:5933](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5933) +Defined in: [gen/types.gen.ts:6646](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6646) Element mappings from the source process instance to the target process instance. @@ -35,7 +35,7 @@ Element mappings from the source process instance to the target process instance optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:5934](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5934) +Defined in: [gen/types.gen.ts:6647](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6647) --- @@ -45,6 +45,6 @@ Defined in: [gen/types.gen.ts:5934](https://github.com/camunda/orchestration-clu targetProcessDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5929](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5929) +Defined in: [gen/types.gen.ts:6642](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6642) The key of process definition to migrate the process instance to. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationActivateInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationActivateInstruction.md index 7605dee2931..367a1b7d821 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationActivateInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationActivateInstruction.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceModificationActivateInstruction = object; ``` -Defined in: [gen/types.gen.ts:5971](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5971) +Defined in: [gen/types.gen.ts:6684](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6684) Instruction describing an element to activate. @@ -20,10 +20,10 @@ Instruction describing an element to activate. ### ancestorElementInstanceKey? ```ts -optional ancestorElementInstanceKey: string | ElementInstanceKey; +optional ancestorElementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:5987](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5987) +Defined in: [gen/types.gen.ts:6700](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6700) 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 @@ -38,7 +38,7 @@ specifically with this property by providing its key. elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:5975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5975) +Defined in: [gen/types.gen.ts:6688](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6688) The id of the element to activate. @@ -50,6 +50,6 @@ The id of the element to activate. optional variableInstructions: ModifyProcessInstanceVariableInstruction[]; ``` -Defined in: [gen/types.gen.ts:5979](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5979) +Defined in: [gen/types.gen.ts:6692](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6692) Instructions describing which variables to create or update. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationBatchOperationRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationBatchOperationRequest.md index 91fc8eac150..4e9dfe0faca 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationBatchOperationRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationBatchOperationRequest.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceModificationBatchOperationRequest = object; ``` -Defined in: [gen/types.gen.ts:966](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L966) +Defined in: [gen/types.gen.ts:997](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L997) The process instance filter to define on which process instances tokens should be moved, and new element instances should be activated or terminated. @@ -24,7 +24,7 @@ and new element instances should be activated or terminated. filter: ProcessInstanceFilter; ``` -Defined in: [gen/types.gen.ts:970](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L970) +Defined in: [gen/types.gen.ts:1001](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1001) The process instance filter. @@ -36,7 +36,7 @@ The process instance filter. moveInstructions: ProcessInstanceModificationMoveBatchOperationInstruction[]; ``` -Defined in: [gen/types.gen.ts:974](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L974) +Defined in: [gen/types.gen.ts:1005](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1005) Instructions for moving tokens between elements. @@ -48,4 +48,4 @@ Instructions for moving tokens between elements. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L975) +Defined in: [gen/types.gen.ts:1006](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1006) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationInstruction.md index 2fbd3649f77..5fb36f30510 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationInstruction.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceModificationInstruction = object; ``` -Defined in: [gen/types.gen.ts:5952](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5952) +Defined in: [gen/types.gen.ts:6665](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6665) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:5952](https://github.com/camunda/orchestration-clu optional activateInstructions: ProcessInstanceModificationActivateInstruction[]; ``` -Defined in: [gen/types.gen.ts:5957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5957) +Defined in: [gen/types.gen.ts:6670](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6670) Instructions describing which elements to activate in which scopes and which variables to create or update. @@ -33,7 +33,7 @@ Instructions describing which elements to activate in which scopes and which var optional moveInstructions: ProcessInstanceModificationMoveInstruction[]; ``` -Defined in: [gen/types.gen.ts:5961](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5961) +Defined in: [gen/types.gen.ts:6674](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6674) Instructions describing which elements to move from one scope to another. @@ -45,7 +45,7 @@ Instructions describing which elements to move from one scope to another. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:5953](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5953) +Defined in: [gen/types.gen.ts:6666](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6666) --- @@ -55,6 +55,6 @@ Defined in: [gen/types.gen.ts:5953](https://github.com/camunda/orchestration-clu optional terminateInstructions: ProcessInstanceModificationTerminateInstruction[]; ``` -Defined in: [gen/types.gen.ts:5965](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5965) +Defined in: [gen/types.gen.ts:6678](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6678) Instructions describing which elements to terminate. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationMoveBatchOperationInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationMoveBatchOperationInstruction.md index ac8a0efe43c..c617a8a1115 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationMoveBatchOperationInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationMoveBatchOperationInstruction.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceModificationMoveBatchOperationInstruction = object; ``` -Defined in: [gen/types.gen.ts:985](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L985) +Defined in: [gen/types.gen.ts:1016](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1016) Instructions describing a move operation. This instruction will terminate all active element instances at `sourceElementId` and activate a new element instance for each @@ -26,7 +26,7 @@ scope of the source element instances. sourceElementId: ElementId; ``` -Defined in: [gen/types.gen.ts:989](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L989) +Defined in: [gen/types.gen.ts:1020](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1020) The source element ID. @@ -38,6 +38,6 @@ The source element ID. targetElementId: ElementId; ``` -Defined in: [gen/types.gen.ts:993](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L993) +Defined in: [gen/types.gen.ts:1024](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1024) The target element ID. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationMoveInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationMoveInstruction.md index 99978bb6082..18014bd38f4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationMoveInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationMoveInstruction.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceModificationMoveInstruction = object; ``` -Defined in: [gen/types.gen.ts:6017](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6017) +Defined in: [gen/types.gen.ts:6730](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6730) 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 @@ -26,7 +26,7 @@ body instances will activate new element instances at the target id. optional ancestorScopeInstruction: AncestorScopeInstruction; ``` -Defined in: [gen/types.gen.ts:6023](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6023) +Defined in: [gen/types.gen.ts:6736](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6736) --- @@ -36,7 +36,7 @@ Defined in: [gen/types.gen.ts:6023](https://github.com/camunda/orchestration-clu sourceElementInstruction: SourceElementInstruction; ``` -Defined in: [gen/types.gen.ts:6018](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6018) +Defined in: [gen/types.gen.ts:6731](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6731) --- @@ -46,7 +46,7 @@ Defined in: [gen/types.gen.ts:6018](https://github.com/camunda/orchestration-clu targetElementId: ElementId; ``` -Defined in: [gen/types.gen.ts:6022](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6022) +Defined in: [gen/types.gen.ts:6735](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6735) The target element id. @@ -58,6 +58,6 @@ The target element id. optional variableInstructions: ModifyProcessInstanceVariableInstruction[]; ``` -Defined in: [gen/types.gen.ts:6027](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6027) +Defined in: [gen/types.gen.ts:6740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6740) Instructions describing which variables to create or update. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateByIdInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateByIdInstruction.md index 2221f334d7b..515b6ad5746 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateByIdInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateByIdInstruction.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceModificationTerminateByIdInstruction = object; ``` -Defined in: [gen/types.gen.ts:6138](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6138) +Defined in: [gen/types.gen.ts:6851](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6851) Instruction describing which elements to terminate. The element instances are determined at runtime by the given id. @@ -24,6 +24,6 @@ at runtime by the given id. elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:6142](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6142) +Defined in: [gen/types.gen.ts:6855](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6855) The id of the elements to terminate. The element instances are determined at runtime. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateByKeyInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateByKeyInstruction.md index dc051987d9d..d9447a3293d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateByKeyInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateByKeyInstruction.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceModificationTerminateByKeyInstruction = object; ``` -Defined in: [gen/types.gen.ts:6148](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6148) +Defined in: [gen/types.gen.ts:6861](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6861) Instruction providing the key of the element instance to terminate. @@ -23,6 +23,6 @@ Instruction providing the key of the element instance to terminate. elementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:6152](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6152) +Defined in: [gen/types.gen.ts:6865](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6865) The key of the element instance to terminate. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateInstruction.md index 2a7fd4c7503..b4cff1f6b03 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceModificationTerminateInstruction.md @@ -13,6 +13,6 @@ type ProcessInstanceModificationTerminateInstruction = | ProcessInstanceModificationTerminateByKeyInstruction; ``` -Defined in: [gen/types.gen.ts:6131](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6131) +Defined in: [gen/types.gen.ts:6844](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6844) Instruction describing which elements to terminate. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceReference.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceReference.md index e4cfde1d098..669b9a2c3ee 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceReference.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceReference.md @@ -11,28 +11,28 @@ mdx: type ProcessInstanceReference = object; ``` -Defined in: [gen/types.gen.ts:1379](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1379) +Defined in: [gen/types.gen.ts:1410](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1410) ## Properties -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:1383](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1383) +Defined in: [gen/types.gen.ts:1414](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1414) The key of the process definition. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:1387](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1387) +Defined in: [gen/types.gen.ts:1418](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1418) The key of the created process instance. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceResult.md index 7923951e6ba..0f8b21f1eae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceResult.md @@ -11,19 +11,33 @@ mdx: type ProcessInstanceResult = object; ``` -Defined in: [gen/types.gen.ts:5811](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5811) +Defined in: [gen/types.gen.ts:6499](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6499) Process instance search response item. ## Properties -### endDate? +### businessId ```ts -optional endDate: string; +businessId: BusinessId | null; ``` -Defined in: [gen/types.gen.ts:5823](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5823) +Defined in: [gen/types.gen.ts:6554](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6554) + +The business id associated with this process instance. + +--- + +### endDate + +```ts +endDate: string | null; +``` + +Defined in: [gen/types.gen.ts:6520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6520) + +The completion or termination time of the process instance. --- @@ -33,31 +47,31 @@ Defined in: [gen/types.gen.ts:5823](https://github.com/camunda/orchestration-clu hasIncident: boolean; ``` -Defined in: [gen/types.gen.ts:5828](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5828) +Defined in: [gen/types.gen.ts:6525](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6525) Whether this process instance has a related incident or not. --- -### parentElementInstanceKey? +### parentElementInstanceKey ```ts -optional parentElementInstanceKey: ElementInstanceKey; +parentElementInstanceKey: ElementInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:5845](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5845) +Defined in: [gen/types.gen.ts:6542](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6542) The parent element instance key. --- -### parentProcessInstanceKey? +### parentProcessInstanceKey ```ts -optional parentProcessInstanceKey: ProcessInstanceKey; +parentProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:5841](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5841) +Defined in: [gen/types.gen.ts:6538](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6538) The parent process instance key. @@ -69,7 +83,7 @@ The parent process instance key. processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:5812](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5812) +Defined in: [gen/types.gen.ts:6500](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6500) --- @@ -79,7 +93,7 @@ Defined in: [gen/types.gen.ts:5812](https://github.com/camunda/orchestration-clu processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5837](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5837) +Defined in: [gen/types.gen.ts:6534](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6534) The process definition key. @@ -88,10 +102,10 @@ The process definition key. ### processDefinitionName ```ts -processDefinitionName: string; +processDefinitionName: string | null; ``` -Defined in: [gen/types.gen.ts:5816](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5816) +Defined in: [gen/types.gen.ts:6504](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6504) The process definition name. @@ -103,17 +117,19 @@ The process definition name. processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:5817](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5817) +Defined in: [gen/types.gen.ts:6508](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6508) + +The process definition version. --- -### processDefinitionVersionTag? +### processDefinitionVersionTag ```ts -optional processDefinitionVersionTag: string; +processDefinitionVersionTag: string | null; ``` -Defined in: [gen/types.gen.ts:5821](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5821) +Defined in: [gen/types.gen.ts:6512](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6512) The process definition version tag. @@ -125,19 +141,23 @@ The process definition version tag. processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:5833](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5833) +Defined in: [gen/types.gen.ts:6530](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6530) The key of this process instance. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:5846](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5846) +Defined in: [gen/types.gen.ts:6549](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6549) + +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. --- @@ -147,7 +167,9 @@ Defined in: [gen/types.gen.ts:5846](https://github.com/camunda/orchestration-clu startDate: string; ``` -Defined in: [gen/types.gen.ts:5822](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5822) +Defined in: [gen/types.gen.ts:6516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6516) + +The start time of the process instance. --- @@ -157,17 +179,17 @@ Defined in: [gen/types.gen.ts:5822](https://github.com/camunda/orchestration-clu state: ProcessInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:5824](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5824) +Defined in: [gen/types.gen.ts:6521](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6521) --- -### tags? +### tags ```ts -optional tags: TagSet; +tags: TagSet; ``` -Defined in: [gen/types.gen.ts:5847](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5847) +Defined in: [gen/types.gen.ts:6550](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6550) --- @@ -177,4 +199,4 @@ Defined in: [gen/types.gen.ts:5847](https://github.com/camunda/orchestration-clu tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5829](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5829) +Defined in: [gen/types.gen.ts:6526](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6526) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQuery.md index f287eda28aa..359f741155c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQuery.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:5610](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5610) +Defined in: [gen/types.gen.ts:6286](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6286) Process instance search request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQueryResult.md index 060b2713565..57162e13614 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQueryResult.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:5801](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5801) +Defined in: [gen/types.gen.ts:6489](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6489) Process instance search response. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQuerySortRequest.md index 17cf9ab7dbe..256d1976d5c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:5599](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5599) +Defined in: [gen/types.gen.ts:6275](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6275) ## Properties @@ -31,10 +31,11 @@ field: | "endDate" | "state" | "hasIncident" - | "tenantId"; + | "tenantId" + | "businessId"; ``` -Defined in: [gen/types.gen.ts:5603](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5603) +Defined in: [gen/types.gen.ts:6279](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6279) The field to sort by. @@ -46,4 +47,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:5604](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5604) +Defined in: [gen/types.gen.ts:6280](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6280) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSequenceFlowResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSequenceFlowResult.md index 9ccdb30428b..3ef1805bde0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSequenceFlowResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSequenceFlowResult.md @@ -11,86 +11,90 @@ mdx: type ProcessInstanceSequenceFlowResult = object; ``` -Defined in: [gen/types.gen.ts:5886](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5886) +Defined in: [gen/types.gen.ts:6593](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6593) Process instance sequence flow result. ## Properties -### elementId? +### elementId ```ts -optional elementId: ElementId; +elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:5907](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5907) +Defined in: [gen/types.gen.ts:6620](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6620) The element id for this sequence flow, as provided in the BPMN process. --- -### processDefinitionId? +### processDefinitionId ```ts -optional processDefinitionId: ProcessDefinitionId; +processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:5903](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5903) +Defined in: [gen/types.gen.ts:6616](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6616) The process definition id. --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:5899](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5899) +Defined in: [gen/types.gen.ts:6612](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6612) The process definition key. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:5894](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5894) +Defined in: [gen/types.gen.ts:6601](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6601) The key of this process instance. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:5895](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5895) +Defined in: [gen/types.gen.ts:6608](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6608) + +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. --- -### sequenceFlowId? +### sequenceFlowId ```ts -optional sequenceFlowId: string; +sequenceFlowId: string; ``` -Defined in: [gen/types.gen.ts:5890](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5890) +Defined in: [gen/types.gen.ts:6597](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6597) The sequence flow id. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:5908](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5908) +Defined in: [gen/types.gen.ts:6621](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6621) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSequenceFlowsQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSequenceFlowsQueryResult.md index 03bcba0b418..adf239c1989 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSequenceFlowsQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceSequenceFlowsQueryResult.md @@ -11,18 +11,18 @@ mdx: type ProcessInstanceSequenceFlowsQueryResult = object; ``` -Defined in: [gen/types.gen.ts:5876](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5876) +Defined in: [gen/types.gen.ts:6583](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6583) Process instance sequence flows query response. ## Properties -### items? +### items ```ts -optional items: ProcessInstanceSequenceFlowResult[]; +items: ProcessInstanceSequenceFlowResult[]; ``` -Defined in: [gen/types.gen.ts:5880](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L5880) +Defined in: [gen/types.gen.ts:6587](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6587) The sequence flows. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateEnum.md index 7bc6b84291a..2cb40774711 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateEnum.md @@ -11,6 +11,6 @@ mdx: type ProcessInstanceStateEnum = "ACTIVE" | "COMPLETED" | "TERMINATED"; ``` -Defined in: [gen/types.gen.ts:6158](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6158) +Defined in: [gen/types.gen.ts:6871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6871) Process instance states diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateExactMatch.md index ca24d7e2a85..bfefe110ca0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateExactMatch.md @@ -11,7 +11,7 @@ mdx: type ProcessInstanceStateExactMatch = ProcessInstanceStateEnum; ``` -Defined in: [gen/types.gen.ts:7633](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7633) +Defined in: [gen/types.gen.ts:8479](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8479) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateFilterProperty.md index 0c5a62a946a..1c272396b6a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ProcessInstanceStateFilterProperty.md @@ -13,6 +13,6 @@ type ProcessInstanceStateFilterProperty = | AdvancedProcessInstanceStateFilter; ``` -Defined in: [gen/types.gen.ts:6188](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6188) +Defined in: [gen/types.gen.ts:6901](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6901) ProcessInstanceStateEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageData.md index e76c167e175..e650efe58a6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageData.md @@ -11,7 +11,7 @@ mdx: type PublishMessageData = object; ``` -Defined in: [gen/types.gen.ts:12599](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12599) +Defined in: [gen/types.gen.ts:12573](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12573) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12599](https://github.com/camunda/orchestration-cl body: MessagePublicationRequest; ``` -Defined in: [gen/types.gen.ts:12600](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12600) +Defined in: [gen/types.gen.ts:12574](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12574) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12600](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:12601](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12601) +Defined in: [gen/types.gen.ts:12575](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12575) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:12601](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:12602](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12602) +Defined in: [gen/types.gen.ts:12576](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12576) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:12602](https://github.com/camunda/orchestration-cl url: "/messages/publication"; ``` -Defined in: [gen/types.gen.ts:12603](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12603) +Defined in: [gen/types.gen.ts:12577](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12577) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageError.md index e5014576d6f..1926332e26a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageError.md @@ -11,4 +11,4 @@ mdx: type PublishMessageError = PublishMessageErrors[keyof PublishMessageErrors]; ``` -Defined in: [gen/types.gen.ts:12622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12622) +Defined in: [gen/types.gen.ts:12596](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12596) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageErrors.md index 46471979738..bf81c3d7f1d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageErrors.md @@ -11,7 +11,7 @@ mdx: type PublishMessageErrors = object; ``` -Defined in: [gen/types.gen.ts:12606](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12606) +Defined in: [gen/types.gen.ts:12580](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12580) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12606](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12610](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12610) +Defined in: [gen/types.gen.ts:12584](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12584) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12614](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12614) +Defined in: [gen/types.gen.ts:12588](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12588) An internal error occurred while processing the request. @@ -45,6 +45,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12619](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12619) +Defined in: [gen/types.gen.ts:12593](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12593) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageResponse.md index 8e01d553053..bba62a1b735 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageResponse.md @@ -12,4 +12,4 @@ type PublishMessageResponse = PublishMessageResponses[keyof PublishMessageResponses]; ``` -Defined in: [gen/types.gen.ts:12640](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12640) +Defined in: [gen/types.gen.ts:12605](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12605) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageResponses.md index 39ae997b444..21437957052 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/PublishMessageResponses.md @@ -11,32 +11,16 @@ mdx: type PublishMessageResponses = object; ``` -Defined in: [gen/types.gen.ts:12624](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12624) +Defined in: [gen/types.gen.ts:12598](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12598) ## Properties ### 200 ```ts -200: object; +200: MessagePublicationResult; ``` -Defined in: [gen/types.gen.ts:12628](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12628) +Defined in: [gen/types.gen.ts:12602](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12602) -The message key of the published message. - -#### messageKey? - -```ts -optional messageKey: MessageKey; -``` - -The key of the published message. - -#### tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant ID of the message. +The message was published. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockData.md index 80c3b351bad..b98701b895d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockData.md @@ -11,7 +11,7 @@ mdx: type ResetClockData = object; ``` -Defined in: [gen/types.gen.ts:8554](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8554) +Defined in: [gen/types.gen.ts:9077](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9077) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8554](https://github.com/camunda/orchestration-clu optional body: never; ``` -Defined in: [gen/types.gen.ts:8555](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8555) +Defined in: [gen/types.gen.ts:9078](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9078) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8555](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:8556](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8556) +Defined in: [gen/types.gen.ts:9079](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9079) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:8556](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:8557](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8557) +Defined in: [gen/types.gen.ts:9080](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9080) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:8557](https://github.com/camunda/orchestration-clu url: "/clock/reset"; ``` -Defined in: [gen/types.gen.ts:8558](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8558) +Defined in: [gen/types.gen.ts:9081](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9081) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockError.md index f3be9eb796e..80fe6f38be0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockError.md @@ -11,4 +11,4 @@ mdx: type ResetClockError = ResetClockErrors[keyof ResetClockErrors]; ``` -Defined in: [gen/types.gen.ts:8573](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8573) +Defined in: [gen/types.gen.ts:9096](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9096) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockErrors.md index 5af58b33a71..2bb06959025 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockErrors.md @@ -11,7 +11,7 @@ mdx: type ResetClockErrors = object; ``` -Defined in: [gen/types.gen.ts:8561](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8561) +Defined in: [gen/types.gen.ts:9084](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9084) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8561](https://github.com/camunda/orchestration-clu 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8565](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8565) +Defined in: [gen/types.gen.ts:9088](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9088) An internal error occurred while processing the request. @@ -33,6 +33,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8570](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8570) +Defined in: [gen/types.gen.ts:9093](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9093) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockResponse.md index 7a5caee521b..83119680882 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockResponse.md @@ -11,4 +11,4 @@ mdx: type ResetClockResponse = ResetClockResponses[keyof ResetClockResponses]; ``` -Defined in: [gen/types.gen.ts:8582](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8582) +Defined in: [gen/types.gen.ts:9105](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9105) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockResponses.md index 0ba52828046..d23839de2af 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResetClockResponses.md @@ -11,7 +11,7 @@ mdx: type ResetClockResponses = object; ``` -Defined in: [gen/types.gen.ts:8575](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8575) +Defined in: [gen/types.gen.ts:9098](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9098) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8575](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:8579](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8579) +Defined in: [gen/types.gen.ts:9102](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9102) The clock was successfully reset to the system time. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentData.md index 423edc077eb..6942edcfaf6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentData.md @@ -11,7 +11,7 @@ mdx: type ResolveIncidentData = object; ``` -Defined in: [gen/types.gen.ts:11542](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11542) +Defined in: [gen/types.gen.ts:11662](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11662) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11542](https://github.com/camunda/orchestration-cl optional body: IncidentResolutionRequest; ``` -Defined in: [gen/types.gen.ts:11543](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11543) +Defined in: [gen/types.gen.ts:11663](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11663) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11543](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11544](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11544) +Defined in: [gen/types.gen.ts:11664](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11664) #### incidentKey @@ -49,7 +49,7 @@ Key of the incident to resolve. optional query: never; ``` -Defined in: [gen/types.gen.ts:11550](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11550) +Defined in: [gen/types.gen.ts:11670](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11670) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:11550](https://github.com/camunda/orchestration-cl url: "/incidents/{incidentKey}/resolution"; ``` -Defined in: [gen/types.gen.ts:11551](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11551) +Defined in: [gen/types.gen.ts:11671](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11671) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentError.md index 6a98d15d33a..eb1abc67c83 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentError.md @@ -11,4 +11,4 @@ mdx: type ResolveIncidentError = ResolveIncidentErrors[keyof ResolveIncidentErrors]; ``` -Defined in: [gen/types.gen.ts:11574](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11574) +Defined in: [gen/types.gen.ts:11700](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11700) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentErrors.md index 0578e2e2005..b6ac38c8a56 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentErrors.md @@ -11,7 +11,7 @@ mdx: type ResolveIncidentErrors = object; ``` -Defined in: [gen/types.gen.ts:11554](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11554) +Defined in: [gen/types.gen.ts:11674](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11674) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11554](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11558](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11558) +Defined in: [gen/types.gen.ts:11678](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11678) The provided data is not valid. @@ -33,19 +33,32 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11562](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11562) +Defined in: [gen/types.gen.ts:11682](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11682) The incident with the incidentKey is not found. --- +### 409 + +```ts +409: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:11688](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11688) + +The incident cannot be resolved due to an invalid state. +For example, the associated job may have no retries left. + +--- + ### 500 ```ts 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11566](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11566) +Defined in: [gen/types.gen.ts:11692](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11692) An internal error occurred while processing the request. @@ -57,6 +70,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11571](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11571) +Defined in: [gen/types.gen.ts:11697](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11697) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentResponse.md index 721a7f99163..7b81c6de567 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentResponse.md @@ -12,4 +12,4 @@ type ResolveIncidentResponse = ResolveIncidentResponses[keyof ResolveIncidentResponses]; ``` -Defined in: [gen/types.gen.ts:11583](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11583) +Defined in: [gen/types.gen.ts:11709](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11709) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentResponses.md index 68106cdba48..60c82b070ea 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentResponses.md @@ -11,7 +11,7 @@ mdx: type ResolveIncidentResponses = object; ``` -Defined in: [gen/types.gen.ts:11576](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11576) +Defined in: [gen/types.gen.ts:11702](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11702) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:11576](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:11580](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11580) +Defined in: [gen/types.gen.ts:11706](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11706) The incident is marked as resolved. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationData.md index c7bb40bc8c9..2540de60beb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationData.md @@ -11,33 +11,17 @@ mdx: type ResolveIncidentsBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:13475](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13475) +Defined in: [gen/types.gen.ts:13074](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13074) ## Properties ### body? ```ts -optional body: object; +optional body: ProcessInstanceIncidentResolutionBatchOperationRequest; ``` -Defined in: [gen/types.gen.ts:13479](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13479) - -The process instance filter that defines which process instances should have their incidents resolved. - -#### filter - -```ts -filter: ProcessInstanceFilter; -``` - -The process instance filter. - -#### operationReference? - -```ts -optional operationReference: OperationReference; -``` +Defined in: [gen/types.gen.ts:13075](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13075) --- @@ -47,7 +31,7 @@ optional operationReference: OperationReference; optional path: never; ``` -Defined in: [gen/types.gen.ts:13486](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13486) +Defined in: [gen/types.gen.ts:13076](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13076) --- @@ -57,7 +41,7 @@ Defined in: [gen/types.gen.ts:13486](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:13487](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13487) +Defined in: [gen/types.gen.ts:13077](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13077) --- @@ -67,4 +51,4 @@ Defined in: [gen/types.gen.ts:13487](https://github.com/camunda/orchestration-cl url: "/process-instances/incident-resolution"; ``` -Defined in: [gen/types.gen.ts:13488](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13488) +Defined in: [gen/types.gen.ts:13078](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13078) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationError.md index bc61340414e..d4d76b1c0b5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationError.md @@ -12,4 +12,4 @@ type ResolveIncidentsBatchOperationError = ResolveIncidentsBatchOperationErrors[keyof ResolveIncidentsBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:13511](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13511) +Defined in: [gen/types.gen.ts:13101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13101) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationErrors.md index f1b0729416a..f98f4ae8488 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type ResolveIncidentsBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:13491](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13491) +Defined in: [gen/types.gen.ts:13081](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13081) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13491](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13496](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13496) +Defined in: [gen/types.gen.ts:13086](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13086) The process instance batch operation failed. More details are provided in the response body. @@ -33,7 +33,7 @@ The process instance batch operation failed. More details are provided in the re 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13500](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13500) +Defined in: [gen/types.gen.ts:13090](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13090) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13504](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13504) +Defined in: [gen/types.gen.ts:13094](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13094) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13508](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13508) +Defined in: [gen/types.gen.ts:13098](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13098) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationResponse.md index bfe0908ea8d..e22d91bf37f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationResponse.md @@ -12,4 +12,4 @@ type ResolveIncidentsBatchOperationResponse = ResolveIncidentsBatchOperationResponses[keyof ResolveIncidentsBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:13520](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13520) +Defined in: [gen/types.gen.ts:13110](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13110) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationResponses.md index 7c6fd290576..d14842efdf5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveIncidentsBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type ResolveIncidentsBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:13513](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13513) +Defined in: [gen/types.gen.ts:13103](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13103) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:13513](https://github.com/camunda/orchestration-cl 200: BatchOperationCreatedResult; ``` -Defined in: [gen/types.gen.ts:13517](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13517) +Defined in: [gen/types.gen.ts:13107](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13107) The batch operation request was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsData.md index 2c48d81a3f7..683b1e69cb0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsData.md @@ -11,7 +11,7 @@ mdx: type ResolveProcessInstanceIncidentsData = object; ``` -Defined in: [gen/types.gen.ts:14024](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14024) +Defined in: [gen/types.gen.ts:13421](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13421) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14024](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14025) +Defined in: [gen/types.gen.ts:13422](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13422) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14025](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14026](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14026) +Defined in: [gen/types.gen.ts:13423](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13423) #### processInstanceKey @@ -49,7 +49,7 @@ The key of the process instance to resolve incidents for. optional query: never; ``` -Defined in: [gen/types.gen.ts:14032](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14032) +Defined in: [gen/types.gen.ts:13429](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13429) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:14032](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}/incident-resolution"; ``` -Defined in: [gen/types.gen.ts:14033](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14033) +Defined in: [gen/types.gen.ts:13430](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13430) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsError.md index 39214f8a8b7..a8b87be8d99 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsError.md @@ -12,4 +12,4 @@ type ResolveProcessInstanceIncidentsError = ResolveProcessInstanceIncidentsErrors[keyof ResolveProcessInstanceIncidentsErrors]; ``` -Defined in: [gen/types.gen.ts:14060](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14060) +Defined in: [gen/types.gen.ts:13457](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13457) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsErrors.md index aca15d09473..78dbc185c14 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsErrors.md @@ -11,7 +11,7 @@ mdx: type ResolveProcessInstanceIncidentsErrors = object; ``` -Defined in: [gen/types.gen.ts:14036](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14036) +Defined in: [gen/types.gen.ts:13433](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13433) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14036](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14040](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14040) +Defined in: [gen/types.gen.ts:13437](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13437) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14044](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14044) +Defined in: [gen/types.gen.ts:13441](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13441) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14048](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14048) +Defined in: [gen/types.gen.ts:13445](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13445) The process instance is not found. @@ -57,7 +57,7 @@ The process instance is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14052](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14052) +Defined in: [gen/types.gen.ts:13449](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13449) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14057](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14057) +Defined in: [gen/types.gen.ts:13454](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13454) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsResponse.md index 0d3a2b46abb..eef9a45e8f3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsResponse.md @@ -12,4 +12,4 @@ type ResolveProcessInstanceIncidentsResponse = ResolveProcessInstanceIncidentsResponses[keyof ResolveProcessInstanceIncidentsResponses]; ``` -Defined in: [gen/types.gen.ts:14069](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14069) +Defined in: [gen/types.gen.ts:13466](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13466) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsResponses.md index f2a5dee41e5..64c88b9e315 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResolveProcessInstanceIncidentsResponses.md @@ -11,7 +11,7 @@ mdx: type ResolveProcessInstanceIncidentsResponses = object; ``` -Defined in: [gen/types.gen.ts:14062](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14062) +Defined in: [gen/types.gen.ts:13459](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13459) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14062](https://github.com/camunda/orchestration-cl 200: BatchOperationCreatedResult; ``` -Defined in: [gen/types.gen.ts:14066](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14066) +Defined in: [gen/types.gen.ts:13463](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13463) The batch operation request for incident resolution was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKey.md index 33729265916..0b3d185d93d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKey.md @@ -15,6 +15,6 @@ type ResourceKey = | DecisionDefinitionKey; ``` -Defined in: [gen/types.gen.ts:2201](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2201) +Defined in: [gen/types.gen.ts:2304](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2304) The system-assigned key for this resource. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKeyExactMatch.md index 7c175052695..03d9a553d70 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type ResourceKeyExactMatch = ResourceKey; ``` -Defined in: [gen/types.gen.ts:7486](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7486) +Defined in: [gen/types.gen.ts:8318](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8318) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKeyFilterProperty.md index e1653a7a612..84bfe0c59f7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceKeyFilterProperty.md @@ -13,6 +13,6 @@ type ResourceKeyFilterProperty = | AdvancedResourceKeyFilter; ``` -Defined in: [gen/types.gen.ts:2239](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2239) +Defined in: [gen/types.gen.ts:2342](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2342) ResourceKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceResult.md index 85f064cb0fd..5362194adde 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceResult.md @@ -11,76 +11,76 @@ mdx: type ResourceResult = object; ``` -Defined in: [gen/types.gen.ts:2166](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2166) +Defined in: [gen/types.gen.ts:2269](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2269) ## Properties -### resourceId? +### resourceId ```ts -optional resourceId: string; +resourceId: string; ``` -Defined in: [gen/types.gen.ts:2182](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2182) +Defined in: [gen/types.gen.ts:2285](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2285) The resource ID of this resource. --- -### resourceKey? +### resourceKey ```ts -optional resourceKey: ResourceKey; +resourceKey: ResourceKey; ``` -Defined in: [gen/types.gen.ts:2190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2190) +Defined in: [gen/types.gen.ts:2293](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2293) The unique key of this resource. --- -### resourceName? +### resourceName ```ts -optional resourceName: string; +resourceName: string; ``` -Defined in: [gen/types.gen.ts:2170](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2170) +Defined in: [gen/types.gen.ts:2273](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2273) The resource name from which this resource was parsed. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:2186](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2186) +Defined in: [gen/types.gen.ts:2289](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2289) The tenant ID of this resource. --- -### version? +### version ```ts -optional version: number; +version: number; ``` -Defined in: [gen/types.gen.ts:2174](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2174) +Defined in: [gen/types.gen.ts:2277](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2277) The assigned resource version. --- -### versionTag? +### versionTag ```ts -optional versionTag: string; +versionTag: string | null; ``` -Defined in: [gen/types.gen.ts:2178](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2178) +Defined in: [gen/types.gen.ts:2281](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2281) The version tag of this resource. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceTypeEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceTypeEnum.md index 982096c2fce..c6f4bf9f7d1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceTypeEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResourceTypeEnum.md @@ -31,6 +31,6 @@ type ResourceTypeEnum = | "USER_TASK"; ``` -Defined in: [gen/types.gen.ts:672](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L672) +Defined in: [gen/types.gen.ts:685](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L685) The type of resource to add/remove permissions to/from. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/Result.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/Result.md index 4674699751f..a2c3b2addfa 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/Result.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/Result.md @@ -19,7 +19,7 @@ type Result = }; ``` -Defined in: [resultClient.ts:4](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/resultClient.ts#L4) +Defined in: [resultClient.ts:4](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/resultClient.ts#L4) ## Type Parameters diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationData.md index a6f48208e19..d212caf121f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationData.md @@ -11,7 +11,7 @@ mdx: type ResumeBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:8426](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8426) +Defined in: [gen/types.gen.ts:8949](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8949) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8426](https://github.com/camunda/orchestration-clu optional body: unknown; ``` -Defined in: [gen/types.gen.ts:8427](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8427) +Defined in: [gen/types.gen.ts:8950](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8950) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8427](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8428](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8428) +Defined in: [gen/types.gen.ts:8951](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8951) #### batchOperationKey @@ -49,7 +49,7 @@ The key (or operate legacy ID) of the batch operation. optional query: never; ``` -Defined in: [gen/types.gen.ts:8434](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8434) +Defined in: [gen/types.gen.ts:8957](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8957) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8434](https://github.com/camunda/orchestration-clu url: "/batch-operations/{batchOperationKey}/resumption"; ``` -Defined in: [gen/types.gen.ts:8435](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8435) +Defined in: [gen/types.gen.ts:8958](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8958) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationError.md index bb23b7423a6..6e46272a6ef 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationError.md @@ -12,4 +12,4 @@ type ResumeBatchOperationError = ResumeBatchOperationErrors[keyof ResumeBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:8462](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8462) +Defined in: [gen/types.gen.ts:8985](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8985) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationErrors.md index be7d8c5b83b..2c6f3833af6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type ResumeBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:8438](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8438) +Defined in: [gen/types.gen.ts:8961](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8961) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8438](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8442](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8442) +Defined in: [gen/types.gen.ts:8965](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8965) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8446](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8446) +Defined in: [gen/types.gen.ts:8969](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8969) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8450](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8450) +Defined in: [gen/types.gen.ts:8973](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8973) Not found. The batch operation was not found. @@ -57,7 +57,7 @@ Not found. The batch operation was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8454](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8454) +Defined in: [gen/types.gen.ts:8977](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8977) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8459](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8459) +Defined in: [gen/types.gen.ts:8982](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8982) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationResponse.md index 16529659d1e..463d3b00fe2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationResponse.md @@ -12,4 +12,4 @@ type ResumeBatchOperationResponse = ResumeBatchOperationResponses[keyof ResumeBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:8471](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8471) +Defined in: [gen/types.gen.ts:8994](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8994) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationResponses.md index e22794f1cf0..f5f694a7596 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ResumeBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type ResumeBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:8464](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8464) +Defined in: [gen/types.gen.ts:8987](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8987) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8464](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:8468](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8468) +Defined in: [gen/types.gen.ts:8991](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8991) The batch operation resume request was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientResult.md index f30be583811..daf5b622a6b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientResult.md @@ -11,16 +11,16 @@ mdx: type RoleClientResult = object; ``` -Defined in: [gen/types.gen.ts:6336](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6336) +Defined in: [gen/types.gen.ts:7049](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7049) ## Properties -### clientId? +### clientId ```ts -optional clientId: string; +clientId: string; ``` -Defined in: [gen/types.gen.ts:6340](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6340) +Defined in: [gen/types.gen.ts:7053](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7053) The ID of the client. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchQueryRequest.md index d0b8f078a7f..62fa8b57061 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type RoleClientSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:6350](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6350) +Defined in: [gen/types.gen.ts:7063](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7063) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchQuerySortRequest.md index 8855b3172d8..6ee0d43114e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type RoleClientSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:6357](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6357) +Defined in: [gen/types.gen.ts:7070](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7070) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6357](https://github.com/camunda/orchestration-clu field: "clientId"; ``` -Defined in: [gen/types.gen.ts:6361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6361) +Defined in: [gen/types.gen.ts:7074](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7074) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:6362](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6362) +Defined in: [gen/types.gen.ts:7075](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7075) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchResult.md index d88fced913a..98862199a50 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleClientSearchResult.md @@ -11,14 +11,14 @@ mdx: type RoleClientSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:6343](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6343) +Defined in: [gen/types.gen.ts:7056](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7056) ## Type Declaration -### items? +### items ```ts -optional items: RoleClientResult[]; +items: RoleClientResult[]; ``` The matching clients. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleCreateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleCreateRequest.md index 3ee56761fc1..74e1967307b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleCreateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleCreateRequest.md @@ -11,7 +11,7 @@ mdx: type RoleCreateRequest = object; ``` -Defined in: [gen/types.gen.ts:6190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6190) +Defined in: [gen/types.gen.ts:6903](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6903) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6190](https://github.com/camunda/orchestration-clu optional description: string; ``` -Defined in: [gen/types.gen.ts:6202](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6202) +Defined in: [gen/types.gen.ts:6915](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6915) The description of the new role. @@ -33,7 +33,7 @@ The description of the new role. name: string; ``` -Defined in: [gen/types.gen.ts:6198](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6198) +Defined in: [gen/types.gen.ts:6911](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6911) The display name of the new role. @@ -45,6 +45,6 @@ The display name of the new role. roleId: string; ``` -Defined in: [gen/types.gen.ts:6194](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6194) +Defined in: [gen/types.gen.ts:6907](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6907) The ID of the new role. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleCreateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleCreateResult.md index 7246f601d04..6552f6d2c62 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleCreateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleCreateResult.md @@ -11,40 +11,40 @@ mdx: type RoleCreateResult = object; ``` -Defined in: [gen/types.gen.ts:6205](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6205) +Defined in: [gen/types.gen.ts:6918](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6918) ## Properties -### description? +### description ```ts -optional description: string; +description: string | null; ``` -Defined in: [gen/types.gen.ts:6217](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6217) +Defined in: [gen/types.gen.ts:6930](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6930) The description of the created role. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:6213](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6213) +Defined in: [gen/types.gen.ts:6926](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6926) The display name of the created role. --- -### roleId? +### roleId ```ts -optional roleId: string; +roleId: string; ``` -Defined in: [gen/types.gen.ts:6209](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6209) +Defined in: [gen/types.gen.ts:6922](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6922) The ID of the created role. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleFilter.md index 1c0d332d8e7..b2639e99381 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleFilter.md @@ -11,7 +11,7 @@ mdx: type RoleFilter = object; ``` -Defined in: [gen/types.gen.ts:6289](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6289) +Defined in: [gen/types.gen.ts:7002](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7002) Role filter request @@ -23,7 +23,7 @@ Role filter request optional name: string; ``` -Defined in: [gen/types.gen.ts:6297](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6297) +Defined in: [gen/types.gen.ts:7010](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7010) The role name search filters. @@ -35,6 +35,6 @@ The role name search filters. optional roleId: string; ``` -Defined in: [gen/types.gen.ts:6293](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6293) +Defined in: [gen/types.gen.ts:7006](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7006) The role ID search filters. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupResult.md index 826a7131889..2ec38ccc926 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupResult.md @@ -11,16 +11,16 @@ mdx: type RoleGroupResult = object; ``` -Defined in: [gen/types.gen.ts:6365](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6365) +Defined in: [gen/types.gen.ts:7078](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7078) ## Properties -### groupId? +### groupId ```ts -optional groupId: string; +groupId: string; ``` -Defined in: [gen/types.gen.ts:6369](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6369) +Defined in: [gen/types.gen.ts:7082](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7082) The id of the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchQueryRequest.md index 243666f5efc..cf152192ce2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type RoleGroupSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:6379](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6379) +Defined in: [gen/types.gen.ts:7092](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7092) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchQuerySortRequest.md index 64acf660bf9..ba548d000df 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type RoleGroupSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:6386](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6386) +Defined in: [gen/types.gen.ts:7106](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7106) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6386](https://github.com/camunda/orchestration-clu field: "groupId"; ``` -Defined in: [gen/types.gen.ts:6390](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6390) +Defined in: [gen/types.gen.ts:7110](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7110) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:6391](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6391) +Defined in: [gen/types.gen.ts:7111](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7111) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchResult.md index 5166a554807..583f8148b86 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleGroupSearchResult.md @@ -11,14 +11,14 @@ mdx: type RoleGroupSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:6372](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6372) +Defined in: [gen/types.gen.ts:7085](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7085) ## Type Declaration -### items? +### items ```ts -optional items: RoleGroupResult[]; +items: RoleGroupResult[]; ``` The matching groups. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleMappingRuleSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleMappingRuleSearchResult.md new file mode 100644 index 00000000000..2dc96256c0b --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleMappingRuleSearchResult.md @@ -0,0 +1,24 @@ +--- +title: "Type Alias: RoleMappingRuleSearchResult" +sidebar_label: "RoleMappingRuleSearchResult" +mdx: + format: md +--- + +# Type Alias: RoleMappingRuleSearchResult + +```ts +type RoleMappingRuleSearchResult = SearchQueryResponse & object; +``` + +Defined in: [gen/types.gen.ts:7099](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7099) + +## Type Declaration + +### items + +```ts +items: MappingRuleResult[]; +``` + +The matching mapping rules. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleResult.md index 0b404459414..ae5f6bf5946 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleResult.md @@ -11,42 +11,42 @@ mdx: type RoleResult = object; ``` -Defined in: [gen/types.gen.ts:6249](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6249) +Defined in: [gen/types.gen.ts:6962](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6962) Role search response item. ## Properties -### description? +### description ```ts -optional description: string; +description: string | null; ``` -Defined in: [gen/types.gen.ts:6261](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6261) +Defined in: [gen/types.gen.ts:6974](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6974) The description of the role. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:6253](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6253) +Defined in: [gen/types.gen.ts:6966](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6966) The role name. --- -### roleId? +### roleId ```ts -optional roleId: string; +roleId: string; ``` -Defined in: [gen/types.gen.ts:6257](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6257) +Defined in: [gen/types.gen.ts:6970](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6970) The role id. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQueryRequest.md index fa8467a0e69..574c99fc4f8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type RoleSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:6275](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6275) +Defined in: [gen/types.gen.ts:6988](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6988) Role search request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQueryResult.md index 8a9a96c23b3..37df38874fd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQueryResult.md @@ -11,16 +11,16 @@ mdx: type RoleSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:6303](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6303) +Defined in: [gen/types.gen.ts:7016](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7016) Role search response. ## Type Declaration -### items? +### items ```ts -optional items: RoleResult[]; +items: RoleResult[]; ``` The matching roles. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQuerySortRequest.md index dcac2582eaf..609a0ccebba 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type RoleSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:6264](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6264) +Defined in: [gen/types.gen.ts:6977](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6977) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6264](https://github.com/camunda/orchestration-clu field: "name" | "roleId"; ``` -Defined in: [gen/types.gen.ts:6268](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6268) +Defined in: [gen/types.gen.ts:6981](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6981) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:6269](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6269) +Defined in: [gen/types.gen.ts:6982](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6982) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUpdateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUpdateRequest.md index 389826183e1..0154f38826c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUpdateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUpdateRequest.md @@ -11,7 +11,7 @@ mdx: type RoleUpdateRequest = object; ``` -Defined in: [gen/types.gen.ts:6220](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6220) +Defined in: [gen/types.gen.ts:6933](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6933) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6220](https://github.com/camunda/orchestration-clu optional description: string; ``` -Defined in: [gen/types.gen.ts:6228](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6228) +Defined in: [gen/types.gen.ts:6941](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6941) The description of the new role. @@ -33,6 +33,6 @@ The description of the new role. name: string; ``` -Defined in: [gen/types.gen.ts:6224](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6224) +Defined in: [gen/types.gen.ts:6937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6937) The display name of the new role. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUpdateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUpdateResult.md index 1e6be2cc6b2..cc0d4e262f6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUpdateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUpdateResult.md @@ -11,40 +11,40 @@ mdx: type RoleUpdateResult = object; ``` -Defined in: [gen/types.gen.ts:6231](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6231) +Defined in: [gen/types.gen.ts:6944](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6944) ## Properties -### description? +### description ```ts -optional description: string; +description: string | null; ``` -Defined in: [gen/types.gen.ts:6239](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6239) +Defined in: [gen/types.gen.ts:6952](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6952) The description of the updated role. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:6235](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6235) +Defined in: [gen/types.gen.ts:6948](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6948) The display name of the updated role. --- -### roleId? +### roleId ```ts -optional roleId: string; +roleId: string; ``` -Defined in: [gen/types.gen.ts:6243](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6243) +Defined in: [gen/types.gen.ts:6956](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6956) The ID of the updated role. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserResult.md index c940e8f0c33..d34a42b422e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserResult.md @@ -11,14 +11,14 @@ mdx: type RoleUserResult = object; ``` -Defined in: [gen/types.gen.ts:6310](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6310) +Defined in: [gen/types.gen.ts:7023](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7023) ## Properties -### username? +### username ```ts -optional username: Username; +username: Username; ``` -Defined in: [gen/types.gen.ts:6311](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6311) +Defined in: [gen/types.gen.ts:7024](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7024) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchQueryRequest.md index 21214887c42..0bb8576525b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type RoleUserSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:6321](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6321) +Defined in: [gen/types.gen.ts:7034](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7034) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchQuerySortRequest.md index adc8ce9180e..87cea3f08d7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type RoleUserSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:6328](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6328) +Defined in: [gen/types.gen.ts:7041](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7041) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6328](https://github.com/camunda/orchestration-clu field: "username"; ``` -Defined in: [gen/types.gen.ts:6332](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6332) +Defined in: [gen/types.gen.ts:7045](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7045) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:6333](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6333) +Defined in: [gen/types.gen.ts:7046](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7046) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchResult.md index fde4dbcc4fe..a75b65ab1fc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/RoleUserSearchResult.md @@ -11,14 +11,14 @@ mdx: type RoleUserSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:6314](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6314) +Defined in: [gen/types.gen.ts:7027](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7027) ## Type Declaration -### items? +### items ```ts -optional items: RoleUserResult[]; +items: RoleUserResult[]; ``` The matching users. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/RootProcessInstanceKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/RootProcessInstanceKey.md deleted file mode 100644 index 6ad2638e482..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/RootProcessInstanceKey.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Type Alias: RootProcessInstanceKey" -sidebar_label: "RootProcessInstanceKey" -mdx: - format: md ---- - -# Type Alias: RootProcessInstanceKey - -```ts -type RootProcessInstanceKey = CamundaKey<"RootProcessInstanceKey">; -``` - -Defined in: [gen/types.gen.ts:4019](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4019) - -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. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKey.md index 7bcfc55efbb..e66afb6fc6c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKey.md @@ -8,9 +8,10 @@ mdx: # Type Alias: ScopeKey ```ts -type ScopeKey = CamundaKey<"ScopeKey">; +type ScopeKey = ProcessInstanceKey | ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:4049](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4049) +Defined in: [gen/types.gen.ts:4688](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4688) -System-generated key for a scope. +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. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKeyExactMatch.md index ed98843a62a..7c2a22b8f68 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type ScopeKeyExactMatch = ScopeKey; ``` -Defined in: [gen/types.gen.ts:7570](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7570) +Defined in: [gen/types.gen.ts:8416](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8416) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKeyFilterProperty.md index dc8ff2ab70f..9c3febbeab0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ScopeKeyFilterProperty.md @@ -11,6 +11,7 @@ mdx: type ScopeKeyFilterProperty = ScopeKeyExactMatch | AdvancedScopeKeyFilter; ``` -Defined in: [gen/types.gen.ts:4271](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4271) +Defined in: [gen/types.gen.ts:4912](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4912) -ScopeKey property with full advanced search capabilities. +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. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SdkError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SdkError.md new file mode 100644 index 00000000000..39dcd000067 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SdkError.md @@ -0,0 +1,19 @@ +--- +title: "Type Alias: SdkError" +sidebar_label: "SdkError" +mdx: + format: md +--- + +# Type Alias: SdkError + +```ts +type SdkError = + | HttpSdkError + | ValidationSdkError + | AuthSdkError + | NetworkSdkError + | CancelSdkError; +``` + +Defined in: [runtime/errors.ts:41](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/errors.ts#L41) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsData.md index c9a293c43f2..7c6a9c9482e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsData.md @@ -11,7 +11,7 @@ mdx: type SearchAuditLogsData = object; ``` -Defined in: [gen/types.gen.ts:7642](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7642) +Defined in: [gen/types.gen.ts:8488](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8488) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7642](https://github.com/camunda/orchestration-clu optional body: AuditLogSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:7643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7643) +Defined in: [gen/types.gen.ts:8489](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8489) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:7643](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:7644](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7644) +Defined in: [gen/types.gen.ts:8490](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8490) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:7644](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:7645](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7645) +Defined in: [gen/types.gen.ts:8491](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8491) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:7645](https://github.com/camunda/orchestration-clu url: "/audit-logs/search"; ``` -Defined in: [gen/types.gen.ts:7646](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7646) +Defined in: [gen/types.gen.ts:8492](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8492) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsError.md index f417836a72c..53213f1534e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsError.md @@ -11,4 +11,4 @@ mdx: type SearchAuditLogsError = SearchAuditLogsErrors[keyof SearchAuditLogsErrors]; ``` -Defined in: [gen/types.gen.ts:7668](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7668) +Defined in: [gen/types.gen.ts:8514](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8514) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsErrors.md index e6baf527aa4..66a2c379981 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchAuditLogsErrors = object; ``` -Defined in: [gen/types.gen.ts:7649](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7649) +Defined in: [gen/types.gen.ts:8495](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8495) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7649](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7653](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7653) +Defined in: [gen/types.gen.ts:8499](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8499) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7657](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7657) +Defined in: [gen/types.gen.ts:8503](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8503) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:7661](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7661) +Defined in: [gen/types.gen.ts:8507](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8507) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: unknown; ``` -Defined in: [gen/types.gen.ts:7665](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7665) +Defined in: [gen/types.gen.ts:8511](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8511) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsResponse.md index 532cb14e097..a4bfd54f255 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsResponse.md @@ -12,4 +12,4 @@ type SearchAuditLogsResponse = SearchAuditLogsResponses[keyof SearchAuditLogsResponses]; ``` -Defined in: [gen/types.gen.ts:7792](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7792) +Defined in: [gen/types.gen.ts:8523](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8523) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsResponses.md index e12f01da292..1e88318fa40 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuditLogsResponses.md @@ -11,26 +11,16 @@ mdx: type SearchAuditLogsResponses = object; ``` -Defined in: [gen/types.gen.ts:7670](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7670) +Defined in: [gen/types.gen.ts:8516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8516) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: AuditLogSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:7674](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7674) +Defined in: [gen/types.gen.ts:8520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8520) -Audit log search response. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching audit logs. +The audit logs search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsData.md index 15c79793395..3aca5ea2deb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsData.md @@ -11,7 +11,7 @@ mdx: type SearchAuthorizationsData = object; ``` -Defined in: [gen/types.gen.ts:8025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8025) +Defined in: [gen/types.gen.ts:8646](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8646) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8025](https://github.com/camunda/orchestration-clu optional body: AuthorizationSearchQuery; ``` -Defined in: [gen/types.gen.ts:8026](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8026) +Defined in: [gen/types.gen.ts:8647](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8647) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8026](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:8027](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8027) +Defined in: [gen/types.gen.ts:8648](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8648) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:8027](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:8028](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8028) +Defined in: [gen/types.gen.ts:8649](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8649) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:8028](https://github.com/camunda/orchestration-clu url: "/authorizations/search"; ``` -Defined in: [gen/types.gen.ts:8029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8029) +Defined in: [gen/types.gen.ts:8650](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8650) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsError.md index 15324988797..b2944ca1fc8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsError.md @@ -12,4 +12,4 @@ type SearchAuthorizationsError = SearchAuthorizationsErrors[keyof SearchAuthorizationsErrors]; ``` -Defined in: [gen/types.gen.ts:8051](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8051) +Defined in: [gen/types.gen.ts:8672](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8672) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsErrors.md index b162f225b59..36d16001961 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchAuthorizationsErrors = object; ``` -Defined in: [gen/types.gen.ts:8032](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8032) +Defined in: [gen/types.gen.ts:8653](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8653) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8032](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8036](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8036) +Defined in: [gen/types.gen.ts:8657](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8657) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8040](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8040) +Defined in: [gen/types.gen.ts:8661](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8661) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8044](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8044) +Defined in: [gen/types.gen.ts:8665](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8665) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8048](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8048) +Defined in: [gen/types.gen.ts:8669](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8669) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsResponse.md index ad1195c00f2..a3e848c60f2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsResponse.md @@ -12,4 +12,4 @@ type SearchAuthorizationsResponse = SearchAuthorizationsResponses[keyof SearchAuthorizationsResponses]; ``` -Defined in: [gen/types.gen.ts:8060](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8060) +Defined in: [gen/types.gen.ts:8681](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8681) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsResponses.md index b556de79458..59a47b0f96a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchAuthorizationsResponses.md @@ -11,7 +11,7 @@ mdx: type SearchAuthorizationsResponses = object; ``` -Defined in: [gen/types.gen.ts:8053](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8053) +Defined in: [gen/types.gen.ts:8674](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8674) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8053](https://github.com/camunda/orchestration-clu 200: AuthorizationSearchResult; ``` -Defined in: [gen/types.gen.ts:8057](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8057) +Defined in: [gen/types.gen.ts:8678](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8678) The authorization search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsData.md index fbc773f7904..faeffffa1a6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsData.md @@ -11,77 +11,17 @@ mdx: type SearchBatchOperationItemsData = object; ``` -Defined in: [gen/types.gen.ts:8190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8190) +Defined in: [gen/types.gen.ts:8811](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8811) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: BatchOperationItemSearchQuery; ``` -Defined in: [gen/types.gen.ts:8194](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8194) - -Batch operation item search request. - -#### Type Declaration - -##### filter? - -```ts -optional filter: object; -``` - -Batch operation item filter request. - -###### filter.batchOperationKey? - -```ts -optional batchOperationKey: BasicStringFilterProperty; -``` - -The key (or operate legacy ID) of the batch operation. - -###### filter.itemKey? - -```ts -optional itemKey: BasicStringFilterProperty; -``` - -The key of the item, e.g. a process instance key. - -###### filter.operationType? - -```ts -optional operationType: BatchOperationTypeFilterProperty; -``` - -The type of the batch operation. - -###### filter.processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKeyFilterProperty; -``` - -The process instance key of the processed item. - -###### filter.state? - -```ts -optional state: BatchOperationItemStateFilterProperty; -``` - -The state of the batch operation. - -##### sort? - -```ts -optional sort: BatchOperationItemSearchQuerySortRequest[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:8812](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8812) --- @@ -91,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:8225](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8225) +Defined in: [gen/types.gen.ts:8813](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8813) --- @@ -101,7 +41,7 @@ Defined in: [gen/types.gen.ts:8225](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:8226](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8226) +Defined in: [gen/types.gen.ts:8814](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8814) --- @@ -111,4 +51,4 @@ Defined in: [gen/types.gen.ts:8226](https://github.com/camunda/orchestration-clu url: "/batch-operation-items/search"; ``` -Defined in: [gen/types.gen.ts:8227](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8227) +Defined in: [gen/types.gen.ts:8815](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8815) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsError.md index af5d6959fd2..25b8860706d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsError.md @@ -12,4 +12,4 @@ type SearchBatchOperationItemsError = SearchBatchOperationItemsErrors[keyof SearchBatchOperationItemsErrors]; ``` -Defined in: [gen/types.gen.ts:8241](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8241) +Defined in: [gen/types.gen.ts:8829](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8829) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsErrors.md index 12aa91c6dd2..69215b91a13 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchBatchOperationItemsErrors = object; ``` -Defined in: [gen/types.gen.ts:8230](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8230) +Defined in: [gen/types.gen.ts:8818](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8818) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8230](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8234](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8234) +Defined in: [gen/types.gen.ts:8822](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8822) The provided data is not valid. @@ -33,6 +33,6 @@ The provided data is not valid. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8238](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8238) +Defined in: [gen/types.gen.ts:8826](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8826) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsResponse.md index 491014a38e5..649f34feb42 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsResponse.md @@ -12,4 +12,4 @@ type SearchBatchOperationItemsResponse = SearchBatchOperationItemsResponses[keyof SearchBatchOperationItemsResponses]; ``` -Defined in: [gen/types.gen.ts:8282](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8282) +Defined in: [gen/types.gen.ts:8838](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8838) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsResponses.md index b9f1a75e0b1..829ba56701b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationItemsResponses.md @@ -11,26 +11,16 @@ mdx: type SearchBatchOperationItemsResponses = object; ``` -Defined in: [gen/types.gen.ts:8243](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8243) +Defined in: [gen/types.gen.ts:8831](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8831) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: BatchOperationItemSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:8247](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8247) +Defined in: [gen/types.gen.ts:8835](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8835) The batch operation search result. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching batch operation items. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsData.md index 391f523ace8..fed902ff0f5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsData.md @@ -11,77 +11,17 @@ mdx: type SearchBatchOperationsData = object; ``` -Defined in: [gen/types.gen.ts:8284](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8284) +Defined in: [gen/types.gen.ts:8840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8840) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: BatchOperationSearchQuery; ``` -Defined in: [gen/types.gen.ts:8288](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8288) - -Batch operation search request. - -#### Type Declaration - -##### filter? - -```ts -optional filter: object; -``` - -Batch operation filter request. - -###### filter.actorId? - -```ts -optional actorId: StringFilterProperty; -``` - -The ID of the actor who performed the operation. - -###### filter.actorType? - -```ts -optional actorType: AuditLogActorTypeEnum; -``` - -The type of the actor who performed the operation. - -###### filter.batchOperationKey? - -```ts -optional batchOperationKey: BasicStringFilterProperty; -``` - -The key (or operate legacy ID) of the batch operation. - -###### filter.operationType? - -```ts -optional operationType: BatchOperationTypeFilterProperty; -``` - -The type of the batch operation. - -###### filter.state? - -```ts -optional state: BatchOperationStateFilterProperty; -``` - -The state of the batch operation. - -##### sort? - -```ts -optional sort: BatchOperationSearchQuerySortRequest[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:8841](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8841) --- @@ -91,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:8319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8319) +Defined in: [gen/types.gen.ts:8842](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8842) --- @@ -101,7 +41,7 @@ Defined in: [gen/types.gen.ts:8319](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:8320](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8320) +Defined in: [gen/types.gen.ts:8843](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8843) --- @@ -111,4 +51,4 @@ Defined in: [gen/types.gen.ts:8320](https://github.com/camunda/orchestration-clu url: "/batch-operations/search"; ``` -Defined in: [gen/types.gen.ts:8321](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8321) +Defined in: [gen/types.gen.ts:8844](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8844) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsError.md index 28634bf2d65..9c349a1e1ae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsError.md @@ -12,4 +12,4 @@ type SearchBatchOperationsError = SearchBatchOperationsErrors[keyof SearchBatchOperationsErrors]; ``` -Defined in: [gen/types.gen.ts:8335](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8335) +Defined in: [gen/types.gen.ts:8858](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8858) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsErrors.md index 41dbfd870d3..0dc7ea01346 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchBatchOperationsErrors = object; ``` -Defined in: [gen/types.gen.ts:8324](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8324) +Defined in: [gen/types.gen.ts:8847](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8847) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8324](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8328](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8328) +Defined in: [gen/types.gen.ts:8851](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8851) The provided data is not valid. @@ -33,6 +33,6 @@ The provided data is not valid. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8332](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8332) +Defined in: [gen/types.gen.ts:8855](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8855) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsResponse.md index 703974865cf..d71af357bed 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsResponse.md @@ -12,4 +12,4 @@ type SearchBatchOperationsResponse = SearchBatchOperationsResponses[keyof SearchBatchOperationsResponses]; ``` -Defined in: [gen/types.gen.ts:8344](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8344) +Defined in: [gen/types.gen.ts:8867](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8867) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsResponses.md index 008b57c2376..4e110bb2587 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchBatchOperationsResponses.md @@ -11,7 +11,7 @@ mdx: type SearchBatchOperationsResponses = object; ``` -Defined in: [gen/types.gen.ts:8337](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8337) +Defined in: [gen/types.gen.ts:8860](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8860) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8337](https://github.com/camunda/orchestration-clu 200: BatchOperationSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:8341](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8341) +Defined in: [gen/types.gen.ts:8864](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8864) The batch operation search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupData.md index 0cf44abfee4..39cc9db01af 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupData.md @@ -11,7 +11,7 @@ mdx: type SearchClientsForGroupData = object; ``` -Defined in: [gen/types.gen.ts:10860](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10860) +Defined in: [gen/types.gen.ts:11028](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11028) ## Properties @@ -21,14 +21,14 @@ Defined in: [gen/types.gen.ts:10860](https://github.com/camunda/orchestration-cl optional body: SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:10861](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10861) +Defined in: [gen/types.gen.ts:11029](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11029) #### Type Declaration ##### sort? ```ts -optional sort: TenantClientSearchQuerySortRequest[]; +optional sort: object[]; ``` Sort field criteria. @@ -41,7 +41,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:10867](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10867) +Defined in: [gen/types.gen.ts:11041](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11041) #### groupId @@ -59,7 +59,7 @@ The group ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:10873](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10873) +Defined in: [gen/types.gen.ts:11047](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11047) --- @@ -69,4 +69,4 @@ Defined in: [gen/types.gen.ts:10873](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/clients/search"; ``` -Defined in: [gen/types.gen.ts:10874](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10874) +Defined in: [gen/types.gen.ts:11048](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11048) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupError.md index b6d5db1463d..d7846383396 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupError.md @@ -12,4 +12,4 @@ type SearchClientsForGroupError = SearchClientsForGroupErrors[keyof SearchClientsForGroupErrors]; ``` -Defined in: [gen/types.gen.ts:10900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10900) +Defined in: [gen/types.gen.ts:11074](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11074) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupErrors.md index 795d2989963..a74a4e8bfe6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupErrors.md @@ -11,7 +11,7 @@ mdx: type SearchClientsForGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:10877](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10877) +Defined in: [gen/types.gen.ts:11051](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11051) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10877](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10881](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10881) +Defined in: [gen/types.gen.ts:11055](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11055) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10885](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10885) +Defined in: [gen/types.gen.ts:11059](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11059) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10889](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10889) +Defined in: [gen/types.gen.ts:11063](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11063) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10893](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10893) +Defined in: [gen/types.gen.ts:11067](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11067) The group with the given ID was not found. @@ -69,6 +69,6 @@ The group with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10897](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10897) +Defined in: [gen/types.gen.ts:11071](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11071) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupResponse.md index 2664f50005a..bc563fa667b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupResponse.md @@ -12,4 +12,4 @@ type SearchClientsForGroupResponse = SearchClientsForGroupResponses[keyof SearchClientsForGroupResponses]; ``` -Defined in: [gen/types.gen.ts:10909](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10909) +Defined in: [gen/types.gen.ts:11093](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11093) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupResponses.md index bfceedb853b..b1412f821a9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForGroupResponses.md @@ -11,16 +11,26 @@ mdx: type SearchClientsForGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:10902](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10902) +Defined in: [gen/types.gen.ts:11076](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11076) ## Properties ### 200 ```ts -200: TenantClientSearchResult; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:10906](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10906) +Defined in: [gen/types.gen.ts:11080](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11080) The clients assigned to the group. + +#### Type Declaration + +##### items + +```ts +items: object[]; +``` + +The matching client IDs. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleData.md index 805d7ed5296..231315adfa9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleData.md @@ -11,7 +11,7 @@ mdx: type SearchClientsForRoleData = object; ``` -Defined in: [gen/types.gen.ts:14732](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14732) +Defined in: [gen/types.gen.ts:14014](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14014) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14732](https://github.com/camunda/orchestration-cl optional body: SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:14733](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14733) +Defined in: [gen/types.gen.ts:14015](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14015) #### Type Declaration @@ -41,7 +41,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:14745](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14745) +Defined in: [gen/types.gen.ts:14027](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14027) #### roleId @@ -59,7 +59,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:14751](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14751) +Defined in: [gen/types.gen.ts:14033](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14033) --- @@ -69,4 +69,4 @@ Defined in: [gen/types.gen.ts:14751](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/clients/search"; ``` -Defined in: [gen/types.gen.ts:14752](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14752) +Defined in: [gen/types.gen.ts:14034](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14034) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleError.md index c97c172f38a..3d1140e6aad 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleError.md @@ -12,4 +12,4 @@ type SearchClientsForRoleError = SearchClientsForRoleErrors[keyof SearchClientsForRoleErrors]; ``` -Defined in: [gen/types.gen.ts:14778](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14778) +Defined in: [gen/types.gen.ts:14060](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14060) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleErrors.md index 8ea6dc83cd3..1fbdb067646 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleErrors.md @@ -11,7 +11,7 @@ mdx: type SearchClientsForRoleErrors = object; ``` -Defined in: [gen/types.gen.ts:14755](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14755) +Defined in: [gen/types.gen.ts:14037](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14037) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14755](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14759](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14759) +Defined in: [gen/types.gen.ts:14041](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14041) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14763](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14763) +Defined in: [gen/types.gen.ts:14045](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14045) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14767](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14767) +Defined in: [gen/types.gen.ts:14049](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14049) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14771](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14771) +Defined in: [gen/types.gen.ts:14053](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14053) The role with the given ID was not found. @@ -69,6 +69,6 @@ The role with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14775](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14775) +Defined in: [gen/types.gen.ts:14057](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14057) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleResponse.md index 1422026c964..9f1777b4f9d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleResponse.md @@ -12,4 +12,4 @@ type SearchClientsForRoleResponse = SearchClientsForRoleResponses[keyof SearchClientsForRoleResponses]; ``` -Defined in: [gen/types.gen.ts:14787](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14787) +Defined in: [gen/types.gen.ts:14079](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14079) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleResponses.md index e898aea6d28..2a95db6f991 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForRoleResponses.md @@ -11,16 +11,26 @@ mdx: type SearchClientsForRoleResponses = object; ``` -Defined in: [gen/types.gen.ts:14780](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14780) +Defined in: [gen/types.gen.ts:14062](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14062) ## Properties ### 200 ```ts -200: TenantClientSearchResult; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:14784](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14784) +Defined in: [gen/types.gen.ts:14066](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14066) The clients with the assigned role. + +#### Type Declaration + +##### items + +```ts +items: object[]; +``` + +The matching clients. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantData.md index 0e4eca8f12b..0220916f711 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantData.md @@ -11,7 +11,7 @@ mdx: type SearchClientsForTenantData = object; ``` -Defined in: [gen/types.gen.ts:15771](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15771) +Defined in: [gen/types.gen.ts:15075](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15075) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15771](https://github.com/camunda/orchestration-cl optional body: SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:15772](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15772) +Defined in: [gen/types.gen.ts:15076](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15076) #### Type Declaration @@ -41,7 +41,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:15784](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15784) +Defined in: [gen/types.gen.ts:15088](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15088) #### tenantId @@ -59,7 +59,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:15790](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15790) +Defined in: [gen/types.gen.ts:15094](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15094) --- @@ -69,4 +69,4 @@ Defined in: [gen/types.gen.ts:15790](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/clients/search"; ``` -Defined in: [gen/types.gen.ts:15791](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15791) +Defined in: [gen/types.gen.ts:15095](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15095) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantResponse.md index 5a6634c2bd9..76e695368c3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantResponse.md @@ -12,4 +12,4 @@ type SearchClientsForTenantResponse = SearchClientsForTenantResponses[keyof SearchClientsForTenantResponses]; ``` -Defined in: [gen/types.gen.ts:15801](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15801) +Defined in: [gen/types.gen.ts:15115](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15115) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantResponses.md index 586d082f34f..b0144d8e94c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClientsForTenantResponses.md @@ -11,16 +11,26 @@ mdx: type SearchClientsForTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:15794](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15794) +Defined in: [gen/types.gen.ts:15098](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15098) ## Properties ### 200 ```ts -200: TenantClientSearchResult; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:15798](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15798) +Defined in: [gen/types.gen.ts:15102](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15102) The search result of users for the tenant. + +#### Type Declaration + +##### items + +```ts +items: object[]; +``` + +The matching clients. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesData.md index ad5a85e1649..6bb323691f7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesData.md @@ -11,99 +11,17 @@ mdx: type SearchClusterVariablesData = object; ``` -Defined in: [gen/types.gen.ts:8759](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8759) +Defined in: [gen/types.gen.ts:9282](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9282) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: ClusterVariableSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:8763](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8763) - -Cluster variable search query request. - -#### Type Declaration - -##### filter? - -```ts -optional filter: object; -``` - -Cluster variable filter request. - -###### filter.isTruncated? - -```ts -optional isTruncated: boolean; -``` - -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. - -###### filter.name? - -```ts -optional name: StringFilterProperty; -``` - -Name of the cluster variable. - -###### filter.scope? - -```ts -optional scope: - | ClusterVariableScopeEnum - | { - $eq?: ClusterVariableScopeEnum; - $exists?: boolean; - $in?: ClusterVariableScopeEnum[]; - $like?: LikeFilter; - $neq?: ClusterVariableScopeEnum; -}; -``` - -ClusterVariableScopeEnum property with full advanced search capabilities. - -###### Type Declaration - -[`ClusterVariableScopeEnum`](ClusterVariableScopeEnum.md) - -```ts -{ - $eq?: ClusterVariableScopeEnum; - $exists?: boolean; - $in?: ClusterVariableScopeEnum[]; - $like?: LikeFilter; - $neq?: ClusterVariableScopeEnum; -} -``` - -###### filter.tenantId? - -```ts -optional tenantId: StringFilterProperty; -``` - -Tenant ID of this variable. - -###### filter.value? - -```ts -optional value: StringFilterProperty; -``` - -The value of the cluster variable. - -##### sort? - -```ts -optional sort: ClusterVariableSearchQuerySortRequest[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:9283](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9283) --- @@ -113,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:8813](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8813) +Defined in: [gen/types.gen.ts:9284](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9284) --- @@ -123,7 +41,7 @@ Defined in: [gen/types.gen.ts:8813](https://github.com/camunda/orchestration-clu optional query: object; ``` -Defined in: [gen/types.gen.ts:8814](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8814) +Defined in: [gen/types.gen.ts:9285](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9285) #### truncateValues? @@ -141,4 +59,4 @@ When true (default), long variable values in the response are truncated. When fa url: "/cluster-variables/search"; ``` -Defined in: [gen/types.gen.ts:8820](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8820) +Defined in: [gen/types.gen.ts:9291](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9291) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesError.md index c0db76d3251..4aef2284631 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesError.md @@ -12,4 +12,4 @@ type SearchClusterVariablesError = SearchClusterVariablesErrors[keyof SearchClusterVariablesErrors]; ``` -Defined in: [gen/types.gen.ts:8842](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8842) +Defined in: [gen/types.gen.ts:9313](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9313) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesErrors.md index 7c7594b9917..206c828a006 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesErrors.md @@ -11,7 +11,7 @@ mdx: type SearchClusterVariablesErrors = object; ``` -Defined in: [gen/types.gen.ts:8823](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8823) +Defined in: [gen/types.gen.ts:9294](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9294) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8823](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8827](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8827) +Defined in: [gen/types.gen.ts:9298](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9298) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8831](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8831) +Defined in: [gen/types.gen.ts:9302](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9302) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8835](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8835) +Defined in: [gen/types.gen.ts:9306](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9306) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8839](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8839) +Defined in: [gen/types.gen.ts:9310](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9310) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesResponse.md index e4075942681..bf7b39100e1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesResponse.md @@ -12,4 +12,4 @@ type SearchClusterVariablesResponse = SearchClusterVariablesResponses[keyof SearchClusterVariablesResponses]; ``` -Defined in: [gen/types.gen.ts:8865](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8865) +Defined in: [gen/types.gen.ts:9322](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9322) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesResponses.md index 94ead54f49e..69eee616b9b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchClusterVariablesResponses.md @@ -11,26 +11,16 @@ mdx: type SearchClusterVariablesResponses = object; ``` -Defined in: [gen/types.gen.ts:8844](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8844) +Defined in: [gen/types.gen.ts:9315](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9315) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: ClusterVariableSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:8848](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8848) +Defined in: [gen/types.gen.ts:9319](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9319) -Cluster variable search query response. - -#### Type Declaration - -##### items? - -```ts -optional items: ClusterVariableResultBase & object[]; -``` - -The matching cluster variables. +The cluster variable search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsData.md index 795aaca9b90..c8a4b3c276e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsData.md @@ -11,7 +11,7 @@ mdx: type SearchCorrelatedMessageSubscriptionsData = object; ``` -Defined in: [gen/types.gen.ts:9104](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9104) +Defined in: [gen/types.gen.ts:9561](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9561) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9104](https://github.com/camunda/orchestration-clu optional body: CorrelatedMessageSubscriptionSearchQuery; ``` -Defined in: [gen/types.gen.ts:9105](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9105) +Defined in: [gen/types.gen.ts:9562](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9562) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9105](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:9106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9106) +Defined in: [gen/types.gen.ts:9563](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9563) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:9106](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:9107](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9107) +Defined in: [gen/types.gen.ts:9564](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9564) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:9107](https://github.com/camunda/orchestration-clu url: "/correlated-message-subscriptions/search"; ``` -Defined in: [gen/types.gen.ts:9108](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9108) +Defined in: [gen/types.gen.ts:9565](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9565) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsError.md index e7c37de9d0c..5cf9e675f9c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsError.md @@ -12,4 +12,4 @@ type SearchCorrelatedMessageSubscriptionsError = SearchCorrelatedMessageSubscriptionsErrors[keyof SearchCorrelatedMessageSubscriptionsErrors]; ``` -Defined in: [gen/types.gen.ts:9130](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9130) +Defined in: [gen/types.gen.ts:9587](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9587) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsErrors.md index 227c35875d1..4d02dc1cffb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchCorrelatedMessageSubscriptionsErrors = object; ``` -Defined in: [gen/types.gen.ts:9111](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9111) +Defined in: [gen/types.gen.ts:9568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9568) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9111](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9115](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9115) +Defined in: [gen/types.gen.ts:9572](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9572) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9119](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9119) +Defined in: [gen/types.gen.ts:9576](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9576) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9123](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9123) +Defined in: [gen/types.gen.ts:9580](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9580) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9127](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9127) +Defined in: [gen/types.gen.ts:9584](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9584) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsResponse.md index 10fb83cb114..b932a864b69 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsResponse.md @@ -12,4 +12,4 @@ type SearchCorrelatedMessageSubscriptionsResponse = SearchCorrelatedMessageSubscriptionsResponses[keyof SearchCorrelatedMessageSubscriptionsResponses]; ``` -Defined in: [gen/types.gen.ts:9194](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9194) +Defined in: [gen/types.gen.ts:9596](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9596) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsResponses.md index 579d7e11660..def748be545 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchCorrelatedMessageSubscriptionsResponses.md @@ -11,26 +11,16 @@ mdx: type SearchCorrelatedMessageSubscriptionsResponses = object; ``` -Defined in: [gen/types.gen.ts:9132](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9132) +Defined in: [gen/types.gen.ts:9589](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9589) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: CorrelatedMessageSubscriptionSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:9136](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9136) +Defined in: [gen/types.gen.ts:9593](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9593) The correlated message subscriptions search result. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching correlated message subscriptions. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsData.md index c2c9bbdaf45..245c17c7434 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsData.md @@ -11,7 +11,7 @@ mdx: type SearchDecisionDefinitionsData = object; ``` -Defined in: [gen/types.gen.ts:9234](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9234) +Defined in: [gen/types.gen.ts:9636](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9636) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9234](https://github.com/camunda/orchestration-clu optional body: DecisionDefinitionSearchQuery; ``` -Defined in: [gen/types.gen.ts:9235](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9235) +Defined in: [gen/types.gen.ts:9637](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9637) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9235](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:9236](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9236) +Defined in: [gen/types.gen.ts:9638](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9638) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:9236](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:9237](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9237) +Defined in: [gen/types.gen.ts:9639](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9639) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:9237](https://github.com/camunda/orchestration-clu url: "/decision-definitions/search"; ``` -Defined in: [gen/types.gen.ts:9238](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9238) +Defined in: [gen/types.gen.ts:9640](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9640) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsError.md index 37ff13e812b..75b19397f51 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsError.md @@ -12,4 +12,4 @@ type SearchDecisionDefinitionsError = SearchDecisionDefinitionsErrors[keyof SearchDecisionDefinitionsErrors]; ``` -Defined in: [gen/types.gen.ts:9260](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9260) +Defined in: [gen/types.gen.ts:9662](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9662) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsErrors.md index a92036d3e47..5a04a69c2c3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchDecisionDefinitionsErrors = object; ``` -Defined in: [gen/types.gen.ts:9241](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9241) +Defined in: [gen/types.gen.ts:9643](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9643) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9241](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9245](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9245) +Defined in: [gen/types.gen.ts:9647](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9647) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9249](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9249) +Defined in: [gen/types.gen.ts:9651](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9651) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9253](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9253) +Defined in: [gen/types.gen.ts:9655](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9655) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9257](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9257) +Defined in: [gen/types.gen.ts:9659](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9659) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsResponse.md index cbbabce479b..e6cce77a509 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsResponse.md @@ -12,4 +12,4 @@ type SearchDecisionDefinitionsResponse = SearchDecisionDefinitionsResponses[keyof SearchDecisionDefinitionsResponses]; ``` -Defined in: [gen/types.gen.ts:9269](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9269) +Defined in: [gen/types.gen.ts:9671](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9671) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsResponses.md index 8e92f7fbb49..5088800221d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionDefinitionsResponses.md @@ -11,7 +11,7 @@ mdx: type SearchDecisionDefinitionsResponses = object; ``` -Defined in: [gen/types.gen.ts:9262](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9262) +Defined in: [gen/types.gen.ts:9664](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9664) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9262](https://github.com/camunda/orchestration-clu 200: DecisionDefinitionSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:9266](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9266) +Defined in: [gen/types.gen.ts:9668](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9668) The decision definition search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesData.md index a1a1e64e78d..f841c3b52e1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesData.md @@ -11,161 +11,17 @@ mdx: type SearchDecisionInstancesData = object; ``` -Defined in: [gen/types.gen.ts:9365](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9365) +Defined in: [gen/types.gen.ts:9767](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9767) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: DecisionInstanceSearchQuery; ``` -Defined in: [gen/types.gen.ts:9366](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9366) - -#### Type Declaration - -##### filter? - -```ts -optional filter: object; -``` - -Decision instance search filter. - -###### filter.decisionDefinitionId? - -```ts -optional decisionDefinitionId: DecisionDefinitionId; -``` - -The ID of the DMN decision. - -###### filter.decisionDefinitionKey? - -```ts -optional decisionDefinitionKey: DecisionDefinitionKeyFilterProperty; -``` - -The key of the decision. - -###### filter.decisionDefinitionName? - -```ts -optional decisionDefinitionName: string; -``` - -The name of the DMN decision. - -###### filter.decisionDefinitionType? - -```ts -optional decisionDefinitionType: DecisionDefinitionTypeEnum; -``` - -###### filter.decisionDefinitionVersion? - -```ts -optional decisionDefinitionVersion: number; -``` - -The version of the decision. - -###### filter.decisionEvaluationInstanceKey? - -```ts -optional decisionEvaluationInstanceKey: DecisionEvaluationInstanceKeyFilterProperty; -``` - -The key of the decision evaluation instance. - -###### filter.decisionEvaluationKey? - -```ts -optional decisionEvaluationKey: DecisionEvaluationKey; -``` - -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. - -###### filter.decisionRequirementsKey? - -```ts -optional decisionRequirementsKey: DecisionRequirementsKeyFilterProperty; -``` - -The key of the decision requirements definition. - -###### filter.elementInstanceKey? - -```ts -optional elementInstanceKey: ElementInstanceKeyFilterProperty; -``` - -The key of the element instance this decision instance is linked to. - -###### filter.evaluationDate? - -```ts -optional evaluationDate: DateTimeFilterProperty; -``` - -The evaluation date of the decision instance. - -###### filter.evaluationFailure? - -```ts -optional evaluationFailure: string; -``` - -The evaluation failure of the decision instance. - -###### filter.processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKey; -``` - -The key of the process definition. - -###### filter.processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKey; -``` - -The key of the process instance. - -###### filter.rootDecisionDefinitionKey? - -```ts -optional rootDecisionDefinitionKey: DecisionDefinitionKeyFilterProperty; -``` - -The key of the root decision definition. - -###### filter.state? - -```ts -optional state: DecisionInstanceStateFilterProperty; -``` - -The state of the decision instance. - -###### filter.tenantId? - -```ts -optional tenantId: TenantId; -``` - -The tenant ID of the decision instance. - -##### sort? - -```ts -optional sort: DecisionInstanceSearchQuerySortRequest[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:9768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9768) --- @@ -175,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:9439](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9439) +Defined in: [gen/types.gen.ts:9769](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9769) --- @@ -185,7 +41,7 @@ Defined in: [gen/types.gen.ts:9439](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:9440](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9440) +Defined in: [gen/types.gen.ts:9770](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9770) --- @@ -195,4 +51,4 @@ Defined in: [gen/types.gen.ts:9440](https://github.com/camunda/orchestration-clu url: "/decision-instances/search"; ``` -Defined in: [gen/types.gen.ts:9441](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9441) +Defined in: [gen/types.gen.ts:9771](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9771) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesError.md index e990dc73af1..d306d078b82 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesError.md @@ -12,4 +12,4 @@ type SearchDecisionInstancesError = SearchDecisionInstancesErrors[keyof SearchDecisionInstancesErrors]; ``` -Defined in: [gen/types.gen.ts:9463](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9463) +Defined in: [gen/types.gen.ts:9793](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9793) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesErrors.md index d9818362b76..227f5bd57f1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesErrors.md @@ -11,7 +11,7 @@ mdx: type SearchDecisionInstancesErrors = object; ``` -Defined in: [gen/types.gen.ts:9444](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9444) +Defined in: [gen/types.gen.ts:9774](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9774) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9444](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9448](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9448) +Defined in: [gen/types.gen.ts:9778](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9778) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9452](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9452) +Defined in: [gen/types.gen.ts:9782](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9782) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9456](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9456) +Defined in: [gen/types.gen.ts:9786](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9786) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9460](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9460) +Defined in: [gen/types.gen.ts:9790](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9790) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesResponse.md index 0d6fe3b3af0..45118f6e71a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesResponse.md @@ -12,4 +12,4 @@ type SearchDecisionInstancesResponse = SearchDecisionInstancesResponses[keyof SearchDecisionInstancesResponses]; ``` -Defined in: [gen/types.gen.ts:9534](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9534) +Defined in: [gen/types.gen.ts:9802](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9802) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesResponses.md index 7c5af1a35e2..50bcc7fd93f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionInstancesResponses.md @@ -11,26 +11,16 @@ mdx: type SearchDecisionInstancesResponses = object; ``` -Defined in: [gen/types.gen.ts:9465](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9465) +Defined in: [gen/types.gen.ts:9795](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9795) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: DecisionInstanceSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:9469](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9469) +Defined in: [gen/types.gen.ts:9799](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9799) The decision instance search result. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching decision instances. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsData.md index 62aa40f32fc..ba3b5b5c293 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsData.md @@ -11,7 +11,7 @@ mdx: type SearchDecisionRequirementsData = object; ``` -Defined in: [gen/types.gen.ts:9808](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9808) +Defined in: [gen/types.gen.ts:9938](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9938) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9808](https://github.com/camunda/orchestration-clu optional body: DecisionRequirementsSearchQuery; ``` -Defined in: [gen/types.gen.ts:9809](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9809) +Defined in: [gen/types.gen.ts:9939](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9939) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9809](https://github.com/camunda/orchestration-clu optional path: never; ``` -Defined in: [gen/types.gen.ts:9810](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9810) +Defined in: [gen/types.gen.ts:9940](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9940) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:9810](https://github.com/camunda/orchestration-clu optional query: never; ``` -Defined in: [gen/types.gen.ts:9811](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9811) +Defined in: [gen/types.gen.ts:9941](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9941) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:9811](https://github.com/camunda/orchestration-clu url: "/decision-requirements/search"; ``` -Defined in: [gen/types.gen.ts:9812](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9812) +Defined in: [gen/types.gen.ts:9942](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9942) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsError.md index fd9c84cb09e..4d6bbc734f9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsError.md @@ -12,4 +12,4 @@ type SearchDecisionRequirementsError = SearchDecisionRequirementsErrors[keyof SearchDecisionRequirementsErrors]; ``` -Defined in: [gen/types.gen.ts:9834](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9834) +Defined in: [gen/types.gen.ts:9964](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9964) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsErrors.md index 7c44a052f1a..0957372d3e4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchDecisionRequirementsErrors = object; ``` -Defined in: [gen/types.gen.ts:9815](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9815) +Defined in: [gen/types.gen.ts:9945](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9945) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9815](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9819](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9819) +Defined in: [gen/types.gen.ts:9949](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9949) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9823](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9823) +Defined in: [gen/types.gen.ts:9953](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9953) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9827](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9827) +Defined in: [gen/types.gen.ts:9957](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9957) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9831](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9831) +Defined in: [gen/types.gen.ts:9961](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9961) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsResponse.md index 22f0b7c1db6..3907e713615 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsResponse.md @@ -12,4 +12,4 @@ type SearchDecisionRequirementsResponse = SearchDecisionRequirementsResponses[keyof SearchDecisionRequirementsResponses]; ``` -Defined in: [gen/types.gen.ts:9843](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9843) +Defined in: [gen/types.gen.ts:9973](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9973) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsResponses.md index de25f5a6801..5f9f28c4ac0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchDecisionRequirementsResponses.md @@ -11,7 +11,7 @@ mdx: type SearchDecisionRequirementsResponses = object; ``` -Defined in: [gen/types.gen.ts:9836](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9836) +Defined in: [gen/types.gen.ts:9966](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9966) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9836](https://github.com/camunda/orchestration-clu 200: DecisionRequirementsSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:9840](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9840) +Defined in: [gen/types.gen.ts:9970](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9970) The decision requirements search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsData.md index ca54adc1ae0..f200368f447 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsData.md @@ -11,7 +11,7 @@ mdx: type SearchElementInstanceIncidentsData = object; ``` -Defined in: [gen/types.gen.ts:10478](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10478) +Defined in: [gen/types.gen.ts:10459](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10459) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10478](https://github.com/camunda/orchestration-cl body: IncidentSearchQuery; ``` -Defined in: [gen/types.gen.ts:10479](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10479) +Defined in: [gen/types.gen.ts:10460](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10460) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10479](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10480](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10480) +Defined in: [gen/types.gen.ts:10461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10461) #### elementInstanceKey @@ -49,7 +49,7 @@ The unique key of the element instance to search incidents for. optional query: never; ``` -Defined in: [gen/types.gen.ts:10486](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10486) +Defined in: [gen/types.gen.ts:10467](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10467) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:10486](https://github.com/camunda/orchestration-cl url: "/element-instances/{elementInstanceKey}/incidents/search"; ``` -Defined in: [gen/types.gen.ts:10487](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10487) +Defined in: [gen/types.gen.ts:10468](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10468) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsError.md index 40c052677db..a40fa898822 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsError.md @@ -12,4 +12,4 @@ type SearchElementInstanceIncidentsError = SearchElementInstanceIncidentsErrors[keyof SearchElementInstanceIncidentsErrors]; ``` -Defined in: [gen/types.gen.ts:10513](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10513) +Defined in: [gen/types.gen.ts:10494](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10494) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsErrors.md index c8714319a03..8c547409879 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchElementInstanceIncidentsErrors = object; ``` -Defined in: [gen/types.gen.ts:10490](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10490) +Defined in: [gen/types.gen.ts:10471](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10471) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10490](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10494](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10494) +Defined in: [gen/types.gen.ts:10475](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10475) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10498](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10498) +Defined in: [gen/types.gen.ts:10479](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10479) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10502](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10502) +Defined in: [gen/types.gen.ts:10483](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10483) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10506](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10506) +Defined in: [gen/types.gen.ts:10487](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10487) The element instance with the given key was not found. @@ -69,6 +69,6 @@ The element instance with the given key was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10510](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10510) +Defined in: [gen/types.gen.ts:10491](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10491) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsResponse.md index bf08393a92c..f7d70a5d85f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsResponse.md @@ -12,4 +12,4 @@ type SearchElementInstanceIncidentsResponse = SearchElementInstanceIncidentsResponses[keyof SearchElementInstanceIncidentsResponses]; ``` -Defined in: [gen/types.gen.ts:10568](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10568) +Defined in: [gen/types.gen.ts:10503](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10503) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsResponses.md index 449e223d822..3386e2f2508 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstanceIncidentsResponses.md @@ -11,26 +11,16 @@ mdx: type SearchElementInstanceIncidentsResponses = object; ``` -Defined in: [gen/types.gen.ts:10515](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10515) +Defined in: [gen/types.gen.ts:10496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10496) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: IncidentSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:10519](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10519) +Defined in: [gen/types.gen.ts:10500](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10500) The element instance incident search result. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching incidents. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesData.md index 2242c1d2a16..9a2c0357d1c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesData.md @@ -11,7 +11,7 @@ mdx: type SearchElementInstancesData = object; ``` -Defined in: [gen/types.gen.ts:10280](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10280) +Defined in: [gen/types.gen.ts:10374](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10374) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10280](https://github.com/camunda/orchestration-cl optional body: ElementInstanceSearchQuery; ``` -Defined in: [gen/types.gen.ts:10281](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10281) +Defined in: [gen/types.gen.ts:10375](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10375) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10281](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:10282](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10282) +Defined in: [gen/types.gen.ts:10376](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10376) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:10282](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:10283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10283) +Defined in: [gen/types.gen.ts:10377](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10377) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:10283](https://github.com/camunda/orchestration-cl url: "/element-instances/search"; ``` -Defined in: [gen/types.gen.ts:10284](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10284) +Defined in: [gen/types.gen.ts:10378](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10378) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesError.md index 9a637575fb1..9de12322456 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesError.md @@ -12,4 +12,4 @@ type SearchElementInstancesError = SearchElementInstancesErrors[keyof SearchElementInstancesErrors]; ``` -Defined in: [gen/types.gen.ts:10306](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10306) +Defined in: [gen/types.gen.ts:10400](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10400) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesErrors.md index 9019407ee7c..2d301e72153 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesErrors.md @@ -11,7 +11,7 @@ mdx: type SearchElementInstancesErrors = object; ``` -Defined in: [gen/types.gen.ts:10287](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10287) +Defined in: [gen/types.gen.ts:10381](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10381) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10287](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10291](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10291) +Defined in: [gen/types.gen.ts:10385](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10385) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10295](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10295) +Defined in: [gen/types.gen.ts:10389](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10389) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10299](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10299) +Defined in: [gen/types.gen.ts:10393](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10393) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10303](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10303) +Defined in: [gen/types.gen.ts:10397](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10397) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesResponse.md index 959be718624..1cf24ff7fe2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesResponse.md @@ -12,4 +12,4 @@ type SearchElementInstancesResponse = SearchElementInstancesResponses[keyof SearchElementInstancesResponses]; ``` -Defined in: [gen/types.gen.ts:10374](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10374) +Defined in: [gen/types.gen.ts:10409](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10409) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesResponses.md index 6369067092a..098ae5d2dbb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchElementInstancesResponses.md @@ -11,26 +11,16 @@ mdx: type SearchElementInstancesResponses = object; ``` -Defined in: [gen/types.gen.ts:10308](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10308) +Defined in: [gen/types.gen.ts:10402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10402) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: ElementInstanceSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:10312](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10312) +Defined in: [gen/types.gen.ts:10406](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10406) The element instance search result. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching element instances. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersData.md new file mode 100644 index 00000000000..750db8c6b2e --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersData.md @@ -0,0 +1,54 @@ +--- +title: "Type Alias: SearchGlobalTaskListenersData" +sidebar_label: "SearchGlobalTaskListenersData" +mdx: + format: md +--- + +# Type Alias: SearchGlobalTaskListenersData + +```ts +type SearchGlobalTaskListenersData = object; +``` + +Defined in: [gen/types.gen.ts:10780](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10780) + +## Properties + +### body? + +```ts +optional body: GlobalTaskListenerSearchQueryRequest; +``` + +Defined in: [gen/types.gen.ts:10781](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10781) + +--- + +### path? + +```ts +optional path: never; +``` + +Defined in: [gen/types.gen.ts:10782](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10782) + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:10783](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10783) + +--- + +### url + +```ts +url: "/global-task-listeners/search"; +``` + +Defined in: [gen/types.gen.ts:10784](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10784) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersError.md new file mode 100644 index 00000000000..ef1af98240e --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: SearchGlobalTaskListenersError" +sidebar_label: "SearchGlobalTaskListenersError" +mdx: + format: md +--- + +# Type Alias: SearchGlobalTaskListenersError + +```ts +type SearchGlobalTaskListenersError = + SearchGlobalTaskListenersErrors[keyof SearchGlobalTaskListenersErrors]; +``` + +Defined in: [gen/types.gen.ts:10806](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10806) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersErrors.md new file mode 100644 index 00000000000..b526806e6ac --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersErrors.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: SearchGlobalTaskListenersErrors" +sidebar_label: "SearchGlobalTaskListenersErrors" +mdx: + format: md +--- + +# Type Alias: SearchGlobalTaskListenersErrors + +```ts +type SearchGlobalTaskListenersErrors = object; +``` + +Defined in: [gen/types.gen.ts:10787](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10787) + +## Properties + +### 400 + +```ts +400: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10791](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10791) + +The provided data is not valid. + +--- + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10795](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10795) + +The request lacks valid authentication credentials. + +--- + +### 403 + +```ts +403: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10799](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10799) + +Forbidden. The request is not allowed. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10803](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10803) + +An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersResponse.md new file mode 100644 index 00000000000..6c8887e2189 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: SearchGlobalTaskListenersResponse" +sidebar_label: "SearchGlobalTaskListenersResponse" +mdx: + format: md +--- + +# Type Alias: SearchGlobalTaskListenersResponse + +```ts +type SearchGlobalTaskListenersResponse = + SearchGlobalTaskListenersResponses[keyof SearchGlobalTaskListenersResponses]; +``` + +Defined in: [gen/types.gen.ts:10815](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10815) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersResponses.md new file mode 100644 index 00000000000..e3d2d3f72ed --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGlobalTaskListenersResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: SearchGlobalTaskListenersResponses" +sidebar_label: "SearchGlobalTaskListenersResponses" +mdx: + format: md +--- + +# Type Alias: SearchGlobalTaskListenersResponses + +```ts +type SearchGlobalTaskListenersResponses = object; +``` + +Defined in: [gen/types.gen.ts:10808](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10808) + +## Properties + +### 200 + +```ts +200: GlobalTaskListenerSearchQueryResult; +``` + +Defined in: [gen/types.gen.ts:10812](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10812) + +The global user task listener search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantData.md index 5cae05adeec..5bf74bb4a49 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantData.md @@ -11,27 +11,17 @@ mdx: type SearchGroupIdsForTenantData = object; ``` -Defined in: [gen/types.gen.ts:15905](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15905) +Defined in: [gen/types.gen.ts:15219](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15219) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: TenantGroupSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:15906](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15906) - -#### Type Declaration - -##### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:15220](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15220) --- @@ -41,7 +31,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:15918](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15918) +Defined in: [gen/types.gen.ts:15221](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15221) #### tenantId @@ -59,7 +49,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:15924](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15924) +Defined in: [gen/types.gen.ts:15227](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15227) --- @@ -69,4 +59,4 @@ Defined in: [gen/types.gen.ts:15924](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/groups/search"; ``` -Defined in: [gen/types.gen.ts:15925](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15925) +Defined in: [gen/types.gen.ts:15228](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15228) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantResponse.md index 49792a57324..ae68e62c80d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantResponse.md @@ -12,4 +12,4 @@ type SearchGroupIdsForTenantResponse = SearchGroupIdsForTenantResponses[keyof SearchGroupIdsForTenantResponses]; ``` -Defined in: [gen/types.gen.ts:15935](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15935) +Defined in: [gen/types.gen.ts:15238](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15238) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantResponses.md index c425d7779d1..17e266b83c7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupIdsForTenantResponses.md @@ -11,7 +11,7 @@ mdx: type SearchGroupIdsForTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:15928](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15928) +Defined in: [gen/types.gen.ts:15231](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15231) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15928](https://github.com/camunda/orchestration-cl 200: TenantGroupSearchResult; ``` -Defined in: [gen/types.gen.ts:15932](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15932) +Defined in: [gen/types.gen.ts:15235](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15235) The search result of groups for the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsData.md index ee10dff5958..ed0566e043b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsData.md @@ -11,7 +11,7 @@ mdx: type SearchGroupsData = object; ``` -Defined in: [gen/types.gen.ts:10691](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10691) +Defined in: [gen/types.gen.ts:10859](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10859) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10691](https://github.com/camunda/orchestration-cl optional body: GroupSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:10692](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10692) +Defined in: [gen/types.gen.ts:10860](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10860) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10692](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:10693](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10693) +Defined in: [gen/types.gen.ts:10861](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10861) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:10693](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:10694](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10694) +Defined in: [gen/types.gen.ts:10862](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10862) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:10694](https://github.com/camunda/orchestration-cl url: "/groups/search"; ``` -Defined in: [gen/types.gen.ts:10695](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10695) +Defined in: [gen/types.gen.ts:10863](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10863) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsError.md index f7b0d396093..bf5a124044a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsError.md @@ -11,4 +11,4 @@ mdx: type SearchGroupsError = SearchGroupsErrors[keyof SearchGroupsErrors]; ``` -Defined in: [gen/types.gen.ts:10717](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10717) +Defined in: [gen/types.gen.ts:10885](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10885) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsErrors.md index 6da1cdad52e..5970e7f1cbb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchGroupsErrors = object; ``` -Defined in: [gen/types.gen.ts:10698](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10698) +Defined in: [gen/types.gen.ts:10866](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10866) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10698](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10702](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10702) +Defined in: [gen/types.gen.ts:10870](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10870) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10706](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10706) +Defined in: [gen/types.gen.ts:10874](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10874) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10710](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10710) +Defined in: [gen/types.gen.ts:10878](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10878) Forbidden. The request is not allowed. @@ -54,9 +54,9 @@ Forbidden. The request is not allowed. ### 500 ```ts -500: unknown; +500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10714](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10714) +Defined in: [gen/types.gen.ts:10882](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10882) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleData.md index 71d03d623f9..9f80d5c9713 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleData.md @@ -11,27 +11,17 @@ mdx: type SearchGroupsForRoleData = object; ``` -Defined in: [gen/types.gen.ts:14895](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14895) +Defined in: [gen/types.gen.ts:14187](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14187) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: RoleGroupSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:14896](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14896) - -#### Type Declaration - -##### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:14188](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14188) --- @@ -41,7 +31,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:14908](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14908) +Defined in: [gen/types.gen.ts:14189](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14189) #### roleId @@ -59,7 +49,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:14914](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14914) +Defined in: [gen/types.gen.ts:14195](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14195) --- @@ -69,4 +59,4 @@ Defined in: [gen/types.gen.ts:14914](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/groups/search"; ``` -Defined in: [gen/types.gen.ts:14915](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14915) +Defined in: [gen/types.gen.ts:14196](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14196) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleError.md index c59850b315b..37a2892a7ed 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleError.md @@ -12,4 +12,4 @@ type SearchGroupsForRoleError = SearchGroupsForRoleErrors[keyof SearchGroupsForRoleErrors]; ``` -Defined in: [gen/types.gen.ts:14941](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14941) +Defined in: [gen/types.gen.ts:14222](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14222) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleErrors.md index 43f8a460b75..e07ef34ee16 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleErrors.md @@ -11,7 +11,7 @@ mdx: type SearchGroupsForRoleErrors = object; ``` -Defined in: [gen/types.gen.ts:14918](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14918) +Defined in: [gen/types.gen.ts:14199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14199) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14918](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14922](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14922) +Defined in: [gen/types.gen.ts:14203](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14203) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14926](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14926) +Defined in: [gen/types.gen.ts:14207](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14207) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14930](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14930) +Defined in: [gen/types.gen.ts:14211](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14211) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14934](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14934) +Defined in: [gen/types.gen.ts:14215](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14215) The role with the given ID was not found. @@ -69,6 +69,6 @@ The role with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14938](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14938) +Defined in: [gen/types.gen.ts:14219](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14219) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleResponse.md index b42305412fa..177d85aff00 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleResponse.md @@ -12,4 +12,4 @@ type SearchGroupsForRoleResponse = SearchGroupsForRoleResponses[keyof SearchGroupsForRoleResponses]; ``` -Defined in: [gen/types.gen.ts:14950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14950) +Defined in: [gen/types.gen.ts:14231](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14231) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleResponses.md index 2dda188910b..5e925866ffe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsForRoleResponses.md @@ -11,7 +11,7 @@ mdx: type SearchGroupsForRoleResponses = object; ``` -Defined in: [gen/types.gen.ts:14943](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14943) +Defined in: [gen/types.gen.ts:14224](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14224) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14943](https://github.com/camunda/orchestration-cl 200: RoleGroupSearchResult; ``` -Defined in: [gen/types.gen.ts:14947](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14947) +Defined in: [gen/types.gen.ts:14228](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14228) The groups with assigned role. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsResponse.md index bafa32afad9..293a810949a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsResponse.md @@ -11,4 +11,4 @@ mdx: type SearchGroupsResponse = SearchGroupsResponses[keyof SearchGroupsResponses]; ``` -Defined in: [gen/types.gen.ts:10726](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10726) +Defined in: [gen/types.gen.ts:10894](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10894) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsResponses.md index 31068f208c6..2ae2bf1d2cb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchGroupsResponses.md @@ -11,7 +11,7 @@ mdx: type SearchGroupsResponses = object; ``` -Defined in: [gen/types.gen.ts:10719](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10719) +Defined in: [gen/types.gen.ts:10887](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10887) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10719](https://github.com/camunda/orchestration-cl 200: GroupSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:10723](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10723) +Defined in: [gen/types.gen.ts:10891](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10891) The groups search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsData.md index 1c62f607a62..2376e5e9875 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsData.md @@ -11,7 +11,7 @@ mdx: type SearchIncidentsData = object; ``` -Defined in: [gen/types.gen.ts:11372](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11372) +Defined in: [gen/types.gen.ts:11579](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11579) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11372](https://github.com/camunda/orchestration-cl optional body: IncidentSearchQuery; ``` -Defined in: [gen/types.gen.ts:11373](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11373) +Defined in: [gen/types.gen.ts:11580](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11580) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11373](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:11374](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11374) +Defined in: [gen/types.gen.ts:11581](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11581) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:11374](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:11375](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11375) +Defined in: [gen/types.gen.ts:11582](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11582) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:11375](https://github.com/camunda/orchestration-cl url: "/incidents/search"; ``` -Defined in: [gen/types.gen.ts:11376](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11376) +Defined in: [gen/types.gen.ts:11583](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11583) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsError.md index 148ed247cf9..ade73c9861b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsError.md @@ -11,4 +11,4 @@ mdx: type SearchIncidentsError = SearchIncidentsErrors[keyof SearchIncidentsErrors]; ``` -Defined in: [gen/types.gen.ts:11398](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11398) +Defined in: [gen/types.gen.ts:11605](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11605) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsErrors.md index cc25a36a25b..dc267335dcc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchIncidentsErrors = object; ``` -Defined in: [gen/types.gen.ts:11379](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11379) +Defined in: [gen/types.gen.ts:11586](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11586) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11379](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11383](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11383) +Defined in: [gen/types.gen.ts:11590](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11590) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11387](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11387) +Defined in: [gen/types.gen.ts:11594](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11594) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11391](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11391) +Defined in: [gen/types.gen.ts:11598](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11598) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11395](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11395) +Defined in: [gen/types.gen.ts:11602](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11602) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsResponse.md index b8aeae6c115..1e49b0f1522 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsResponse.md @@ -12,4 +12,4 @@ type SearchIncidentsResponse = SearchIncidentsResponses[keyof SearchIncidentsResponses]; ``` -Defined in: [gen/types.gen.ts:11453](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11453) +Defined in: [gen/types.gen.ts:11614](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11614) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsResponses.md index ab21f099197..79bfc70b22c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchIncidentsResponses.md @@ -11,26 +11,16 @@ mdx: type SearchIncidentsResponses = object; ``` -Defined in: [gen/types.gen.ts:11400](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11400) +Defined in: [gen/types.gen.ts:11607](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11607) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: IncidentSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:11404](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11404) +Defined in: [gen/types.gen.ts:11611](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11611) The incident search result. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching incidents. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsData.md index 990b3a35bca..bde5a9f17a0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsData.md @@ -11,7 +11,7 @@ mdx: type SearchJobsData = object; ``` -Defined in: [gen/types.gen.ts:11812](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11812) +Defined in: [gen/types.gen.ts:11827](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11827) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11812](https://github.com/camunda/orchestration-cl optional body: JobSearchQuery; ``` -Defined in: [gen/types.gen.ts:11813](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11813) +Defined in: [gen/types.gen.ts:11828](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11828) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11813](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:11814](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11814) +Defined in: [gen/types.gen.ts:11829](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11829) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:11814](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:11815](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11815) +Defined in: [gen/types.gen.ts:11830](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11830) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:11815](https://github.com/camunda/orchestration-cl url: "/jobs/search"; ``` -Defined in: [gen/types.gen.ts:11816](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11816) +Defined in: [gen/types.gen.ts:11831](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11831) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsError.md index e19716219bc..4606919fa0e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsError.md @@ -11,4 +11,4 @@ mdx: type SearchJobsError = SearchJobsErrors[keyof SearchJobsErrors]; ``` -Defined in: [gen/types.gen.ts:11838](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11838) +Defined in: [gen/types.gen.ts:11853](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11853) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsErrors.md index 25383685e02..7826eb758da 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchJobsErrors = object; ``` -Defined in: [gen/types.gen.ts:11819](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11819) +Defined in: [gen/types.gen.ts:11834](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11834) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11819](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11823](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11823) +Defined in: [gen/types.gen.ts:11838](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11838) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11827](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11827) +Defined in: [gen/types.gen.ts:11842](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11842) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11831](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11831) +Defined in: [gen/types.gen.ts:11846](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11846) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11835](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11835) +Defined in: [gen/types.gen.ts:11850](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11850) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsResponse.md index 15f4316e508..c19a00aa29c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsResponse.md @@ -11,4 +11,4 @@ mdx: type SearchJobsResponse = SearchJobsResponses[keyof SearchJobsResponses]; ``` -Defined in: [gen/types.gen.ts:11936](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11936) +Defined in: [gen/types.gen.ts:11862](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11862) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsResponses.md index 891c102c99f..dd0eb7c3df3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchJobsResponses.md @@ -11,26 +11,16 @@ mdx: type SearchJobsResponses = object; ``` -Defined in: [gen/types.gen.ts:11840](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11840) +Defined in: [gen/types.gen.ts:11855](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11855) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: JobSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:11844](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11844) +Defined in: [gen/types.gen.ts:11859](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11859) -Job search response. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching jobs. +The job search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleData.md index 183512f5730..4af1e2c057a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleData.md @@ -11,7 +11,7 @@ mdx: type SearchMappingRuleData = object; ``` -Defined in: [gen/types.gen.ts:12248](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12248) +Defined in: [gen/types.gen.ts:12322](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12322) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12248](https://github.com/camunda/orchestration-cl optional body: MappingRuleSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:12249](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12249) +Defined in: [gen/types.gen.ts:12323](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12323) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12249](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:12250](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12250) +Defined in: [gen/types.gen.ts:12324](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12324) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:12250](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:12251](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12251) +Defined in: [gen/types.gen.ts:12325](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12325) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:12251](https://github.com/camunda/orchestration-cl url: "/mapping-rules/search"; ``` -Defined in: [gen/types.gen.ts:12252](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12252) +Defined in: [gen/types.gen.ts:12326](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12326) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleError.md index 8ea694e97a0..1fb45ad7470 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleError.md @@ -12,4 +12,4 @@ type SearchMappingRuleError = SearchMappingRuleErrors[keyof SearchMappingRuleErrors]; ``` -Defined in: [gen/types.gen.ts:12274](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12274) +Defined in: [gen/types.gen.ts:12348](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12348) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleErrors.md index 0c324a87523..5cb158e3a73 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleErrors.md @@ -11,7 +11,7 @@ mdx: type SearchMappingRuleErrors = object; ``` -Defined in: [gen/types.gen.ts:12255](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12255) +Defined in: [gen/types.gen.ts:12329](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12329) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12255](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12259](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12259) +Defined in: [gen/types.gen.ts:12333](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12333) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12263](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12263) +Defined in: [gen/types.gen.ts:12337](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12337) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12267](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12267) +Defined in: [gen/types.gen.ts:12341](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12341) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12271](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12271) +Defined in: [gen/types.gen.ts:12345](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12345) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleResponse.md index c793ba49a82..c78c93dd5fe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleResponse.md @@ -12,4 +12,4 @@ type SearchMappingRuleResponse = SearchMappingRuleResponses[keyof SearchMappingRuleResponses]; ``` -Defined in: [gen/types.gen.ts:12283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12283) +Defined in: [gen/types.gen.ts:12362](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12362) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleResponses.md index e9d9394fc4e..1aada9a6c9b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRuleResponses.md @@ -11,16 +11,26 @@ mdx: type SearchMappingRuleResponses = object; ``` -Defined in: [gen/types.gen.ts:12276](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12276) +Defined in: [gen/types.gen.ts:12350](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12350) ## Properties ### 200 ```ts -200: MappingRuleSearchQueryResult; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:12280](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12280) +Defined in: [gen/types.gen.ts:12354](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12354) The mapping rule search result. + +#### Type Declaration + +##### items + +```ts +items: MappingRuleResult[]; +``` + +The matching mapping rules. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupData.md index 6617842fb4b..df710fbeb2c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupData.md @@ -11,7 +11,7 @@ mdx: type SearchMappingRulesForGroupData = object; ``` -Defined in: [gen/types.gen.ts:11017](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11017) +Defined in: [gen/types.gen.ts:11201](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11201) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11017](https://github.com/camunda/orchestration-cl optional body: MappingRuleSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:11018](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11018) +Defined in: [gen/types.gen.ts:11202](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11202) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11018](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11019](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11019) +Defined in: [gen/types.gen.ts:11203](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11203) #### groupId @@ -49,7 +49,7 @@ The group ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:11025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11025) +Defined in: [gen/types.gen.ts:11209](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11209) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:11025](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/mapping-rules/search"; ``` -Defined in: [gen/types.gen.ts:11026](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11026) +Defined in: [gen/types.gen.ts:11210](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11210) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupError.md index 8b15c25d2de..bee39a1a073 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupError.md @@ -12,4 +12,4 @@ type SearchMappingRulesForGroupError = SearchMappingRulesForGroupErrors[keyof SearchMappingRulesForGroupErrors]; ``` -Defined in: [gen/types.gen.ts:11052](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11052) +Defined in: [gen/types.gen.ts:11236](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11236) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupErrors.md index f093a584449..3f79afc96a0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupErrors.md @@ -11,7 +11,7 @@ mdx: type SearchMappingRulesForGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:11029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11029) +Defined in: [gen/types.gen.ts:11213](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11213) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11029](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11033](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11033) +Defined in: [gen/types.gen.ts:11217](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11217) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11037](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11037) +Defined in: [gen/types.gen.ts:11221](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11221) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11041](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11041) +Defined in: [gen/types.gen.ts:11225](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11225) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11045](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11045) +Defined in: [gen/types.gen.ts:11229](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11229) The group with the given ID was not found. @@ -69,6 +69,6 @@ The group with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11049](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11049) +Defined in: [gen/types.gen.ts:11233](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11233) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupResponse.md index cd57cd53320..2028dc73f6b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupResponse.md @@ -12,4 +12,4 @@ type SearchMappingRulesForGroupResponse = SearchMappingRulesForGroupResponses[keyof SearchMappingRulesForGroupResponses]; ``` -Defined in: [gen/types.gen.ts:11061](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11061) +Defined in: [gen/types.gen.ts:11250](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11250) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupResponses.md index 6df5401d4cf..7054c9fcf69 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForGroupResponses.md @@ -11,16 +11,26 @@ mdx: type SearchMappingRulesForGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:11054](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11054) +Defined in: [gen/types.gen.ts:11238](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11238) ## Properties ### 200 ```ts -200: SearchQueryResponse; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:11058](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11058) +Defined in: [gen/types.gen.ts:11242](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11242) The mapping rules assigned to the group. + +#### Type Declaration + +##### items + +```ts +items: MappingRuleResult[]; +``` + +The matching mapping rules. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleData.md index 779ba801a92..b4ae634ad44 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleData.md @@ -11,7 +11,7 @@ mdx: type SearchMappingRulesForRoleData = object; ``` -Defined in: [gen/types.gen.ts:15058](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15058) +Defined in: [gen/types.gen.ts:14339](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14339) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15058](https://github.com/camunda/orchestration-cl optional body: MappingRuleSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:15059](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15059) +Defined in: [gen/types.gen.ts:14340](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14340) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15059](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15060](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15060) +Defined in: [gen/types.gen.ts:14341](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14341) #### roleId @@ -49,7 +49,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:15066](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15066) +Defined in: [gen/types.gen.ts:14347](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14347) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:15066](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/mapping-rules/search"; ``` -Defined in: [gen/types.gen.ts:15067](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15067) +Defined in: [gen/types.gen.ts:14348](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14348) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleError.md index 533af259251..d32595697e9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleError.md @@ -12,4 +12,4 @@ type SearchMappingRulesForRoleError = SearchMappingRulesForRoleErrors[keyof SearchMappingRulesForRoleErrors]; ``` -Defined in: [gen/types.gen.ts:15093](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15093) +Defined in: [gen/types.gen.ts:14374](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14374) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleErrors.md index 49d8506b653..5dd754f4147 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleErrors.md @@ -11,7 +11,7 @@ mdx: type SearchMappingRulesForRoleErrors = object; ``` -Defined in: [gen/types.gen.ts:15070](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15070) +Defined in: [gen/types.gen.ts:14351](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14351) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15070](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15074](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15074) +Defined in: [gen/types.gen.ts:14355](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14355) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15078](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15078) +Defined in: [gen/types.gen.ts:14359](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14359) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15082](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15082) +Defined in: [gen/types.gen.ts:14363](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14363) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15086](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15086) +Defined in: [gen/types.gen.ts:14367](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14367) The role with the given ID was not found. @@ -69,6 +69,6 @@ The role with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15090](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15090) +Defined in: [gen/types.gen.ts:14371](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14371) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleResponse.md index e103393f780..353580b99b0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleResponse.md @@ -12,4 +12,4 @@ type SearchMappingRulesForRoleResponse = SearchMappingRulesForRoleResponses[keyof SearchMappingRulesForRoleResponses]; ``` -Defined in: [gen/types.gen.ts:15102](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15102) +Defined in: [gen/types.gen.ts:14388](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14388) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleResponses.md index 471073e7740..d7d108be244 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForRoleResponses.md @@ -11,16 +11,26 @@ mdx: type SearchMappingRulesForRoleResponses = object; ``` -Defined in: [gen/types.gen.ts:15095](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15095) +Defined in: [gen/types.gen.ts:14376](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14376) ## Properties ### 200 ```ts -200: SearchQueryResponse; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:15099](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15099) +Defined in: [gen/types.gen.ts:14380](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14380) The mapping rules with assigned role. + +#### Type Declaration + +##### items + +```ts +items: MappingRuleResult[]; +``` + +The matching mapping rules. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantData.md index f7349220ffe..0ced1905bd6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantData.md @@ -11,7 +11,7 @@ mdx: type SearchMappingRulesForTenantData = object; ``` -Defined in: [gen/types.gen.ts:16039](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16039) +Defined in: [gen/types.gen.ts:15342](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15342) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16039](https://github.com/camunda/orchestration-cl optional body: MappingRuleSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:16040](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16040) +Defined in: [gen/types.gen.ts:15343](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15343) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16040](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16041](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16041) +Defined in: [gen/types.gen.ts:15344](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15344) #### tenantId @@ -49,7 +49,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:16047](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16047) +Defined in: [gen/types.gen.ts:15350](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15350) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:16047](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/mapping-rules/search"; ``` -Defined in: [gen/types.gen.ts:16048](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16048) +Defined in: [gen/types.gen.ts:15351](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15351) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantResponse.md index d0a05e54101..6d4753a3ae2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantResponse.md @@ -12,4 +12,4 @@ type SearchMappingRulesForTenantResponse = SearchMappingRulesForTenantResponses[keyof SearchMappingRulesForTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16058](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16058) +Defined in: [gen/types.gen.ts:15366](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15366) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantResponses.md index 86dfc42810f..e093d5e34f1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMappingRulesForTenantResponses.md @@ -11,16 +11,26 @@ mdx: type SearchMappingRulesForTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16051](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16051) +Defined in: [gen/types.gen.ts:15354](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15354) ## Properties ### 200 ```ts -200: SearchQueryResponse; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:16055](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16055) +Defined in: [gen/types.gen.ts:15358](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15358) The search result of MappingRules for the tenant. + +#### Type Declaration + +##### items + +```ts +items: MappingRuleResult[]; +``` + +The matching mapping rules. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsData.md index 6332c5d8235..7d5795f0d08 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsData.md @@ -11,123 +11,17 @@ mdx: type SearchMessageSubscriptionsData = object; ``` -Defined in: [gen/types.gen.ts:12415](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12415) +Defined in: [gen/types.gen.ts:12494](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12494) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: MessageSubscriptionSearchQuery; ``` -Defined in: [gen/types.gen.ts:12416](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12416) - -#### Type Declaration - -##### filter? - -```ts -optional filter: object; -``` - -Message subscription search filter. - -###### filter.correlationKey? - -```ts -optional correlationKey: StringFilterProperty; -``` - -The correlation key of the message subscription. - -###### filter.elementId? - -```ts -optional elementId: StringFilterProperty; -``` - -The element ID associated with this message subscription. - -###### filter.elementInstanceKey? - -```ts -optional elementInstanceKey: ElementInstanceKeyFilterProperty; -``` - -The element instance key associated with this message subscription. - -###### filter.lastUpdatedDate? - -```ts -optional lastUpdatedDate: DateTimeFilterProperty; -``` - -The last updated date of the message subscription. - -###### filter.messageName? - -```ts -optional messageName: StringFilterProperty; -``` - -The name of the message associated with the message subscription. - -###### filter.messageSubscriptionKey? - -```ts -optional messageSubscriptionKey: MessageSubscriptionKeyFilterProperty; -``` - -The message subscription key associated with this message subscription. - -###### filter.messageSubscriptionState? - -```ts -optional messageSubscriptionState: MessageSubscriptionStateFilterProperty; -``` - -The message subscription state. - -###### filter.processDefinitionId? - -```ts -optional processDefinitionId: StringFilterProperty; -``` - -The process definition ID associated with this message subscription. - -###### filter.processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKeyFilterProperty; -``` - -The process definition key associated with this correlated message subscription. This only works for data created with 8.9 and later. - -###### filter.processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKeyFilterProperty; -``` - -The process instance key associated with this message subscription. - -###### filter.tenantId? - -```ts -optional tenantId: StringFilterProperty; -``` - -The unique external tenant ID. - -##### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:12495](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12495) --- @@ -137,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:12477](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12477) +Defined in: [gen/types.gen.ts:12496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12496) --- @@ -147,7 +41,7 @@ Defined in: [gen/types.gen.ts:12477](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:12478](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12478) +Defined in: [gen/types.gen.ts:12497](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12497) --- @@ -157,4 +51,4 @@ Defined in: [gen/types.gen.ts:12478](https://github.com/camunda/orchestration-cl url: "/message-subscriptions/search"; ``` -Defined in: [gen/types.gen.ts:12479](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12479) +Defined in: [gen/types.gen.ts:12498](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12498) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsError.md index 1c6bc4da713..3042e4a30ca 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsError.md @@ -12,4 +12,4 @@ type SearchMessageSubscriptionsError = SearchMessageSubscriptionsErrors[keyof SearchMessageSubscriptionsErrors]; ``` -Defined in: [gen/types.gen.ts:12501](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12501) +Defined in: [gen/types.gen.ts:12520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12520) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsErrors.md index dcfe8d99029..d2b516d0526 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchMessageSubscriptionsErrors = object; ``` -Defined in: [gen/types.gen.ts:12482](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12482) +Defined in: [gen/types.gen.ts:12501](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12501) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12482](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12486](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12486) +Defined in: [gen/types.gen.ts:12505](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12505) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12490](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12490) +Defined in: [gen/types.gen.ts:12509](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12509) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12494](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12494) +Defined in: [gen/types.gen.ts:12513](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12513) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12498](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12498) +Defined in: [gen/types.gen.ts:12517](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12517) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsResponse.md index 9bfa63b62ab..dc6bb3d9848 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsResponse.md @@ -12,4 +12,4 @@ type SearchMessageSubscriptionsResponse = SearchMessageSubscriptionsResponses[keyof SearchMessageSubscriptionsResponses]; ``` -Defined in: [gen/types.gen.ts:12555](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12555) +Defined in: [gen/types.gen.ts:12529](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12529) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsResponses.md index 5081f4f8d05..b2a28f4285c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchMessageSubscriptionsResponses.md @@ -11,26 +11,16 @@ mdx: type SearchMessageSubscriptionsResponses = object; ``` -Defined in: [gen/types.gen.ts:12503](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12503) +Defined in: [gen/types.gen.ts:12522](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12522) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: MessageSubscriptionSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:12507](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12507) +Defined in: [gen/types.gen.ts:12526](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12526) The message subscription search result. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching message subscriptions. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsData.md index 41dff8fec52..39ce0f818a8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsData.md @@ -11,35 +11,17 @@ mdx: type SearchProcessDefinitionsData = object; ``` -Defined in: [gen/types.gen.ts:12642](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12642) +Defined in: [gen/types.gen.ts:12607](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12607) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: ProcessDefinitionSearchQuery; ``` -Defined in: [gen/types.gen.ts:12643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12643) - -#### Type Declaration - -##### filter? - -```ts -optional filter: ProcessDefinitionFilter; -``` - -The process definition search filters. - -##### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:12608](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12608) --- @@ -49,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:12659](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12659) +Defined in: [gen/types.gen.ts:12609](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12609) --- @@ -59,7 +41,7 @@ Defined in: [gen/types.gen.ts:12659](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:12660](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12660) +Defined in: [gen/types.gen.ts:12610](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12610) --- @@ -69,4 +51,4 @@ Defined in: [gen/types.gen.ts:12660](https://github.com/camunda/orchestration-cl url: "/process-definitions/search"; ``` -Defined in: [gen/types.gen.ts:12661](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12661) +Defined in: [gen/types.gen.ts:12611](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12611) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsError.md index c1b3a28fb6b..2ddb1eafaa9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsError.md @@ -12,4 +12,4 @@ type SearchProcessDefinitionsError = SearchProcessDefinitionsErrors[keyof SearchProcessDefinitionsErrors]; ``` -Defined in: [gen/types.gen.ts:12683](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12683) +Defined in: [gen/types.gen.ts:12633](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12633) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsErrors.md index 14ab5e17aa8..b45a3479909 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchProcessDefinitionsErrors = object; ``` -Defined in: [gen/types.gen.ts:12664](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12664) +Defined in: [gen/types.gen.ts:12614](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12614) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12664](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12668](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12668) +Defined in: [gen/types.gen.ts:12618](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12618) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12672](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12672) +Defined in: [gen/types.gen.ts:12622](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12622) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12676](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12676) +Defined in: [gen/types.gen.ts:12626](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12626) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12680](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12680) +Defined in: [gen/types.gen.ts:12630](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12630) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsResponse.md index 02885c90c36..568222d4dcc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsResponse.md @@ -12,4 +12,4 @@ type SearchProcessDefinitionsResponse = SearchProcessDefinitionsResponses[keyof SearchProcessDefinitionsResponses]; ``` -Defined in: [gen/types.gen.ts:12692](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12692) +Defined in: [gen/types.gen.ts:12642](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12642) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsResponses.md index 4f9ae4b85cb..50a0ac78f6e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessDefinitionsResponses.md @@ -11,7 +11,7 @@ mdx: type SearchProcessDefinitionsResponses = object; ``` -Defined in: [gen/types.gen.ts:12685](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12685) +Defined in: [gen/types.gen.ts:12635](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12635) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12685](https://github.com/camunda/orchestration-cl 200: ProcessDefinitionSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:12689](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12689) +Defined in: [gen/types.gen.ts:12639](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12639) The process definition search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsData.md index 56a0bc7465d..704921d6391 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsData.md @@ -11,7 +11,7 @@ mdx: type SearchProcessInstanceIncidentsData = object; ``` -Defined in: [gen/types.gen.ts:14071](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14071) +Defined in: [gen/types.gen.ts:13468](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13468) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14071](https://github.com/camunda/orchestration-cl optional body: IncidentSearchQuery; ``` -Defined in: [gen/types.gen.ts:14072](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14072) +Defined in: [gen/types.gen.ts:13469](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13469) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14072](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14073](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14073) +Defined in: [gen/types.gen.ts:13470](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13470) #### processInstanceKey @@ -49,7 +49,7 @@ The assigned key of the process instance, which acts as a unique identifier for optional query: never; ``` -Defined in: [gen/types.gen.ts:14079](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14079) +Defined in: [gen/types.gen.ts:13476](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13476) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:14079](https://github.com/camunda/orchestration-cl url: "/process-instances/{processInstanceKey}/incidents/search"; ``` -Defined in: [gen/types.gen.ts:14080](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14080) +Defined in: [gen/types.gen.ts:13477](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13477) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsError.md index 5ed621a5d3d..bdf9e7f7913 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsError.md @@ -12,4 +12,4 @@ type SearchProcessInstanceIncidentsError = SearchProcessInstanceIncidentsErrors[keyof SearchProcessInstanceIncidentsErrors]; ``` -Defined in: [gen/types.gen.ts:14106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14106) +Defined in: [gen/types.gen.ts:13503](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13503) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsErrors.md index 518b253d3b4..5e883429c23 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchProcessInstanceIncidentsErrors = object; ``` -Defined in: [gen/types.gen.ts:14083](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14083) +Defined in: [gen/types.gen.ts:13480](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13480) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14083](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14087](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14087) +Defined in: [gen/types.gen.ts:13484](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13484) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14091](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14091) +Defined in: [gen/types.gen.ts:13488](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13488) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14095](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14095) +Defined in: [gen/types.gen.ts:13492](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13492) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14099](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14099) +Defined in: [gen/types.gen.ts:13496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13496) The process instance with the given key was not found. @@ -69,6 +69,6 @@ The process instance with the given key was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14103) +Defined in: [gen/types.gen.ts:13500](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13500) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsResponse.md index 108f74de5f1..c44501ae393 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsResponse.md @@ -12,4 +12,4 @@ type SearchProcessInstanceIncidentsResponse = SearchProcessInstanceIncidentsResponses[keyof SearchProcessInstanceIncidentsResponses]; ``` -Defined in: [gen/types.gen.ts:14161](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14161) +Defined in: [gen/types.gen.ts:13512](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13512) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsResponses.md index b0b9fbdd90e..54b798c4197 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstanceIncidentsResponses.md @@ -11,26 +11,16 @@ mdx: type SearchProcessInstanceIncidentsResponses = object; ``` -Defined in: [gen/types.gen.ts:14108](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14108) +Defined in: [gen/types.gen.ts:13505](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13505) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: IncidentSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:14112](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14112) +Defined in: [gen/types.gen.ts:13509](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13509) The process instance search result. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching incidents. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesData.md index aa3fb1337b9..c0afa8e995a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesData.md @@ -11,115 +11,17 @@ mdx: type SearchProcessInstancesData = object; ``` -Defined in: [gen/types.gen.ts:13623](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13623) +Defined in: [gen/types.gen.ts:13188](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13188) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: ProcessInstanceSearchQuery; ``` -Defined in: [gen/types.gen.ts:13627](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13627) - -Process instance search request. - -#### Type Declaration - -##### filter? - -```ts -optional filter: BaseProcessInstanceFilterFields & object & object; -``` - -Process instance search filter. - -###### Type Declaration - -###### processDefinitionId? - -```ts -optional processDefinitionId: StringFilterProperty; -``` - -The process definition id. - -###### processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKeyFilterProperty; -``` - -The process definition key. - -###### processDefinitionName? - -```ts -optional processDefinitionName: StringFilterProperty; -``` - -The process definition name. - -###### processDefinitionVersion? - -```ts -optional processDefinitionVersion: IntegerFilterProperty; -``` - -The process definition version. - -###### processDefinitionVersionTag? - -```ts -optional processDefinitionVersionTag: StringFilterProperty; -``` - -The process definition version tag. - -###### Type Declaration - -###### $or? - -```ts -optional $or: BaseProcessInstanceFilterFields & object[]; -``` - -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. - -##### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:13189](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13189) --- @@ -129,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:13720](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13720) +Defined in: [gen/types.gen.ts:13190](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13190) --- @@ -139,7 +41,7 @@ Defined in: [gen/types.gen.ts:13720](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:13721](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13721) +Defined in: [gen/types.gen.ts:13191](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13191) --- @@ -149,4 +51,4 @@ Defined in: [gen/types.gen.ts:13721](https://github.com/camunda/orchestration-cl url: "/process-instances/search"; ``` -Defined in: [gen/types.gen.ts:13722](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13722) +Defined in: [gen/types.gen.ts:13192](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13192) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesError.md index bba4cc06faa..989b0ee2464 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesError.md @@ -12,4 +12,4 @@ type SearchProcessInstancesError = SearchProcessInstancesErrors[keyof SearchProcessInstancesErrors]; ``` -Defined in: [gen/types.gen.ts:13744](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13744) +Defined in: [gen/types.gen.ts:13214](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13214) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesErrors.md index e44b6a9d43f..f6430276bd0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesErrors.md @@ -11,7 +11,7 @@ mdx: type SearchProcessInstancesErrors = object; ``` -Defined in: [gen/types.gen.ts:13725](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13725) +Defined in: [gen/types.gen.ts:13195](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13195) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:13725](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13729](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13729) +Defined in: [gen/types.gen.ts:13199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13199) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13733](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13733) +Defined in: [gen/types.gen.ts:13203](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13203) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13737](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13737) +Defined in: [gen/types.gen.ts:13207](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13207) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:13741](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13741) +Defined in: [gen/types.gen.ts:13211](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13211) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesResponse.md index a6e8b1686a0..9fef122941b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesResponse.md @@ -12,4 +12,4 @@ type SearchProcessInstancesResponse = SearchProcessInstancesResponses[keyof SearchProcessInstancesResponses]; ``` -Defined in: [gen/types.gen.ts:13795](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13795) +Defined in: [gen/types.gen.ts:13223](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13223) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesResponses.md index d47d03362f3..cc9316576b8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchProcessInstancesResponses.md @@ -11,26 +11,16 @@ mdx: type SearchProcessInstancesResponses = object; ``` -Defined in: [gen/types.gen.ts:13746](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13746) +Defined in: [gen/types.gen.ts:13216](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13216) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: ProcessInstanceSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:13750](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L13750) +Defined in: [gen/types.gen.ts:13220](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13220) -Process instance search response. - -#### Type Declaration - -##### items - -```ts -items: object[]; -``` - -The matching process instances. +The process instance search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryPageRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryPageRequest.md index 7f922f0065f..38fa025ad8c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryPageRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryPageRequest.md @@ -15,6 +15,6 @@ type SearchQueryPageRequest = | CursorBackwardPagination; ``` -Defined in: [gen/types.gen.ts:6404](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6404) +Defined in: [gen/types.gen.ts:7124](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7124) Pagination criteria. Can use offset-based pagination (from/limit) OR cursor-based pagination (after/before + limit), but not both. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryPageResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryPageResponse.md index b29cc7550e7..d1d6416b982 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryPageResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryPageResponse.md @@ -11,44 +11,43 @@ mdx: type SearchQueryPageResponse = object; ``` -Defined in: [gen/types.gen.ts:6470](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6470) +Defined in: [gen/types.gen.ts:7190](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7190) Pagination information about the search results. ## Properties -### endCursor? +### endCursor ```ts -optional endCursor: EndCursor; +endCursor: EndCursor | null; ``` -Defined in: [gen/types.gen.ts:6488](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6488) +Defined in: [gen/types.gen.ts:7207](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7207) The cursor value for getting the next page of results. Use this in the `after` field of an ensuing request. --- -### hasMoreTotalItems? +### hasMoreTotalItems ```ts -optional hasMoreTotalItems: boolean; +hasMoreTotalItems: boolean; ``` -Defined in: [gen/types.gen.ts:6480](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6480) +Defined in: [gen/types.gen.ts:7199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7199) -Indicates whether there are more items matching the criteria beyond the returned items. -This is useful for determining if additional requests are needed to retrieve all results. +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. --- -### startCursor? +### startCursor ```ts -optional startCursor: StartCursor; +startCursor: StartCursor | null; ``` -Defined in: [gen/types.gen.ts:6484](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6484) +Defined in: [gen/types.gen.ts:7203](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7203) The cursor value for getting the previous page of results. Use this in the `before` field of an ensuing request. @@ -60,6 +59,6 @@ The cursor value for getting the previous page of results. Use this in the `befo totalItems: number; ``` -Defined in: [gen/types.gen.ts:6474](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6474) +Defined in: [gen/types.gen.ts:7194](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7194) Total items matching the criteria. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryRequest.md index 70bef55c267..fe603fe7ffe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type SearchQueryRequest = object; ``` -Defined in: [gen/types.gen.ts:6394](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6394) +Defined in: [gen/types.gen.ts:7114](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7114) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:6394](https://github.com/camunda/orchestration-clu optional page: SearchQueryPageRequest; ``` -Defined in: [gen/types.gen.ts:6398](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6398) +Defined in: [gen/types.gen.ts:7118](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7118) Pagination criteria. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryResponse.md index 18aac7c14db..3ec05bfee09 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchQueryResponse.md @@ -11,7 +11,7 @@ mdx: type SearchQueryResponse = object; ``` -Defined in: [gen/types.gen.ts:6458](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6458) +Defined in: [gen/types.gen.ts:7178](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7178) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/types.gen.ts:6458](https://github.com/camunda/orchestration-clu page: SearchQueryPageResponse; ``` -Defined in: [gen/types.gen.ts:6459](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6459) +Defined in: [gen/types.gen.ts:7179](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7179) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesData.md index 42b7baf4be4..756b39e3e60 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesData.md @@ -11,7 +11,7 @@ mdx: type SearchRolesData = object; ``` -Defined in: [gen/types.gen.ts:14563](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14563) +Defined in: [gen/types.gen.ts:13845](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13845) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14563](https://github.com/camunda/orchestration-cl optional body: RoleSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:14564](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14564) +Defined in: [gen/types.gen.ts:13846](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13846) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14564](https://github.com/camunda/orchestration-cl optional path: never; ``` -Defined in: [gen/types.gen.ts:14565](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14565) +Defined in: [gen/types.gen.ts:13847](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13847) --- @@ -41,7 +41,7 @@ Defined in: [gen/types.gen.ts:14565](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:14566](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14566) +Defined in: [gen/types.gen.ts:13848](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13848) --- @@ -51,4 +51,4 @@ Defined in: [gen/types.gen.ts:14566](https://github.com/camunda/orchestration-cl url: "/roles/search"; ``` -Defined in: [gen/types.gen.ts:14567](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14567) +Defined in: [gen/types.gen.ts:13849](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13849) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesError.md index 1c86aa2a92c..577709c1f2d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesError.md @@ -11,4 +11,4 @@ mdx: type SearchRolesError = SearchRolesErrors[keyof SearchRolesErrors]; ``` -Defined in: [gen/types.gen.ts:14589](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14589) +Defined in: [gen/types.gen.ts:13871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13871) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesErrors.md index 768895063f4..9536ae2d7e9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesErrors.md @@ -11,7 +11,7 @@ mdx: type SearchRolesErrors = object; ``` -Defined in: [gen/types.gen.ts:14570](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14570) +Defined in: [gen/types.gen.ts:13852](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13852) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14570](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14574](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14574) +Defined in: [gen/types.gen.ts:13856](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13856) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14578](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14578) +Defined in: [gen/types.gen.ts:13860](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13860) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14582](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14582) +Defined in: [gen/types.gen.ts:13864](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13864) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14586](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14586) +Defined in: [gen/types.gen.ts:13868](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13868) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupData.md index af0ebf4135d..8c33812b5a3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupData.md @@ -11,7 +11,7 @@ mdx: type SearchRolesForGroupData = object; ``` -Defined in: [gen/types.gen.ts:11169](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11169) +Defined in: [gen/types.gen.ts:11358](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11358) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11169](https://github.com/camunda/orchestration-cl optional body: RoleSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:11170](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11170) +Defined in: [gen/types.gen.ts:11359](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11359) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11170](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11171](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11171) +Defined in: [gen/types.gen.ts:11360](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11360) #### groupId @@ -49,7 +49,7 @@ The group ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:11177](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11177) +Defined in: [gen/types.gen.ts:11366](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11366) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:11177](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/roles/search"; ``` -Defined in: [gen/types.gen.ts:11178](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11178) +Defined in: [gen/types.gen.ts:11367](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11367) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupError.md index c7c68f34d7d..dfc4880fdd0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupError.md @@ -12,4 +12,4 @@ type SearchRolesForGroupError = SearchRolesForGroupErrors[keyof SearchRolesForGroupErrors]; ``` -Defined in: [gen/types.gen.ts:11204](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11204) +Defined in: [gen/types.gen.ts:11393](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11393) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupErrors.md index f932ccae1c8..5c03c83057a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupErrors.md @@ -11,7 +11,7 @@ mdx: type SearchRolesForGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:11181](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11181) +Defined in: [gen/types.gen.ts:11370](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11370) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11181](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11185](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11185) +Defined in: [gen/types.gen.ts:11374](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11374) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11189](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11189) +Defined in: [gen/types.gen.ts:11378](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11378) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11193](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11193) +Defined in: [gen/types.gen.ts:11382](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11382) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11197](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11197) +Defined in: [gen/types.gen.ts:11386](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11386) The group with the given ID was not found. @@ -69,6 +69,6 @@ The group with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11201](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11201) +Defined in: [gen/types.gen.ts:11390](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11390) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupResponse.md index e988002f6ff..41cd3995d32 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupResponse.md @@ -12,4 +12,4 @@ type SearchRolesForGroupResponse = SearchRolesForGroupResponses[keyof SearchRolesForGroupResponses]; ``` -Defined in: [gen/types.gen.ts:11213](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11213) +Defined in: [gen/types.gen.ts:11407](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11407) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupResponses.md index af882ddc834..c064cb4010a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForGroupResponses.md @@ -11,16 +11,26 @@ mdx: type SearchRolesForGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:11206](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11206) +Defined in: [gen/types.gen.ts:11395](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11395) ## Properties ### 200 ```ts -200: SearchQueryResponse; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:11210](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11210) +Defined in: [gen/types.gen.ts:11399](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11399) The roles assigned to the group. + +#### Type Declaration + +##### items + +```ts +items: RoleResult[]; +``` + +The matching roles. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantData.md index c849a2fce87..538d99545d5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantData.md @@ -11,7 +11,7 @@ mdx: type SearchRolesForTenantData = object; ``` -Defined in: [gen/types.gen.ts:16162](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16162) +Defined in: [gen/types.gen.ts:15470](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15470) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16162](https://github.com/camunda/orchestration-cl optional body: RoleSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:16163](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16163) +Defined in: [gen/types.gen.ts:15471](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15471) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16163](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16164](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16164) +Defined in: [gen/types.gen.ts:15472](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15472) #### tenantId @@ -49,7 +49,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:16170](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16170) +Defined in: [gen/types.gen.ts:15478](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15478) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:16170](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/roles/search"; ``` -Defined in: [gen/types.gen.ts:16171](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16171) +Defined in: [gen/types.gen.ts:15479](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15479) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantResponse.md index c32b2e7a949..03a71b4d2e3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantResponse.md @@ -12,4 +12,4 @@ type SearchRolesForTenantResponse = SearchRolesForTenantResponses[keyof SearchRolesForTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16181](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16181) +Defined in: [gen/types.gen.ts:15494](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15494) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantResponses.md index 3cc6a0b4dcd..e8821ece55b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesForTenantResponses.md @@ -11,16 +11,26 @@ mdx: type SearchRolesForTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16174](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16174) +Defined in: [gen/types.gen.ts:15482](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15482) ## Properties ### 200 ```ts -200: SearchQueryResponse; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:16178](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16178) +Defined in: [gen/types.gen.ts:15486](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15486) The search result of roles for the tenant. + +#### Type Declaration + +##### items + +```ts +items: RoleResult[]; +``` + +The matching roles. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesResponse.md index 8538f94b89f..4d63fee70be 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesResponse.md @@ -11,4 +11,4 @@ mdx: type SearchRolesResponse = SearchRolesResponses[keyof SearchRolesResponses]; ``` -Defined in: [gen/types.gen.ts:14598](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14598) +Defined in: [gen/types.gen.ts:13880](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13880) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesResponses.md index ea8dd90e071..2371ef1df0d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchRolesResponses.md @@ -11,7 +11,7 @@ mdx: type SearchRolesResponses = object; ``` -Defined in: [gen/types.gen.ts:14591](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14591) +Defined in: [gen/types.gen.ts:13873](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13873) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14591](https://github.com/camunda/orchestration-cl 200: RoleSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:14595](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14595) +Defined in: [gen/types.gen.ts:13877](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13877) The roles search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsData.md index 932b8ed0877..c327d796adf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsData.md @@ -11,37 +11,17 @@ mdx: type SearchTenantsData = object; ``` -Defined in: [gen/types.gen.ts:15572](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15572) +Defined in: [gen/types.gen.ts:14894](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14894) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: TenantSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:15576](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15576) - -Tenant search request - -#### Type Declaration - -##### filter? - -```ts -optional filter: TenantFilter; -``` - -The tenant search filters. - -##### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:14895](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14895) --- @@ -51,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:15592](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15592) +Defined in: [gen/types.gen.ts:14896](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14896) --- @@ -61,7 +41,7 @@ Defined in: [gen/types.gen.ts:15592](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:15593](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15593) +Defined in: [gen/types.gen.ts:14897](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14897) --- @@ -71,4 +51,4 @@ Defined in: [gen/types.gen.ts:15593](https://github.com/camunda/orchestration-cl url: "/tenants/search"; ``` -Defined in: [gen/types.gen.ts:15594](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15594) +Defined in: [gen/types.gen.ts:14898](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14898) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsError.md index 432317bddc9..77cb5f27e77 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsError.md @@ -11,4 +11,4 @@ mdx: type SearchTenantsError = SearchTenantsErrors[keyof SearchTenantsErrors]; ``` -Defined in: [gen/types.gen.ts:15620](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15620) +Defined in: [gen/types.gen.ts:14924](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14924) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsErrors.md index eae106e8834..da8c4e30838 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchTenantsErrors = object; ``` -Defined in: [gen/types.gen.ts:15597](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15597) +Defined in: [gen/types.gen.ts:14901](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14901) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15597](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15601](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15601) +Defined in: [gen/types.gen.ts:14905](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14905) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15605](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15605) +Defined in: [gen/types.gen.ts:14909](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14909) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15609](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15609) +Defined in: [gen/types.gen.ts:14913](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14913) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15613](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15613) +Defined in: [gen/types.gen.ts:14917](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14917) Not found @@ -69,6 +69,6 @@ Not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15617](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15617) +Defined in: [gen/types.gen.ts:14921](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14921) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsResponse.md index 0eccdfdc7ce..0ffa3863c81 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsResponse.md @@ -12,4 +12,4 @@ type SearchTenantsResponse = SearchTenantsResponses[keyof SearchTenantsResponses]; ``` -Defined in: [gen/types.gen.ts:15629](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15629) +Defined in: [gen/types.gen.ts:14933](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14933) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsResponses.md index 218d8ade60c..af9c1c558a3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchTenantsResponses.md @@ -11,7 +11,7 @@ mdx: type SearchTenantsResponses = object; ``` -Defined in: [gen/types.gen.ts:15622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15622) +Defined in: [gen/types.gen.ts:14926](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14926) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15622](https://github.com/camunda/orchestration-cl 200: TenantSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:15626](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15626) +Defined in: [gen/types.gen.ts:14930](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14930) The tenants search result diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsData.md index 65d174bda2b..2532c96d45c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsData.md @@ -11,35 +11,17 @@ mdx: type SearchUserTaskAuditLogsData = object; ``` -Defined in: [gen/types.gen.ts:17175](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17175) +Defined in: [gen/types.gen.ts:16263](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16263) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: UserTaskAuditLogSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:17179](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17179) - -User task search query request. - -#### Type Declaration - -##### filter? - -```ts -optional filter: UserTaskAuditLogFilter; -``` - -##### sort? - -```ts -optional sort: AuditLogSearchQuerySortRequest[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:16264](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16264) --- @@ -49,7 +31,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:17186](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17186) +Defined in: [gen/types.gen.ts:16265](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16265) #### userTaskKey @@ -67,7 +49,7 @@ The key of the user task. optional query: never; ``` -Defined in: [gen/types.gen.ts:17192](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17192) +Defined in: [gen/types.gen.ts:16271](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16271) --- @@ -77,4 +59,4 @@ Defined in: [gen/types.gen.ts:17192](https://github.com/camunda/orchestration-cl url: "/user-tasks/{userTaskKey}/audit-logs/search"; ``` -Defined in: [gen/types.gen.ts:17193](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17193) +Defined in: [gen/types.gen.ts:16272](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16272) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsError.md index 9b8a75889f6..966d0770d03 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsError.md @@ -12,4 +12,4 @@ type SearchUserTaskAuditLogsError = SearchUserTaskAuditLogsErrors[keyof SearchUserTaskAuditLogsErrors]; ``` -Defined in: [gen/types.gen.ts:17207](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17207) +Defined in: [gen/types.gen.ts:16286](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16286) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsErrors.md index 3ed6d98b436..1aaa0af8c13 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsErrors.md @@ -11,7 +11,7 @@ mdx: type SearchUserTaskAuditLogsErrors = object; ``` -Defined in: [gen/types.gen.ts:17196](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17196) +Defined in: [gen/types.gen.ts:16275](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16275) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17196](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17200](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17200) +Defined in: [gen/types.gen.ts:16279](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16279) The provided data is not valid. @@ -33,6 +33,6 @@ The provided data is not valid. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17204](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17204) +Defined in: [gen/types.gen.ts:16283](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16283) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsResponse.md index ca92eb70ffd..9785f3bf9ea 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsResponse.md @@ -12,4 +12,4 @@ type SearchUserTaskAuditLogsResponse = SearchUserTaskAuditLogsResponses[keyof SearchUserTaskAuditLogsResponses]; ``` -Defined in: [gen/types.gen.ts:17331](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17331) +Defined in: [gen/types.gen.ts:16295](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16295) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsResponses.md index ac4546312f8..34789a727a5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskAuditLogsResponses.md @@ -11,26 +11,16 @@ mdx: type SearchUserTaskAuditLogsResponses = object; ``` -Defined in: [gen/types.gen.ts:17209](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17209) +Defined in: [gen/types.gen.ts:16288](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16288) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: AuditLogSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:17213](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17213) +Defined in: [gen/types.gen.ts:16292](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16292) -Audit log search response. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching audit logs. +The user task audit log search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesData.md new file mode 100644 index 00000000000..dcc80e18efe --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesData.md @@ -0,0 +1,96 @@ +--- +title: "Type Alias: SearchUserTaskEffectiveVariablesData" +sidebar_label: "SearchUserTaskEffectiveVariablesData" +mdx: + format: md +--- + +# Type Alias: SearchUserTaskEffectiveVariablesData + +```ts +type SearchUserTaskEffectiveVariablesData = object; +``` + +Defined in: [gen/types.gen.ts:16351](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16351) + +## Properties + +### body? + +```ts +optional body: object; +``` + +Defined in: [gen/types.gen.ts:16356](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16356) + +User task effective variable search query request. Uses offset-based pagination only. + +#### filter? + +```ts +optional filter: UserTaskVariableFilter; +``` + +The user task variable search filters. + +#### page? + +```ts +optional page: OffsetPagination; +``` + +Pagination parameters. + +#### sort? + +```ts +optional sort: object[]; +``` + +Sort field criteria. + +--- + +### path + +```ts +path: object; +``` + +Defined in: [gen/types.gen.ts:16376](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16376) + +#### userTaskKey + +```ts +userTaskKey: UserTaskKey; +``` + +The key of the user task. + +--- + +### query? + +```ts +optional query: object; +``` + +Defined in: [gen/types.gen.ts:16382](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16382) + +#### truncateValues? + +```ts +optional truncateValues: boolean; +``` + +When true (default), long variable values in the response are truncated. When false, full variable values are returned. + +--- + +### url + +```ts +url: "/user-tasks/{userTaskKey}/effective-variables/search"; +``` + +Defined in: [gen/types.gen.ts:16388](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16388) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesError.md new file mode 100644 index 00000000000..6bdec3e7397 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: SearchUserTaskEffectiveVariablesError" +sidebar_label: "SearchUserTaskEffectiveVariablesError" +mdx: + format: md +--- + +# Type Alias: SearchUserTaskEffectiveVariablesError + +```ts +type SearchUserTaskEffectiveVariablesError = + SearchUserTaskEffectiveVariablesErrors[keyof SearchUserTaskEffectiveVariablesErrors]; +``` + +Defined in: [gen/types.gen.ts:16402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16402) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesErrors.md new file mode 100644 index 00000000000..5097db8ab71 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesErrors.md @@ -0,0 +1,38 @@ +--- +title: "Type Alias: SearchUserTaskEffectiveVariablesErrors" +sidebar_label: "SearchUserTaskEffectiveVariablesErrors" +mdx: + format: md +--- + +# Type Alias: SearchUserTaskEffectiveVariablesErrors + +```ts +type SearchUserTaskEffectiveVariablesErrors = object; +``` + +Defined in: [gen/types.gen.ts:16391](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16391) + +## Properties + +### 400 + +```ts +400: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:16395](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16395) + +The provided data is not valid. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:16399](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16399) + +An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesResponse.md new file mode 100644 index 00000000000..acb7b0af835 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: SearchUserTaskEffectiveVariablesResponse" +sidebar_label: "SearchUserTaskEffectiveVariablesResponse" +mdx: + format: md +--- + +# Type Alias: SearchUserTaskEffectiveVariablesResponse + +```ts +type SearchUserTaskEffectiveVariablesResponse = + SearchUserTaskEffectiveVariablesResponses[keyof SearchUserTaskEffectiveVariablesResponses]; +``` + +Defined in: [gen/types.gen.ts:16411](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16411) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesResponses.md new file mode 100644 index 00000000000..5c6ddf3384e --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskEffectiveVariablesResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: SearchUserTaskEffectiveVariablesResponses" +sidebar_label: "SearchUserTaskEffectiveVariablesResponses" +mdx: + format: md +--- + +# Type Alias: SearchUserTaskEffectiveVariablesResponses + +```ts +type SearchUserTaskEffectiveVariablesResponses = object; +``` + +Defined in: [gen/types.gen.ts:16404](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16404) + +## Properties + +### 200 + +```ts +200: VariableSearchQueryResult; +``` + +Defined in: [gen/types.gen.ts:16408](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16408) + +The user task effective variable search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesData.md index c27fea61557..71e3230ac09 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesData.md @@ -11,7 +11,7 @@ mdx: type SearchUserTaskVariablesData = object; ``` -Defined in: [gen/types.gen.ts:17454](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17454) +Defined in: [gen/types.gen.ts:16463](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16463) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17454](https://github.com/camunda/orchestration-cl optional body: SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:17458](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17458) +Defined in: [gen/types.gen.ts:16467](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16467) User task search query request. @@ -30,19 +30,11 @@ User task search query request. ##### filter? ```ts -optional filter: object; +optional filter: UserTaskVariableFilter; ``` The user task variable search filters. -###### filter.name? - -```ts -optional name: StringFilterProperty; -``` - -Name of the variable. - ##### sort? ```ts @@ -59,7 +51,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:17479](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17479) +Defined in: [gen/types.gen.ts:16483](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16483) #### userTaskKey @@ -77,7 +69,7 @@ The key of the user task. optional query: object; ``` -Defined in: [gen/types.gen.ts:17485](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17485) +Defined in: [gen/types.gen.ts:16489](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16489) #### truncateValues? @@ -95,4 +87,4 @@ When true (default), long variable values in the response are truncated. When fa url: "/user-tasks/{userTaskKey}/variables/search"; ``` -Defined in: [gen/types.gen.ts:17491](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17491) +Defined in: [gen/types.gen.ts:16495](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16495) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesError.md index 5f20cbb8fa9..83914d5e1ae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesError.md @@ -12,4 +12,4 @@ type SearchUserTaskVariablesError = SearchUserTaskVariablesErrors[keyof SearchUserTaskVariablesErrors]; ``` -Defined in: [gen/types.gen.ts:17505](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17505) +Defined in: [gen/types.gen.ts:16509](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16509) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesErrors.md index cf54142fdb3..c76c3e86c21 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesErrors.md @@ -11,7 +11,7 @@ mdx: type SearchUserTaskVariablesErrors = object; ``` -Defined in: [gen/types.gen.ts:17494](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17494) +Defined in: [gen/types.gen.ts:16498](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16498) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17494](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17498](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17498) +Defined in: [gen/types.gen.ts:16502](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16502) The provided data is not valid. @@ -33,6 +33,6 @@ The provided data is not valid. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17502](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17502) +Defined in: [gen/types.gen.ts:16506](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16506) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesResponse.md index 5077277a4c4..d22ad257a57 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesResponse.md @@ -12,4 +12,4 @@ type SearchUserTaskVariablesResponse = SearchUserTaskVariablesResponses[keyof SearchUserTaskVariablesResponses]; ``` -Defined in: [gen/types.gen.ts:17550](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17550) +Defined in: [gen/types.gen.ts:16518](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16518) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesResponses.md index d59598639af..ef1de0295ae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTaskVariablesResponses.md @@ -11,26 +11,16 @@ mdx: type SearchUserTaskVariablesResponses = object; ``` -Defined in: [gen/types.gen.ts:17507](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17507) +Defined in: [gen/types.gen.ts:16511](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16511) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: VariableSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:17511](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17511) +Defined in: [gen/types.gen.ts:16515](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16515) -Variable search query response. - -#### Type Declaration - -##### items? - -```ts -optional items: object & object[]; -``` - -The matching variables. +The user task variable search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksData.md index a64ffb2598b..98f3b8cce22 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksData.md @@ -11,191 +11,17 @@ mdx: type SearchUserTasksData = object; ``` -Defined in: [gen/types.gen.ts:16678](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16678) +Defined in: [gen/types.gen.ts:16018](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16018) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: UserTaskSearchQuery; ``` -Defined in: [gen/types.gen.ts:16682](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16682) - -User task search query request. - -#### Type Declaration - -##### filter? - -```ts -optional filter: object; -``` - -User task filter request. - -###### filter.assignee? - -```ts -optional assignee: StringFilterProperty; -``` - -The assignee of the user task. - -###### filter.candidateGroup? - -```ts -optional candidateGroup: StringFilterProperty; -``` - -The candidate group for this user task. - -###### filter.candidateUser? - -```ts -optional candidateUser: StringFilterProperty; -``` - -The candidate user for this user task. - -###### filter.completionDate? - -```ts -optional completionDate: DateTimeFilterProperty; -``` - -The user task completion date. - -###### filter.creationDate? - -```ts -optional creationDate: DateTimeFilterProperty; -``` - -The user task creation date. - -###### filter.dueDate? - -```ts -optional dueDate: DateTimeFilterProperty; -``` - -The user task due date. - -###### filter.elementId? - -```ts -optional elementId: ElementId; -``` - -The element ID of the user task. - -###### filter.elementInstanceKey? - -```ts -optional elementInstanceKey: ElementInstanceKey; -``` - -The key of the element instance. - -###### filter.followUpDate? - -```ts -optional followUpDate: DateTimeFilterProperty; -``` - -The user task follow-up date. - -###### filter.localVariables? - -```ts -optional localVariables: VariableValueFilterProperty[]; -``` - -###### filter.name? - -```ts -optional name: StringFilterProperty; -``` - -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. - -###### filter.priority? - -```ts -optional priority: IntegerFilterProperty; -``` - -The priority of the user task. - -###### filter.processDefinitionId? - -```ts -optional processDefinitionId: ProcessDefinitionId; -``` - -The ID of the process definition. - -###### filter.processDefinitionKey? - -```ts -optional processDefinitionKey: ProcessDefinitionKey; -``` - -The key of the process definition. - -###### filter.processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKey; -``` - -The key of the process instance. - -###### filter.processInstanceVariables? - -```ts -optional processInstanceVariables: VariableValueFilterProperty[]; -``` - -###### filter.state? - -```ts -optional state: UserTaskStateFilterProperty; -``` - -The user task state. - -###### filter.tags? - -```ts -optional tags: TagSet; -``` - -###### filter.tenantId? - -```ts -optional tenantId: StringFilterProperty; -``` - -Tenant ID of this user task. - -###### filter.userTaskKey? - -```ts -optional userTaskKey: UserTaskKey; -``` - -The key for this user task. - -##### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:16019](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16019) --- @@ -205,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:16771](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16771) +Defined in: [gen/types.gen.ts:16020](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16020) --- @@ -215,7 +41,7 @@ Defined in: [gen/types.gen.ts:16771](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:16772](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16772) +Defined in: [gen/types.gen.ts:16021](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16021) --- @@ -225,4 +51,4 @@ Defined in: [gen/types.gen.ts:16772](https://github.com/camunda/orchestration-cl url: "/user-tasks/search"; ``` -Defined in: [gen/types.gen.ts:16773](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16773) +Defined in: [gen/types.gen.ts:16022](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16022) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksError.md index 7aafc199439..59e6a5631c1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksError.md @@ -11,4 +11,4 @@ mdx: type SearchUserTasksError = SearchUserTasksErrors[keyof SearchUserTasksErrors]; ``` -Defined in: [gen/types.gen.ts:16795](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16795) +Defined in: [gen/types.gen.ts:16044](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16044) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksErrors.md index cf28540860b..476ad0a15cd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksErrors.md @@ -11,7 +11,7 @@ mdx: type SearchUserTasksErrors = object; ``` -Defined in: [gen/types.gen.ts:16776](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16776) +Defined in: [gen/types.gen.ts:16025](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16025) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16776](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16780](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16780) +Defined in: [gen/types.gen.ts:16029](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16029) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16784](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16784) +Defined in: [gen/types.gen.ts:16033](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16033) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16788](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16788) +Defined in: [gen/types.gen.ts:16037](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16037) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16792](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16792) +Defined in: [gen/types.gen.ts:16041](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16041) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksResponse.md index a82ad8c52ed..75b59cb4f7a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksResponse.md @@ -12,4 +12,4 @@ type SearchUserTasksResponse = SearchUserTasksResponses[keyof SearchUserTasksResponses]; ``` -Defined in: [gen/types.gen.ts:16896](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16896) +Defined in: [gen/types.gen.ts:16053](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16053) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksResponses.md index 25baec716d2..aa60510b568 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUserTasksResponses.md @@ -11,26 +11,16 @@ mdx: type SearchUserTasksResponses = object; ``` -Defined in: [gen/types.gen.ts:16797](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16797) +Defined in: [gen/types.gen.ts:16046](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16046) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: UserTaskSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:16801](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16801) +Defined in: [gen/types.gen.ts:16050](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16050) -User task search query response. - -#### Type Declaration - -##### items? - -```ts -optional items: object[]; -``` - -The matching user tasks. +The user task search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersData.md index 756dfc42a90..328c557f00e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersData.md @@ -11,35 +11,17 @@ mdx: type SearchUsersData = object; ``` -Defined in: [gen/types.gen.ts:16494](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16494) +Defined in: [gen/types.gen.ts:15814](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15814) ## Properties ### body? ```ts -optional body: SearchQueryRequest & object; +optional body: UserSearchQueryRequest; ``` -Defined in: [gen/types.gen.ts:16495](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16495) - -#### Type Declaration - -##### filter? - -```ts -optional filter: UserFilter; -``` - -The user search filters. - -##### sort? - -```ts -optional sort: object[]; -``` - -Sort field criteria. +Defined in: [gen/types.gen.ts:15815](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15815) --- @@ -49,7 +31,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:16511](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16511) +Defined in: [gen/types.gen.ts:15816](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15816) --- @@ -59,7 +41,7 @@ Defined in: [gen/types.gen.ts:16511](https://github.com/camunda/orchestration-cl optional query: never; ``` -Defined in: [gen/types.gen.ts:16512](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16512) +Defined in: [gen/types.gen.ts:15817](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15817) --- @@ -69,4 +51,4 @@ Defined in: [gen/types.gen.ts:16512](https://github.com/camunda/orchestration-cl url: "/users/search"; ``` -Defined in: [gen/types.gen.ts:16513](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16513) +Defined in: [gen/types.gen.ts:15818](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15818) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersError.md index 421bb64bd24..143b22e6d90 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersError.md @@ -11,4 +11,4 @@ mdx: type SearchUsersError = SearchUsersErrors[keyof SearchUsersErrors]; ``` -Defined in: [gen/types.gen.ts:16535](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16535) +Defined in: [gen/types.gen.ts:15840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15840) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersErrors.md index 401dcc34a89..50a9c237a2a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersErrors.md @@ -11,7 +11,7 @@ mdx: type SearchUsersErrors = object; ``` -Defined in: [gen/types.gen.ts:16516](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16516) +Defined in: [gen/types.gen.ts:15821](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15821) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16516](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16520](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16520) +Defined in: [gen/types.gen.ts:15825](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15825) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16524](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16524) +Defined in: [gen/types.gen.ts:15829](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15829) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16528](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16528) +Defined in: [gen/types.gen.ts:15833](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15833) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16532](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16532) +Defined in: [gen/types.gen.ts:15837](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15837) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupData.md index 15efc8a7adf..598923facc8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupData.md @@ -11,7 +11,7 @@ mdx: type SearchUsersForGroupData = object; ``` -Defined in: [gen/types.gen.ts:11215](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11215) +Defined in: [gen/types.gen.ts:11409](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11409) ## Properties @@ -21,14 +21,14 @@ Defined in: [gen/types.gen.ts:11215](https://github.com/camunda/orchestration-cl optional body: SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:11216](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11216) +Defined in: [gen/types.gen.ts:11410](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11410) #### Type Declaration ##### sort? ```ts -optional sort: TenantUserSearchQuerySortRequest[]; +optional sort: object[]; ``` Sort field criteria. @@ -41,7 +41,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:11222](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11222) +Defined in: [gen/types.gen.ts:11422](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11422) #### groupId @@ -59,7 +59,7 @@ The group ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:11228](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11228) +Defined in: [gen/types.gen.ts:11428](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11428) --- @@ -69,4 +69,4 @@ Defined in: [gen/types.gen.ts:11228](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/users/search"; ``` -Defined in: [gen/types.gen.ts:11229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11229) +Defined in: [gen/types.gen.ts:11429](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11429) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupError.md index 2cec91aa4c1..d169ce17138 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupError.md @@ -12,4 +12,4 @@ type SearchUsersForGroupError = SearchUsersForGroupErrors[keyof SearchUsersForGroupErrors]; ``` -Defined in: [gen/types.gen.ts:11255](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11255) +Defined in: [gen/types.gen.ts:11455](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11455) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupErrors.md index 91b0c41d387..b05f873d3a8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupErrors.md @@ -11,7 +11,7 @@ mdx: type SearchUsersForGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:11232](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11232) +Defined in: [gen/types.gen.ts:11432](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11432) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11232](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11236](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11236) +Defined in: [gen/types.gen.ts:11436](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11436) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11240](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11240) +Defined in: [gen/types.gen.ts:11440](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11440) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11244](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11244) +Defined in: [gen/types.gen.ts:11444](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11444) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11248](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11248) +Defined in: [gen/types.gen.ts:11448](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11448) The group with the given ID was not found. @@ -69,6 +69,6 @@ The group with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11252](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11252) +Defined in: [gen/types.gen.ts:11452](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11452) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupResponse.md index 52488b49d75..12879a683d9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupResponse.md @@ -12,4 +12,4 @@ type SearchUsersForGroupResponse = SearchUsersForGroupResponses[keyof SearchUsersForGroupResponses]; ``` -Defined in: [gen/types.gen.ts:11264](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11264) +Defined in: [gen/types.gen.ts:11471](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11471) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupResponses.md index c6ce549e908..224b7013b08 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForGroupResponses.md @@ -11,16 +11,26 @@ mdx: type SearchUsersForGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:11257](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11257) +Defined in: [gen/types.gen.ts:11457](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11457) ## Properties ### 200 ```ts -200: TenantUserSearchResult; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:11261](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11261) +Defined in: [gen/types.gen.ts:11461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11461) The users assigned to the group. + +#### Type Declaration + +##### items + +```ts +items: object[]; +``` + +The matching members. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleData.md index a84d4f98098..a9b3d793d06 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleData.md @@ -11,7 +11,7 @@ mdx: type SearchUsersForRoleData = object; ``` -Defined in: [gen/types.gen.ts:15210](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15210) +Defined in: [gen/types.gen.ts:14496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14496) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15210](https://github.com/camunda/orchestration-cl optional body: SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:15211](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15211) +Defined in: [gen/types.gen.ts:14497](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14497) #### Type Declaration @@ -41,7 +41,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:15223](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15223) +Defined in: [gen/types.gen.ts:14509](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14509) #### roleId @@ -59,7 +59,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:15229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15229) +Defined in: [gen/types.gen.ts:14515](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14515) --- @@ -69,4 +69,4 @@ Defined in: [gen/types.gen.ts:15229](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/users/search"; ``` -Defined in: [gen/types.gen.ts:15230](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15230) +Defined in: [gen/types.gen.ts:14516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14516) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleError.md index 64a57cb6fe0..d77367dd8be 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleError.md @@ -12,4 +12,4 @@ type SearchUsersForRoleError = SearchUsersForRoleErrors[keyof SearchUsersForRoleErrors]; ``` -Defined in: [gen/types.gen.ts:15256](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15256) +Defined in: [gen/types.gen.ts:14542](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14542) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleErrors.md index c7af2c2af80..cb2616fc89d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleErrors.md @@ -11,7 +11,7 @@ mdx: type SearchUsersForRoleErrors = object; ``` -Defined in: [gen/types.gen.ts:15233](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15233) +Defined in: [gen/types.gen.ts:14519](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14519) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15233](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15237](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15237) +Defined in: [gen/types.gen.ts:14523](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14523) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15241](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15241) +Defined in: [gen/types.gen.ts:14527](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14527) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15245](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15245) +Defined in: [gen/types.gen.ts:14531](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14531) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15249](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15249) +Defined in: [gen/types.gen.ts:14535](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14535) The role with the given ID was not found. @@ -69,6 +69,6 @@ The role with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15253](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15253) +Defined in: [gen/types.gen.ts:14539](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14539) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleResponse.md index fb491400e34..069abf95988 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleResponse.md @@ -12,4 +12,4 @@ type SearchUsersForRoleResponse = SearchUsersForRoleResponses[keyof SearchUsersForRoleResponses]; ``` -Defined in: [gen/types.gen.ts:15265](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15265) +Defined in: [gen/types.gen.ts:14558](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14558) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleResponses.md index bea4ee6c6d0..c6d24709a03 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForRoleResponses.md @@ -11,16 +11,26 @@ mdx: type SearchUsersForRoleResponses = object; ``` -Defined in: [gen/types.gen.ts:15258](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15258) +Defined in: [gen/types.gen.ts:14544](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14544) ## Properties ### 200 ```ts -200: TenantUserSearchResult; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:15262](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15262) +Defined in: [gen/types.gen.ts:14548](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14548) The users with the assigned role. + +#### Type Declaration + +##### items + +```ts +items: object[]; +``` + +The matching users. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantData.md index 5eb849848aa..9caf7e1c038 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantData.md @@ -11,7 +11,7 @@ mdx: type SearchUsersForTenantData = object; ``` -Defined in: [gen/types.gen.ts:16285](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16285) +Defined in: [gen/types.gen.ts:15598](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15598) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16285](https://github.com/camunda/orchestration-cl optional body: SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:16286](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16286) +Defined in: [gen/types.gen.ts:15599](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15599) #### Type Declaration @@ -41,7 +41,7 @@ Sort field criteria. path: object; ``` -Defined in: [gen/types.gen.ts:16298](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16298) +Defined in: [gen/types.gen.ts:15611](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15611) #### tenantId @@ -59,7 +59,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:16304](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16304) +Defined in: [gen/types.gen.ts:15617](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15617) --- @@ -69,4 +69,4 @@ Defined in: [gen/types.gen.ts:16304](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/users/search"; ``` -Defined in: [gen/types.gen.ts:16305](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16305) +Defined in: [gen/types.gen.ts:15618](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15618) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantResponse.md index 8a193c1f41f..bdd842e4abf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantResponse.md @@ -12,4 +12,4 @@ type SearchUsersForTenantResponse = SearchUsersForTenantResponses[keyof SearchUsersForTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16315](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16315) +Defined in: [gen/types.gen.ts:15635](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15635) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantResponses.md index 8180b3dea56..f1b78cc9d0e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersForTenantResponses.md @@ -11,16 +11,26 @@ mdx: type SearchUsersForTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16308](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16308) +Defined in: [gen/types.gen.ts:15621](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15621) ## Properties ### 200 ```ts -200: TenantUserSearchResult; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:16312](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16312) +Defined in: [gen/types.gen.ts:15625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15625) The search result of users for the tenant. + +#### Type Declaration + +##### items + +```ts +items: object[]; +``` + +The matching users. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersResponse.md index 8a04f7755cc..d496234033a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersResponse.md @@ -11,4 +11,4 @@ mdx: type SearchUsersResponse = SearchUsersResponses[keyof SearchUsersResponses]; ``` -Defined in: [gen/types.gen.ts:16544](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16544) +Defined in: [gen/types.gen.ts:15864](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15864) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersResponses.md index b73048896ac..0d8834e03c8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchUsersResponses.md @@ -11,16 +11,26 @@ mdx: type SearchUsersResponses = object; ``` -Defined in: [gen/types.gen.ts:16537](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16537) +Defined in: [gen/types.gen.ts:15842](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15842) ## Properties ### 200 ```ts -200: UserSearchResult; +200: SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:16541](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16541) +Defined in: [gen/types.gen.ts:15846](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15846) The user search result. + +#### Type Declaration + +##### items + +```ts +items: object[]; +``` + +The matching users. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesData.md index e91412e09bf..cea3bf7aed1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesData.md @@ -11,7 +11,7 @@ mdx: type SearchVariablesData = object; ``` -Defined in: [gen/types.gen.ts:17552](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17552) +Defined in: [gen/types.gen.ts:16520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16520) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17552](https://github.com/camunda/orchestration-cl optional body: SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:17556](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17556) +Defined in: [gen/types.gen.ts:16524](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16524) Variable search query request. @@ -30,66 +30,10 @@ Variable search query request. ##### filter? ```ts -optional filter: object; +optional filter: VariableFilter; ``` -Variable filter request. - -###### filter.isTruncated? - -```ts -optional isTruncated: boolean; -``` - -Whether the value is truncated or not. - -###### filter.name? - -```ts -optional name: StringFilterProperty; -``` - -Name of the variable. - -###### filter.processInstanceKey? - -```ts -optional processInstanceKey: ProcessInstanceKeyFilterProperty; -``` - -The key of the process instance of this variable. - -###### filter.scopeKey? - -```ts -optional scopeKey: ScopeKeyFilterProperty; -``` - -The key of the scope of this variable. - -###### filter.tenantId? - -```ts -optional tenantId: TenantId; -``` - -Tenant ID of this variable. - -###### filter.value? - -```ts -optional value: StringFilterProperty; -``` - -The value of the variable. - -###### filter.variableKey? - -```ts -optional variableKey: VariableKeyFilterProperty; -``` - -The key for this variable. +The variable search filters. ##### sort? @@ -107,7 +51,7 @@ Sort field criteria. optional path: never; ``` -Defined in: [gen/types.gen.ts:17601](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17601) +Defined in: [gen/types.gen.ts:16540](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16540) --- @@ -117,7 +61,7 @@ Defined in: [gen/types.gen.ts:17601](https://github.com/camunda/orchestration-cl optional query: object; ``` -Defined in: [gen/types.gen.ts:17602](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17602) +Defined in: [gen/types.gen.ts:16541](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16541) #### truncateValues? @@ -135,4 +79,4 @@ When true (default), long variable values in the response are truncated. When fa url: "/variables/search"; ``` -Defined in: [gen/types.gen.ts:17608](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17608) +Defined in: [gen/types.gen.ts:16547](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16547) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesError.md index 82bd205e854..7afecefd982 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesError.md @@ -11,4 +11,4 @@ mdx: type SearchVariablesError = SearchVariablesErrors[keyof SearchVariablesErrors]; ``` -Defined in: [gen/types.gen.ts:17630](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17630) +Defined in: [gen/types.gen.ts:16569](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16569) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesErrors.md index e4a95af8f74..4e3a08a1218 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesErrors.md @@ -11,7 +11,7 @@ mdx: type SearchVariablesErrors = object; ``` -Defined in: [gen/types.gen.ts:17611](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17611) +Defined in: [gen/types.gen.ts:16550](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16550) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17611](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17615](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17615) +Defined in: [gen/types.gen.ts:16554](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16554) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17619](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17619) +Defined in: [gen/types.gen.ts:16558](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16558) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17623](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17623) +Defined in: [gen/types.gen.ts:16562](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16562) Forbidden. The request is not allowed. @@ -57,6 +57,6 @@ Forbidden. The request is not allowed. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17627](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17627) +Defined in: [gen/types.gen.ts:16566](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16566) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesResponse.md index f4e01d7a9e4..cc91a2a7339 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesResponse.md @@ -12,4 +12,4 @@ type SearchVariablesResponse = SearchVariablesResponses[keyof SearchVariablesResponses]; ``` -Defined in: [gen/types.gen.ts:17675](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17675) +Defined in: [gen/types.gen.ts:16578](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16578) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesResponses.md index 09592acfec3..24739f4c394 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SearchVariablesResponses.md @@ -11,26 +11,16 @@ mdx: type SearchVariablesResponses = object; ``` -Defined in: [gen/types.gen.ts:17632](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17632) +Defined in: [gen/types.gen.ts:16571](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16571) ## Properties ### 200 ```ts -200: SearchQueryResponse & object; +200: VariableSearchQueryResult; ``` -Defined in: [gen/types.gen.ts:17636](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17636) +Defined in: [gen/types.gen.ts:16575](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16575) -Variable search query response. - -#### Type Declaration - -##### items? - -```ts -optional items: object & object[]; -``` - -The matching variables. +The variable search result. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SetVariableRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SetVariableRequest.md index 6336f4a98ae..42e07a05c8c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SetVariableRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SetVariableRequest.md @@ -11,7 +11,7 @@ mdx: type SetVariableRequest = object; ``` -Defined in: [gen/types.gen.ts:7372](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7372) +Defined in: [gen/types.gen.ts:8202](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8202) ## Properties @@ -21,19 +21,22 @@ Defined in: [gen/types.gen.ts:7372](https://github.com/camunda/orchestration-clu optional local: boolean; ``` -Defined in: [gen/types.gen.ts:7393](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7393) +Defined in: [gen/types.gen.ts:8225](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8225) -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: +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 }. + +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 }. --- @@ -43,7 +46,7 @@ and scope '2' will be { "bar" : 1 }. optional operationReference: OperationReference; ``` -Defined in: [gen/types.gen.ts:7394](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7394) +Defined in: [gen/types.gen.ts:8226](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8226) --- @@ -53,7 +56,7 @@ Defined in: [gen/types.gen.ts:7394](https://github.com/camunda/orchestration-clu variables: object; ``` -Defined in: [gen/types.gen.ts:7376](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7376) +Defined in: [gen/types.gen.ts:8206](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8206) JSON object representing the variables to set in the element’s scope. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalBroadcastRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalBroadcastRequest.md index a577c156a19..8bc6da91b61 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalBroadcastRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalBroadcastRequest.md @@ -11,7 +11,7 @@ mdx: type SignalBroadcastRequest = object; ``` -Defined in: [gen/types.gen.ts:6491](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6491) +Defined in: [gen/types.gen.ts:7210](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7210) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6491](https://github.com/camunda/orchestration-clu signalName: string; ``` -Defined in: [gen/types.gen.ts:6495](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6495) +Defined in: [gen/types.gen.ts:7214](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7214) The name of the signal to broadcast. @@ -33,7 +33,7 @@ The name of the signal to broadcast. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:6505](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6505) +Defined in: [gen/types.gen.ts:7224](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7224) The ID of the tenant that owns the signal. @@ -45,7 +45,7 @@ The ID of the tenant that owns the signal. optional variables: object; ``` -Defined in: [gen/types.gen.ts:6499](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6499) +Defined in: [gen/types.gen.ts:7218](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7218) The signal variables as a JSON object. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalBroadcastResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalBroadcastResult.md index 43c5fc89fc6..e65cb93d794 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalBroadcastResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalBroadcastResult.md @@ -11,7 +11,7 @@ mdx: type SignalBroadcastResult = object; ``` -Defined in: [gen/types.gen.ts:6508](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6508) +Defined in: [gen/types.gen.ts:7227](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7227) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6508](https://github.com/camunda/orchestration-clu signalKey: SignalKey; ``` -Defined in: [gen/types.gen.ts:6516](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6516) +Defined in: [gen/types.gen.ts:7235](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7235) The key of the broadcasted signal. @@ -33,6 +33,6 @@ The key of the broadcasted signal. tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:6512](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6512) +Defined in: [gen/types.gen.ts:7231](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7231) The tenant ID of the signal that was broadcast. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalKey.md index 34fc9f505c0..a79a0fce936 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SignalKey.md @@ -11,6 +11,6 @@ mdx: type SignalKey = CamundaKey<"SignalKey">; ``` -Defined in: [gen/types.gen.ts:6522](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6522) +Defined in: [gen/types.gen.ts:7241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7241) System-generated key for an signal. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SortOrderEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SortOrderEnum.md index 3a91ca02d49..b95b8e917b3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SortOrderEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SortOrderEnum.md @@ -11,6 +11,6 @@ mdx: type SortOrderEnum = "ASC" | "DESC"; ``` -Defined in: [gen/types.gen.ts:6465](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6465) +Defined in: [gen/types.gen.ts:7185](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7185) The order in which to sort the related field. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementIdInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementIdInstruction.md index de2b5cc684d..eaf8037ca30 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementIdInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementIdInstruction.md @@ -11,7 +11,7 @@ mdx: type SourceElementIdInstruction = object; ``` -Defined in: [gen/types.gen.ts:6046](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6046) +Defined in: [gen/types.gen.ts:6759](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6759) 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 @@ -25,7 +25,7 @@ one at targetElementId. sourceElementId: ElementId; ``` -Defined in: [gen/types.gen.ts:6055](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6055) +Defined in: [gen/types.gen.ts:6768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6768) The id of the source element for the move instruction. @@ -37,6 +37,6 @@ The id of the source element for the move instruction. sourceType: string; ``` -Defined in: [gen/types.gen.ts:6050](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6050) +Defined in: [gen/types.gen.ts:6763](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6763) The type of source element instruction. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementInstanceKeyInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementInstanceKeyInstruction.md index da8f02ad7c8..ce1bcfc8013 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementInstanceKeyInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementInstanceKeyInstruction.md @@ -11,7 +11,7 @@ mdx: type SourceElementInstanceKeyInstruction = object; ``` -Defined in: [gen/types.gen.ts:6063](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6063) +Defined in: [gen/types.gen.ts:6776](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6776) 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. @@ -24,7 +24,7 @@ instance with the sourceElementInstanceKey and activate a new element instance a sourceElementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:6072](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6072) +Defined in: [gen/types.gen.ts:6785](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6785) The source element instance key for the move instruction. @@ -36,6 +36,6 @@ The source element instance key for the move instruction. sourceType: string; ``` -Defined in: [gen/types.gen.ts:6067](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6067) +Defined in: [gen/types.gen.ts:6780](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6780) The type of source element instruction. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementInstruction.md index 38c5e9f91e2..ace81abab1f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SourceElementInstruction.md @@ -13,6 +13,6 @@ type SourceElementInstruction = | (object & SourceElementInstanceKeyInstruction); ``` -Defined in: [gen/types.gen.ts:6034](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6034) +Defined in: [gen/types.gen.ts:6747](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6747) Defines the source element identifier for the move instruction. It can either be a sourceElementId, or sourceElementInstanceKey. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/StartCursor.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/StartCursor.md index a2f1b75f8f8..24013792828 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/StartCursor.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/StartCursor.md @@ -11,6 +11,6 @@ mdx: type StartCursor = CamundaKey<"StartCursor">; ``` -Defined in: [gen/types.gen.ts:1393](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1393) +Defined in: [gen/types.gen.ts:1424](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1424) The start cursor in a search query result set. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/StatusMetric.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/StatusMetric.md index 8f349105ab9..3aa87a49267 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/StatusMetric.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/StatusMetric.md @@ -11,7 +11,7 @@ mdx: type StatusMetric = object; ``` -Defined in: [gen/types.gen.ts:3327](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3327) +Defined in: [gen/types.gen.ts:3704](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3704) Metric for a single job status. @@ -23,7 +23,7 @@ Metric for a single job status. count: number; ``` -Defined in: [gen/types.gen.ts:3331](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3331) +Defined in: [gen/types.gen.ts:3708](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3708) Number of jobs in this status. @@ -32,9 +32,9 @@ Number of jobs in this status. ### lastUpdatedAt ```ts -lastUpdatedAt: string; +lastUpdatedAt: string | null; ``` -Defined in: [gen/types.gen.ts:3335](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3335) +Defined in: [gen/types.gen.ts:3712](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3712) ISO 8601 timestamp of the last update for this status. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/StringFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/StringFilterProperty.md index 5a485c3fb5d..1910ab6d757 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/StringFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/StringFilterProperty.md @@ -11,6 +11,6 @@ mdx: type StringFilterProperty = string | AdvancedStringFilter; ``` -Defined in: [gen/types.gen.ts:2667](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2667) +Defined in: [gen/types.gen.ts:2825](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2825) String property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationData.md index a85b15eb52f..1638be92d18 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationData.md @@ -11,7 +11,7 @@ mdx: type SuspendBatchOperationData = object; ``` -Defined in: [gen/types.gen.ts:8473](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8473) +Defined in: [gen/types.gen.ts:8996](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8996) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8473](https://github.com/camunda/orchestration-clu optional body: unknown; ``` -Defined in: [gen/types.gen.ts:8474](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8474) +Defined in: [gen/types.gen.ts:8997](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8997) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8474](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8475](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8475) +Defined in: [gen/types.gen.ts:8998](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8998) #### batchOperationKey @@ -49,7 +49,7 @@ The key (or operate legacy ID) of the batch operation. optional query: never; ``` -Defined in: [gen/types.gen.ts:8481](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8481) +Defined in: [gen/types.gen.ts:9004](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9004) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8481](https://github.com/camunda/orchestration-clu url: "/batch-operations/{batchOperationKey}/suspension"; ``` -Defined in: [gen/types.gen.ts:8482](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8482) +Defined in: [gen/types.gen.ts:9005](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9005) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationError.md index 8c4f0ce9912..cabc169bcdf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationError.md @@ -12,4 +12,4 @@ type SuspendBatchOperationError = SuspendBatchOperationErrors[keyof SuspendBatchOperationErrors]; ``` -Defined in: [gen/types.gen.ts:8509](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8509) +Defined in: [gen/types.gen.ts:9032](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9032) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationErrors.md index aa8b3cfbd31..8d5a779ff18 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationErrors.md @@ -11,7 +11,7 @@ mdx: type SuspendBatchOperationErrors = object; ``` -Defined in: [gen/types.gen.ts:8485](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8485) +Defined in: [gen/types.gen.ts:9008](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9008) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8485](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8489](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8489) +Defined in: [gen/types.gen.ts:9012](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9012) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8493](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8493) +Defined in: [gen/types.gen.ts:9016](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9016) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8497](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8497) +Defined in: [gen/types.gen.ts:9020](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9020) Not found. The batch operation was not found. @@ -57,7 +57,7 @@ Not found. The batch operation was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8501](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8501) +Defined in: [gen/types.gen.ts:9024](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9024) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8506](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8506) +Defined in: [gen/types.gen.ts:9029](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9029) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationResponse.md index 2cfa308b0dc..7f47d85bd1e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationResponse.md @@ -12,4 +12,4 @@ type SuspendBatchOperationResponse = SuspendBatchOperationResponses[keyof SuspendBatchOperationResponses]; ``` -Defined in: [gen/types.gen.ts:8518](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8518) +Defined in: [gen/types.gen.ts:9041](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9041) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationResponses.md index 7143f8ddb2a..5be96e80484 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SuspendBatchOperationResponses.md @@ -11,7 +11,7 @@ mdx: type SuspendBatchOperationResponses = object; ``` -Defined in: [gen/types.gen.ts:8511](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8511) +Defined in: [gen/types.gen.ts:9034](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9034) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8511](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:8515](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8515) +Defined in: [gen/types.gen.ts:9038](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9038) The batch operation pause request was created. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/SystemConfigurationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/SystemConfigurationResponse.md new file mode 100644 index 00000000000..de561559793 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/SystemConfigurationResponse.md @@ -0,0 +1,27 @@ +--- +title: "Type Alias: SystemConfigurationResponse" +sidebar_label: "SystemConfigurationResponse" +mdx: + format: md +--- + +# Type Alias: SystemConfigurationResponse + +```ts +type SystemConfigurationResponse = object; +``` + +Defined in: [gen/types.gen.ts:7276](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7276) + +Envelope for all system configuration sections. Each property +represents a feature area. + +## Properties + +### jobMetrics + +```ts +jobMetrics: JobMetricsConfigurationResponse; +``` + +Defined in: [gen/types.gen.ts:7277](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7277) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/Tag.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/Tag.md index a2fb2f59f83..2da9083123f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/Tag.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/Tag.md @@ -11,6 +11,6 @@ mdx: type Tag = CamundaKey<"Tag">; ``` -Defined in: [gen/types.gen.ts:2992](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2992) +Defined in: [gen/types.gen.ts:3344](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3344) A tag. Needs to start with a letter; then alphanumerics, `_`, `-`, `:`, or `.`; length ≤ 100. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TagSet.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TagSet.md index e2443e9da9c..3b44ad9c70d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TagSet.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TagSet.md @@ -11,7 +11,7 @@ mdx: type TagSet = Tag[] & object; ``` -Defined in: [gen/types.gen.ts:2997](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2997) +Defined in: [gen/types.gen.ts:3349](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3349) List of tags. Tags need to start with a letter; then alphanumerics, `_`, `-`, `:`, or `.`; length ≤ 100. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientResult.md index 1c73141463a..78603698acf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientResult.md @@ -11,16 +11,16 @@ mdx: type TenantClientResult = object; ``` -Defined in: [gen/types.gen.ts:6686](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6686) +Defined in: [gen/types.gen.ts:7444](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7444) ## Properties -### clientId? +### clientId ```ts -optional clientId: string; +clientId: string; ``` -Defined in: [gen/types.gen.ts:6690](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6690) +Defined in: [gen/types.gen.ts:7448](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7448) The ID of the client. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchQueryRequest.md index a3ce1796d80..01cd6fb4438 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type TenantClientSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:6700](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6700) +Defined in: [gen/types.gen.ts:7458](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7458) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchQuerySortRequest.md index dbe8df7d22f..a54daf5c718 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type TenantClientSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:6707](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6707) +Defined in: [gen/types.gen.ts:7465](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7465) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6707](https://github.com/camunda/orchestration-clu field: "clientId"; ``` -Defined in: [gen/types.gen.ts:6711](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6711) +Defined in: [gen/types.gen.ts:7469](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7469) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:6712](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6712) +Defined in: [gen/types.gen.ts:7470](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7470) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchResult.md index 1511d083324..74b6bbeb52c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantClientSearchResult.md @@ -11,14 +11,14 @@ mdx: type TenantClientSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:6693](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6693) +Defined in: [gen/types.gen.ts:7451](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7451) ## Type Declaration -### items? +### items ```ts -optional items: TenantClientResult[]; +items: TenantClientResult[]; ``` The matching clients. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantCreateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantCreateRequest.md index fbe00eeb116..e992f13a011 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantCreateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantCreateRequest.md @@ -11,7 +11,7 @@ mdx: type TenantCreateRequest = object; ``` -Defined in: [gen/types.gen.ts:6552](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6552) +Defined in: [gen/types.gen.ts:7310](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7310) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6552](https://github.com/camunda/orchestration-clu optional description: string; ``` -Defined in: [gen/types.gen.ts:6564](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6564) +Defined in: [gen/types.gen.ts:7322](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7322) The description of the tenant. @@ -33,7 +33,7 @@ The description of the tenant. name: string; ``` -Defined in: [gen/types.gen.ts:6560](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6560) +Defined in: [gen/types.gen.ts:7318](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7318) The name of the tenant. @@ -45,6 +45,6 @@ The name of the tenant. tenantId: string; ``` -Defined in: [gen/types.gen.ts:6556](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6556) +Defined in: [gen/types.gen.ts:7314](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7314) The unique ID for the tenant. Must be 255 characters or less. Can contain letters, numbers, [`_`, `-`, `+`, `.`, `@`]. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantCreateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantCreateResult.md index efee6a77989..17dedb6f420 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantCreateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantCreateResult.md @@ -11,38 +11,38 @@ mdx: type TenantCreateResult = object; ``` -Defined in: [gen/types.gen.ts:6567](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6567) +Defined in: [gen/types.gen.ts:7325](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7325) ## Properties -### description? +### description ```ts -optional description: string; +description: string | null; ``` -Defined in: [gen/types.gen.ts:6576](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6576) +Defined in: [gen/types.gen.ts:7334](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7334) The description of the tenant. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:6572](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6572) +Defined in: [gen/types.gen.ts:7330](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7330) The name of the tenant. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:6568](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6568) +Defined in: [gen/types.gen.ts:7326](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7326) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantFilter.md index b97c8d5d0a3..e457249de00 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantFilter.md @@ -11,7 +11,7 @@ mdx: type TenantFilter = object; ``` -Defined in: [gen/types.gen.ts:6642](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6642) +Defined in: [gen/types.gen.ts:7400](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7400) Tenant filter request @@ -23,7 +23,7 @@ Tenant filter request optional name: string; ``` -Defined in: [gen/types.gen.ts:6647](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6647) +Defined in: [gen/types.gen.ts:7405](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7405) The name of the tenant. @@ -35,4 +35,4 @@ The name of the tenant. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:6643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6643) +Defined in: [gen/types.gen.ts:7401](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7401) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantFilterEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantFilterEnum.md index 7dfdfdfd630..c93d8242ec0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantFilterEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantFilterEnum.md @@ -11,6 +11,6 @@ mdx: type TenantFilterEnum = "PROVIDED" | "ASSIGNED"; ``` -Defined in: [gen/types.gen.ts:3896](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3896) +Defined in: [gen/types.gen.ts:4541](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4541) 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. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupResult.md index 6c6277a3417..23eb914b7f5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupResult.md @@ -11,16 +11,16 @@ mdx: type TenantGroupResult = object; ``` -Defined in: [gen/types.gen.ts:6715](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6715) +Defined in: [gen/types.gen.ts:7473](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7473) ## Properties -### groupId? +### groupId ```ts -optional groupId: string; +groupId: string; ``` -Defined in: [gen/types.gen.ts:6719](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6719) +Defined in: [gen/types.gen.ts:7477](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7477) The groupId of the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchQueryRequest.md index a9135381f2b..b2129a5a25f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type TenantGroupSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:6729](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6729) +Defined in: [gen/types.gen.ts:7487](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7487) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchQuerySortRequest.md index 1bc0d632bb4..0d67ae8d08b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type TenantGroupSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:6736](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6736) +Defined in: [gen/types.gen.ts:7508](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7508) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6736](https://github.com/camunda/orchestration-clu field: "groupId"; ``` -Defined in: [gen/types.gen.ts:6740](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6740) +Defined in: [gen/types.gen.ts:7512](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7512) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:6741](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6741) +Defined in: [gen/types.gen.ts:7513](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7513) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchResult.md index c32c2a6dd06..b510924741e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantGroupSearchResult.md @@ -11,14 +11,14 @@ mdx: type TenantGroupSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:6722](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6722) +Defined in: [gen/types.gen.ts:7480](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7480) ## Type Declaration -### items? +### items ```ts -optional items: TenantGroupResult[]; +items: TenantGroupResult[]; ``` The matching groups. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantId.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantId.md index 36977984083..e767634e528 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantId.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantId.md @@ -11,6 +11,6 @@ mdx: type TenantId = CamundaKey<"TenantId">; ``` -Defined in: [gen/types.gen.ts:2982](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2982) +Defined in: [gen/types.gen.ts:3334](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3334) The unique identifier of the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantMappingRuleSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantMappingRuleSearchResult.md new file mode 100644 index 00000000000..d9c717b5caf --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantMappingRuleSearchResult.md @@ -0,0 +1,24 @@ +--- +title: "Type Alias: TenantMappingRuleSearchResult" +sidebar_label: "TenantMappingRuleSearchResult" +mdx: + format: md +--- + +# Type Alias: TenantMappingRuleSearchResult + +```ts +type TenantMappingRuleSearchResult = SearchQueryResponse & object; +``` + +Defined in: [gen/types.gen.ts:7501](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7501) + +## Type Declaration + +### items + +```ts +items: MappingRuleResult[]; +``` + +The matching mapping rules. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantResult.md index 15f7c57b276..6845e187733 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantResult.md @@ -11,40 +11,40 @@ mdx: type TenantResult = object; ``` -Defined in: [gen/types.gen.ts:6605](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6605) +Defined in: [gen/types.gen.ts:7363](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7363) Tenant search response item. ## Properties -### description? +### description ```ts -optional description: string; +description: string | null; ``` -Defined in: [gen/types.gen.ts:6614](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6614) +Defined in: [gen/types.gen.ts:7372](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7372) The tenant description. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:6609](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6609) +Defined in: [gen/types.gen.ts:7367](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7367) The tenant name. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:6610](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6610) +Defined in: [gen/types.gen.ts:7368](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7368) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantRoleSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantRoleSearchResult.md new file mode 100644 index 00000000000..4fc054f5b2e --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantRoleSearchResult.md @@ -0,0 +1,24 @@ +--- +title: "Type Alias: TenantRoleSearchResult" +sidebar_label: "TenantRoleSearchResult" +mdx: + format: md +--- + +# Type Alias: TenantRoleSearchResult + +```ts +type TenantRoleSearchResult = SearchQueryResponse & object; +``` + +Defined in: [gen/types.gen.ts:7494](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7494) + +## Type Declaration + +### items + +```ts +items: RoleResult[]; +``` + +The matching roles. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQueryRequest.md index 14a5187adec..66b82193546 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type TenantSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:6628](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6628) +Defined in: [gen/types.gen.ts:7386](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7386) Tenant search request diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQueryResult.md index 8d42fa31cad..4126bcbfcf4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQueryResult.md @@ -11,16 +11,16 @@ mdx: type TenantSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:6653](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6653) +Defined in: [gen/types.gen.ts:7411](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7411) Tenant search response. ## Type Declaration -### items? +### items ```ts -optional items: TenantResult[]; +items: TenantResult[]; ``` The matching tenants. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQuerySortRequest.md index 150d36f7052..7dc84581703 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type TenantSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:6617](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6617) +Defined in: [gen/types.gen.ts:7375](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7375) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6617](https://github.com/camunda/orchestration-clu field: "key" | "name" | "tenantId"; ``` -Defined in: [gen/types.gen.ts:6621](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6621) +Defined in: [gen/types.gen.ts:7379](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7379) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:6622](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6622) +Defined in: [gen/types.gen.ts:7380](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7380) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUpdateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUpdateRequest.md index 79ac3f8dc2c..2d8f4a20be0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUpdateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUpdateRequest.md @@ -11,7 +11,7 @@ mdx: type TenantUpdateRequest = object; ``` -Defined in: [gen/types.gen.ts:6579](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6579) +Defined in: [gen/types.gen.ts:7337](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7337) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6579](https://github.com/camunda/orchestration-clu optional description: string; ``` -Defined in: [gen/types.gen.ts:6587](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6587) +Defined in: [gen/types.gen.ts:7345](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7345) The new description of the tenant. @@ -33,6 +33,6 @@ The new description of the tenant. name: string; ``` -Defined in: [gen/types.gen.ts:6583](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6583) +Defined in: [gen/types.gen.ts:7341](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7341) The new name of the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUpdateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUpdateResult.md index 844b858e7ec..acbed925aad 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUpdateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUpdateResult.md @@ -11,38 +11,38 @@ mdx: type TenantUpdateResult = object; ``` -Defined in: [gen/types.gen.ts:6590](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6590) +Defined in: [gen/types.gen.ts:7348](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7348) ## Properties -### description? +### description ```ts -optional description: string; +description: string | null; ``` -Defined in: [gen/types.gen.ts:6599](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6599) +Defined in: [gen/types.gen.ts:7357](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7357) The description of the tenant. --- -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:6595](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6595) +Defined in: [gen/types.gen.ts:7353](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7353) The name of the tenant. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:6591](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6591) +Defined in: [gen/types.gen.ts:7349](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7349) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserResult.md index 0876421bb60..1f5ef313909 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserResult.md @@ -11,14 +11,14 @@ mdx: type TenantUserResult = object; ``` -Defined in: [gen/types.gen.ts:6660](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6660) +Defined in: [gen/types.gen.ts:7418](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7418) ## Properties -### username? +### username ```ts -optional username: Username; +username: Username; ``` -Defined in: [gen/types.gen.ts:6661](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6661) +Defined in: [gen/types.gen.ts:7419](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7419) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchQueryRequest.md index a750d8dda50..1314a8fbdf2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type TenantUserSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:6671](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6671) +Defined in: [gen/types.gen.ts:7429](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7429) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchQuerySortRequest.md index 8dbf8f5b560..7ac07c4b9ce 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type TenantUserSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:6678](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6678) +Defined in: [gen/types.gen.ts:7436](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7436) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6678](https://github.com/camunda/orchestration-clu field: "username"; ``` -Defined in: [gen/types.gen.ts:6682](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6682) +Defined in: [gen/types.gen.ts:7440](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7440) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:6683](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6683) +Defined in: [gen/types.gen.ts:7441](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7441) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchResult.md index a7f74661708..75bec725078 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TenantUserSearchResult.md @@ -11,14 +11,14 @@ mdx: type TenantUserSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:6664](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6664) +Defined in: [gen/types.gen.ts:7422](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7422) ## Type Declaration -### items? +### items ```ts -optional items: TenantUserResult[]; +items: TenantUserResult[]; ``` The matching users. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThreadedJob.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThreadedJob.md new file mode 100644 index 00000000000..6004d652228 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThreadedJob.md @@ -0,0 +1,17 @@ +--- +title: "Type Alias: ThreadedJob" +sidebar_label: "ThreadedJob" +mdx: + format: md +--- + +# Type Alias: ThreadedJob + +```ts +type ThreadedJob = Omit; +``` + +Defined in: [runtime/threadedJobWorker.ts:15](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L15) + +The job object received by a threaded handler. +Same shape as EnrichedActivatedJob but without the logger (not available across threads). diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThreadedJobHandler.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThreadedJobHandler.md new file mode 100644 index 00000000000..2a05aa2c5e5 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThreadedJobHandler.md @@ -0,0 +1,46 @@ +--- +title: "Type Alias: ThreadedJobHandler()" +sidebar_label: "ThreadedJobHandler()" +mdx: + format: md +--- + +# Type Alias: ThreadedJobHandler() + +```ts +type ThreadedJobHandler = ( + job, + client +) => Promise | JobActionReceipt; +``` + +Defined in: [runtime/threadedJobWorker.ts:32](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/threadedJobWorker.ts#L32) + +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; +``` + +## Parameters + +### job + +[`ThreadedJob`](ThreadedJob.md) + +### client + +[`CamundaClient`](../classes/CamundaClient.md) + +## Returns + +\| `Promise`\<[`JobActionReceipt`](JobActionReceipt.md)\> +\| [`JobActionReceipt`](JobActionReceipt.md) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorData.md index a2deb893502..42a174c6329 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorData.md @@ -11,7 +11,7 @@ mdx: type ThrowJobErrorData = object; ``` -Defined in: [gen/types.gen.ts:12034](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12034) +Defined in: [gen/types.gen.ts:11960](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11960) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12034](https://github.com/camunda/orchestration-cl body: JobErrorRequest; ``` -Defined in: [gen/types.gen.ts:12035](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12035) +Defined in: [gen/types.gen.ts:11961](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11961) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12035](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:12036](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12036) +Defined in: [gen/types.gen.ts:11962](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11962) #### jobKey @@ -49,7 +49,7 @@ The key of the job. optional query: never; ``` -Defined in: [gen/types.gen.ts:12042](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12042) +Defined in: [gen/types.gen.ts:11968](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11968) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:12042](https://github.com/camunda/orchestration-cl url: "/jobs/{jobKey}/error"; ``` -Defined in: [gen/types.gen.ts:12043](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12043) +Defined in: [gen/types.gen.ts:11969](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11969) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorError.md index d9b8410e0b7..8743bcac721 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorError.md @@ -11,4 +11,4 @@ mdx: type ThrowJobErrorError = ThrowJobErrorErrors[keyof ThrowJobErrorErrors]; ``` -Defined in: [gen/types.gen.ts:12072](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12072) +Defined in: [gen/types.gen.ts:11998](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11998) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorErrors.md index b0fdd4d3852..e07487c24d9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorErrors.md @@ -11,7 +11,7 @@ mdx: type ThrowJobErrorErrors = object; ``` -Defined in: [gen/types.gen.ts:12046](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12046) +Defined in: [gen/types.gen.ts:11972](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11972) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12046](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12050](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12050) +Defined in: [gen/types.gen.ts:11976](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11976) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12055](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12055) +Defined in: [gen/types.gen.ts:11981](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11981) The job with the given key was not found or is not activated. @@ -45,7 +45,7 @@ The job with the given key was not found or is not activated. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12060](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12060) +Defined in: [gen/types.gen.ts:11986](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11986) The job with the given key is in the wrong state currently. More details are provided in the response body. @@ -57,7 +57,7 @@ The job with the given key is in the wrong state currently. More details are pro 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12064](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12064) +Defined in: [gen/types.gen.ts:11990](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11990) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12069](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12069) +Defined in: [gen/types.gen.ts:11995](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11995) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorResponse.md index 7f44e78e4e2..5fef4e42926 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorResponse.md @@ -12,4 +12,4 @@ type ThrowJobErrorResponse = ThrowJobErrorResponses[keyof ThrowJobErrorResponses]; ``` -Defined in: [gen/types.gen.ts:12081](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12081) +Defined in: [gen/types.gen.ts:12007](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12007) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorResponses.md index 35cdc1f025f..fe2f3812a41 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ThrowJobErrorResponses.md @@ -11,7 +11,7 @@ mdx: type ThrowJobErrorResponses = object; ``` -Defined in: [gen/types.gen.ts:12074](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12074) +Defined in: [gen/types.gen.ts:12000](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12000) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12074](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:12078](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12078) +Defined in: [gen/types.gen.ts:12004](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12004) An error is thrown for the job. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/TopologyResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/TopologyResponse.md index dad49b37e2a..9b6c9de910a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/TopologyResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/TopologyResponse.md @@ -11,7 +11,7 @@ mdx: type TopologyResponse = object; ``` -Defined in: [gen/types.gen.ts:1263](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1263) +Defined in: [gen/types.gen.ts:1294](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1294) The response of a topology request. @@ -23,19 +23,19 @@ The response of a topology request. brokers: BrokerInfo[]; ``` -Defined in: [gen/types.gen.ts:1267](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1267) +Defined in: [gen/types.gen.ts:1298](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1298) A list of brokers that are part of this cluster. --- -### clusterId? +### clusterId ```ts -optional clusterId: string | null; +clusterId: string | null; ``` -Defined in: [gen/types.gen.ts:1271](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1271) +Defined in: [gen/types.gen.ts:1302](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1302) The cluster Id. @@ -47,7 +47,7 @@ The cluster Id. clusterSize: number; ``` -Defined in: [gen/types.gen.ts:1275](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1275) +Defined in: [gen/types.gen.ts:1306](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1306) The number of brokers in the cluster. @@ -59,7 +59,7 @@ The number of brokers in the cluster. gatewayVersion: string; ``` -Defined in: [gen/types.gen.ts:1287](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1287) +Defined in: [gen/types.gen.ts:1318](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1318) The version of the Zeebe Gateway. @@ -71,7 +71,7 @@ The version of the Zeebe Gateway. lastCompletedChangeId: string; ``` -Defined in: [gen/types.gen.ts:1291](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1291) +Defined in: [gen/types.gen.ts:1322](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1322) ID of the last completed change @@ -83,7 +83,7 @@ ID of the last completed change partitionsCount: number; ``` -Defined in: [gen/types.gen.ts:1279](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1279) +Defined in: [gen/types.gen.ts:1310](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1310) The number of partitions are spread across the cluster. @@ -95,6 +95,6 @@ The number of partitions are spread across the cluster. replicationFactor: number; ``` -Defined in: [gen/types.gen.ts:1283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1283) +Defined in: [gen/types.gen.ts:1314](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1314) The configured replication factor for this cluster. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupData.md index 6b51845d0f7..c1c055ac0a6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupData.md @@ -11,7 +11,7 @@ mdx: type UnassignClientFromGroupData = object; ``` -Defined in: [gen/types.gen.ts:10911](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10911) +Defined in: [gen/types.gen.ts:11095](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11095) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10911](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:10912](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10912) +Defined in: [gen/types.gen.ts:11096](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11096) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10912](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10913](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10913) +Defined in: [gen/types.gen.ts:11097](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11097) #### clientId @@ -57,7 +57,7 @@ The group ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:10923](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10923) +Defined in: [gen/types.gen.ts:11107](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11107) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:10923](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/clients/{clientId}"; ``` -Defined in: [gen/types.gen.ts:10924](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10924) +Defined in: [gen/types.gen.ts:11108](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11108) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupError.md index 69c9eb24b08..abe71a49e19 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupError.md @@ -12,4 +12,4 @@ type UnassignClientFromGroupError = UnassignClientFromGroupErrors[keyof UnassignClientFromGroupErrors]; ``` -Defined in: [gen/types.gen.ts:10951](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10951) +Defined in: [gen/types.gen.ts:11135](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11135) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupErrors.md index dfda1d708d8..53c07193f1e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignClientFromGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:10927](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10927) +Defined in: [gen/types.gen.ts:11111](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11111) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10927](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10931](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10931) +Defined in: [gen/types.gen.ts:11115](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11115) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10935](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10935) +Defined in: [gen/types.gen.ts:11119](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11119) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10939](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10939) +Defined in: [gen/types.gen.ts:11123](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11123) The group with the given ID was not found, or the client is not assigned to this group. @@ -57,7 +57,7 @@ The group with the given ID was not found, or the client is not assigned to this 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10943](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10943) +Defined in: [gen/types.gen.ts:11127](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11127) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10948](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10948) +Defined in: [gen/types.gen.ts:11132](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11132) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupResponse.md index 4dc3b7ea44a..bae89ca8277 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupResponse.md @@ -12,4 +12,4 @@ type UnassignClientFromGroupResponse = UnassignClientFromGroupResponses[keyof UnassignClientFromGroupResponses]; ``` -Defined in: [gen/types.gen.ts:10960](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10960) +Defined in: [gen/types.gen.ts:11144](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11144) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupResponses.md index bc5036c5f3a..a89e6bd0bfc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromGroupResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignClientFromGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:10953](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10953) +Defined in: [gen/types.gen.ts:11137](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11137) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10953](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:10957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10957) +Defined in: [gen/types.gen.ts:11141](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11141) The client was unassigned successfully from the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantData.md index dd48bcf9da4..3c32099b9f4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantData.md @@ -11,7 +11,7 @@ mdx: type UnassignClientFromTenantData = object; ``` -Defined in: [gen/types.gen.ts:15803](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15803) +Defined in: [gen/types.gen.ts:15117](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15117) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15803](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15804](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15804) +Defined in: [gen/types.gen.ts:15118](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15118) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15804](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15805](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15805) +Defined in: [gen/types.gen.ts:15119](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15119) #### clientId @@ -57,7 +57,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:15815](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15815) +Defined in: [gen/types.gen.ts:15129](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15129) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:15815](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/clients/{clientId}"; ``` -Defined in: [gen/types.gen.ts:15816](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15816) +Defined in: [gen/types.gen.ts:15130](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15130) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantError.md index 1954a818bce..d69f0730550 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantError.md @@ -12,4 +12,4 @@ type UnassignClientFromTenantError = UnassignClientFromTenantErrors[keyof UnassignClientFromTenantErrors]; ``` -Defined in: [gen/types.gen.ts:15843](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15843) +Defined in: [gen/types.gen.ts:15157](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15157) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantErrors.md index 26c025d50b5..51fc0c272d8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignClientFromTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:15819](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15819) +Defined in: [gen/types.gen.ts:15133](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15133) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15819](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15823](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15823) +Defined in: [gen/types.gen.ts:15137](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15137) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15827](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15827) +Defined in: [gen/types.gen.ts:15141](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15141) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15831](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15831) +Defined in: [gen/types.gen.ts:15145](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15145) The tenant does not exist or the client was not assigned to it. @@ -57,7 +57,7 @@ The tenant does not exist or the client was not assigned to it. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15835](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15835) +Defined in: [gen/types.gen.ts:15149](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15149) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15840](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15840) +Defined in: [gen/types.gen.ts:15154](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15154) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantResponse.md index cb04dead6dc..7a38bff8a09 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantResponse.md @@ -12,4 +12,4 @@ type UnassignClientFromTenantResponse = UnassignClientFromTenantResponses[keyof UnassignClientFromTenantResponses]; ``` -Defined in: [gen/types.gen.ts:15852](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15852) +Defined in: [gen/types.gen.ts:15166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15166) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantResponses.md index 98bc314aca2..38096eb7c26 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignClientFromTenantResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignClientFromTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:15845](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15845) +Defined in: [gen/types.gen.ts:15159](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15159) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15845](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15849](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15849) +Defined in: [gen/types.gen.ts:15163](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15163) The client was successfully unassigned from the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantData.md index 1146c54b325..5c11deb578b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantData.md @@ -11,7 +11,7 @@ mdx: type UnassignGroupFromTenantData = object; ``` -Defined in: [gen/types.gen.ts:15937](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15937) +Defined in: [gen/types.gen.ts:15240](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15240) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15937](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15938](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15938) +Defined in: [gen/types.gen.ts:15241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15241) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15938](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15939](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15939) +Defined in: [gen/types.gen.ts:15242](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15242) #### groupId @@ -57,7 +57,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:15949](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15949) +Defined in: [gen/types.gen.ts:15252](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15252) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:15949](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/groups/{groupId}"; ``` -Defined in: [gen/types.gen.ts:15950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15950) +Defined in: [gen/types.gen.ts:15253](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15253) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantError.md index d2658bbfb7b..2444bfe4519 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantError.md @@ -12,4 +12,4 @@ type UnassignGroupFromTenantError = UnassignGroupFromTenantErrors[keyof UnassignGroupFromTenantErrors]; ``` -Defined in: [gen/types.gen.ts:15977](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15977) +Defined in: [gen/types.gen.ts:15280](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15280) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantErrors.md index 6e70f357e58..61cb74010ff 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignGroupFromTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:15953](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15953) +Defined in: [gen/types.gen.ts:15256](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15256) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15953](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15957) +Defined in: [gen/types.gen.ts:15260](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15260) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15961](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15961) +Defined in: [gen/types.gen.ts:15264](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15264) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15965](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15965) +Defined in: [gen/types.gen.ts:15268](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15268) Not found. The tenant or group was not found. @@ -57,7 +57,7 @@ Not found. The tenant or group was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15969](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15969) +Defined in: [gen/types.gen.ts:15272](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15272) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15974](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15974) +Defined in: [gen/types.gen.ts:15277](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15277) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantResponse.md index bad11c2c1cb..c917c763308 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantResponse.md @@ -12,4 +12,4 @@ type UnassignGroupFromTenantResponse = UnassignGroupFromTenantResponses[keyof UnassignGroupFromTenantResponses]; ``` -Defined in: [gen/types.gen.ts:15986](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15986) +Defined in: [gen/types.gen.ts:15289](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15289) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantResponses.md index b85f066e485..ce90ea661d5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignGroupFromTenantResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignGroupFromTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:15979](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15979) +Defined in: [gen/types.gen.ts:15282](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15282) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15979](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15983](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15983) +Defined in: [gen/types.gen.ts:15286](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15286) The group was successfully unassigned from the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupData.md index 1001967457d..05cec955a8b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupData.md @@ -11,7 +11,7 @@ mdx: type UnassignMappingRuleFromGroupData = object; ``` -Defined in: [gen/types.gen.ts:11063](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11063) +Defined in: [gen/types.gen.ts:11252](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11252) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11063](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:11064](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11064) +Defined in: [gen/types.gen.ts:11253](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11253) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11064](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11065](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11065) +Defined in: [gen/types.gen.ts:11254](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11254) #### groupId @@ -57,7 +57,7 @@ The mapping rule ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:11075](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11075) +Defined in: [gen/types.gen.ts:11264](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11264) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:11075](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/mapping-rules/{mappingRuleId}"; ``` -Defined in: [gen/types.gen.ts:11076](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11076) +Defined in: [gen/types.gen.ts:11265](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11265) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupError.md index c2d2ea79890..c0a76ee5ece 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupError.md @@ -12,4 +12,4 @@ type UnassignMappingRuleFromGroupError = UnassignMappingRuleFromGroupErrors[keyof UnassignMappingRuleFromGroupErrors]; ``` -Defined in: [gen/types.gen.ts:11103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11103) +Defined in: [gen/types.gen.ts:11292](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11292) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupErrors.md index 0d184b44dc4..bd4aeb3346a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignMappingRuleFromGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:11079](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11079) +Defined in: [gen/types.gen.ts:11268](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11268) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11079](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11083](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11083) +Defined in: [gen/types.gen.ts:11272](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11272) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11087](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11087) +Defined in: [gen/types.gen.ts:11276](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11276) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11091](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11091) +Defined in: [gen/types.gen.ts:11280](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11280) The group or mapping rule with the given ID was not found, or the mapping rule is not assigned to this group. @@ -57,7 +57,7 @@ The group or mapping rule with the given ID was not found, or the mapping rule i 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11095](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11095) +Defined in: [gen/types.gen.ts:11284](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11284) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11100](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11100) +Defined in: [gen/types.gen.ts:11289](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11289) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupResponse.md index 716d068049d..c795ba37d38 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupResponse.md @@ -12,4 +12,4 @@ type UnassignMappingRuleFromGroupResponse = UnassignMappingRuleFromGroupResponses[keyof UnassignMappingRuleFromGroupResponses]; ``` -Defined in: [gen/types.gen.ts:11112](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11112) +Defined in: [gen/types.gen.ts:11301](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11301) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupResponses.md index b859861b097..f8096612819 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromGroupResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignMappingRuleFromGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:11105](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11105) +Defined in: [gen/types.gen.ts:11294](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11294) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:11105](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:11109](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11109) +Defined in: [gen/types.gen.ts:11298](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11298) The mapping rule was unassigned successfully from the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantData.md index 7e4080de21d..a011d22beb0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantData.md @@ -11,7 +11,7 @@ mdx: type UnassignMappingRuleFromTenantData = object; ``` -Defined in: [gen/types.gen.ts:16060](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16060) +Defined in: [gen/types.gen.ts:15368](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15368) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16060](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16061](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16061) +Defined in: [gen/types.gen.ts:15369](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15369) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16061](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16062](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16062) +Defined in: [gen/types.gen.ts:15370](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15370) #### mappingRuleId @@ -57,7 +57,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:16072](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16072) +Defined in: [gen/types.gen.ts:15380](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15380) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:16072](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/mapping-rules/{mappingRuleId}"; ``` -Defined in: [gen/types.gen.ts:16073](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16073) +Defined in: [gen/types.gen.ts:15381](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15381) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantError.md index f7b81be89d5..bc21cfc07b5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantError.md @@ -12,4 +12,4 @@ type UnassignMappingRuleFromTenantError = UnassignMappingRuleFromTenantErrors[keyof UnassignMappingRuleFromTenantErrors]; ``` -Defined in: [gen/types.gen.ts:16100](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16100) +Defined in: [gen/types.gen.ts:15408](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15408) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantErrors.md index 0259f58481f..ecf5b833e86 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignMappingRuleFromTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:16076](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16076) +Defined in: [gen/types.gen.ts:15384](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15384) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16076](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16080](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16080) +Defined in: [gen/types.gen.ts:15388](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15388) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16084](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16084) +Defined in: [gen/types.gen.ts:15392](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15392) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16088](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16088) +Defined in: [gen/types.gen.ts:15396](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15396) Not found. The tenant or mapping rule was not found. @@ -57,7 +57,7 @@ Not found. The tenant or mapping rule was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16092](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16092) +Defined in: [gen/types.gen.ts:15400](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15400) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16097](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16097) +Defined in: [gen/types.gen.ts:15405](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15405) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantResponse.md index a7f6473649c..c02fb1d9a6e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantResponse.md @@ -12,4 +12,4 @@ type UnassignMappingRuleFromTenantResponse = UnassignMappingRuleFromTenantResponses[keyof UnassignMappingRuleFromTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16109](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16109) +Defined in: [gen/types.gen.ts:15417](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15417) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantResponses.md index adf46d23698..8a4f78f0906 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignMappingRuleFromTenantResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignMappingRuleFromTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16102](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16102) +Defined in: [gen/types.gen.ts:15410](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15410) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16102](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:16106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16106) +Defined in: [gen/types.gen.ts:15414](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15414) The mapping rule was successfully unassigned from the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientData.md index 0d38ed3d835..b51c343ce85 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientData.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromClientData = object; ``` -Defined in: [gen/types.gen.ts:14789](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14789) +Defined in: [gen/types.gen.ts:14081](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14081) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14789](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14790](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14790) +Defined in: [gen/types.gen.ts:14082](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14082) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14790](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14791](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14791) +Defined in: [gen/types.gen.ts:14083](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14083) #### clientId @@ -57,7 +57,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:14801](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14801) +Defined in: [gen/types.gen.ts:14093](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14093) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:14801](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/clients/{clientId}"; ``` -Defined in: [gen/types.gen.ts:14802](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14802) +Defined in: [gen/types.gen.ts:14094](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14094) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientError.md index c2b24ede648..4d7dc0ede58 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientError.md @@ -12,4 +12,4 @@ type UnassignRoleFromClientError = UnassignRoleFromClientErrors[keyof UnassignRoleFromClientErrors]; ``` -Defined in: [gen/types.gen.ts:14829](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14829) +Defined in: [gen/types.gen.ts:14121](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14121) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientErrors.md index caded7df879..936addb238a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromClientErrors = object; ``` -Defined in: [gen/types.gen.ts:14805](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14805) +Defined in: [gen/types.gen.ts:14097](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14097) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14805](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14809](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14809) +Defined in: [gen/types.gen.ts:14101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14101) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14813](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14813) +Defined in: [gen/types.gen.ts:14105](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14105) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14817](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14817) +Defined in: [gen/types.gen.ts:14109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14109) The role or client with the given ID or username was not found. @@ -57,7 +57,7 @@ The role or client with the given ID or username was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14821](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14821) +Defined in: [gen/types.gen.ts:14113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14113) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14826](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14826) +Defined in: [gen/types.gen.ts:14118](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14118) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientResponse.md index 9b5b6c3ccb7..67df8520ddb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientResponse.md @@ -12,4 +12,4 @@ type UnassignRoleFromClientResponse = UnassignRoleFromClientResponses[keyof UnassignRoleFromClientResponses]; ``` -Defined in: [gen/types.gen.ts:14838](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14838) +Defined in: [gen/types.gen.ts:14130](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14130) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientResponses.md index 5800aa2f550..a08c84f9d37 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromClientResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromClientResponses = object; ``` -Defined in: [gen/types.gen.ts:14831](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14831) +Defined in: [gen/types.gen.ts:14123](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14123) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14831](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:14835](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14835) +Defined in: [gen/types.gen.ts:14127](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14127) The role was unassigned successfully from the client. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupData.md index 2ef9f6bb01e..7ee9cb8375b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupData.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromGroupData = object; ``` -Defined in: [gen/types.gen.ts:14952](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14952) +Defined in: [gen/types.gen.ts:14233](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14233) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14952](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:14953](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14953) +Defined in: [gen/types.gen.ts:14234](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14234) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14953](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14954](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14954) +Defined in: [gen/types.gen.ts:14235](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14235) #### groupId @@ -57,7 +57,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:14964](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14964) +Defined in: [gen/types.gen.ts:14245](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14245) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:14964](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/groups/{groupId}"; ``` -Defined in: [gen/types.gen.ts:14965](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14965) +Defined in: [gen/types.gen.ts:14246](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14246) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupError.md index 35a2f2524b2..76c0d6bbed8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupError.md @@ -12,4 +12,4 @@ type UnassignRoleFromGroupError = UnassignRoleFromGroupErrors[keyof UnassignRoleFromGroupErrors]; ``` -Defined in: [gen/types.gen.ts:14992](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14992) +Defined in: [gen/types.gen.ts:14273](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14273) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupErrors.md index 70fc08dc3c1..bf7f2772102 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:14968](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14968) +Defined in: [gen/types.gen.ts:14249](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14249) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14968](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14972](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14972) +Defined in: [gen/types.gen.ts:14253](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14253) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14976](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14976) +Defined in: [gen/types.gen.ts:14257](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14257) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14980](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14980) +Defined in: [gen/types.gen.ts:14261](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14261) The role or group with the given ID was not found. @@ -57,7 +57,7 @@ The role or group with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14984](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14984) +Defined in: [gen/types.gen.ts:14265](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14265) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14989](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14989) +Defined in: [gen/types.gen.ts:14270](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14270) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupResponse.md index 119d64f06d6..3e760d7f5da 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupResponse.md @@ -12,4 +12,4 @@ type UnassignRoleFromGroupResponse = UnassignRoleFromGroupResponses[keyof UnassignRoleFromGroupResponses]; ``` -Defined in: [gen/types.gen.ts:15001](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15001) +Defined in: [gen/types.gen.ts:14282](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14282) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupResponses.md index 5104ae0086a..7f9472fade8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromGroupResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:14994](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14994) +Defined in: [gen/types.gen.ts:14275](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14275) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14994](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:14998](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14998) +Defined in: [gen/types.gen.ts:14279](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14279) The role was unassigned successfully from the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleData.md index 68b0ce026b8..ae2c6def6a6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleData.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromMappingRuleData = object; ``` -Defined in: [gen/types.gen.ts:15104](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15104) +Defined in: [gen/types.gen.ts:14390](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14390) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15104](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15105](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15105) +Defined in: [gen/types.gen.ts:14391](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14391) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15105](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15106](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15106) +Defined in: [gen/types.gen.ts:14392](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14392) #### mappingRuleId @@ -57,7 +57,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:15116](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15116) +Defined in: [gen/types.gen.ts:14402](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14402) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:15116](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/mapping-rules/{mappingRuleId}"; ``` -Defined in: [gen/types.gen.ts:15117](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15117) +Defined in: [gen/types.gen.ts:14403](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14403) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleError.md index b5d864d26be..72edad926d1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleError.md @@ -12,4 +12,4 @@ type UnassignRoleFromMappingRuleError = UnassignRoleFromMappingRuleErrors[keyof UnassignRoleFromMappingRuleErrors]; ``` -Defined in: [gen/types.gen.ts:15144](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15144) +Defined in: [gen/types.gen.ts:14430](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14430) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleErrors.md index 456690f6cae..17e5118ba80 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromMappingRuleErrors = object; ``` -Defined in: [gen/types.gen.ts:15120](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15120) +Defined in: [gen/types.gen.ts:14406](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14406) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15120](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15124](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15124) +Defined in: [gen/types.gen.ts:14410](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14410) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15128](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15128) +Defined in: [gen/types.gen.ts:14414](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14414) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15132](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15132) +Defined in: [gen/types.gen.ts:14418](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14418) The role or mapping rule with the given ID was not found. @@ -57,7 +57,7 @@ The role or mapping rule with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15136](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15136) +Defined in: [gen/types.gen.ts:14422](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14422) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15141](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15141) +Defined in: [gen/types.gen.ts:14427](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14427) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleResponse.md index 9c7a99fae1e..67dfe2b68c0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleResponse.md @@ -12,4 +12,4 @@ type UnassignRoleFromMappingRuleResponse = UnassignRoleFromMappingRuleResponses[keyof UnassignRoleFromMappingRuleResponses]; ``` -Defined in: [gen/types.gen.ts:15153](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15153) +Defined in: [gen/types.gen.ts:14439](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14439) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleResponses.md index 4f93ccfee97..c0b1a2ecfe0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromMappingRuleResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromMappingRuleResponses = object; ``` -Defined in: [gen/types.gen.ts:15146](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15146) +Defined in: [gen/types.gen.ts:14432](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14432) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15146](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15150](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15150) +Defined in: [gen/types.gen.ts:14436](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14436) The role was unassigned successfully from the mapping rule. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantData.md index dad9e09f493..3247ef01ce5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantData.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromTenantData = object; ``` -Defined in: [gen/types.gen.ts:16183](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16183) +Defined in: [gen/types.gen.ts:15496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15496) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16183](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16184](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16184) +Defined in: [gen/types.gen.ts:15497](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15497) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16184](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16185](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16185) +Defined in: [gen/types.gen.ts:15498](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15498) #### roleId @@ -57,7 +57,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:16195](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16195) +Defined in: [gen/types.gen.ts:15508](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15508) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:16195](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/roles/{roleId}"; ``` -Defined in: [gen/types.gen.ts:16196](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16196) +Defined in: [gen/types.gen.ts:15509](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15509) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantError.md index 4fc17788e73..fc458cee3f6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantError.md @@ -12,4 +12,4 @@ type UnassignRoleFromTenantError = UnassignRoleFromTenantErrors[keyof UnassignRoleFromTenantErrors]; ``` -Defined in: [gen/types.gen.ts:16223](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16223) +Defined in: [gen/types.gen.ts:15536](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15536) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantErrors.md index 42757e3a465..15e16903e22 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:16199](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16199) +Defined in: [gen/types.gen.ts:15512](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15512) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16199](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16203](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16203) +Defined in: [gen/types.gen.ts:15516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15516) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16207](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16207) +Defined in: [gen/types.gen.ts:15520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15520) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16211](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16211) +Defined in: [gen/types.gen.ts:15524](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15524) Not found. The tenant or role was not found. @@ -57,7 +57,7 @@ Not found. The tenant or role was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16215](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16215) +Defined in: [gen/types.gen.ts:15528](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15528) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16220](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16220) +Defined in: [gen/types.gen.ts:15533](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15533) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantResponse.md index 275ae22aa04..902be150648 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantResponse.md @@ -12,4 +12,4 @@ type UnassignRoleFromTenantResponse = UnassignRoleFromTenantResponses[keyof UnassignRoleFromTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16232](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16232) +Defined in: [gen/types.gen.ts:15545](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15545) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantResponses.md index 5a47880547b..4db5c2dc565 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromTenantResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16225](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16225) +Defined in: [gen/types.gen.ts:15538](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15538) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16225](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:16229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16229) +Defined in: [gen/types.gen.ts:15542](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15542) The role was successfully unassigned from the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserData.md index d121d51c39a..66e92cee8cb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserData.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromUserData = object; ``` -Defined in: [gen/types.gen.ts:15267](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15267) +Defined in: [gen/types.gen.ts:14560](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14560) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15267](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:15268](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15268) +Defined in: [gen/types.gen.ts:14561](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14561) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15268](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15269](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15269) +Defined in: [gen/types.gen.ts:14562](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14562) #### roleId @@ -57,7 +57,7 @@ The user username. optional query: never; ``` -Defined in: [gen/types.gen.ts:15279](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15279) +Defined in: [gen/types.gen.ts:14572](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14572) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:15279](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}/users/{username}"; ``` -Defined in: [gen/types.gen.ts:15280](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15280) +Defined in: [gen/types.gen.ts:14573](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14573) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserError.md index 856194d8988..900e45849b2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserError.md @@ -12,4 +12,4 @@ type UnassignRoleFromUserError = UnassignRoleFromUserErrors[keyof UnassignRoleFromUserErrors]; ``` -Defined in: [gen/types.gen.ts:15307](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15307) +Defined in: [gen/types.gen.ts:14600](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14600) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserErrors.md index 195a72ca032..8198b84c066 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromUserErrors = object; ``` -Defined in: [gen/types.gen.ts:15283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15283) +Defined in: [gen/types.gen.ts:14576](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14576) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15283](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15287](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15287) +Defined in: [gen/types.gen.ts:14580](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14580) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15291](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15291) +Defined in: [gen/types.gen.ts:14584](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14584) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15295](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15295) +Defined in: [gen/types.gen.ts:14588](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14588) The role or user with the given ID or username was not found. @@ -57,7 +57,7 @@ The role or user with the given ID or username was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15299](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15299) +Defined in: [gen/types.gen.ts:14592](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14592) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15304](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15304) +Defined in: [gen/types.gen.ts:14597](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14597) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserResponse.md index 9ef7318aa7e..b2cdf33d5a9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserResponse.md @@ -12,4 +12,4 @@ type UnassignRoleFromUserResponse = UnassignRoleFromUserResponses[keyof UnassignRoleFromUserResponses]; ``` -Defined in: [gen/types.gen.ts:15316](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15316) +Defined in: [gen/types.gen.ts:14609](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14609) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserResponses.md index 85c482c37bb..2745c0b32df 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignRoleFromUserResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignRoleFromUserResponses = object; ``` -Defined in: [gen/types.gen.ts:15309](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15309) +Defined in: [gen/types.gen.ts:14602](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14602) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15309](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:15313](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15313) +Defined in: [gen/types.gen.ts:14606](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14606) The role was unassigned successfully from the user. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupData.md index 7adbc0da245..c9ff2d17dc0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupData.md @@ -11,7 +11,7 @@ mdx: type UnassignUserFromGroupData = object; ``` -Defined in: [gen/types.gen.ts:11266](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11266) +Defined in: [gen/types.gen.ts:11473](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11473) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11266](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:11267](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11267) +Defined in: [gen/types.gen.ts:11474](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11474) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11267](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11268](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11268) +Defined in: [gen/types.gen.ts:11475](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11475) #### groupId @@ -57,7 +57,7 @@ The user username. optional query: never; ``` -Defined in: [gen/types.gen.ts:11278](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11278) +Defined in: [gen/types.gen.ts:11485](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11485) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:11278](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}/users/{username}"; ``` -Defined in: [gen/types.gen.ts:11279](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11279) +Defined in: [gen/types.gen.ts:11486](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11486) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupError.md index 000f707b3b0..9fb4a3e9511 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupError.md @@ -12,4 +12,4 @@ type UnassignUserFromGroupError = UnassignUserFromGroupErrors[keyof UnassignUserFromGroupErrors]; ``` -Defined in: [gen/types.gen.ts:11306](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11306) +Defined in: [gen/types.gen.ts:11513](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11513) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupErrors.md index c885c60f5fc..93184b0a178 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignUserFromGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:11282](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11282) +Defined in: [gen/types.gen.ts:11489](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11489) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11282](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11286](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11286) +Defined in: [gen/types.gen.ts:11493](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11493) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11290](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11290) +Defined in: [gen/types.gen.ts:11497](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11497) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11294](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11294) +Defined in: [gen/types.gen.ts:11501](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11501) The group or user with the given ID was not found, or the user is not assigned to this group. @@ -57,7 +57,7 @@ The group or user with the given ID was not found, or the user is not assigned t 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11298](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11298) +Defined in: [gen/types.gen.ts:11505](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11505) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11303](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11303) +Defined in: [gen/types.gen.ts:11510](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11510) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupResponse.md index 0bda6bb0a01..b495b917bee 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupResponse.md @@ -12,4 +12,4 @@ type UnassignUserFromGroupResponse = UnassignUserFromGroupResponses[keyof UnassignUserFromGroupResponses]; ``` -Defined in: [gen/types.gen.ts:11315](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11315) +Defined in: [gen/types.gen.ts:11522](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11522) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupResponses.md index 49950ad706e..cbb16847ffe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromGroupResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignUserFromGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:11308](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11308) +Defined in: [gen/types.gen.ts:11515](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11515) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:11308](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:11312](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11312) +Defined in: [gen/types.gen.ts:11519](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11519) The user was unassigned successfully from the group. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantData.md index 2d2baf49af8..15f8307ec86 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantData.md @@ -11,7 +11,7 @@ mdx: type UnassignUserFromTenantData = object; ``` -Defined in: [gen/types.gen.ts:16317](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16317) +Defined in: [gen/types.gen.ts:15637](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15637) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16317](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:16318](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16318) +Defined in: [gen/types.gen.ts:15638](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15638) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16318](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16319) +Defined in: [gen/types.gen.ts:15639](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15639) #### tenantId @@ -57,7 +57,7 @@ The unique identifier of the user. optional query: never; ``` -Defined in: [gen/types.gen.ts:16329](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16329) +Defined in: [gen/types.gen.ts:15649](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15649) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:16329](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}/users/{username}"; ``` -Defined in: [gen/types.gen.ts:16330](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16330) +Defined in: [gen/types.gen.ts:15650](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15650) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantError.md index c102dac60f9..591d2346ed5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantError.md @@ -12,4 +12,4 @@ type UnassignUserFromTenantError = UnassignUserFromTenantErrors[keyof UnassignUserFromTenantErrors]; ``` -Defined in: [gen/types.gen.ts:16357](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16357) +Defined in: [gen/types.gen.ts:15677](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15677) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantErrors.md index c66ac14d8e2..284d87782bc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignUserFromTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:16333](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16333) +Defined in: [gen/types.gen.ts:15653](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15653) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16333](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16337](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16337) +Defined in: [gen/types.gen.ts:15657](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15657) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16341](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16341) +Defined in: [gen/types.gen.ts:15661](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15661) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16345](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16345) +Defined in: [gen/types.gen.ts:15665](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15665) Not found. The tenant or user was not found. @@ -57,7 +57,7 @@ Not found. The tenant or user was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16349](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16349) +Defined in: [gen/types.gen.ts:15669](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15669) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16354](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16354) +Defined in: [gen/types.gen.ts:15674](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15674) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantResponse.md index bae7dcc7926..cc412dc4de5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantResponse.md @@ -12,4 +12,4 @@ type UnassignUserFromTenantResponse = UnassignUserFromTenantResponses[keyof UnassignUserFromTenantResponses]; ``` -Defined in: [gen/types.gen.ts:16366](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16366) +Defined in: [gen/types.gen.ts:15686](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15686) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantResponses.md index fd5fd9ab42f..bdb49e332a1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserFromTenantResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignUserFromTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:16359](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16359) +Defined in: [gen/types.gen.ts:15679](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15679) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:16359](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:16363](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16363) +Defined in: [gen/types.gen.ts:15683](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15683) The user was successfully unassigned from the tenant. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskData.md index 104ace30f30..36046bc001e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskData.md @@ -11,7 +11,7 @@ mdx: type UnassignUserTaskData = object; ``` -Defined in: [gen/types.gen.ts:17079](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17079) +Defined in: [gen/types.gen.ts:16155](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16155) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17079](https://github.com/camunda/orchestration-cl optional body: never; ``` -Defined in: [gen/types.gen.ts:17080](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17080) +Defined in: [gen/types.gen.ts:16156](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16156) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:17080](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:17081](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17081) +Defined in: [gen/types.gen.ts:16157](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16157) #### userTaskKey @@ -49,7 +49,7 @@ The key of the user task. optional query: never; ``` -Defined in: [gen/types.gen.ts:17087](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17087) +Defined in: [gen/types.gen.ts:16163](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16163) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:17087](https://github.com/camunda/orchestration-cl url: "/user-tasks/{userTaskKey}/assignee"; ``` -Defined in: [gen/types.gen.ts:17088](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17088) +Defined in: [gen/types.gen.ts:16164](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16164) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskError.md index 952121000c1..8c75fe5e292 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskError.md @@ -12,4 +12,4 @@ type UnassignUserTaskError = UnassignUserTaskErrors[keyof UnassignUserTaskErrors]; ``` -Defined in: [gen/types.gen.ts:17116](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17116) +Defined in: [gen/types.gen.ts:16198](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16198) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskErrors.md index db83b66a54e..c8f019cbf8f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskErrors.md @@ -11,7 +11,7 @@ mdx: type UnassignUserTaskErrors = object; ``` -Defined in: [gen/types.gen.ts:17091](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17091) +Defined in: [gen/types.gen.ts:16167](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16167) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17091](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17095](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17095) +Defined in: [gen/types.gen.ts:16171](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16171) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17099](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17099) +Defined in: [gen/types.gen.ts:16175](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16175) The user task with the given key was not found. @@ -45,7 +45,7 @@ The user task with the given key was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17104](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17104) +Defined in: [gen/types.gen.ts:16180](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16180) The user task with the given key is in the wrong state currently. More details are provided in the response body. @@ -57,7 +57,7 @@ The user task with the given key is in the wrong state currently. More details a 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17108](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17108) +Defined in: [gen/types.gen.ts:16184](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16184) An internal error occurred while processing the request. @@ -69,6 +69,19 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17113](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17113) +Defined in: [gen/types.gen.ts:16189](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16189) 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 . + +--- + +### 504 + +```ts +504: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:16195](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16195) + +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 diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskResponse.md index 5502aad29a1..db3ce2c491d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskResponse.md @@ -12,4 +12,4 @@ type UnassignUserTaskResponse = UnassignUserTaskResponses[keyof UnassignUserTaskResponses]; ``` -Defined in: [gen/types.gen.ts:17125](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17125) +Defined in: [gen/types.gen.ts:16207](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16207) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskResponses.md index 36068624115..f48d60df779 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UnassignUserTaskResponses.md @@ -11,7 +11,7 @@ mdx: type UnassignUserTaskResponses = object; ``` -Defined in: [gen/types.gen.ts:17118](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17118) +Defined in: [gen/types.gen.ts:16200](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16200) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:17118](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:17122](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17122) +Defined in: [gen/types.gen.ts:16204](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16204) The user task was unassigned successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationData.md index 81aa7b28dcc..2b65f2c21ae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationData.md @@ -11,7 +11,7 @@ mdx: type UpdateAuthorizationData = object; ``` -Defined in: [gen/types.gen.ts:8147](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8147) +Defined in: [gen/types.gen.ts:8768](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8768) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8147](https://github.com/camunda/orchestration-clu body: AuthorizationRequest; ``` -Defined in: [gen/types.gen.ts:8148](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8148) +Defined in: [gen/types.gen.ts:8769](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8769) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8148](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8149](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8149) +Defined in: [gen/types.gen.ts:8770](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8770) #### authorizationKey @@ -49,7 +49,7 @@ The key of the authorization to delete. optional query: never; ``` -Defined in: [gen/types.gen.ts:8155](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8155) +Defined in: [gen/types.gen.ts:8776](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8776) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8155](https://github.com/camunda/orchestration-clu url: "/authorizations/{authorizationKey}"; ``` -Defined in: [gen/types.gen.ts:8156](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8156) +Defined in: [gen/types.gen.ts:8777](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8777) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationError.md index 96852b86231..9a309d3d7fd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationError.md @@ -12,4 +12,4 @@ type UpdateAuthorizationError = UpdateAuthorizationErrors[keyof UpdateAuthorizationErrors]; ``` -Defined in: [gen/types.gen.ts:8179](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8179) +Defined in: [gen/types.gen.ts:8800](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8800) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationErrors.md index 9b03faee2a0..1900cfa2347 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateAuthorizationErrors = object; ``` -Defined in: [gen/types.gen.ts:8159](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8159) +Defined in: [gen/types.gen.ts:8780](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8780) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8159](https://github.com/camunda/orchestration-clu 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8163](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8163) +Defined in: [gen/types.gen.ts:8784](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8784) The request lacks valid authentication credentials. @@ -33,7 +33,7 @@ The request lacks valid authentication credentials. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8167](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8167) +Defined in: [gen/types.gen.ts:8788](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8788) The authorization with the authorizationKey was not found. @@ -45,7 +45,7 @@ The authorization with the authorizationKey was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8171](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8171) +Defined in: [gen/types.gen.ts:8792](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8792) An internal error occurred while processing the request. @@ -57,6 +57,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8176](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8176) +Defined in: [gen/types.gen.ts:8797](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8797) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationResponse.md index bffdefebd41..201dd86c069 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationResponse.md @@ -12,4 +12,4 @@ type UpdateAuthorizationResponse = UpdateAuthorizationResponses[keyof UpdateAuthorizationResponses]; ``` -Defined in: [gen/types.gen.ts:8188](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8188) +Defined in: [gen/types.gen.ts:8809](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8809) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationResponses.md index 84781b710db..de9a3430df4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateAuthorizationResponses.md @@ -11,7 +11,7 @@ mdx: type UpdateAuthorizationResponses = object; ``` -Defined in: [gen/types.gen.ts:8181](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8181) +Defined in: [gen/types.gen.ts:8802](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8802) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8181](https://github.com/camunda/orchestration-clu 204: void; ``` -Defined in: [gen/types.gen.ts:8185](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8185) +Defined in: [gen/types.gen.ts:8806](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8806) The authorization was updated successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateClusterVariableRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateClusterVariableRequest.md index 2f26f2eec70..c7714a9d993 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateClusterVariableRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateClusterVariableRequest.md @@ -11,7 +11,7 @@ mdx: type UpdateClusterVariableRequest = object; ``` -Defined in: [gen/types.gen.ts:1126](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1126) +Defined in: [gen/types.gen.ts:1157](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1157) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:1126](https://github.com/camunda/orchestration-clu value: object; ``` -Defined in: [gen/types.gen.ts:1130](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L1130) +Defined in: [gen/types.gen.ts:1161](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L1161) The new value of the cluster variable. Can be any JSON object or primitive value. Will be serialized as a JSON string in responses. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableData.md index a0d1391b85c..77a90013b66 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableData.md @@ -11,7 +11,7 @@ mdx: type UpdateGlobalClusterVariableData = object; ``` -Defined in: [gen/types.gen.ts:8713](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8713) +Defined in: [gen/types.gen.ts:9236](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9236) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8713](https://github.com/camunda/orchestration-clu body: UpdateClusterVariableRequest; ``` -Defined in: [gen/types.gen.ts:8714](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8714) +Defined in: [gen/types.gen.ts:9237](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9237) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:8714](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:8715](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8715) +Defined in: [gen/types.gen.ts:9238](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9238) #### name @@ -49,7 +49,7 @@ The name of the cluster variable optional query: never; ``` -Defined in: [gen/types.gen.ts:8721](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8721) +Defined in: [gen/types.gen.ts:9244](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9244) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:8721](https://github.com/camunda/orchestration-clu url: "/cluster-variables/global/{name}"; ``` -Defined in: [gen/types.gen.ts:8722](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8722) +Defined in: [gen/types.gen.ts:9245](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9245) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableError.md index 4429d0392f8..d574446528a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableError.md @@ -12,4 +12,4 @@ type UpdateGlobalClusterVariableError = UpdateGlobalClusterVariableErrors[keyof UpdateGlobalClusterVariableErrors]; ``` -Defined in: [gen/types.gen.ts:8748](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8748) +Defined in: [gen/types.gen.ts:9271](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9271) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableErrors.md index 9716dc00476..12863548602 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateGlobalClusterVariableErrors = object; ``` -Defined in: [gen/types.gen.ts:8725](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8725) +Defined in: [gen/types.gen.ts:9248](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9248) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:8725](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8729](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8729) +Defined in: [gen/types.gen.ts:9252](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9252) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8733](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8733) +Defined in: [gen/types.gen.ts:9256](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9256) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8737](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8737) +Defined in: [gen/types.gen.ts:9260](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9260) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8741](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8741) +Defined in: [gen/types.gen.ts:9264](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9264) Cluster variable not found @@ -69,6 +69,6 @@ Cluster variable not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:8745](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8745) +Defined in: [gen/types.gen.ts:9268](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9268) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableResponse.md index 8b801eb44e5..849a82dd7de 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableResponse.md @@ -12,4 +12,4 @@ type UpdateGlobalClusterVariableResponse = UpdateGlobalClusterVariableResponses[keyof UpdateGlobalClusterVariableResponses]; ``` -Defined in: [gen/types.gen.ts:8757](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8757) +Defined in: [gen/types.gen.ts:9280](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9280) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableResponses.md index 15d3ec6955f..06d1620e86c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalClusterVariableResponses.md @@ -11,7 +11,7 @@ mdx: type UpdateGlobalClusterVariableResponses = object; ``` -Defined in: [gen/types.gen.ts:8750](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8750) +Defined in: [gen/types.gen.ts:9273](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9273) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:8750](https://github.com/camunda/orchestration-clu 200: ClusterVariableResult; ``` -Defined in: [gen/types.gen.ts:8754](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L8754) +Defined in: [gen/types.gen.ts:9277](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9277) Cluster variable updated successfully diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerData.md new file mode 100644 index 00000000000..3cd34e21604 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerData.md @@ -0,0 +1,62 @@ +--- +title: "Type Alias: UpdateGlobalTaskListenerData" +sidebar_label: "UpdateGlobalTaskListenerData" +mdx: + format: md +--- + +# Type Alias: UpdateGlobalTaskListenerData + +```ts +type UpdateGlobalTaskListenerData = object; +``` + +Defined in: [gen/types.gen.ts:10729](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10729) + +## Properties + +### body + +```ts +body: UpdateGlobalTaskListenerRequest; +``` + +Defined in: [gen/types.gen.ts:10730](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10730) + +--- + +### path + +```ts +path: object; +``` + +Defined in: [gen/types.gen.ts:10731](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10731) + +#### id + +```ts +id: GlobalListenerId; +``` + +The id of the global user task listener to update. + +--- + +### query? + +```ts +optional query: never; +``` + +Defined in: [gen/types.gen.ts:10737](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10737) + +--- + +### url + +```ts +url: "/global-task-listeners/{id}"; +``` + +Defined in: [gen/types.gen.ts:10738](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10738) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerError.md new file mode 100644 index 00000000000..92cbb2d8f32 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerError.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: UpdateGlobalTaskListenerError" +sidebar_label: "UpdateGlobalTaskListenerError" +mdx: + format: md +--- + +# Type Alias: UpdateGlobalTaskListenerError + +```ts +type UpdateGlobalTaskListenerError = + UpdateGlobalTaskListenerErrors[keyof UpdateGlobalTaskListenerErrors]; +``` + +Defined in: [gen/types.gen.ts:10769](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10769) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerErrors.md new file mode 100644 index 00000000000..8ee93e25072 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerErrors.md @@ -0,0 +1,86 @@ +--- +title: "Type Alias: UpdateGlobalTaskListenerErrors" +sidebar_label: "UpdateGlobalTaskListenerErrors" +mdx: + format: md +--- + +# Type Alias: UpdateGlobalTaskListenerErrors + +```ts +type UpdateGlobalTaskListenerErrors = object; +``` + +Defined in: [gen/types.gen.ts:10741](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10741) + +## Properties + +### 400 + +```ts +400: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10745](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10745) + +The provided data is not valid. + +--- + +### 401 + +```ts +401: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10749](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10749) + +The request lacks valid authentication credentials. + +--- + +### 403 + +```ts +403: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10753](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10753) + +Forbidden. The request is not allowed. + +--- + +### 404 + +```ts +404: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10757) + +The global user task listener was not found. + +--- + +### 500 + +```ts +500: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10761](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10761) + +An internal error occurred while processing the request. + +--- + +### 503 + +```ts +503: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:10766](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10766) + +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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerRequest.md new file mode 100644 index 00000000000..ce5949c7685 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerRequest.md @@ -0,0 +1,14 @@ +--- +title: "Type Alias: UpdateGlobalTaskListenerRequest" +sidebar_label: "UpdateGlobalTaskListenerRequest" +mdx: + format: md +--- + +# Type Alias: UpdateGlobalTaskListenerRequest + +```ts +type UpdateGlobalTaskListenerRequest = GlobalTaskListenerBase; +``` + +Defined in: [gen/types.gen.ts:2983](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L2983) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerResponse.md new file mode 100644 index 00000000000..5035ae597f8 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerResponse.md @@ -0,0 +1,15 @@ +--- +title: "Type Alias: UpdateGlobalTaskListenerResponse" +sidebar_label: "UpdateGlobalTaskListenerResponse" +mdx: + format: md +--- + +# Type Alias: UpdateGlobalTaskListenerResponse + +```ts +type UpdateGlobalTaskListenerResponse = + UpdateGlobalTaskListenerResponses[keyof UpdateGlobalTaskListenerResponses]; +``` + +Defined in: [gen/types.gen.ts:10778](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10778) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerResponses.md new file mode 100644 index 00000000000..55097c81463 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGlobalTaskListenerResponses.md @@ -0,0 +1,26 @@ +--- +title: "Type Alias: UpdateGlobalTaskListenerResponses" +sidebar_label: "UpdateGlobalTaskListenerResponses" +mdx: + format: md +--- + +# Type Alias: UpdateGlobalTaskListenerResponses + +```ts +type UpdateGlobalTaskListenerResponses = object; +``` + +Defined in: [gen/types.gen.ts:10771](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10771) + +## Properties + +### 200 + +```ts +200: GlobalTaskListenerResult; +``` + +Defined in: [gen/types.gen.ts:10775](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10775) + +The global listener was updated successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupData.md index 88c148b803f..83072822454 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupData.md @@ -11,7 +11,7 @@ mdx: type UpdateGroupData = object; ``` -Defined in: [gen/types.gen.ts:10813](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10813) +Defined in: [gen/types.gen.ts:10981](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10981) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10813](https://github.com/camunda/orchestration-cl body: GroupUpdateRequest; ``` -Defined in: [gen/types.gen.ts:10814](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10814) +Defined in: [gen/types.gen.ts:10982](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10982) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:10814](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:10815](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10815) +Defined in: [gen/types.gen.ts:10983](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10983) #### groupId @@ -49,7 +49,7 @@ The group ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:10821](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10821) +Defined in: [gen/types.gen.ts:10989](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10989) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:10821](https://github.com/camunda/orchestration-cl url: "/groups/{groupId}"; ``` -Defined in: [gen/types.gen.ts:10822](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10822) +Defined in: [gen/types.gen.ts:10990](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10990) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupError.md index ff82536ce8c..80d32879bd5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupError.md @@ -11,4 +11,4 @@ mdx: type UpdateGroupError = UpdateGroupErrors[keyof UpdateGroupErrors]; ``` -Defined in: [gen/types.gen.ts:10849](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10849) +Defined in: [gen/types.gen.ts:11017](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11017) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupErrors.md index 8da03569679..e653bd4b1d6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateGroupErrors = object; ``` -Defined in: [gen/types.gen.ts:10825](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10825) +Defined in: [gen/types.gen.ts:10993](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10993) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:10825](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10829](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10829) +Defined in: [gen/types.gen.ts:10997](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L10997) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10833](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10833) +Defined in: [gen/types.gen.ts:11001](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11001) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10837](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10837) +Defined in: [gen/types.gen.ts:11005](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11005) The group with the given ID was not found. @@ -57,7 +57,7 @@ The group with the given ID was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10841](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10841) +Defined in: [gen/types.gen.ts:11009](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11009) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:10846](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10846) +Defined in: [gen/types.gen.ts:11014](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11014) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupResponse.md index 0d4b77cfdb4..8cb2ae0abc8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupResponse.md @@ -11,4 +11,4 @@ mdx: type UpdateGroupResponse = UpdateGroupResponses[keyof UpdateGroupResponses]; ``` -Defined in: [gen/types.gen.ts:10858](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10858) +Defined in: [gen/types.gen.ts:11026](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11026) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupResponses.md index 7ba872cf51a..7d25e4b6fa8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateGroupResponses.md @@ -11,7 +11,7 @@ mdx: type UpdateGroupResponses = object; ``` -Defined in: [gen/types.gen.ts:10851](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10851) +Defined in: [gen/types.gen.ts:11019](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11019) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:10851](https://github.com/camunda/orchestration-cl 200: GroupUpdateResult; ``` -Defined in: [gen/types.gen.ts:10855](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L10855) +Defined in: [gen/types.gen.ts:11023](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11023) The group was updated successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobData.md index ab9c878774c..d9068b87f48 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobData.md @@ -11,7 +11,7 @@ mdx: type UpdateJobData = object; ``` -Defined in: [gen/types.gen.ts:11938](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11938) +Defined in: [gen/types.gen.ts:11864](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11864) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11938](https://github.com/camunda/orchestration-cl body: JobUpdateRequest; ``` -Defined in: [gen/types.gen.ts:11939](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11939) +Defined in: [gen/types.gen.ts:11865](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11865) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:11939](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:11940](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11940) +Defined in: [gen/types.gen.ts:11866](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11866) #### jobKey @@ -49,7 +49,7 @@ The key of the job to update. optional query: never; ``` -Defined in: [gen/types.gen.ts:11946](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11946) +Defined in: [gen/types.gen.ts:11872](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11872) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:11946](https://github.com/camunda/orchestration-cl url: "/jobs/{jobKey}"; ``` -Defined in: [gen/types.gen.ts:11947](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11947) +Defined in: [gen/types.gen.ts:11873](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11873) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobError.md index 94708e27086..c7d08142b04 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobError.md @@ -11,4 +11,4 @@ mdx: type UpdateJobError = UpdateJobErrors[keyof UpdateJobErrors]; ``` -Defined in: [gen/types.gen.ts:11975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11975) +Defined in: [gen/types.gen.ts:11901](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11901) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobErrors.md index e171de9986b..9938b778481 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateJobErrors = object; ``` -Defined in: [gen/types.gen.ts:11950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11950) +Defined in: [gen/types.gen.ts:11876](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11876) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:11950](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11954](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11954) +Defined in: [gen/types.gen.ts:11880](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11880) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11958](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11958) +Defined in: [gen/types.gen.ts:11884](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11884) The job with the jobKey is not found. @@ -45,7 +45,7 @@ The job with the jobKey is not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11963](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11963) +Defined in: [gen/types.gen.ts:11889](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11889) The job with the given key is in the wrong state currently. More details are provided in the response body. @@ -57,7 +57,7 @@ The job with the given key is in the wrong state currently. More details are pro 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11967](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11967) +Defined in: [gen/types.gen.ts:11893](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11893) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:11972](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11972) +Defined in: [gen/types.gen.ts:11898](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11898) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobResponse.md index b7207bdd529..f94b9308edd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobResponse.md @@ -11,4 +11,4 @@ mdx: type UpdateJobResponse = UpdateJobResponses[keyof UpdateJobResponses]; ``` -Defined in: [gen/types.gen.ts:11984](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11984) +Defined in: [gen/types.gen.ts:11910](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11910) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobResponses.md index f40b61b4db9..6ae2a03dc6c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateJobResponses.md @@ -11,7 +11,7 @@ mdx: type UpdateJobResponses = object; ``` -Defined in: [gen/types.gen.ts:11977](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11977) +Defined in: [gen/types.gen.ts:11903](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11903) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:11977](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:11981](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L11981) +Defined in: [gen/types.gen.ts:11907](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L11907) The job was updated successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleData.md index 76b526164a0..fe277ae8a44 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleData.md @@ -11,17 +11,17 @@ mdx: type UpdateMappingRuleData = object; ``` -Defined in: [gen/types.gen.ts:12366](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12366) +Defined in: [gen/types.gen.ts:12445](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12445) ## Properties ### body? ```ts -optional body: MappingRuleCreateUpdateRequest; +optional body: MappingRuleUpdateRequest; ``` -Defined in: [gen/types.gen.ts:12367](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12367) +Defined in: [gen/types.gen.ts:12446](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12446) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:12367](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:12368](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12368) +Defined in: [gen/types.gen.ts:12447](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12447) #### mappingRuleId @@ -49,7 +49,7 @@ The ID of the mapping rule to update. optional query: never; ``` -Defined in: [gen/types.gen.ts:12374](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12374) +Defined in: [gen/types.gen.ts:12453](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12453) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:12374](https://github.com/camunda/orchestration-cl url: "/mapping-rules/{mappingRuleId}"; ``` -Defined in: [gen/types.gen.ts:12375](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12375) +Defined in: [gen/types.gen.ts:12454](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12454) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleError.md index c6320a6a663..e3e5ed51f4b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleError.md @@ -12,4 +12,4 @@ type UpdateMappingRuleError = UpdateMappingRuleErrors[keyof UpdateMappingRuleErrors]; ``` -Defined in: [gen/types.gen.ts:12404](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12404) +Defined in: [gen/types.gen.ts:12483](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12483) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleErrors.md index cd739dd19e1..032f43f149b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateMappingRuleErrors = object; ``` -Defined in: [gen/types.gen.ts:12378](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12378) +Defined in: [gen/types.gen.ts:12457](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12457) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:12378](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12382](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12382) +Defined in: [gen/types.gen.ts:12461](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12461) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12388](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12388) +Defined in: [gen/types.gen.ts:12467](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12467) The request to update a mapping rule was denied. More details are provided in the response body. @@ -46,7 +46,7 @@ More details are provided in the response body. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12392](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12392) +Defined in: [gen/types.gen.ts:12471](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12471) The request to update a mapping rule was denied. @@ -58,7 +58,7 @@ The request to update a mapping rule was denied. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12396](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12396) +Defined in: [gen/types.gen.ts:12475](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12475) An internal error occurred while processing the request. @@ -70,6 +70,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:12401](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12401) +Defined in: [gen/types.gen.ts:12480](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12480) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleResponse.md index b7da4d0631a..8872ef2f363 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleResponse.md @@ -12,4 +12,4 @@ type UpdateMappingRuleResponse = UpdateMappingRuleResponses[keyof UpdateMappingRuleResponses]; ``` -Defined in: [gen/types.gen.ts:12413](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12413) +Defined in: [gen/types.gen.ts:12492](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12492) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleResponses.md index 3dde141281e..4df2313fa90 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateMappingRuleResponses.md @@ -11,7 +11,7 @@ mdx: type UpdateMappingRuleResponses = object; ``` -Defined in: [gen/types.gen.ts:12406](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12406) +Defined in: [gen/types.gen.ts:12485](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12485) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:12406](https://github.com/camunda/orchestration-cl 200: MappingRuleCreateUpdateResult; ``` -Defined in: [gen/types.gen.ts:12410](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L12410) +Defined in: [gen/types.gen.ts:12489](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L12489) The mapping rule was updated successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleData.md index ff8eb700ef1..bbcf7fc26cf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleData.md @@ -11,7 +11,7 @@ mdx: type UpdateRoleData = object; ``` -Defined in: [gen/types.gen.ts:14685](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14685) +Defined in: [gen/types.gen.ts:13967](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13967) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14685](https://github.com/camunda/orchestration-cl body: RoleUpdateRequest; ``` -Defined in: [gen/types.gen.ts:14686](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14686) +Defined in: [gen/types.gen.ts:13968](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13968) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:14686](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:14687](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14687) +Defined in: [gen/types.gen.ts:13969](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13969) #### roleId @@ -49,7 +49,7 @@ The role ID. optional query: never; ``` -Defined in: [gen/types.gen.ts:14693](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14693) +Defined in: [gen/types.gen.ts:13975](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13975) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:14693](https://github.com/camunda/orchestration-cl url: "/roles/{roleId}"; ``` -Defined in: [gen/types.gen.ts:14694](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14694) +Defined in: [gen/types.gen.ts:13976](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13976) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleError.md index 994172ccbe2..7d96c69285d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleError.md @@ -11,4 +11,4 @@ mdx: type UpdateRoleError = UpdateRoleErrors[keyof UpdateRoleErrors]; ``` -Defined in: [gen/types.gen.ts:14721](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14721) +Defined in: [gen/types.gen.ts:14003](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14003) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleErrors.md index c05c05d2d8c..12ee3bcb135 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateRoleErrors = object; ``` -Defined in: [gen/types.gen.ts:14697](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14697) +Defined in: [gen/types.gen.ts:13979](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13979) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:14697](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14701](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14701) +Defined in: [gen/types.gen.ts:13983](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13983) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14705](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14705) +Defined in: [gen/types.gen.ts:13987](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13987) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14709](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14709) +Defined in: [gen/types.gen.ts:13991](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13991) The role with the ID is not found. @@ -57,7 +57,7 @@ The role with the ID is not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14713](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14713) +Defined in: [gen/types.gen.ts:13995](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L13995) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:14718](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14718) +Defined in: [gen/types.gen.ts:14000](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14000) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleResponse.md index 05f6cbda9e3..30d146c8851 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleResponse.md @@ -11,4 +11,4 @@ mdx: type UpdateRoleResponse = UpdateRoleResponses[keyof UpdateRoleResponses]; ``` -Defined in: [gen/types.gen.ts:14730](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14730) +Defined in: [gen/types.gen.ts:14012](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14012) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleResponses.md index de36665b923..e75835833c2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateRoleResponses.md @@ -11,7 +11,7 @@ mdx: type UpdateRoleResponses = object; ``` -Defined in: [gen/types.gen.ts:14723](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14723) +Defined in: [gen/types.gen.ts:14005](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14005) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:14723](https://github.com/camunda/orchestration-cl 200: RoleUpdateResult; ``` -Defined in: [gen/types.gen.ts:14727](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L14727) +Defined in: [gen/types.gen.ts:14009](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L14009) The role was updated successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableData.md index 61b27569a91..b1157d04cc7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableData.md @@ -11,7 +11,7 @@ mdx: type UpdateTenantClusterVariableData = object; ``` -Defined in: [gen/types.gen.ts:9009](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9009) +Defined in: [gen/types.gen.ts:9466](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9466) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9009](https://github.com/camunda/orchestration-clu body: UpdateClusterVariableRequest; ``` -Defined in: [gen/types.gen.ts:9010](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9010) +Defined in: [gen/types.gen.ts:9467](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9467) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:9010](https://github.com/camunda/orchestration-clu path: object; ``` -Defined in: [gen/types.gen.ts:9011](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9011) +Defined in: [gen/types.gen.ts:9468](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9468) #### name @@ -57,7 +57,7 @@ The tenant ID optional query: never; ``` -Defined in: [gen/types.gen.ts:9021](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9021) +Defined in: [gen/types.gen.ts:9478](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9478) --- @@ -67,4 +67,4 @@ Defined in: [gen/types.gen.ts:9021](https://github.com/camunda/orchestration-clu url: "/cluster-variables/tenants/{tenantId}/{name}"; ``` -Defined in: [gen/types.gen.ts:9022](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9022) +Defined in: [gen/types.gen.ts:9479](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9479) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableError.md index 9b79540b1b1..e03d27a31ad 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableError.md @@ -12,4 +12,4 @@ type UpdateTenantClusterVariableError = UpdateTenantClusterVariableErrors[keyof UpdateTenantClusterVariableErrors]; ``` -Defined in: [gen/types.gen.ts:9048](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9048) +Defined in: [gen/types.gen.ts:9505](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9505) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableErrors.md index adfdf6900ea..a3691a5c05d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateTenantClusterVariableErrors = object; ``` -Defined in: [gen/types.gen.ts:9025](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9025) +Defined in: [gen/types.gen.ts:9482](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9482) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:9025](https://github.com/camunda/orchestration-clu 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9029](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9029) +Defined in: [gen/types.gen.ts:9486](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9486) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 401: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9033](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9033) +Defined in: [gen/types.gen.ts:9490](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9490) The request lacks valid authentication credentials. @@ -45,7 +45,7 @@ The request lacks valid authentication credentials. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9037](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9037) +Defined in: [gen/types.gen.ts:9494](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9494) Forbidden. The request is not allowed. @@ -57,7 +57,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9041](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9041) +Defined in: [gen/types.gen.ts:9498](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9498) Cluster variable not found @@ -69,6 +69,6 @@ Cluster variable not found 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:9045](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9045) +Defined in: [gen/types.gen.ts:9502](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9502) An internal error occurred while processing the request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableResponse.md index e1d2f0b45ad..fd8227044dc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableResponse.md @@ -12,4 +12,4 @@ type UpdateTenantClusterVariableResponse = UpdateTenantClusterVariableResponses[keyof UpdateTenantClusterVariableResponses]; ``` -Defined in: [gen/types.gen.ts:9057](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9057) +Defined in: [gen/types.gen.ts:9514](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9514) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableResponses.md index be45a89650a..e8305312e0d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantClusterVariableResponses.md @@ -11,7 +11,7 @@ mdx: type UpdateTenantClusterVariableResponses = object; ``` -Defined in: [gen/types.gen.ts:9050](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9050) +Defined in: [gen/types.gen.ts:9507](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9507) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:9050](https://github.com/camunda/orchestration-clu 200: ClusterVariableResult; ``` -Defined in: [gen/types.gen.ts:9054](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L9054) +Defined in: [gen/types.gen.ts:9511](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L9511) Cluster variable updated successfully diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantData.md index 5309244a00c..458ff9cb7f9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantData.md @@ -11,7 +11,7 @@ mdx: type UpdateTenantData = object; ``` -Defined in: [gen/types.gen.ts:15724](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15724) +Defined in: [gen/types.gen.ts:15028](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15028) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15724](https://github.com/camunda/orchestration-cl body: TenantUpdateRequest; ``` -Defined in: [gen/types.gen.ts:15725](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15725) +Defined in: [gen/types.gen.ts:15029](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15029) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:15725](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:15726](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15726) +Defined in: [gen/types.gen.ts:15030](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15030) #### tenantId @@ -49,7 +49,7 @@ The unique identifier of the tenant. optional query: never; ``` -Defined in: [gen/types.gen.ts:15732](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15732) +Defined in: [gen/types.gen.ts:15036](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15036) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:15732](https://github.com/camunda/orchestration-cl url: "/tenants/{tenantId}"; ``` -Defined in: [gen/types.gen.ts:15733](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15733) +Defined in: [gen/types.gen.ts:15037](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15037) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantError.md index 0b3488a9121..3816a3fe50b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantError.md @@ -11,4 +11,4 @@ mdx: type UpdateTenantError = UpdateTenantErrors[keyof UpdateTenantErrors]; ``` -Defined in: [gen/types.gen.ts:15760](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15760) +Defined in: [gen/types.gen.ts:15064](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15064) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantErrors.md index 826d62885fc..80ca089ff1d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateTenantErrors = object; ``` -Defined in: [gen/types.gen.ts:15736](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15736) +Defined in: [gen/types.gen.ts:15040](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15040) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:15736](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15740](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15740) +Defined in: [gen/types.gen.ts:15044](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15044) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15744](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15744) +Defined in: [gen/types.gen.ts:15048](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15048) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15748](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15748) +Defined in: [gen/types.gen.ts:15052](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15052) Not found. The tenant was not found. @@ -57,7 +57,7 @@ Not found. The tenant was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15752](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15752) +Defined in: [gen/types.gen.ts:15056](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15056) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:15757](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15757) +Defined in: [gen/types.gen.ts:15061](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15061) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantResponse.md index 9afed6bf3c7..2012b127991 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantResponse.md @@ -11,4 +11,4 @@ mdx: type UpdateTenantResponse = UpdateTenantResponses[keyof UpdateTenantResponses]; ``` -Defined in: [gen/types.gen.ts:15769](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15769) +Defined in: [gen/types.gen.ts:15073](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15073) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantResponses.md index 0150af9be2c..e110553d781 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateTenantResponses.md @@ -11,7 +11,7 @@ mdx: type UpdateTenantResponses = object; ``` -Defined in: [gen/types.gen.ts:15762](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15762) +Defined in: [gen/types.gen.ts:15066](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15066) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:15762](https://github.com/camunda/orchestration-cl 200: TenantUpdateResult; ``` -Defined in: [gen/types.gen.ts:15766](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L15766) +Defined in: [gen/types.gen.ts:15070](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15070) The tenant was updated successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserData.md index 30940dd71ba..6143ce69585 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserData.md @@ -11,7 +11,7 @@ mdx: type UpdateUserData = object; ``` -Defined in: [gen/types.gen.ts:16631](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16631) +Defined in: [gen/types.gen.ts:15961](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15961) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16631](https://github.com/camunda/orchestration-cl body: UserUpdateRequest; ``` -Defined in: [gen/types.gen.ts:16632](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16632) +Defined in: [gen/types.gen.ts:15962](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15962) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:16632](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:16633](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16633) +Defined in: [gen/types.gen.ts:15963](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15963) #### username @@ -49,7 +49,7 @@ The username of the user to update. optional query: never; ``` -Defined in: [gen/types.gen.ts:16639](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16639) +Defined in: [gen/types.gen.ts:15969](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15969) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:16639](https://github.com/camunda/orchestration-cl url: "/users/{username}"; ``` -Defined in: [gen/types.gen.ts:16640](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16640) +Defined in: [gen/types.gen.ts:15970](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15970) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserError.md index 636ab65ca3a..37e52557bb0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserError.md @@ -11,4 +11,4 @@ mdx: type UpdateUserError = UpdateUserErrors[keyof UpdateUserErrors]; ``` -Defined in: [gen/types.gen.ts:16667](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16667) +Defined in: [gen/types.gen.ts:15997](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15997) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserErrors.md index 63f5af1dc66..4fd8eed9f93 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateUserErrors = object; ``` -Defined in: [gen/types.gen.ts:16643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16643) +Defined in: [gen/types.gen.ts:15973](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15973) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:16643](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16647](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16647) +Defined in: [gen/types.gen.ts:15977](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15977) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 403: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16651](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16651) +Defined in: [gen/types.gen.ts:15981](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15981) Forbidden. The request is not allowed. @@ -45,7 +45,7 @@ Forbidden. The request is not allowed. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16655](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16655) +Defined in: [gen/types.gen.ts:15985](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15985) The user was not found. @@ -57,7 +57,7 @@ The user was not found. 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16659](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16659) +Defined in: [gen/types.gen.ts:15989](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15989) An internal error occurred while processing the request. @@ -69,6 +69,6 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:16664](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16664) +Defined in: [gen/types.gen.ts:15994](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15994) 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 . diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserResponse.md index 7a29a41e0d3..3e4a999d31c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserResponse.md @@ -11,4 +11,4 @@ mdx: type UpdateUserResponse = UpdateUserResponses[keyof UpdateUserResponses]; ``` -Defined in: [gen/types.gen.ts:16676](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16676) +Defined in: [gen/types.gen.ts:16016](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16016) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserResponses.md index 0633ed5b5f6..bf95046df34 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserResponses.md @@ -11,16 +11,38 @@ mdx: type UpdateUserResponses = object; ``` -Defined in: [gen/types.gen.ts:16669](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16669) +Defined in: [gen/types.gen.ts:15999](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L15999) ## Properties ### 200 ```ts -200: UserResult; +200: object; ``` -Defined in: [gen/types.gen.ts:16673](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L16673) +Defined in: [gen/types.gen.ts:16003](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16003) The user was updated successfully. + +#### email + +```ts +email: string | null; +``` + +The email of the user. + +#### name + +```ts +name: string | null; +``` + +The name of the user. + +#### username + +```ts +username: Username; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskData.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskData.md index dce51751d31..87da46e1fe0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskData.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskData.md @@ -11,7 +11,7 @@ mdx: type UpdateUserTaskData = object; ``` -Defined in: [gen/types.gen.ts:17031](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17031) +Defined in: [gen/types.gen.ts:16101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16101) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17031](https://github.com/camunda/orchestration-cl optional body: UserTaskUpdateRequest; ``` -Defined in: [gen/types.gen.ts:17032](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17032) +Defined in: [gen/types.gen.ts:16102](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16102) --- @@ -31,7 +31,7 @@ Defined in: [gen/types.gen.ts:17032](https://github.com/camunda/orchestration-cl path: object; ``` -Defined in: [gen/types.gen.ts:17033](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17033) +Defined in: [gen/types.gen.ts:16103](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16103) #### userTaskKey @@ -49,7 +49,7 @@ The key of the user task to update. optional query: never; ``` -Defined in: [gen/types.gen.ts:17039](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17039) +Defined in: [gen/types.gen.ts:16109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16109) --- @@ -59,4 +59,4 @@ Defined in: [gen/types.gen.ts:17039](https://github.com/camunda/orchestration-cl url: "/user-tasks/{userTaskKey}"; ``` -Defined in: [gen/types.gen.ts:17040](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17040) +Defined in: [gen/types.gen.ts:16110](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16110) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskError.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskError.md index 71fbacbc82c..84b95d7ffd7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskError.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskError.md @@ -11,4 +11,4 @@ mdx: type UpdateUserTaskError = UpdateUserTaskErrors[keyof UpdateUserTaskErrors]; ``` -Defined in: [gen/types.gen.ts:17068](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17068) +Defined in: [gen/types.gen.ts:16144](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16144) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskErrors.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskErrors.md index acc3f34b909..6a418353205 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskErrors.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskErrors.md @@ -11,7 +11,7 @@ mdx: type UpdateUserTaskErrors = object; ``` -Defined in: [gen/types.gen.ts:17043](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17043) +Defined in: [gen/types.gen.ts:16113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16113) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:17043](https://github.com/camunda/orchestration-cl 400: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17047](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17047) +Defined in: [gen/types.gen.ts:16117](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16117) The provided data is not valid. @@ -33,7 +33,7 @@ The provided data is not valid. 404: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17051](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17051) +Defined in: [gen/types.gen.ts:16121](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16121) The user task with the given key was not found. @@ -45,7 +45,7 @@ The user task with the given key was not found. 409: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17056](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17056) +Defined in: [gen/types.gen.ts:16126](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16126) The user task with the given key is in the wrong state currently. More details are provided in the response body. @@ -57,7 +57,7 @@ The user task with the given key is in the wrong state currently. More details a 500: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17060](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17060) +Defined in: [gen/types.gen.ts:16130](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16130) An internal error occurred while processing the request. @@ -69,6 +69,19 @@ An internal error occurred while processing the request. 503: ProblemDetail; ``` -Defined in: [gen/types.gen.ts:17065](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17065) +Defined in: [gen/types.gen.ts:16135](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16135) 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 . + +--- + +### 504 + +```ts +504: ProblemDetail; +``` + +Defined in: [gen/types.gen.ts:16141](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16141) + +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 diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskResponse.md index a2db805e924..008bb062140 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskResponse.md @@ -12,4 +12,4 @@ type UpdateUserTaskResponse = UpdateUserTaskResponses[keyof UpdateUserTaskResponses]; ``` -Defined in: [gen/types.gen.ts:17077](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17077) +Defined in: [gen/types.gen.ts:16153](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16153) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskResponses.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskResponses.md index d6a0657308c..c1853b4feee 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskResponses.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UpdateUserTaskResponses.md @@ -11,7 +11,7 @@ mdx: type UpdateUserTaskResponses = object; ``` -Defined in: [gen/types.gen.ts:17070](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17070) +Defined in: [gen/types.gen.ts:16146](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16146) ## Properties @@ -21,6 +21,6 @@ Defined in: [gen/types.gen.ts:17070](https://github.com/camunda/orchestration-cl 204: void; ``` -Defined in: [gen/types.gen.ts:17074](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L17074) +Defined in: [gen/types.gen.ts:16150](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L16150) The user task was updated successfully. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UsageMetricsResponse.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UsageMetricsResponse.md index a5db251b2de..86e20132349 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UsageMetricsResponse.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UsageMetricsResponse.md @@ -11,22 +11,22 @@ mdx: type UsageMetricsResponse = UsageMetricsResponseItem & object; ``` -Defined in: [gen/types.gen.ts:6524](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6524) +Defined in: [gen/types.gen.ts:7243](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7243) ## Type Declaration -### activeTenants? +### activeTenants ```ts -optional activeTenants: number; +activeTenants: number; ``` The amount of active tenants. -### tenants? +### tenants ```ts -optional tenants: object; +tenants: object; ``` The usage metrics by tenants. Only available if request `withTenants` query parameter was `true`. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UsageMetricsResponseItem.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UsageMetricsResponseItem.md index 1dd0618f05a..7630fb3f052 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UsageMetricsResponseItem.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UsageMetricsResponseItem.md @@ -11,40 +11,40 @@ mdx: type UsageMetricsResponseItem = object; ``` -Defined in: [gen/types.gen.ts:6537](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6537) +Defined in: [gen/types.gen.ts:7256](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7256) ## Properties -### assignees? +### assignees ```ts -optional assignees: number; +assignees: number; ``` -Defined in: [gen/types.gen.ts:6549](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6549) +Defined in: [gen/types.gen.ts:7268](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7268) The amount of unique active task users. --- -### decisionInstances? +### decisionInstances ```ts -optional decisionInstances: number; +decisionInstances: number; ``` -Defined in: [gen/types.gen.ts:6545](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6545) +Defined in: [gen/types.gen.ts:7264](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7264) The amount of executed decision instances. --- -### processInstances? +### processInstances ```ts -optional processInstances: number; +processInstances: number; ``` -Defined in: [gen/types.gen.ts:6541](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6541) +Defined in: [gen/types.gen.ts:7260](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7260) The amount of created root process instances. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UseSourceParentKeyInstruction.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UseSourceParentKeyInstruction.md index d83b9a40a59..e71135f2ea1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UseSourceParentKeyInstruction.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UseSourceParentKeyInstruction.md @@ -11,7 +11,7 @@ mdx: type UseSourceParentKeyInstruction = object; ``` -Defined in: [gen/types.gen.ts:6121](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6121) +Defined in: [gen/types.gen.ts:6834](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6834) 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. @@ -23,6 +23,6 @@ Instructs the engine to use the source's direct parent key as the ancestor scope ancestorScopeType: string; ``` -Defined in: [gen/types.gen.ts:6125](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6125) +Defined in: [gen/types.gen.ts:6838](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L6838) The type of ancestor scope instruction. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserCreateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserCreateResult.md index 1830002794d..45ab89bcbf2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserCreateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserCreateResult.md @@ -11,38 +11,38 @@ mdx: type UserCreateResult = object; ``` -Defined in: [gen/types.gen.ts:7149](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7149) +Defined in: [gen/types.gen.ts:7956](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7956) ## Properties -### email? +### email ```ts -optional email: string; +email: string | null; ``` -Defined in: [gen/types.gen.ts:7158](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7158) +Defined in: [gen/types.gen.ts:7965](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7965) The email of the user. --- -### name? +### name ```ts -optional name: string; +name: string | null; ``` -Defined in: [gen/types.gen.ts:7154](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7154) +Defined in: [gen/types.gen.ts:7961](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7961) The name of the user. --- -### username? +### username ```ts -optional username: Username; +username: Username; ``` -Defined in: [gen/types.gen.ts:7150](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7150) +Defined in: [gen/types.gen.ts:7957](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7957) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserFilter.md index a96bff79da2..8d3cb8eb433 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserFilter.md @@ -11,7 +11,7 @@ mdx: type UserFilter = object; ``` -Defined in: [gen/types.gen.ts:7222](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7222) +Defined in: [gen/types.gen.ts:8029](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8029) User search filter. @@ -23,7 +23,7 @@ User search filter. optional email: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:7234](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7234) +Defined in: [gen/types.gen.ts:8041](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8041) The email of the user. @@ -35,7 +35,7 @@ The email of the user. optional name: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:7230](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7230) +Defined in: [gen/types.gen.ts:8037](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8037) The name of the user. @@ -47,6 +47,6 @@ The name of the user. optional username: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:7226](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7226) +Defined in: [gen/types.gen.ts:8033](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8033) The username of the user. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserRequest.md index 8fe73e15386..7f02b1d60f9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserRequest.md @@ -11,7 +11,7 @@ mdx: type UserRequest = object; ``` -Defined in: [gen/types.gen.ts:7130](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7130) +Defined in: [gen/types.gen.ts:7937](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7937) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7130](https://github.com/camunda/orchestration-clu optional email: string; ``` -Defined in: [gen/types.gen.ts:7146](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7146) +Defined in: [gen/types.gen.ts:7953](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7953) The email of the user. @@ -33,7 +33,7 @@ The email of the user. optional name: string; ``` -Defined in: [gen/types.gen.ts:7142](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7142) +Defined in: [gen/types.gen.ts:7949](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7949) The name of the user. @@ -45,7 +45,7 @@ The name of the user. password: string; ``` -Defined in: [gen/types.gen.ts:7134](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7134) +Defined in: [gen/types.gen.ts:7941](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7941) The password of the user. @@ -57,6 +57,6 @@ The password of the user. username: string; ``` -Defined in: [gen/types.gen.ts:7138](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7138) +Defined in: [gen/types.gen.ts:7945](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7945) The username of the user. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserResult.md index 2e2da94c37e..41ddcf4b43c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserResult.md @@ -11,38 +11,38 @@ mdx: type UserResult = object; ``` -Defined in: [gen/types.gen.ts:7188](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7188) +Defined in: [gen/types.gen.ts:7995](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7995) ## Properties -### email? +### email ```ts -optional email: string; +email: string | null; ``` -Defined in: [gen/types.gen.ts:7197](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7197) +Defined in: [gen/types.gen.ts:8004](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8004) The email of the user. --- -### name? +### name ```ts -optional name: string; +name: string | null; ``` -Defined in: [gen/types.gen.ts:7193](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7193) +Defined in: [gen/types.gen.ts:8000](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8000) The name of the user. --- -### username? +### username ```ts -optional username: Username; +username: Username; ``` -Defined in: [gen/types.gen.ts:7189](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7189) +Defined in: [gen/types.gen.ts:7996](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7996) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchQueryRequest.md index 2b2e36a08d3..3b217051535 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type UserSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:7208](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7208) +Defined in: [gen/types.gen.ts:8015](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8015) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchQuerySortRequest.md index 38a26c5c1db..e6208cc79bd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type UserSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:7200](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7200) +Defined in: [gen/types.gen.ts:8007](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8007) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7200](https://github.com/camunda/orchestration-clu field: "username" | "name" | "email"; ``` -Defined in: [gen/types.gen.ts:7204](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7204) +Defined in: [gen/types.gen.ts:8011](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8011) The field to sort by. @@ -33,4 +33,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:7205](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7205) +Defined in: [gen/types.gen.ts:8012](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8012) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchResult.md index 4368516978e..7f8c64713c9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserSearchResult.md @@ -11,7 +11,7 @@ mdx: type UserSearchResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:7237](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7237) +Defined in: [gen/types.gen.ts:8044](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8044) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAssignmentRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAssignmentRequest.md index b8607cafbb9..787a528e0d8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAssignmentRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAssignmentRequest.md @@ -11,7 +11,7 @@ mdx: type UserTaskAssignmentRequest = object; ``` -Defined in: [gen/types.gen.ts:6957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6957) +Defined in: [gen/types.gen.ts:7743](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7743) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6957](https://github.com/camunda/orchestration-clu optional action: string | null; ``` -Defined in: [gen/types.gen.ts:6971](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6971) +Defined in: [gen/types.gen.ts:7757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7757) 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". @@ -33,7 +33,7 @@ A custom action value that will be accessible from user task events resulting fr optional allowOverride: boolean | null; ``` -Defined in: [gen/types.gen.ts:6966](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6966) +Defined in: [gen/types.gen.ts:7752](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7752) 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. @@ -45,6 +45,6 @@ By default, the task is reassigned if it was already assigned. Set this to `fals optional assignee: string; ``` -Defined in: [gen/types.gen.ts:6961](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6961) +Defined in: [gen/types.gen.ts:7747](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7747) The assignee for the user task. The assignee must not be empty or `null`. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAuditLogFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAuditLogFilter.md index 2e4a36d09a0..58ba31ffa74 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAuditLogFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAuditLogFilter.md @@ -11,7 +11,7 @@ mdx: type UserTaskAuditLogFilter = object; ``` -Defined in: [gen/types.gen.ts:7107](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7107) +Defined in: [gen/types.gen.ts:7914](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7914) The user task audit log search filters. @@ -23,7 +23,7 @@ The user task audit log search filters. optional actorId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:7127](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7127) +Defined in: [gen/types.gen.ts:7934](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7934) The actor ID search filter. @@ -35,7 +35,7 @@ The actor ID search filter. optional actorType: AuditLogActorTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:7123](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7123) +Defined in: [gen/types.gen.ts:7930](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7930) The actor type search filter. @@ -47,7 +47,7 @@ The actor type search filter. optional operationType: OperationTypeFilterProperty; ``` -Defined in: [gen/types.gen.ts:7111](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7111) +Defined in: [gen/types.gen.ts:7918](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7918) The audit log operation type search filter. @@ -59,7 +59,7 @@ The audit log operation type search filter. optional result: AuditLogResultFilterProperty; ``` -Defined in: [gen/types.gen.ts:7115](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7115) +Defined in: [gen/types.gen.ts:7922](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7922) The audit log result search filter. @@ -71,6 +71,6 @@ The audit log result search filter. optional timestamp: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:7119](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7119) +Defined in: [gen/types.gen.ts:7926](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7926) The audit log timestamp filter. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAuditLogSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAuditLogSearchQueryRequest.md index 40d32c7ebee..aa02a8d3b9c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAuditLogSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskAuditLogSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type UserTaskAuditLogSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:7051](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7051) +Defined in: [gen/types.gen.ts:7856](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7856) User task search query request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskCompletionRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskCompletionRequest.md index 88733ce0e19..6399573ce67 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskCompletionRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskCompletionRequest.md @@ -11,7 +11,7 @@ mdx: type UserTaskCompletionRequest = object; ``` -Defined in: [gen/types.gen.ts:6943](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6943) +Defined in: [gen/types.gen.ts:7729](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7729) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6943](https://github.com/camunda/orchestration-clu optional action: string | null; ``` -Defined in: [gen/types.gen.ts:6954](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6954) +Defined in: [gen/types.gen.ts:7740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7740) 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". @@ -37,6 +37,6 @@ optional variables: | null; ``` -Defined in: [gen/types.gen.ts:6947](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6947) +Defined in: [gen/types.gen.ts:7733](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7733) The variables to complete the user task with. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskEffectiveVariableSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskEffectiveVariableSearchQueryRequest.md new file mode 100644 index 00000000000..05f991cda4f --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskEffectiveVariableSearchQueryRequest.md @@ -0,0 +1,52 @@ +--- +title: "Type Alias: UserTaskEffectiveVariableSearchQueryRequest" +sidebar_label: "UserTaskEffectiveVariableSearchQueryRequest" +mdx: + format: md +--- + +# Type Alias: UserTaskEffectiveVariableSearchQueryRequest + +```ts +type UserTaskEffectiveVariableSearchQueryRequest = object; +``` + +Defined in: [gen/types.gen.ts:7838](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7838) + +User task effective variable search query request. Uses offset-based pagination only. + +## Properties + +### filter? + +```ts +optional filter: UserTaskVariableFilter; +``` + +Defined in: [gen/types.gen.ts:7850](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7850) + +The user task variable search filters. + +--- + +### page? + +```ts +optional page: OffsetPagination; +``` + +Defined in: [gen/types.gen.ts:7842](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7842) + +Pagination parameters. + +--- + +### sort? + +```ts +optional sort: UserTaskVariableSearchQuerySortRequest[]; +``` + +Defined in: [gen/types.gen.ts:7846](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7846) + +Sort field criteria. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskFilter.md index feb2f20a39a..58303ef8f5f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskFilter.md @@ -11,7 +11,7 @@ mdx: type UserTaskFilter = object; ``` -Defined in: [gen/types.gen.ts:6769](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6769) +Defined in: [gen/types.gen.ts:7541](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7541) User task filter request. @@ -23,7 +23,7 @@ User task filter request. optional assignee: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:6777](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6777) +Defined in: [gen/types.gen.ts:7549](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7549) The assignee of the user task. @@ -35,7 +35,7 @@ The assignee of the user task. optional candidateGroup: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:6794](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6794) +Defined in: [gen/types.gen.ts:7566](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7566) The candidate group for this user task. @@ -47,7 +47,7 @@ The candidate group for this user task. optional candidateUser: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:6798](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6798) +Defined in: [gen/types.gen.ts:7570](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7570) The candidate user for this user task. @@ -59,7 +59,7 @@ The candidate user for this user task. optional completionDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:6814](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6814) +Defined in: [gen/types.gen.ts:7586](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7586) The user task completion date. @@ -71,7 +71,7 @@ The user task completion date. optional creationDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:6810](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6810) +Defined in: [gen/types.gen.ts:7582](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7582) The user task creation date. @@ -83,7 +83,7 @@ The user task creation date. optional dueDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:6822](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6822) +Defined in: [gen/types.gen.ts:7594](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7594) The user task due date. @@ -95,7 +95,7 @@ The user task due date. optional elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:6785](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6785) +Defined in: [gen/types.gen.ts:7557](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7557) The element ID of the user task. @@ -107,7 +107,7 @@ The element ID of the user task. optional elementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:6840](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6840) +Defined in: [gen/types.gen.ts:7618](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7618) The key of the element instance. @@ -119,7 +119,7 @@ The key of the element instance. optional followUpDate: DateTimeFilterProperty; ``` -Defined in: [gen/types.gen.ts:6818](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6818) +Defined in: [gen/types.gen.ts:7590](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7590) The user task follow-up date. @@ -131,7 +131,9 @@ The user task follow-up date. optional localVariables: VariableValueFilterProperty[]; ``` -Defined in: [gen/types.gen.ts:6824](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6824) +Defined in: [gen/types.gen.ts:7602](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7602) + +The local variables of the user task. --- @@ -141,7 +143,7 @@ Defined in: [gen/types.gen.ts:6824](https://github.com/camunda/orchestration-clu optional name: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:6790](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6790) +Defined in: [gen/types.gen.ts:7562](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7562) 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. @@ -153,7 +155,7 @@ The task name. This only works for data created with 8.8 and onwards. Instances optional priority: IntegerFilterProperty; ``` -Defined in: [gen/types.gen.ts:6781](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6781) +Defined in: [gen/types.gen.ts:7553](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7553) The priority of the user task. @@ -165,7 +167,7 @@ The priority of the user task. optional processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:6806](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6806) +Defined in: [gen/types.gen.ts:7578](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7578) The ID of the process definition. @@ -177,7 +179,7 @@ The ID of the process definition. optional processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:6832](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6832) +Defined in: [gen/types.gen.ts:7610](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7610) The key of the process definition. @@ -189,7 +191,7 @@ The key of the process definition. optional processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:6836](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6836) +Defined in: [gen/types.gen.ts:7614](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7614) The key of the process instance. @@ -201,7 +203,9 @@ The key of the process instance. optional processInstanceVariables: VariableValueFilterProperty[]; ``` -Defined in: [gen/types.gen.ts:6823](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6823) +Defined in: [gen/types.gen.ts:7598](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7598) + +The variables of the process instance. --- @@ -211,7 +215,7 @@ Defined in: [gen/types.gen.ts:6823](https://github.com/camunda/orchestration-clu optional state: UserTaskStateFilterProperty; ``` -Defined in: [gen/types.gen.ts:6773](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6773) +Defined in: [gen/types.gen.ts:7545](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7545) The user task state. @@ -223,7 +227,7 @@ The user task state. optional tags: TagSet; ``` -Defined in: [gen/types.gen.ts:6841](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6841) +Defined in: [gen/types.gen.ts:7619](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7619) --- @@ -233,7 +237,7 @@ Defined in: [gen/types.gen.ts:6841](https://github.com/camunda/orchestration-clu optional tenantId: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:6802](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6802) +Defined in: [gen/types.gen.ts:7574](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7574) Tenant ID of this user task. @@ -245,6 +249,6 @@ Tenant ID of this user task. optional userTaskKey: UserTaskKey; ``` -Defined in: [gen/types.gen.ts:6828](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6828) +Defined in: [gen/types.gen.ts:7606](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7606) The key for this user task. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskKey.md index eff6c691450..5cf9303e495 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskKey.md @@ -11,6 +11,6 @@ mdx: type UserTaskKey = CamundaKey<"UserTaskKey">; ``` -Defined in: [gen/types.gen.ts:4034](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4034) +Defined in: [gen/types.gen.ts:4671](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4671) System-generated key for a user task. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskProperties.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskProperties.md index 038ff33dc45..d31537aa832 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskProperties.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskProperties.md @@ -11,126 +11,126 @@ mdx: type UserTaskProperties = object; ``` -Defined in: [gen/types.gen.ts:3453](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3453) +Defined in: [gen/types.gen.ts:4090](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4090) Contains properties of a user task. ## Properties -### action? +### action ```ts -optional action: string; +action: string; ``` -Defined in: [gen/types.gen.ts:3457](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3457) +Defined in: [gen/types.gen.ts:4094](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4094) The action performed on the user task. --- -### assignee? +### assignee ```ts -optional assignee: string | null; +assignee: string | null; ``` -Defined in: [gen/types.gen.ts:3461](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3461) +Defined in: [gen/types.gen.ts:4098](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4098) The user assigned to the task. --- -### candidateGroups? +### candidateGroups ```ts -optional candidateGroups: string[]; +candidateGroups: string[]; ``` -Defined in: [gen/types.gen.ts:3465](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3465) +Defined in: [gen/types.gen.ts:4102](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4102) The groups eligible to claim the task. --- -### candidateUsers? +### candidateUsers ```ts -optional candidateUsers: string[]; +candidateUsers: string[]; ``` -Defined in: [gen/types.gen.ts:3469](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3469) +Defined in: [gen/types.gen.ts:4106](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4106) The users eligible to claim the task. --- -### changedAttributes? +### changedAttributes ```ts -optional changedAttributes: string[]; +changedAttributes: string[]; ``` -Defined in: [gen/types.gen.ts:3473](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3473) +Defined in: [gen/types.gen.ts:4110](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4110) The attributes that were changed in the task. --- -### dueDate? +### dueDate ```ts -optional dueDate: string | null; +dueDate: string | null; ``` -Defined in: [gen/types.gen.ts:3477](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3477) +Defined in: [gen/types.gen.ts:4114](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4114) The due date of the user task in ISO 8601 format. --- -### followUpDate? +### followUpDate ```ts -optional followUpDate: string | null; +followUpDate: string | null; ``` -Defined in: [gen/types.gen.ts:3481](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3481) +Defined in: [gen/types.gen.ts:4118](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4118) The follow-up date of the user task in ISO 8601 format. --- -### formKey? +### formKey ```ts -optional formKey: FormKey; +formKey: FormKey | null; ``` -Defined in: [gen/types.gen.ts:3485](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3485) +Defined in: [gen/types.gen.ts:4122](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4122) The key of the form associated with the user task. --- -### priority? +### priority ```ts -optional priority: number | null; +priority: number | null; ``` -Defined in: [gen/types.gen.ts:3489](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3489) +Defined in: [gen/types.gen.ts:4126](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4126) The priority of the user task. --- -### userTaskKey? +### userTaskKey ```ts -optional userTaskKey: UserTaskKey | null; +userTaskKey: UserTaskKey | null; ``` -Defined in: [gen/types.gen.ts:3493](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L3493) +Defined in: [gen/types.gen.ts:4130](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4130) The unique key identifying the user task. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskResult.md index 1f3331908f5..4f07e1f7c34 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskResult.md @@ -11,77 +11,77 @@ mdx: type UserTaskResult = object; ``` -Defined in: [gen/types.gen.ts:6854](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6854) +Defined in: [gen/types.gen.ts:7632](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7632) ## Properties -### assignee? +### assignee ```ts -optional assignee: string; +assignee: string | null; ``` -Defined in: [gen/types.gen.ts:6863](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6863) +Defined in: [gen/types.gen.ts:7641](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7641) The assignee of the user task. --- -### candidateGroups? +### candidateGroups ```ts -optional candidateGroups: string[]; +candidateGroups: string[]; ``` -Defined in: [gen/types.gen.ts:6871](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6871) +Defined in: [gen/types.gen.ts:7649](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7649) The candidate groups for this user task. --- -### candidateUsers? +### candidateUsers ```ts -optional candidateUsers: string[]; +candidateUsers: string[]; ``` -Defined in: [gen/types.gen.ts:6875](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6875) +Defined in: [gen/types.gen.ts:7653](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7653) The candidate users for this user task. --- -### completionDate? +### completionDate ```ts -optional completionDate: string; +completionDate: string | null; ``` -Defined in: [gen/types.gen.ts:6887](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6887) +Defined in: [gen/types.gen.ts:7665](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7665) The completion date of a user task. --- -### creationDate? +### creationDate ```ts -optional creationDate: string; +creationDate: string; ``` -Defined in: [gen/types.gen.ts:6883](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6883) +Defined in: [gen/types.gen.ts:7661](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7661) The creation date of a user task. --- -### customHeaders? +### customHeaders ```ts -optional customHeaders: object; +customHeaders: object; ``` -Defined in: [gen/types.gen.ts:6908](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6908) +Defined in: [gen/types.gen.ts:7686](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7686) Custom headers for the user task. @@ -93,208 +93,213 @@ Custom headers for the user task. --- -### dueDate? +### dueDate ```ts -optional dueDate: string; +dueDate: string | null; ``` -Defined in: [gen/types.gen.ts:6895](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6895) +Defined in: [gen/types.gen.ts:7673](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7673) The due date of a user task. --- -### elementId? +### elementId ```ts -optional elementId: ElementId; +elementId: ElementId; ``` -Defined in: [gen/types.gen.ts:6867](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6867) +Defined in: [gen/types.gen.ts:7645](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7645) The element ID of the user task. --- -### elementInstanceKey? +### elementInstanceKey ```ts -optional elementInstanceKey: ElementInstanceKey; +elementInstanceKey: ElementInstanceKey; ``` -Defined in: [gen/types.gen.ts:6922](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6922) +Defined in: [gen/types.gen.ts:7700](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7700) The key of the element instance. --- -### externalFormReference? +### externalFormReference ```ts -optional externalFormReference: string; +externalFormReference: string | null; ``` -Defined in: [gen/types.gen.ts:6900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6900) +Defined in: [gen/types.gen.ts:7678](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7678) The external form reference. --- -### followUpDate? +### followUpDate ```ts -optional followUpDate: string; +followUpDate: string | null; ``` -Defined in: [gen/types.gen.ts:6891](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6891) +Defined in: [gen/types.gen.ts:7669](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7669) The follow date of a user task. --- -### formKey? +### formKey ```ts -optional formKey: FormKey; +formKey: FormKey | null; ``` -Defined in: [gen/types.gen.ts:6939](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6939) +Defined in: [gen/types.gen.ts:7725](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7725) The key of the form. --- -### name? +### name ```ts -optional name: string; +name: string | null; ``` -Defined in: [gen/types.gen.ts:6858](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6858) +Defined in: [gen/types.gen.ts:7636](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7636) The name for this user task. --- -### priority? +### priority ```ts -optional priority: number; +priority: number; ``` -Defined in: [gen/types.gen.ts:6914](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6914) +Defined in: [gen/types.gen.ts:7692](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7692) The priority of a user task. The higher the value the higher the priority. --- -### processDefinitionId? +### processDefinitionId ```ts -optional processDefinitionId: ProcessDefinitionId; +processDefinitionId: ProcessDefinitionId; ``` -Defined in: [gen/types.gen.ts:6879](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6879) +Defined in: [gen/types.gen.ts:7657](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7657) The ID of the process definition. --- -### processDefinitionKey? +### processDefinitionKey ```ts -optional processDefinitionKey: ProcessDefinitionKey; +processDefinitionKey: ProcessDefinitionKey; ``` -Defined in: [gen/types.gen.ts:6930](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6930) +Defined in: [gen/types.gen.ts:7710](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7710) The key of the process definition. --- -### processDefinitionVersion? +### processDefinitionVersion ```ts -optional processDefinitionVersion: number; +processDefinitionVersion: number; ``` -Defined in: [gen/types.gen.ts:6904](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6904) +Defined in: [gen/types.gen.ts:7682](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7682) The version of the process definition. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:6934](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6934) +Defined in: [gen/types.gen.ts:7714](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7714) The key of the process instance. --- -### processName? +### processName ```ts -optional processName: string; +processName: string | null; ``` -Defined in: [gen/types.gen.ts:6926](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6926) +Defined in: [gen/types.gen.ts:7706](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7706) The name of the process definition. +This is `null` if the process has no name defined. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:6935](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6935) +Defined in: [gen/types.gen.ts:7721](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7721) + +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. --- -### state? +### state ```ts -optional state: UserTaskStateEnum; +state: UserTaskStateEnum; ``` -Defined in: [gen/types.gen.ts:6859](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6859) +Defined in: [gen/types.gen.ts:7637](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7637) --- -### tags? +### tags ```ts -optional tags: TagSet; +tags: TagSet; ``` -Defined in: [gen/types.gen.ts:6940](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6940) +Defined in: [gen/types.gen.ts:7726](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7726) --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:6896](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6896) +Defined in: [gen/types.gen.ts:7674](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7674) --- -### userTaskKey? +### userTaskKey ```ts -optional userTaskKey: UserTaskKey; +userTaskKey: UserTaskKey; ``` -Defined in: [gen/types.gen.ts:6918](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6918) +Defined in: [gen/types.gen.ts:7696](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7696) The key of the user task. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQuery.md index 659a5ed119c..91f47fd2e5e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQuery.md @@ -11,7 +11,7 @@ mdx: type UserTaskSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:6755](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6755) +Defined in: [gen/types.gen.ts:7527](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7527) User task search query request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQueryResult.md index 569fe4605fd..93c1437b025 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQueryResult.md @@ -11,16 +11,16 @@ mdx: type UserTaskSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:6847](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6847) +Defined in: [gen/types.gen.ts:7625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7625) User task search query response. ## Type Declaration -### items? +### items ```ts -optional items: UserTaskResult[]; +items: UserTaskResult[]; ``` The matching user tasks. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQuerySortRequest.md index 0396e3eae4a..b49a25ead14 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type UserTaskSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:6744](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6744) +Defined in: [gen/types.gen.ts:7516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7516) ## Properties @@ -27,7 +27,7 @@ field: | "name"; ``` -Defined in: [gen/types.gen.ts:6748](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6748) +Defined in: [gen/types.gen.ts:7520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7520) The field to sort by. @@ -39,4 +39,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:6749](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6749) +Defined in: [gen/types.gen.ts:7521](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7521) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateEnum.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateEnum.md index 7f8682b8732..8d30260985f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateEnum.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateEnum.md @@ -20,6 +20,7 @@ type UserTaskStateEnum = | "FAILED"; ``` -Defined in: [gen/types.gen.ts:7062](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7062) +Defined in: [gen/types.gen.ts:7869](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7869) The state of the user task. +Note: FAILED state is only for legacy job-worker-based tasks. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateExactMatch.md index bcfa4c401bb..e373d302eed 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateExactMatch.md @@ -11,7 +11,7 @@ mdx: type UserTaskStateExactMatch = UserTaskStateEnum; ``` -Defined in: [gen/types.gen.ts:7640](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7640) +Defined in: [gen/types.gen.ts:8486](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8486) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateFilterProperty.md index f3b79ef38a1..5fe3e05f56e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskStateFilterProperty.md @@ -13,6 +13,6 @@ type UserTaskStateFilterProperty = | AdvancedUserTaskStateFilter; ``` -Defined in: [gen/types.gen.ts:7077](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7077) +Defined in: [gen/types.gen.ts:7884](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7884) UserTaskStateEnum property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskUpdateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskUpdateRequest.md index f1bcf401a31..38d53ab0db3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskUpdateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskUpdateRequest.md @@ -11,7 +11,7 @@ mdx: type UserTaskUpdateRequest = object; ``` -Defined in: [gen/types.gen.ts:6974](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6974) +Defined in: [gen/types.gen.ts:7760](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7760) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:6974](https://github.com/camunda/orchestration-clu optional action: string | null; ``` -Defined in: [gen/types.gen.ts:6980](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6980) +Defined in: [gen/types.gen.ts:7766](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7766) 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". @@ -33,4 +33,4 @@ A custom action value that will be accessible from user task events resulting fr optional changeset: Changeset; ``` -Defined in: [gen/types.gen.ts:6975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L6975) +Defined in: [gen/types.gen.ts:7761](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7761) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableFilter.md index 5e7132678b0..3f6993ce8c9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableFilter.md @@ -11,7 +11,7 @@ mdx: type UserTaskVariableFilter = object; ``` -Defined in: [gen/types.gen.ts:7067](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7067) +Defined in: [gen/types.gen.ts:7874](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7874) The user task variable search filters. @@ -23,6 +23,6 @@ The user task variable search filters. optional name: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:7071](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7071) +Defined in: [gen/types.gen.ts:7878](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7878) Name of the variable. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableSearchQueryRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableSearchQueryRequest.md index 8dada0cf439..c6f0d0979b6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableSearchQueryRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableSearchQueryRequest.md @@ -11,7 +11,7 @@ mdx: type UserTaskVariableSearchQueryRequest = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:7037](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7037) +Defined in: [gen/types.gen.ts:7823](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7823) User task search query request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableSearchQuerySortRequest.md index 3670118d61a..02dd1a03f54 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserTaskVariableSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type UserTaskVariableSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:7026](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7026) +Defined in: [gen/types.gen.ts:7812](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7812) ## Properties @@ -27,7 +27,7 @@ field: | "processInstanceKey"; ``` -Defined in: [gen/types.gen.ts:7030](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7030) +Defined in: [gen/types.gen.ts:7816](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7816) The field to sort by. @@ -39,4 +39,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:7031](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7031) +Defined in: [gen/types.gen.ts:7817](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7817) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserUpdateRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserUpdateRequest.md index 65e98913e9d..41d12723f91 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserUpdateRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserUpdateRequest.md @@ -11,7 +11,7 @@ mdx: type UserUpdateRequest = object; ``` -Defined in: [gen/types.gen.ts:7161](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7161) +Defined in: [gen/types.gen.ts:7968](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7968) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7161](https://github.com/camunda/orchestration-clu optional email: string; ``` -Defined in: [gen/types.gen.ts:7173](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7173) +Defined in: [gen/types.gen.ts:7980](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7980) The email of the user. @@ -33,7 +33,7 @@ The email of the user. optional name: string; ``` -Defined in: [gen/types.gen.ts:7169](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7169) +Defined in: [gen/types.gen.ts:7976](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7976) The name of the user. @@ -45,6 +45,6 @@ The name of the user. optional password: string; ``` -Defined in: [gen/types.gen.ts:7165](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7165) +Defined in: [gen/types.gen.ts:7972](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7972) The password of the user. If blank, the password is unchanged. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserUpdateResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserUpdateResult.md index 484dddba393..38f1d733ada 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/UserUpdateResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/UserUpdateResult.md @@ -11,38 +11,38 @@ mdx: type UserUpdateResult = object; ``` -Defined in: [gen/types.gen.ts:7176](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7176) +Defined in: [gen/types.gen.ts:7983](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7983) ## Properties -### email? +### email ```ts -optional email: string; +email: string | null; ``` -Defined in: [gen/types.gen.ts:7185](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7185) +Defined in: [gen/types.gen.ts:7992](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7992) The email of the user. --- -### name? +### name ```ts -optional name: string; +name: string | null; ``` -Defined in: [gen/types.gen.ts:7181](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7181) +Defined in: [gen/types.gen.ts:7988](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7988) The name of the user. --- -### username? +### username ```ts -optional username: Username; +username: Username; ``` -Defined in: [gen/types.gen.ts:7177](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7177) +Defined in: [gen/types.gen.ts:7984](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L7984) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/Username.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/Username.md index 8229d177f50..295310728f8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/Username.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/Username.md @@ -11,6 +11,6 @@ mdx: type Username = CamundaKey<"Username">; ``` -Defined in: [gen/types.gen.ts:2987](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L2987) +Defined in: [gen/types.gen.ts:3339](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L3339) The unique name of a user. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/ValidationMode.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/ValidationMode.md index d91c0ecae49..a8bc550d6ed 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/ValidationMode.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/ValidationMode.md @@ -11,4 +11,4 @@ mdx: type ValidationMode = "none" | "warn" | "strict" | "fanatical"; ``` -Defined in: [runtime/unifiedConfiguration.ts:22](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/unifiedConfiguration.ts#L22) +Defined in: [runtime/unifiedConfiguration.ts:22](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/unifiedConfiguration.ts#L22) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableFilter.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableFilter.md index b9b23e851c0..3f56ecc9c13 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableFilter.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableFilter.md @@ -11,7 +11,7 @@ mdx: type VariableFilter = object; ``` -Defined in: [gen/types.gen.ts:7269](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7269) +Defined in: [gen/types.gen.ts:8076](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8076) Variable filter request. @@ -23,7 +23,7 @@ Variable filter request. optional isTruncated: boolean; ``` -Defined in: [gen/types.gen.ts:7285](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7285) +Defined in: [gen/types.gen.ts:8096](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8096) Whether the value is truncated or not. @@ -35,7 +35,7 @@ Whether the value is truncated or not. optional name: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:7273](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7273) +Defined in: [gen/types.gen.ts:8080](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8080) Name of the variable. @@ -47,7 +47,7 @@ Name of the variable. optional processInstanceKey: ProcessInstanceKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:7297](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7297) +Defined in: [gen/types.gen.ts:8113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8113) The key of the process instance of this variable. @@ -59,9 +59,13 @@ The key of the process instance of this variable. optional scopeKey: ScopeKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:7293](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7293) +Defined in: [gen/types.gen.ts:8109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8109) -The key of the scope of this variable. +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. --- @@ -71,7 +75,7 @@ The key of the scope of this variable. optional tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:7281](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7281) +Defined in: [gen/types.gen.ts:8092](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8092) Tenant ID of this variable. @@ -83,9 +87,12 @@ Tenant ID of this variable. optional value: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:7277](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7277) +Defined in: [gen/types.gen.ts:8088](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8088) 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. --- @@ -95,6 +102,6 @@ The value of the variable. optional variableKey: VariableKeyFilterProperty; ``` -Defined in: [gen/types.gen.ts:7289](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7289) +Defined in: [gen/types.gen.ts:8100](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8100) The key for this variable. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKey.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKey.md index 8a8b02fe0b5..071f0aae31e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKey.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKey.md @@ -11,6 +11,6 @@ mdx: type VariableKey = CamundaKey<"VariableKey">; ``` -Defined in: [gen/types.gen.ts:4044](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4044) +Defined in: [gen/types.gen.ts:4681](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4681) System-generated key for a variable. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKeyExactMatch.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKeyExactMatch.md index 6e3bbc8040b..57d97de6155 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKeyExactMatch.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKeyExactMatch.md @@ -11,7 +11,7 @@ mdx: type VariableKeyExactMatch = VariableKey; ``` -Defined in: [gen/types.gen.ts:7577](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7577) +Defined in: [gen/types.gen.ts:8423](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8423) Exact match diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKeyFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKeyFilterProperty.md index fc24c4dd5de..df69ad50a04 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKeyFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableKeyFilterProperty.md @@ -13,6 +13,6 @@ type VariableKeyFilterProperty = | AdvancedVariableKeyFilter; ``` -Defined in: [gen/types.gen.ts:4304](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L4304) +Defined in: [gen/types.gen.ts:4945](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L4945) VariableKey property with full advanced search capabilities. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableResult.md index 2a290a168af..4de9e71dcb1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableResult.md @@ -11,16 +11,16 @@ mdx: type VariableResult = VariableResultBase & object; ``` -Defined in: [gen/types.gen.ts:7327](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7327) +Defined in: [gen/types.gen.ts:8143](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8143) Variable search response item. ## Type Declaration -### value? +### value ```ts -optional value: string; +value: string; ``` Full value of this variable. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableResultBase.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableResultBase.md index 42aecfc4480..ab9959a9c13 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableResultBase.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableResultBase.md @@ -11,76 +11,83 @@ mdx: type VariableResultBase = object; ``` -Defined in: [gen/types.gen.ts:7337](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7337) +Defined in: [gen/types.gen.ts:8153](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8153) Variable response item. ## Properties -### name? +### name ```ts -optional name: string; +name: string; ``` -Defined in: [gen/types.gen.ts:7341](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7341) +Defined in: [gen/types.gen.ts:8157](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8157) Name of this variable. --- -### processInstanceKey? +### processInstanceKey ```ts -optional processInstanceKey: ProcessInstanceKey; +processInstanceKey: ProcessInstanceKey; ``` -Defined in: [gen/types.gen.ts:7357](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7357) +Defined in: [gen/types.gen.ts:8177](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8177) The key of the process instance of this variable. --- -### rootProcessInstanceKey? +### rootProcessInstanceKey ```ts -optional rootProcessInstanceKey: RootProcessInstanceKey; +rootProcessInstanceKey: ProcessInstanceKey | null; ``` -Defined in: [gen/types.gen.ts:7358](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7358) +Defined in: [gen/types.gen.ts:8184](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8184) + +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. --- -### scopeKey? +### scopeKey ```ts -optional scopeKey: ScopeKey; +scopeKey: ScopeKey; ``` -Defined in: [gen/types.gen.ts:7353](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7353) +Defined in: [gen/types.gen.ts:8173](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8173) -The key of the scope of this variable. +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. --- -### tenantId? +### tenantId ```ts -optional tenantId: TenantId; +tenantId: TenantId; ``` -Defined in: [gen/types.gen.ts:7345](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7345) +Defined in: [gen/types.gen.ts:8161](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8161) Tenant ID of this variable. --- -### variableKey? +### variableKey ```ts -optional variableKey: VariableKey; +variableKey: VariableKey; ``` -Defined in: [gen/types.gen.ts:7349](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7349) +Defined in: [gen/types.gen.ts:8165](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8165) The key for this variable. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQuery.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQuery.md index dc04b81edee..9ae8a2b4442 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQuery.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQuery.md @@ -11,7 +11,7 @@ mdx: type VariableSearchQuery = SearchQueryRequest & object; ``` -Defined in: [gen/types.gen.ts:7255](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7255) +Defined in: [gen/types.gen.ts:8062](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8062) Variable search query request. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQueryResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQueryResult.md index 4847b97e84d..4bac9897120 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQueryResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQueryResult.md @@ -11,16 +11,16 @@ mdx: type VariableSearchQueryResult = SearchQueryResponse & object; ``` -Defined in: [gen/types.gen.ts:7303](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7303) +Defined in: [gen/types.gen.ts:8119](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8119) Variable search query response. ## Type Declaration -### items? +### items ```ts -optional items: VariableSearchResult[]; +items: VariableSearchResult[]; ``` The matching variables. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQuerySortRequest.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQuerySortRequest.md index c303600d46e..df7c74cf695 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQuerySortRequest.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchQuerySortRequest.md @@ -11,7 +11,7 @@ mdx: type VariableSearchQuerySortRequest = object; ``` -Defined in: [gen/types.gen.ts:7244](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7244) +Defined in: [gen/types.gen.ts:8051](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8051) ## Properties @@ -27,7 +27,7 @@ field: | "processInstanceKey"; ``` -Defined in: [gen/types.gen.ts:7248](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7248) +Defined in: [gen/types.gen.ts:8055](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8055) The field to sort by. @@ -39,4 +39,4 @@ The field to sort by. optional order: SortOrderEnum; ``` -Defined in: [gen/types.gen.ts:7249](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7249) +Defined in: [gen/types.gen.ts:8056](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8056) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchResult.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchResult.md index 98f252648a6..3d4789e313b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchResult.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableSearchResult.md @@ -11,24 +11,24 @@ mdx: type VariableSearchResult = VariableResultBase & object; ``` -Defined in: [gen/types.gen.ts:7313](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7313) +Defined in: [gen/types.gen.ts:8129](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8129) Variable search response item. ## Type Declaration -### isTruncated? +### isTruncated ```ts -optional isTruncated: boolean; +isTruncated: boolean; ``` Whether the value is truncated or not. -### value? +### value ```ts -optional value: string; +value: string; ``` Value of this variable. Can be truncated. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableValueFilterProperty.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableValueFilterProperty.md index e9f72f7a9b4..bb816b72255 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableValueFilterProperty.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/VariableValueFilterProperty.md @@ -11,7 +11,7 @@ mdx: type VariableValueFilterProperty = object; ``` -Defined in: [gen/types.gen.ts:7361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7361) +Defined in: [gen/types.gen.ts:8187](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8187) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/types.gen.ts:7361](https://github.com/camunda/orchestration-clu name: string; ``` -Defined in: [gen/types.gen.ts:7365](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7365) +Defined in: [gen/types.gen.ts:8191](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8191) Name of the variable. @@ -33,6 +33,9 @@ Name of the variable. value: StringFilterProperty; ``` -Defined in: [gen/types.gen.ts:7369](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/types.gen.ts#L7369) +Defined in: [gen/types.gen.ts:8199](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/types.gen.ts#L8199) 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. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/activateAdHocSubProcessActivitiesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/activateAdHocSubProcessActivitiesInput.md index 2b2068e7baa..cb64b894a73 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/activateAdHocSubProcessActivitiesInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/activateAdHocSubProcessActivitiesInput.md @@ -12,7 +12,7 @@ type activateAdHocSubProcessActivitiesInput = activateAdHocSubProcessActivitiesBody & object; ``` -Defined in: [gen/CamundaClient.ts:52](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L52) +Defined in: [gen/CamundaClient.ts:58](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L58) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/activateJobsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/activateJobsInput.md index 6c0ea234134..1d60e36d264 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/activateJobsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/activateJobsInput.md @@ -11,4 +11,4 @@ mdx: type activateJobsInput = activateJobsBody; ``` -Defined in: [gen/CamundaClient.ts:55](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L55) +Defined in: [gen/CamundaClient.ts:61](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L61) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignClientToGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignClientToGroupInput.md index 4b0d424f2e1..d652a3e7150 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignClientToGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignClientToGroupInput.md @@ -11,7 +11,7 @@ mdx: type assignClientToGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:59](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L59) +Defined in: [gen/CamundaClient.ts:65](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L65) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:59](https://github.com/camunda/orchestration-c clientId: assignClientToGroupPathParam_clientId; ``` -Defined in: [gen/CamundaClient.ts:59](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L59) +Defined in: [gen/CamundaClient.ts:65](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L65) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:59](https://github.com/camunda/orchestration-c groupId: assignClientToGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:59](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L59) +Defined in: [gen/CamundaClient.ts:65](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L65) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignClientToTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignClientToTenantInput.md index ca6fda66350..8db46aac235 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignClientToTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignClientToTenantInput.md @@ -11,7 +11,7 @@ mdx: type assignClientToTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:63](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L63) +Defined in: [gen/CamundaClient.ts:69](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L69) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:63](https://github.com/camunda/orchestration-c clientId: assignClientToTenantPathParam_clientId; ``` -Defined in: [gen/CamundaClient.ts:63](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L63) +Defined in: [gen/CamundaClient.ts:69](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L69) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:63](https://github.com/camunda/orchestration-c tenantId: assignClientToTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:63](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L63) +Defined in: [gen/CamundaClient.ts:69](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L69) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignGroupToTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignGroupToTenantInput.md index 6a4c0422ef7..0e983b63bc7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignGroupToTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignGroupToTenantInput.md @@ -11,7 +11,7 @@ mdx: type assignGroupToTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:67](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L67) +Defined in: [gen/CamundaClient.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L73) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:67](https://github.com/camunda/orchestration-c groupId: assignGroupToTenantPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:67](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L67) +Defined in: [gen/CamundaClient.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L73) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:67](https://github.com/camunda/orchestration-c tenantId: assignGroupToTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:67](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L67) +Defined in: [gen/CamundaClient.ts:73](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L73) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignMappingRuleToGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignMappingRuleToGroupInput.md index 95bbb5dae6f..23a97cc2b4a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignMappingRuleToGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignMappingRuleToGroupInput.md @@ -11,7 +11,7 @@ mdx: type assignMappingRuleToGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:71](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L71) +Defined in: [gen/CamundaClient.ts:77](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L77) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:71](https://github.com/camunda/orchestration-c groupId: assignMappingRuleToGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:71](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L71) +Defined in: [gen/CamundaClient.ts:77](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L77) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:71](https://github.com/camunda/orchestration-c mappingRuleId: assignMappingRuleToGroupPathParam_mappingRuleId; ``` -Defined in: [gen/CamundaClient.ts:71](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L71) +Defined in: [gen/CamundaClient.ts:77](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L77) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignMappingRuleToTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignMappingRuleToTenantInput.md index 15db323e6b9..d4581e2cfdc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignMappingRuleToTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignMappingRuleToTenantInput.md @@ -11,7 +11,7 @@ mdx: type assignMappingRuleToTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:75](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L75) +Defined in: [gen/CamundaClient.ts:81](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L81) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:75](https://github.com/camunda/orchestration-c mappingRuleId: assignMappingRuleToTenantPathParam_mappingRuleId; ``` -Defined in: [gen/CamundaClient.ts:75](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L75) +Defined in: [gen/CamundaClient.ts:81](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L81) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:75](https://github.com/camunda/orchestration-c tenantId: assignMappingRuleToTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:75](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L75) +Defined in: [gen/CamundaClient.ts:81](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L81) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToClientInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToClientInput.md index 3eb22f368c2..80ad9b39174 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToClientInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToClientInput.md @@ -11,7 +11,7 @@ mdx: type assignRoleToClientInput = object; ``` -Defined in: [gen/CamundaClient.ts:79](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L79) +Defined in: [gen/CamundaClient.ts:85](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L85) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:79](https://github.com/camunda/orchestration-c clientId: assignRoleToClientPathParam_clientId; ``` -Defined in: [gen/CamundaClient.ts:79](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L79) +Defined in: [gen/CamundaClient.ts:85](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L85) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:79](https://github.com/camunda/orchestration-c roleId: assignRoleToClientPathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:79](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L79) +Defined in: [gen/CamundaClient.ts:85](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L85) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToGroupInput.md index 48665ecf363..1a72599a34d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToGroupInput.md @@ -11,7 +11,7 @@ mdx: type assignRoleToGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:83](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L83) +Defined in: [gen/CamundaClient.ts:89](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L89) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:83](https://github.com/camunda/orchestration-c groupId: assignRoleToGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:83](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L83) +Defined in: [gen/CamundaClient.ts:89](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L89) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:83](https://github.com/camunda/orchestration-c roleId: assignRoleToGroupPathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:83](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L83) +Defined in: [gen/CamundaClient.ts:89](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L89) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToMappingRuleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToMappingRuleInput.md index a24fc33d679..10b4b400523 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToMappingRuleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToMappingRuleInput.md @@ -11,7 +11,7 @@ mdx: type assignRoleToMappingRuleInput = object; ``` -Defined in: [gen/CamundaClient.ts:87](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L87) +Defined in: [gen/CamundaClient.ts:93](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L93) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:87](https://github.com/camunda/orchestration-c mappingRuleId: assignRoleToMappingRulePathParam_mappingRuleId; ``` -Defined in: [gen/CamundaClient.ts:87](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L87) +Defined in: [gen/CamundaClient.ts:93](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L93) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:87](https://github.com/camunda/orchestration-c roleId: assignRoleToMappingRulePathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:87](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L87) +Defined in: [gen/CamundaClient.ts:93](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L93) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToTenantInput.md index 554a349c456..e444a87ff78 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToTenantInput.md @@ -11,7 +11,7 @@ mdx: type assignRoleToTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:91](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L91) +Defined in: [gen/CamundaClient.ts:97](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L97) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:91](https://github.com/camunda/orchestration-c roleId: assignRoleToTenantPathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:91](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L91) +Defined in: [gen/CamundaClient.ts:97](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L97) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:91](https://github.com/camunda/orchestration-c tenantId: assignRoleToTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:91](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L91) +Defined in: [gen/CamundaClient.ts:97](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L97) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToUserInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToUserInput.md index 537d3be017e..19e7e09ef14 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToUserInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignRoleToUserInput.md @@ -11,7 +11,7 @@ mdx: type assignRoleToUserInput = object; ``` -Defined in: [gen/CamundaClient.ts:95](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L95) +Defined in: [gen/CamundaClient.ts:101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L101) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:95](https://github.com/camunda/orchestration-c roleId: assignRoleToUserPathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:95](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L95) +Defined in: [gen/CamundaClient.ts:101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L101) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:95](https://github.com/camunda/orchestration-c username: assignRoleToUserPathParam_username; ``` -Defined in: [gen/CamundaClient.ts:95](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L95) +Defined in: [gen/CamundaClient.ts:101](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L101) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserTaskInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserTaskInput.md index 0f1831d8974..78380a6d96b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserTaskInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserTaskInput.md @@ -11,7 +11,7 @@ mdx: type assignUserTaskInput = assignUserTaskBody & object; ``` -Defined in: [gen/CamundaClient.ts:99](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L99) +Defined in: [gen/CamundaClient.ts:105](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L105) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserToGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserToGroupInput.md index 394b0f204d7..c6fb0539653 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserToGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserToGroupInput.md @@ -11,7 +11,7 @@ mdx: type assignUserToGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L103) +Defined in: [gen/CamundaClient.ts:109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L109) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:103](https://github.com/camunda/orchestration- groupId: assignUserToGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L103) +Defined in: [gen/CamundaClient.ts:109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L109) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:103](https://github.com/camunda/orchestration- username: assignUserToGroupPathParam_username; ``` -Defined in: [gen/CamundaClient.ts:103](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L103) +Defined in: [gen/CamundaClient.ts:109](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L109) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserToTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserToTenantInput.md index 087a2a034f4..6c201748444 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserToTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/assignUserToTenantInput.md @@ -11,7 +11,7 @@ mdx: type assignUserToTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:107](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L107) +Defined in: [gen/CamundaClient.ts:113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L113) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:107](https://github.com/camunda/orchestration- tenantId: assignUserToTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:107](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L107) +Defined in: [gen/CamundaClient.ts:113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L113) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:107](https://github.com/camunda/orchestration- username: assignUserToTenantPathParam_username; ``` -Defined in: [gen/CamundaClient.ts:107](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L107) +Defined in: [gen/CamundaClient.ts:113](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L113) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/broadcastSignalInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/broadcastSignalInput.md index 35275cbc93a..2a6b7fb8053 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/broadcastSignalInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/broadcastSignalInput.md @@ -11,4 +11,4 @@ mdx: type broadcastSignalInput = broadcastSignalBody; ``` -Defined in: [gen/CamundaClient.ts:110](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L110) +Defined in: [gen/CamundaClient.ts:116](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L116) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelBatchOperationConsistency.md deleted file mode 100644 index 7253362b55c..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelBatchOperationConsistency.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Type Alias: cancelBatchOperationConsistency" -sidebar_label: "cancelBatchOperationConsistency" -mdx: - format: md ---- - -# Type Alias: cancelBatchOperationConsistency - -```ts -type cancelBatchOperationConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:116](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L116) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions<_DataOf>; -``` - -Defined in: [gen/CamundaClient.ts:118](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L118) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelBatchOperationInput.md index cfd118a6f55..d719aabb462 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelBatchOperationInput.md @@ -11,7 +11,7 @@ mdx: type cancelBatchOperationInput = cancelBatchOperationBody & object; ``` -Defined in: [gen/CamundaClient.ts:114](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L114) +Defined in: [gen/CamundaClient.ts:120](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L120) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstanceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstanceInput.md index b5174219233..cc4eaee9eca 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstanceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstanceInput.md @@ -11,7 +11,7 @@ mdx: type cancelProcessInstanceInput = cancelProcessInstanceBody & object; ``` -Defined in: [gen/CamundaClient.ts:123](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L123) +Defined in: [gen/CamundaClient.ts:124](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L124) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstancesBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstancesBatchOperationConsistency.md deleted file mode 100644 index 0a5894a8173..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstancesBatchOperationConsistency.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Type Alias: cancelProcessInstancesBatchOperationConsistency" -sidebar_label: "cancelProcessInstancesBatchOperationConsistency" -mdx: - format: md ---- - -# Type Alias: cancelProcessInstancesBatchOperationConsistency - -```ts -type cancelProcessInstancesBatchOperationConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:128](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L128) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions< - _DataOf ->; -``` - -Defined in: [gen/CamundaClient.ts:130](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L130) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstancesBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstancesBatchOperationInput.md index 22d463a1281..0c47be1f060 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstancesBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/cancelProcessInstancesBatchOperationInput.md @@ -12,4 +12,4 @@ type cancelProcessInstancesBatchOperationInput = cancelProcessInstancesBatchOperationBody; ``` -Defined in: [gen/CamundaClient.ts:126](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L126) +Defined in: [gen/CamundaClient.ts:127](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L127) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/completeJobInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/completeJobInput.md index 2c9403490c4..b36acfd4834 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/completeJobInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/completeJobInput.md @@ -11,7 +11,7 @@ mdx: type completeJobInput = completeJobBody & object; ``` -Defined in: [gen/CamundaClient.ts:135](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L135) +Defined in: [gen/CamundaClient.ts:131](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L131) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/completeUserTaskInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/completeUserTaskInput.md index 6d98dd3985b..410486bd573 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/completeUserTaskInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/completeUserTaskInput.md @@ -11,7 +11,7 @@ mdx: type completeUserTaskInput = completeUserTaskBody & object; ``` -Defined in: [gen/CamundaClient.ts:139](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L139) +Defined in: [gen/CamundaClient.ts:135](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L135) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/correlateMessageInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/correlateMessageInput.md index a73effc1bef..2b685895347 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/correlateMessageInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/correlateMessageInput.md @@ -11,4 +11,4 @@ mdx: type correlateMessageInput = correlateMessageBody; ``` -Defined in: [gen/CamundaClient.ts:142](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L142) +Defined in: [gen/CamundaClient.ts:138](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L138) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createAdminUserConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createAdminUserConsistency.md deleted file mode 100644 index 43f9f847192..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createAdminUserConsistency.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Type Alias: createAdminUserConsistency" -sidebar_label: "createAdminUserConsistency" -mdx: - format: md ---- - -# Type Alias: createAdminUserConsistency - -```ts -type createAdminUserConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:147](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L147) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions<_DataOf>; -``` - -Defined in: [gen/CamundaClient.ts:149](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L149) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createAdminUserInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createAdminUserInput.md index 192a20aa4cc..aed32c25fdf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createAdminUserInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createAdminUserInput.md @@ -11,4 +11,4 @@ mdx: type createAdminUserInput = createAdminUserBody; ``` -Defined in: [gen/CamundaClient.ts:145](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L145) +Defined in: [gen/CamundaClient.ts:141](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L141) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createAuthorizationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createAuthorizationInput.md index 860a7b1cc47..c9e4866722b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createAuthorizationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createAuthorizationInput.md @@ -11,4 +11,4 @@ mdx: type createAuthorizationInput = createAuthorizationBody; ``` -Defined in: [gen/CamundaClient.ts:153](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L153) +Defined in: [gen/CamundaClient.ts:144](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L144) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createDeploymentInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createDeploymentInput.md index f00eec90676..07250e42c1d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createDeploymentInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createDeploymentInput.md @@ -11,7 +11,7 @@ mdx: type createDeploymentInput = Omit & object; ``` -Defined in: [gen/CamundaClient.ts:156](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L156) +Defined in: [gen/CamundaClient.ts:147](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L147) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentInput.md index 229e2d8e190..6fe07803b66 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentInput.md @@ -11,7 +11,7 @@ mdx: type createDocumentInput = createDocumentBody & object; ``` -Defined in: [gen/CamundaClient.ts:161](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L161) +Defined in: [gen/CamundaClient.ts:152](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L152) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentLinkInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentLinkInput.md index f174237dfe7..0f1807c95c7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentLinkInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentLinkInput.md @@ -11,7 +11,7 @@ mdx: type createDocumentLinkInput = createDocumentLinkBody & object; ``` -Defined in: [gen/CamundaClient.ts:167](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L167) +Defined in: [gen/CamundaClient.ts:158](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L158) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentsInput.md index 2a345796cf2..4de9ee3483f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createDocumentsInput.md @@ -11,7 +11,7 @@ mdx: type createDocumentsInput = createDocumentsBody & object; ``` -Defined in: [gen/CamundaClient.ts:171](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L171) +Defined in: [gen/CamundaClient.ts:162](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L162) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createElementInstanceVariablesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createElementInstanceVariablesInput.md index ef8c0099c12..ba2f01b8c05 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createElementInstanceVariablesInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createElementInstanceVariablesInput.md @@ -12,7 +12,7 @@ type createElementInstanceVariablesInput = createElementInstanceVariablesBody & object; ``` -Defined in: [gen/CamundaClient.ts:175](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L175) +Defined in: [gen/CamundaClient.ts:166](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L166) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createGlobalClusterVariableInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createGlobalClusterVariableInput.md index b6796515135..455077a76e4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createGlobalClusterVariableInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createGlobalClusterVariableInput.md @@ -11,4 +11,4 @@ mdx: type createGlobalClusterVariableInput = createGlobalClusterVariableBody; ``` -Defined in: [gen/CamundaClient.ts:178](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L178) +Defined in: [gen/CamundaClient.ts:169](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L169) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createGlobalTaskListenerInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createGlobalTaskListenerInput.md new file mode 100644 index 00000000000..100fcd07af5 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createGlobalTaskListenerInput.md @@ -0,0 +1,14 @@ +--- +title: "Type Alias: createGlobalTaskListenerInput" +sidebar_label: "createGlobalTaskListenerInput" +mdx: + format: md +--- + +# Type Alias: createGlobalTaskListenerInput + +```ts +type createGlobalTaskListenerInput = createGlobalTaskListenerBody; +``` + +Defined in: [gen/CamundaClient.ts:172](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L172) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createGroupInput.md index 2b024482b6e..52fbb7e4182 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createGroupInput.md @@ -11,4 +11,4 @@ mdx: type createGroupInput = createGroupBody; ``` -Defined in: [gen/CamundaClient.ts:181](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L181) +Defined in: [gen/CamundaClient.ts:175](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L175) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createMappingRuleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createMappingRuleInput.md index fc51aa0e302..33e41b083ec 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createMappingRuleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createMappingRuleInput.md @@ -11,4 +11,4 @@ mdx: type createMappingRuleInput = createMappingRuleBody; ``` -Defined in: [gen/CamundaClient.ts:184](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L184) +Defined in: [gen/CamundaClient.ts:178](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L178) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createProcessInstanceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createProcessInstanceInput.md index 24e4386aab9..6652a2ff2a5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createProcessInstanceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createProcessInstanceInput.md @@ -11,4 +11,4 @@ mdx: type createProcessInstanceInput = createProcessInstanceBody; ``` -Defined in: [gen/CamundaClient.ts:187](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L187) +Defined in: [gen/CamundaClient.ts:181](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L181) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createRoleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createRoleInput.md index 9765fd1fbe8..fbbbccd9b39 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createRoleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createRoleInput.md @@ -11,4 +11,4 @@ mdx: type createRoleInput = createRoleBody; ``` -Defined in: [gen/CamundaClient.ts:190](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L190) +Defined in: [gen/CamundaClient.ts:184](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L184) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createTenantClusterVariableInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createTenantClusterVariableInput.md index a30ac7e1dfc..30c406b22b8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createTenantClusterVariableInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createTenantClusterVariableInput.md @@ -12,7 +12,7 @@ type createTenantClusterVariableInput = createTenantClusterVariableBody & object; ``` -Defined in: [gen/CamundaClient.ts:197](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L197) +Defined in: [gen/CamundaClient.ts:191](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L191) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createTenantInput.md index 41efb183e46..2867a60327d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createTenantInput.md @@ -11,4 +11,4 @@ mdx: type createTenantInput = createTenantBody; ``` -Defined in: [gen/CamundaClient.ts:193](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L193) +Defined in: [gen/CamundaClient.ts:187](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L187) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createUserConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createUserConsistency.md deleted file mode 100644 index 91a0e69fff9..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createUserConsistency.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Type Alias: createUserConsistency" -sidebar_label: "createUserConsistency" -mdx: - format: md ---- - -# Type Alias: createUserConsistency - -```ts -type createUserConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:202](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L202) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions<_DataOf>; -``` - -Defined in: [gen/CamundaClient.ts:204](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L204) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/createUserInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/createUserInput.md index d4581b04b22..a414ef79a62 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/createUserInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/createUserInput.md @@ -11,4 +11,4 @@ mdx: type createUserInput = createUserBody; ``` -Defined in: [gen/CamundaClient.ts:200](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L200) +Defined in: [gen/CamundaClient.ts:194](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L194) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteAuthorizationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteAuthorizationInput.md index 8de625745f6..e24ef13e610 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteAuthorizationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteAuthorizationInput.md @@ -11,7 +11,7 @@ mdx: type deleteAuthorizationInput = object; ``` -Defined in: [gen/CamundaClient.ts:208](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L208) +Defined in: [gen/CamundaClient.ts:197](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L197) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:208](https://github.com/camunda/orchestration- authorizationKey: deleteAuthorizationPathParam_authorizationKey; ``` -Defined in: [gen/CamundaClient.ts:208](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L208) +Defined in: [gen/CamundaClient.ts:197](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L197) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstanceConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstanceConsistency.md deleted file mode 100644 index 1408f5d890d..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstanceConsistency.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Type Alias: deleteDecisionInstanceConsistency" -sidebar_label: "deleteDecisionInstanceConsistency" -mdx: - format: md ---- - -# Type Alias: deleteDecisionInstanceConsistency - -```ts -type deleteDecisionInstanceConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:214](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L214) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions<_DataOf>; -``` - -Defined in: [gen/CamundaClient.ts:216](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L216) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstanceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstanceInput.md index c514d838b0c..b7e734f7724 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstanceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstanceInput.md @@ -11,12 +11,12 @@ mdx: type deleteDecisionInstanceInput = deleteDecisionInstanceBody & object; ``` -Defined in: [gen/CamundaClient.ts:212](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L212) +Defined in: [gen/CamundaClient.ts:201](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L201) ## Type Declaration -### decisionInstanceKey +### decisionEvaluationKey ```ts -decisionInstanceKey: deleteDecisionInstancePathParam_decisionInstanceKey; +decisionEvaluationKey: deleteDecisionInstancePathParam_decisionEvaluationKey; ``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstancesBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstancesBatchOperationConsistency.md deleted file mode 100644 index b46309ce7de..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstancesBatchOperationConsistency.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Type Alias: deleteDecisionInstancesBatchOperationConsistency" -sidebar_label: "deleteDecisionInstancesBatchOperationConsistency" -mdx: - format: md ---- - -# Type Alias: deleteDecisionInstancesBatchOperationConsistency - -```ts -type deleteDecisionInstancesBatchOperationConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:222](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L222) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions< - _DataOf ->; -``` - -Defined in: [gen/CamundaClient.ts:224](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L224) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstancesBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstancesBatchOperationInput.md index 7dcf24aa743..3ea287b785d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstancesBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDecisionInstancesBatchOperationInput.md @@ -12,4 +12,4 @@ type deleteDecisionInstancesBatchOperationInput = deleteDecisionInstancesBatchOperationBody; ``` -Defined in: [gen/CamundaClient.ts:220](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L220) +Defined in: [gen/CamundaClient.ts:204](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L204) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDocumentInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDocumentInput.md index b807214811b..f61e33b18ae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDocumentInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteDocumentInput.md @@ -11,7 +11,7 @@ mdx: type deleteDocumentInput = object; ``` -Defined in: [gen/CamundaClient.ts:229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L229) +Defined in: [gen/CamundaClient.ts:208](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L208) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:229](https://github.com/camunda/orchestration- documentId: deleteDocumentPathParam_documentId; ``` -Defined in: [gen/CamundaClient.ts:229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L229) +Defined in: [gen/CamundaClient.ts:208](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L208) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:229](https://github.com/camunda/orchestration- optional storeId: deleteDocumentQueryParam_storeId; ``` -Defined in: [gen/CamundaClient.ts:229](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L229) +Defined in: [gen/CamundaClient.ts:208](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L208) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGlobalClusterVariableInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGlobalClusterVariableInput.md index 1db460041c8..fb6bba9e488 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGlobalClusterVariableInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGlobalClusterVariableInput.md @@ -11,7 +11,7 @@ mdx: type deleteGlobalClusterVariableInput = object; ``` -Defined in: [gen/CamundaClient.ts:232](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L232) +Defined in: [gen/CamundaClient.ts:211](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L211) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:232](https://github.com/camunda/orchestration- name: deleteGlobalClusterVariablePathParam_name; ``` -Defined in: [gen/CamundaClient.ts:232](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L232) +Defined in: [gen/CamundaClient.ts:211](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L211) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGlobalTaskListenerInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGlobalTaskListenerInput.md new file mode 100644 index 00000000000..5ff2ea45064 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGlobalTaskListenerInput.md @@ -0,0 +1,24 @@ +--- +title: "Type Alias: deleteGlobalTaskListenerInput" +sidebar_label: "deleteGlobalTaskListenerInput" +mdx: + format: md +--- + +# Type Alias: deleteGlobalTaskListenerInput + +```ts +type deleteGlobalTaskListenerInput = object; +``` + +Defined in: [gen/CamundaClient.ts:214](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L214) + +## Properties + +### id + +```ts +id: deleteGlobalTaskListenerPathParam_id; +``` + +Defined in: [gen/CamundaClient.ts:214](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L214) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGroupInput.md index 9a198ed0cca..8810ef6c3ef 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteGroupInput.md @@ -11,7 +11,7 @@ mdx: type deleteGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:235](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L235) +Defined in: [gen/CamundaClient.ts:217](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L217) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:235](https://github.com/camunda/orchestration- groupId: deleteGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:235](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L235) +Defined in: [gen/CamundaClient.ts:217](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L217) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteMappingRuleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteMappingRuleInput.md index d34eeb4a78b..74b73a3edb2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteMappingRuleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteMappingRuleInput.md @@ -11,7 +11,7 @@ mdx: type deleteMappingRuleInput = object; ``` -Defined in: [gen/CamundaClient.ts:238](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L238) +Defined in: [gen/CamundaClient.ts:220](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L220) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:238](https://github.com/camunda/orchestration- mappingRuleId: deleteMappingRulePathParam_mappingRuleId; ``` -Defined in: [gen/CamundaClient.ts:238](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L238) +Defined in: [gen/CamundaClient.ts:220](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L220) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstanceConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstanceConsistency.md deleted file mode 100644 index a633de06c23..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstanceConsistency.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Type Alias: deleteProcessInstanceConsistency" -sidebar_label: "deleteProcessInstanceConsistency" -mdx: - format: md ---- - -# Type Alias: deleteProcessInstanceConsistency - -```ts -type deleteProcessInstanceConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:244](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L244) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions<_DataOf>; -``` - -Defined in: [gen/CamundaClient.ts:246](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L246) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstanceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstanceInput.md index bcdd46eb0b6..59d38da1672 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstanceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstanceInput.md @@ -11,7 +11,7 @@ mdx: type deleteProcessInstanceInput = deleteProcessInstanceBody & object; ``` -Defined in: [gen/CamundaClient.ts:242](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L242) +Defined in: [gen/CamundaClient.ts:224](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L224) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstancesBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstancesBatchOperationConsistency.md deleted file mode 100644 index 0413cd7e7fa..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstancesBatchOperationConsistency.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Type Alias: deleteProcessInstancesBatchOperationConsistency" -sidebar_label: "deleteProcessInstancesBatchOperationConsistency" -mdx: - format: md ---- - -# Type Alias: deleteProcessInstancesBatchOperationConsistency - -```ts -type deleteProcessInstancesBatchOperationConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:252](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L252) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions< - _DataOf ->; -``` - -Defined in: [gen/CamundaClient.ts:254](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L254) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstancesBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstancesBatchOperationInput.md index a137190e77d..0e0959d70e0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstancesBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteProcessInstancesBatchOperationInput.md @@ -12,4 +12,4 @@ type deleteProcessInstancesBatchOperationInput = deleteProcessInstancesBatchOperationBody; ``` -Defined in: [gen/CamundaClient.ts:250](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L250) +Defined in: [gen/CamundaClient.ts:227](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L227) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteResourceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteResourceInput.md index 5f4a4a0d536..cf59259bef4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteResourceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteResourceInput.md @@ -11,7 +11,7 @@ mdx: type deleteResourceInput = deleteResourceBody & object; ``` -Defined in: [gen/CamundaClient.ts:259](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L259) +Defined in: [gen/CamundaClient.ts:231](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L231) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteRoleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteRoleInput.md index 2f9716e1fd9..296f34e0aa6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteRoleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteRoleInput.md @@ -11,7 +11,7 @@ mdx: type deleteRoleInput = object; ``` -Defined in: [gen/CamundaClient.ts:262](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L262) +Defined in: [gen/CamundaClient.ts:234](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L234) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:262](https://github.com/camunda/orchestration- roleId: deleteRolePathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:262](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L262) +Defined in: [gen/CamundaClient.ts:234](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L234) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteTenantClusterVariableInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteTenantClusterVariableInput.md index 4d4e3807b41..60be1ef44b3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteTenantClusterVariableInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteTenantClusterVariableInput.md @@ -11,7 +11,7 @@ mdx: type deleteTenantClusterVariableInput = object; ``` -Defined in: [gen/CamundaClient.ts:269](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L269) +Defined in: [gen/CamundaClient.ts:241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L241) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:269](https://github.com/camunda/orchestration- name: deleteTenantClusterVariablePathParam_name; ``` -Defined in: [gen/CamundaClient.ts:269](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L269) +Defined in: [gen/CamundaClient.ts:241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L241) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:269](https://github.com/camunda/orchestration- tenantId: deleteTenantClusterVariablePathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:269](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L269) +Defined in: [gen/CamundaClient.ts:241](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L241) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteTenantInput.md index 1640d8291db..7ab85e86171 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteTenantInput.md @@ -11,7 +11,7 @@ mdx: type deleteTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:265](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L265) +Defined in: [gen/CamundaClient.ts:237](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L237) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:265](https://github.com/camunda/orchestration- tenantId: deleteTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:265](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L265) +Defined in: [gen/CamundaClient.ts:237](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L237) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteUserConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteUserConsistency.md deleted file mode 100644 index 4ddebfe2012..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteUserConsistency.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Type Alias: deleteUserConsistency" -sidebar_label: "deleteUserConsistency" -mdx: - format: md ---- - -# Type Alias: deleteUserConsistency - -```ts -type deleteUserConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:274](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L274) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions<_DataOf>; -``` - -Defined in: [gen/CamundaClient.ts:276](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L276) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteUserInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteUserInput.md index acaf0de3c80..28ca21a53d0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteUserInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/deleteUserInput.md @@ -11,7 +11,7 @@ mdx: type deleteUserInput = object; ``` -Defined in: [gen/CamundaClient.ts:272](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L272) +Defined in: [gen/CamundaClient.ts:244](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L244) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:272](https://github.com/camunda/orchestration- username: deleteUserPathParam_username; ``` -Defined in: [gen/CamundaClient.ts:272](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L272) +Defined in: [gen/CamundaClient.ts:244](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L244) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateConditionalsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateConditionalsInput.md index a78c0f33445..87105376a9a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateConditionalsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateConditionalsInput.md @@ -11,4 +11,4 @@ mdx: type evaluateConditionalsInput = evaluateConditionalsBody; ``` -Defined in: [gen/CamundaClient.ts:280](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L280) +Defined in: [gen/CamundaClient.ts:247](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L247) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateDecisionInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateDecisionInput.md index 311b6306581..31f9bb4bc6b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateDecisionInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateDecisionInput.md @@ -11,4 +11,4 @@ mdx: type evaluateDecisionInput = evaluateDecisionBody; ``` -Defined in: [gen/CamundaClient.ts:283](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L283) +Defined in: [gen/CamundaClient.ts:250](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L250) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateExpressionInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateExpressionInput.md index b53e750f869..5e67750b2e1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateExpressionInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/evaluateExpressionInput.md @@ -11,4 +11,4 @@ mdx: type evaluateExpressionInput = evaluateExpressionBody; ``` -Defined in: [gen/CamundaClient.ts:286](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L286) +Defined in: [gen/CamundaClient.ts:253](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L253) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/failJobInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/failJobInput.md index ffc1e20bafa..8f9d8d6f07a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/failJobInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/failJobInput.md @@ -11,7 +11,7 @@ mdx: type failJobInput = failJobBody & object; ``` -Defined in: [gen/CamundaClient.ts:290](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L290) +Defined in: [gen/CamundaClient.ts:257](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L257) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuditLogConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuditLogConsistency.md index c0a7993365c..a9eb537633c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuditLogConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuditLogConsistency.md @@ -11,7 +11,7 @@ mdx: type getAuditLogConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:295](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L295) +Defined in: [gen/CamundaClient.ts:262](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L262) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:297](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L297) +Defined in: [gen/CamundaClient.ts:264](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L264) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuditLogInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuditLogInput.md index 35f7fe64ff3..9da2a822bc0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuditLogInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuditLogInput.md @@ -11,7 +11,7 @@ mdx: type getAuditLogInput = object; ``` -Defined in: [gen/CamundaClient.ts:293](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L293) +Defined in: [gen/CamundaClient.ts:260](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L260) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:293](https://github.com/camunda/orchestration- auditLogKey: getAuditLogPathParam_auditLogKey; ``` -Defined in: [gen/CamundaClient.ts:293](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L293) +Defined in: [gen/CamundaClient.ts:260](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L260) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthenticationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthenticationInput.md index fe5868cb6de..67c0f47d4e5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthenticationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthenticationInput.md @@ -11,4 +11,4 @@ mdx: type getAuthenticationInput = void; ``` -Defined in: [gen/CamundaClient.ts:300](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L300) +Defined in: [gen/CamundaClient.ts:267](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L267) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthorizationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthorizationConsistency.md index c0bfcac34c2..606a5f6fdde 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthorizationConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthorizationConsistency.md @@ -11,7 +11,7 @@ mdx: type getAuthorizationConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:305](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L305) +Defined in: [gen/CamundaClient.ts:272](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L272) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:307](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L307) +Defined in: [gen/CamundaClient.ts:274](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L274) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthorizationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthorizationInput.md index d500705497e..4e20713758a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthorizationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getAuthorizationInput.md @@ -11,7 +11,7 @@ mdx: type getAuthorizationInput = object; ``` -Defined in: [gen/CamundaClient.ts:303](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L303) +Defined in: [gen/CamundaClient.ts:270](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L270) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:303](https://github.com/camunda/orchestration- authorizationKey: getAuthorizationPathParam_authorizationKey; ``` -Defined in: [gen/CamundaClient.ts:303](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L303) +Defined in: [gen/CamundaClient.ts:270](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L270) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getBatchOperationConsistency.md index 17e247ae462..070bc2fb3a6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getBatchOperationConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getBatchOperationConsistency.md @@ -11,7 +11,7 @@ mdx: type getBatchOperationConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:313](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L313) +Defined in: [gen/CamundaClient.ts:280](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L280) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:315](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L315) +Defined in: [gen/CamundaClient.ts:282](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L282) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getBatchOperationInput.md index cc229f59d73..576e5431ef0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getBatchOperationInput.md @@ -11,7 +11,7 @@ mdx: type getBatchOperationInput = object; ``` -Defined in: [gen/CamundaClient.ts:311](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L311) +Defined in: [gen/CamundaClient.ts:278](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L278) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:311](https://github.com/camunda/orchestration- batchOperationKey: getBatchOperationPathParam_batchOperationKey; ``` -Defined in: [gen/CamundaClient.ts:311](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L311) +Defined in: [gen/CamundaClient.ts:278](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L278) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionConsistency.md index 41e2dc72865..c14d7622be6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionConsistency.md @@ -11,7 +11,7 @@ mdx: type getDecisionDefinitionConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:321](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L321) +Defined in: [gen/CamundaClient.ts:288](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L288) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:323](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L323) +Defined in: [gen/CamundaClient.ts:290](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L290) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionInput.md index 5c48e1c9668..1df5c90a394 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionInput.md @@ -11,7 +11,7 @@ mdx: type getDecisionDefinitionInput = object; ``` -Defined in: [gen/CamundaClient.ts:319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L319) +Defined in: [gen/CamundaClient.ts:286](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L286) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:319](https://github.com/camunda/orchestration- decisionDefinitionKey: getDecisionDefinitionPathParam_decisionDefinitionKey; ``` -Defined in: [gen/CamundaClient.ts:319](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L319) +Defined in: [gen/CamundaClient.ts:286](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L286) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionXmlConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionXmlConsistency.md index 37847f05fa8..ae39c841beb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionXmlConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionXmlConsistency.md @@ -11,7 +11,7 @@ mdx: type getDecisionDefinitionXmlConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:329](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L329) +Defined in: [gen/CamundaClient.ts:296](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L296) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:331](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L331) +Defined in: [gen/CamundaClient.ts:298](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L298) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionXmlInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionXmlInput.md index 17f78c19b6b..8338b431a88 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionXmlInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionDefinitionXmlInput.md @@ -11,7 +11,7 @@ mdx: type getDecisionDefinitionXmlInput = object; ``` -Defined in: [gen/CamundaClient.ts:327](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L327) +Defined in: [gen/CamundaClient.ts:294](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L294) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:327](https://github.com/camunda/orchestration- decisionDefinitionKey: getDecisionDefinitionXmlPathParam_decisionDefinitionKey; ``` -Defined in: [gen/CamundaClient.ts:327](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L327) +Defined in: [gen/CamundaClient.ts:294](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L294) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionInstanceConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionInstanceConsistency.md index 103de7a1d60..53827a655bc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionInstanceConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionInstanceConsistency.md @@ -11,7 +11,7 @@ mdx: type getDecisionInstanceConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:337](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L337) +Defined in: [gen/CamundaClient.ts:304](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L304) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:339](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L339) +Defined in: [gen/CamundaClient.ts:306](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L306) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionInstanceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionInstanceInput.md index 8d22f79df57..e6993eec40b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionInstanceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionInstanceInput.md @@ -11,7 +11,7 @@ mdx: type getDecisionInstanceInput = object; ``` -Defined in: [gen/CamundaClient.ts:335](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L335) +Defined in: [gen/CamundaClient.ts:302](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L302) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:335](https://github.com/camunda/orchestration- decisionEvaluationInstanceKey: getDecisionInstancePathParam_decisionEvaluationInstanceKey; ``` -Defined in: [gen/CamundaClient.ts:335](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L335) +Defined in: [gen/CamundaClient.ts:302](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L302) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsConsistency.md index 4d09b2024f6..d45e3fa9c13 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsConsistency.md @@ -11,7 +11,7 @@ mdx: type getDecisionRequirementsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:345](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L345) +Defined in: [gen/CamundaClient.ts:312](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L312) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:347](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L347) +Defined in: [gen/CamundaClient.ts:314](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L314) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsInput.md index 8fa00db0bea..33959142569 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsInput.md @@ -11,7 +11,7 @@ mdx: type getDecisionRequirementsInput = object; ``` -Defined in: [gen/CamundaClient.ts:343](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L343) +Defined in: [gen/CamundaClient.ts:310](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L310) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:343](https://github.com/camunda/orchestration- decisionRequirementsKey: getDecisionRequirementsPathParam_decisionRequirementsKey; ``` -Defined in: [gen/CamundaClient.ts:343](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L343) +Defined in: [gen/CamundaClient.ts:310](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L310) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsXmlConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsXmlConsistency.md index 26c872e83eb..42baa9e740b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsXmlConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsXmlConsistency.md @@ -11,7 +11,7 @@ mdx: type getDecisionRequirementsXmlConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:353](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L353) +Defined in: [gen/CamundaClient.ts:320](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L320) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:355](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L355) +Defined in: [gen/CamundaClient.ts:322](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L322) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsXmlInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsXmlInput.md index 7f81e982bd0..ddb6ea96f42 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsXmlInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDecisionRequirementsXmlInput.md @@ -11,7 +11,7 @@ mdx: type getDecisionRequirementsXmlInput = object; ``` -Defined in: [gen/CamundaClient.ts:351](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L351) +Defined in: [gen/CamundaClient.ts:318](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L318) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:351](https://github.com/camunda/orchestration- decisionRequirementsKey: getDecisionRequirementsXmlPathParam_decisionRequirementsKey; ``` -Defined in: [gen/CamundaClient.ts:351](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L351) +Defined in: [gen/CamundaClient.ts:318](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L318) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDocumentInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDocumentInput.md index 216378168fd..8d899876053 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getDocumentInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getDocumentInput.md @@ -11,7 +11,7 @@ mdx: type getDocumentInput = object; ``` -Defined in: [gen/CamundaClient.ts:361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L361) +Defined in: [gen/CamundaClient.ts:328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L328) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:361](https://github.com/camunda/orchestration- optional contentHash: getDocumentQueryParam_contentHash; ``` -Defined in: [gen/CamundaClient.ts:361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L361) +Defined in: [gen/CamundaClient.ts:328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L328) --- @@ -31,7 +31,7 @@ Defined in: [gen/CamundaClient.ts:361](https://github.com/camunda/orchestration- documentId: getDocumentPathParam_documentId; ``` -Defined in: [gen/CamundaClient.ts:361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L361) +Defined in: [gen/CamundaClient.ts:328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L328) --- @@ -41,4 +41,4 @@ Defined in: [gen/CamundaClient.ts:361](https://github.com/camunda/orchestration- optional storeId: getDocumentQueryParam_storeId; ``` -Defined in: [gen/CamundaClient.ts:361](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L361) +Defined in: [gen/CamundaClient.ts:328](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L328) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getElementInstanceConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getElementInstanceConsistency.md index 7bf729d31a2..f43f75e5504 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getElementInstanceConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getElementInstanceConsistency.md @@ -11,7 +11,7 @@ mdx: type getElementInstanceConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:366](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L366) +Defined in: [gen/CamundaClient.ts:333](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L333) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:368](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L368) +Defined in: [gen/CamundaClient.ts:335](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L335) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getElementInstanceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getElementInstanceInput.md index afa8aed2ace..c4f5c915387 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getElementInstanceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getElementInstanceInput.md @@ -11,7 +11,7 @@ mdx: type getElementInstanceInput = object; ``` -Defined in: [gen/CamundaClient.ts:364](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L364) +Defined in: [gen/CamundaClient.ts:331](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L331) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:364](https://github.com/camunda/orchestration- elementInstanceKey: getElementInstancePathParam_elementInstanceKey; ``` -Defined in: [gen/CamundaClient.ts:364](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L364) +Defined in: [gen/CamundaClient.ts:331](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L331) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalClusterVariableConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalClusterVariableConsistency.md index d8f3276a1cd..f324057bfa1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalClusterVariableConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalClusterVariableConsistency.md @@ -11,7 +11,7 @@ mdx: type getGlobalClusterVariableConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:374](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L374) +Defined in: [gen/CamundaClient.ts:341](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L341) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:376](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L376) +Defined in: [gen/CamundaClient.ts:343](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L343) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalClusterVariableInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalClusterVariableInput.md index d9147f07d22..b4fcdcec656 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalClusterVariableInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalClusterVariableInput.md @@ -11,7 +11,7 @@ mdx: type getGlobalClusterVariableInput = object; ``` -Defined in: [gen/CamundaClient.ts:372](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L372) +Defined in: [gen/CamundaClient.ts:339](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L339) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:372](https://github.com/camunda/orchestration- name: getGlobalClusterVariablePathParam_name; ``` -Defined in: [gen/CamundaClient.ts:372](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L372) +Defined in: [gen/CamundaClient.ts:339](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L339) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalJobStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalJobStatisticsConsistency.md index 7f475839238..b46c079898e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalJobStatisticsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalJobStatisticsConsistency.md @@ -11,7 +11,7 @@ mdx: type getGlobalJobStatisticsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:384](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L384) +Defined in: [gen/CamundaClient.ts:351](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L351) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:386](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L386) +Defined in: [gen/CamundaClient.ts:353](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L353) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalJobStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalJobStatisticsInput.md index 44911006c68..c09550f82ad 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalJobStatisticsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalJobStatisticsInput.md @@ -11,7 +11,7 @@ mdx: type getGlobalJobStatisticsInput = object; ``` -Defined in: [gen/CamundaClient.ts:382](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L382) +Defined in: [gen/CamundaClient.ts:349](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L349) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:382](https://github.com/camunda/orchestration- from: getGlobalJobStatisticsQueryParam_from; ``` -Defined in: [gen/CamundaClient.ts:382](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L382) +Defined in: [gen/CamundaClient.ts:349](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L349) --- @@ -31,7 +31,7 @@ Defined in: [gen/CamundaClient.ts:382](https://github.com/camunda/orchestration- optional jobType: getGlobalJobStatisticsQueryParam_jobType; ``` -Defined in: [gen/CamundaClient.ts:382](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L382) +Defined in: [gen/CamundaClient.ts:349](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L349) --- @@ -41,4 +41,4 @@ Defined in: [gen/CamundaClient.ts:382](https://github.com/camunda/orchestration- to: getGlobalJobStatisticsQueryParam_to; ``` -Defined in: [gen/CamundaClient.ts:382](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L382) +Defined in: [gen/CamundaClient.ts:349](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L349) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalTaskListenerConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalTaskListenerConsistency.md new file mode 100644 index 00000000000..2ff0c30ce15 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalTaskListenerConsistency.md @@ -0,0 +1,28 @@ +--- +title: "Type Alias: getGlobalTaskListenerConsistency" +sidebar_label: "getGlobalTaskListenerConsistency" +mdx: + format: md +--- + +# Type Alias: getGlobalTaskListenerConsistency + +```ts +type getGlobalTaskListenerConsistency = object; +``` + +Defined in: [gen/CamundaClient.ts:359](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L359) + +Management of eventual consistency \* + +## Properties + +### consistency + +```ts +consistency: ConsistencyOptions<_DataOf>; +``` + +Defined in: [gen/CamundaClient.ts:361](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L361) + +Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalTaskListenerInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalTaskListenerInput.md new file mode 100644 index 00000000000..9089403a547 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGlobalTaskListenerInput.md @@ -0,0 +1,24 @@ +--- +title: "Type Alias: getGlobalTaskListenerInput" +sidebar_label: "getGlobalTaskListenerInput" +mdx: + format: md +--- + +# Type Alias: getGlobalTaskListenerInput + +```ts +type getGlobalTaskListenerInput = object; +``` + +Defined in: [gen/CamundaClient.ts:357](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L357) + +## Properties + +### id + +```ts +id: getGlobalTaskListenerPathParam_id; +``` + +Defined in: [gen/CamundaClient.ts:357](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L357) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGroupConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGroupConsistency.md index 27ec3337185..115a8882819 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGroupConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGroupConsistency.md @@ -11,7 +11,7 @@ mdx: type getGroupConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:392](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L392) +Defined in: [gen/CamundaClient.ts:367](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L367) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:394](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L394) +Defined in: [gen/CamundaClient.ts:369](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L369) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGroupInput.md index f716e6e328b..cc977f4e922 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getGroupInput.md @@ -11,7 +11,7 @@ mdx: type getGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:390](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L390) +Defined in: [gen/CamundaClient.ts:365](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L365) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:390](https://github.com/camunda/orchestration- groupId: getGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:390](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L390) +Defined in: [gen/CamundaClient.ts:365](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L365) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getIncidentConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getIncidentConsistency.md index e20a7584ad8..c52b8461b7b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getIncidentConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getIncidentConsistency.md @@ -11,7 +11,7 @@ mdx: type getIncidentConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:400](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L400) +Defined in: [gen/CamundaClient.ts:375](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L375) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:402](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L402) +Defined in: [gen/CamundaClient.ts:377](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L377) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getIncidentInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getIncidentInput.md index 591b9550e30..d739f3f41bf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getIncidentInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getIncidentInput.md @@ -11,7 +11,7 @@ mdx: type getIncidentInput = object; ``` -Defined in: [gen/CamundaClient.ts:398](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L398) +Defined in: [gen/CamundaClient.ts:373](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L373) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:398](https://github.com/camunda/orchestration- incidentKey: getIncidentPathParam_incidentKey; ``` -Defined in: [gen/CamundaClient.ts:398](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L398) +Defined in: [gen/CamundaClient.ts:373](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L373) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobErrorStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobErrorStatisticsConsistency.md new file mode 100644 index 00000000000..8d8f25526f9 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobErrorStatisticsConsistency.md @@ -0,0 +1,28 @@ +--- +title: "Type Alias: getJobErrorStatisticsConsistency" +sidebar_label: "getJobErrorStatisticsConsistency" +mdx: + format: md +--- + +# Type Alias: getJobErrorStatisticsConsistency + +```ts +type getJobErrorStatisticsConsistency = object; +``` + +Defined in: [gen/CamundaClient.ts:383](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L383) + +Management of eventual consistency \* + +## Properties + +### consistency + +```ts +consistency: ConsistencyOptions<_DataOf>; +``` + +Defined in: [gen/CamundaClient.ts:385](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L385) + +Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobErrorStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobErrorStatisticsInput.md new file mode 100644 index 00000000000..53e3afd5165 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobErrorStatisticsInput.md @@ -0,0 +1,14 @@ +--- +title: "Type Alias: getJobErrorStatisticsInput" +sidebar_label: "getJobErrorStatisticsInput" +mdx: + format: md +--- + +# Type Alias: getJobErrorStatisticsInput + +```ts +type getJobErrorStatisticsInput = getJobErrorStatisticsBody; +``` + +Defined in: [gen/CamundaClient.ts:381](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L381) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTimeSeriesStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTimeSeriesStatisticsConsistency.md new file mode 100644 index 00000000000..e7dfc10ae60 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTimeSeriesStatisticsConsistency.md @@ -0,0 +1,28 @@ +--- +title: "Type Alias: getJobTimeSeriesStatisticsConsistency" +sidebar_label: "getJobTimeSeriesStatisticsConsistency" +mdx: + format: md +--- + +# Type Alias: getJobTimeSeriesStatisticsConsistency + +```ts +type getJobTimeSeriesStatisticsConsistency = object; +``` + +Defined in: [gen/CamundaClient.ts:391](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L391) + +Management of eventual consistency \* + +## Properties + +### consistency + +```ts +consistency: ConsistencyOptions<_DataOf>; +``` + +Defined in: [gen/CamundaClient.ts:393](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L393) + +Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTimeSeriesStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTimeSeriesStatisticsInput.md new file mode 100644 index 00000000000..e442bdc9d89 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTimeSeriesStatisticsInput.md @@ -0,0 +1,14 @@ +--- +title: "Type Alias: getJobTimeSeriesStatisticsInput" +sidebar_label: "getJobTimeSeriesStatisticsInput" +mdx: + format: md +--- + +# Type Alias: getJobTimeSeriesStatisticsInput + +```ts +type getJobTimeSeriesStatisticsInput = getJobTimeSeriesStatisticsBody; +``` + +Defined in: [gen/CamundaClient.ts:389](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L389) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTypeStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTypeStatisticsConsistency.md new file mode 100644 index 00000000000..71d64a5206b --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTypeStatisticsConsistency.md @@ -0,0 +1,28 @@ +--- +title: "Type Alias: getJobTypeStatisticsConsistency" +sidebar_label: "getJobTypeStatisticsConsistency" +mdx: + format: md +--- + +# Type Alias: getJobTypeStatisticsConsistency + +```ts +type getJobTypeStatisticsConsistency = object; +``` + +Defined in: [gen/CamundaClient.ts:399](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L399) + +Management of eventual consistency \* + +## Properties + +### consistency + +```ts +consistency: ConsistencyOptions<_DataOf>; +``` + +Defined in: [gen/CamundaClient.ts:401](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L401) + +Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTypeStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTypeStatisticsInput.md new file mode 100644 index 00000000000..d5914e66d24 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobTypeStatisticsInput.md @@ -0,0 +1,14 @@ +--- +title: "Type Alias: getJobTypeStatisticsInput" +sidebar_label: "getJobTypeStatisticsInput" +mdx: + format: md +--- + +# Type Alias: getJobTypeStatisticsInput + +```ts +type getJobTypeStatisticsInput = getJobTypeStatisticsBody; +``` + +Defined in: [gen/CamundaClient.ts:397](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L397) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobWorkerStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobWorkerStatisticsConsistency.md new file mode 100644 index 00000000000..ca752902235 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobWorkerStatisticsConsistency.md @@ -0,0 +1,28 @@ +--- +title: "Type Alias: getJobWorkerStatisticsConsistency" +sidebar_label: "getJobWorkerStatisticsConsistency" +mdx: + format: md +--- + +# Type Alias: getJobWorkerStatisticsConsistency + +```ts +type getJobWorkerStatisticsConsistency = object; +``` + +Defined in: [gen/CamundaClient.ts:407](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L407) + +Management of eventual consistency \* + +## Properties + +### consistency + +```ts +consistency: ConsistencyOptions<_DataOf>; +``` + +Defined in: [gen/CamundaClient.ts:409](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L409) + +Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobWorkerStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobWorkerStatisticsInput.md new file mode 100644 index 00000000000..a4f36700091 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getJobWorkerStatisticsInput.md @@ -0,0 +1,14 @@ +--- +title: "Type Alias: getJobWorkerStatisticsInput" +sidebar_label: "getJobWorkerStatisticsInput" +mdx: + format: md +--- + +# Type Alias: getJobWorkerStatisticsInput + +```ts +type getJobWorkerStatisticsInput = getJobWorkerStatisticsBody; +``` + +Defined in: [gen/CamundaClient.ts:405](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L405) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getLicenseInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getLicenseInput.md index 1231ad34261..03a3fba7a6f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getLicenseInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getLicenseInput.md @@ -11,4 +11,4 @@ mdx: type getLicenseInput = void; ``` -Defined in: [gen/CamundaClient.ts:405](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L405) +Defined in: [gen/CamundaClient.ts:412](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L412) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getMappingRuleConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getMappingRuleConsistency.md index 82a22f854f0..823bf0c05d0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getMappingRuleConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getMappingRuleConsistency.md @@ -11,7 +11,7 @@ mdx: type getMappingRuleConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:410](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L410) +Defined in: [gen/CamundaClient.ts:417](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L417) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:412](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L412) +Defined in: [gen/CamundaClient.ts:419](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L419) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getMappingRuleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getMappingRuleInput.md index 9bfa36e4682..e77e8bb8a67 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getMappingRuleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getMappingRuleInput.md @@ -11,7 +11,7 @@ mdx: type getMappingRuleInput = object; ``` -Defined in: [gen/CamundaClient.ts:408](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L408) +Defined in: [gen/CamundaClient.ts:415](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L415) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:408](https://github.com/camunda/orchestration- mappingRuleId: getMappingRulePathParam_mappingRuleId; ``` -Defined in: [gen/CamundaClient.ts:408](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L408) +Defined in: [gen/CamundaClient.ts:415](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L415) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionConsistency.md index d7fd374297d..7f5081b321d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessDefinitionConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:418](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L418) +Defined in: [gen/CamundaClient.ts:425](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L425) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:420](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L420) +Defined in: [gen/CamundaClient.ts:427](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L427) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInput.md index 66f90f8fcd8..c03cc569113 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInput.md @@ -11,7 +11,7 @@ mdx: type getProcessDefinitionInput = object; ``` -Defined in: [gen/CamundaClient.ts:416](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L416) +Defined in: [gen/CamundaClient.ts:423](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L423) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:416](https://github.com/camunda/orchestration- processDefinitionKey: getProcessDefinitionPathParam_processDefinitionKey; ``` -Defined in: [gen/CamundaClient.ts:416](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L416) +Defined in: [gen/CamundaClient.ts:423](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L423) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceStatisticsConsistency.md index eaa248af379..a9601abba94 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceStatisticsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceStatisticsConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessDefinitionInstanceStatisticsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:426](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L426) +Defined in: [gen/CamundaClient.ts:433](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L433) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:428](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L428) +Defined in: [gen/CamundaClient.ts:435](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L435) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceStatisticsInput.md index 475543ba974..51123eefa8e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceStatisticsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceStatisticsInput.md @@ -12,4 +12,4 @@ type getProcessDefinitionInstanceStatisticsInput = getProcessDefinitionInstanceStatisticsBody; ``` -Defined in: [gen/CamundaClient.ts:424](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L424) +Defined in: [gen/CamundaClient.ts:431](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L431) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceVersionStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceVersionStatisticsConsistency.md index 8972596a8bb..e56c9e99e5b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceVersionStatisticsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceVersionStatisticsConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessDefinitionInstanceVersionStatisticsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:434](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L434) +Defined in: [gen/CamundaClient.ts:441](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L441) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:436](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L436) +Defined in: [gen/CamundaClient.ts:443](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L443) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceVersionStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceVersionStatisticsInput.md index d59bc2adff0..d0ac7c7c9a5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceVersionStatisticsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionInstanceVersionStatisticsInput.md @@ -12,4 +12,4 @@ type getProcessDefinitionInstanceVersionStatisticsInput = getProcessDefinitionInstanceVersionStatisticsBody; ``` -Defined in: [gen/CamundaClient.ts:432](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L432) +Defined in: [gen/CamundaClient.ts:439](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L439) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionMessageSubscriptionStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionMessageSubscriptionStatisticsConsistency.md index 4fcc13a9846..d3c68de5267 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionMessageSubscriptionStatisticsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionMessageSubscriptionStatisticsConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessDefinitionMessageSubscriptionStatisticsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:442](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L442) +Defined in: [gen/CamundaClient.ts:449](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L449) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:444](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L444) +Defined in: [gen/CamundaClient.ts:451](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L451) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionMessageSubscriptionStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionMessageSubscriptionStatisticsInput.md index b602de2cd32..daee2f07858 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionMessageSubscriptionStatisticsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionMessageSubscriptionStatisticsInput.md @@ -12,4 +12,4 @@ type getProcessDefinitionMessageSubscriptionStatisticsInput = getProcessDefinitionMessageSubscriptionStatisticsBody; ``` -Defined in: [gen/CamundaClient.ts:440](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L440) +Defined in: [gen/CamundaClient.ts:447](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L447) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionStatisticsConsistency.md index 5345195ce70..0a0bc6eb779 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionStatisticsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionStatisticsConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessDefinitionStatisticsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:451](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L451) +Defined in: [gen/CamundaClient.ts:458](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L458) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:453](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L453) +Defined in: [gen/CamundaClient.ts:460](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L460) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionStatisticsInput.md index 44f28859214..d81c9687f82 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionStatisticsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionStatisticsInput.md @@ -12,7 +12,7 @@ type getProcessDefinitionStatisticsInput = getProcessDefinitionStatisticsBody & object; ``` -Defined in: [gen/CamundaClient.ts:449](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L449) +Defined in: [gen/CamundaClient.ts:456](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L456) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionXmlConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionXmlConsistency.md index ff4ccadf461..588391fe95a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionXmlConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionXmlConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessDefinitionXmlConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:459](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L459) +Defined in: [gen/CamundaClient.ts:466](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L466) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:461](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L461) +Defined in: [gen/CamundaClient.ts:468](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L468) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionXmlInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionXmlInput.md index a747e3099ad..c20ac0b30df 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionXmlInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessDefinitionXmlInput.md @@ -11,7 +11,7 @@ mdx: type getProcessDefinitionXmlInput = object; ``` -Defined in: [gen/CamundaClient.ts:457](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L457) +Defined in: [gen/CamundaClient.ts:464](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L464) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:457](https://github.com/camunda/orchestration- processDefinitionKey: getProcessDefinitionXmlPathParam_processDefinitionKey; ``` -Defined in: [gen/CamundaClient.ts:457](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L457) +Defined in: [gen/CamundaClient.ts:464](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L464) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceCallHierarchyConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceCallHierarchyConsistency.md index 58637c254ca..1b0c27d0532 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceCallHierarchyConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceCallHierarchyConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceCallHierarchyConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:475](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L475) +Defined in: [gen/CamundaClient.ts:482](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L482) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:477](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L477) +Defined in: [gen/CamundaClient.ts:484](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L484) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceCallHierarchyInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceCallHierarchyInput.md index 8cf596978ef..3a1608ab435 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceCallHierarchyInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceCallHierarchyInput.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceCallHierarchyInput = object; ``` -Defined in: [gen/CamundaClient.ts:473](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L473) +Defined in: [gen/CamundaClient.ts:480](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L480) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:473](https://github.com/camunda/orchestration- processInstanceKey: getProcessInstanceCallHierarchyPathParam_processInstanceKey; ``` -Defined in: [gen/CamundaClient.ts:473](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L473) +Defined in: [gen/CamundaClient.ts:480](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L480) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceConsistency.md index b8abb3d9ca3..a00247a1ea3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:467](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L467) +Defined in: [gen/CamundaClient.ts:474](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L474) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:469](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L469) +Defined in: [gen/CamundaClient.ts:476](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L476) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceInput.md index bde37db09de..aa12244af82 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceInput.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceInput = object; ``` -Defined in: [gen/CamundaClient.ts:465](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L465) +Defined in: [gen/CamundaClient.ts:472](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L472) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:465](https://github.com/camunda/orchestration- processInstanceKey: getProcessInstancePathParam_processInstanceKey; ``` -Defined in: [gen/CamundaClient.ts:465](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L465) +Defined in: [gen/CamundaClient.ts:472](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L472) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceSequenceFlowsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceSequenceFlowsConsistency.md index 03e4a01893c..1c30b071457 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceSequenceFlowsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceSequenceFlowsConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceSequenceFlowsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:483](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L483) +Defined in: [gen/CamundaClient.ts:490](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L490) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:485](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L485) +Defined in: [gen/CamundaClient.ts:492](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L492) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceSequenceFlowsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceSequenceFlowsInput.md index 84bc922fe6b..41c4f5daf43 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceSequenceFlowsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceSequenceFlowsInput.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceSequenceFlowsInput = object; ``` -Defined in: [gen/CamundaClient.ts:481](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L481) +Defined in: [gen/CamundaClient.ts:488](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L488) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:481](https://github.com/camunda/orchestration- processInstanceKey: getProcessInstanceSequenceFlowsPathParam_processInstanceKey; ``` -Defined in: [gen/CamundaClient.ts:481](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L481) +Defined in: [gen/CamundaClient.ts:488](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L488) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByDefinitionConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByDefinitionConsistency.md index 9ef9679f5f2..6f949c90a11 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByDefinitionConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByDefinitionConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceStatisticsByDefinitionConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:499](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L499) +Defined in: [gen/CamundaClient.ts:506](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L506) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:501](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L501) +Defined in: [gen/CamundaClient.ts:508](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L508) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByDefinitionInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByDefinitionInput.md index 8ea48ccb9d8..afb653c7f88 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByDefinitionInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByDefinitionInput.md @@ -12,4 +12,4 @@ type getProcessInstanceStatisticsByDefinitionInput = getProcessInstanceStatisticsByDefinitionBody; ``` -Defined in: [gen/CamundaClient.ts:497](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L497) +Defined in: [gen/CamundaClient.ts:504](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L504) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByErrorConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByErrorConsistency.md index fc71e9c9aa9..98dd0261c84 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByErrorConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByErrorConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceStatisticsByErrorConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:507](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L507) +Defined in: [gen/CamundaClient.ts:514](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L514) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:509](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L509) +Defined in: [gen/CamundaClient.ts:516](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L516) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByErrorInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByErrorInput.md index e4da5b9652a..1cba59f1430 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByErrorInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsByErrorInput.md @@ -12,4 +12,4 @@ type getProcessInstanceStatisticsByErrorInput = getProcessInstanceStatisticsByErrorBody; ``` -Defined in: [gen/CamundaClient.ts:505](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L505) +Defined in: [gen/CamundaClient.ts:512](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L512) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsConsistency.md index 70d826a75c2..735e4e14e58 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsConsistency.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceStatisticsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:491](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L491) +Defined in: [gen/CamundaClient.ts:498](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L498) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:493](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L493) +Defined in: [gen/CamundaClient.ts:500](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L500) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsInput.md index 5833cb8a85e..3c81bf904fc 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getProcessInstanceStatisticsInput.md @@ -11,7 +11,7 @@ mdx: type getProcessInstanceStatisticsInput = object; ``` -Defined in: [gen/CamundaClient.ts:489](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L489) +Defined in: [gen/CamundaClient.ts:496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L496) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:489](https://github.com/camunda/orchestration- processInstanceKey: getProcessInstanceStatisticsPathParam_processInstanceKey; ``` -Defined in: [gen/CamundaClient.ts:489](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L489) +Defined in: [gen/CamundaClient.ts:496](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L496) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getResourceContentInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getResourceContentInput.md index 96bb3d312e4..8216b76b2a4 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getResourceContentInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getResourceContentInput.md @@ -11,7 +11,7 @@ mdx: type getResourceContentInput = object; ``` -Defined in: [gen/CamundaClient.ts:516](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L516) +Defined in: [gen/CamundaClient.ts:523](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L523) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:516](https://github.com/camunda/orchestration- resourceKey: getResourceContentPathParam_resourceKey; ``` -Defined in: [gen/CamundaClient.ts:516](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L516) +Defined in: [gen/CamundaClient.ts:523](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L523) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getResourceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getResourceInput.md index 176a3423ec0..5f1174f850e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getResourceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getResourceInput.md @@ -11,7 +11,7 @@ mdx: type getResourceInput = object; ``` -Defined in: [gen/CamundaClient.ts:513](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L513) +Defined in: [gen/CamundaClient.ts:520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L520) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:513](https://github.com/camunda/orchestration- resourceKey: getResourcePathParam_resourceKey; ``` -Defined in: [gen/CamundaClient.ts:513](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L513) +Defined in: [gen/CamundaClient.ts:520](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L520) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getRoleConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getRoleConsistency.md index 3947c7662e0..356d14fc089 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getRoleConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getRoleConsistency.md @@ -11,7 +11,7 @@ mdx: type getRoleConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:521](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L521) +Defined in: [gen/CamundaClient.ts:528](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L528) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:523](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L523) +Defined in: [gen/CamundaClient.ts:530](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L530) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getRoleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getRoleInput.md index d22189a502d..2fa07814c89 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getRoleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getRoleInput.md @@ -11,7 +11,7 @@ mdx: type getRoleInput = object; ``` -Defined in: [gen/CamundaClient.ts:519](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L519) +Defined in: [gen/CamundaClient.ts:526](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L526) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:519](https://github.com/camunda/orchestration- roleId: getRolePathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:519](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L519) +Defined in: [gen/CamundaClient.ts:526](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L526) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getStartProcessFormConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getStartProcessFormConsistency.md index 2ccf6bce417..f183929e584 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getStartProcessFormConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getStartProcessFormConsistency.md @@ -11,7 +11,7 @@ mdx: type getStartProcessFormConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:529](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L529) +Defined in: [gen/CamundaClient.ts:536](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L536) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:531](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L531) +Defined in: [gen/CamundaClient.ts:538](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L538) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getStartProcessFormInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getStartProcessFormInput.md index c159c0d1bfd..48c51ad7585 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getStartProcessFormInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getStartProcessFormInput.md @@ -11,7 +11,7 @@ mdx: type getStartProcessFormInput = object; ``` -Defined in: [gen/CamundaClient.ts:527](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L527) +Defined in: [gen/CamundaClient.ts:534](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L534) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:527](https://github.com/camunda/orchestration- processDefinitionKey: getStartProcessFormPathParam_processDefinitionKey; ``` -Defined in: [gen/CamundaClient.ts:527](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L527) +Defined in: [gen/CamundaClient.ts:534](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L534) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getStatusInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getStatusInput.md index 108aaabbfd3..daadceb8720 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getStatusInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getStatusInput.md @@ -11,4 +11,4 @@ mdx: type getStatusInput = void; ``` -Defined in: [gen/CamundaClient.ts:534](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L534) +Defined in: [gen/CamundaClient.ts:541](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L541) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getSystemConfigurationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getSystemConfigurationInput.md new file mode 100644 index 00000000000..05b2a7c807b --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getSystemConfigurationInput.md @@ -0,0 +1,14 @@ +--- +title: "Type Alias: getSystemConfigurationInput" +sidebar_label: "getSystemConfigurationInput" +mdx: + format: md +--- + +# Type Alias: getSystemConfigurationInput + +```ts +type getSystemConfigurationInput = void; +``` + +Defined in: [gen/CamundaClient.ts:543](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L543) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantClusterVariableConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantClusterVariableConsistency.md index 9e5d39ddb0e..c84da0b9c90 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantClusterVariableConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantClusterVariableConsistency.md @@ -11,7 +11,7 @@ mdx: type getTenantClusterVariableConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:548](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L548) +Defined in: [gen/CamundaClient.ts:557](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L557) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:550](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L550) +Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L559) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantClusterVariableInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantClusterVariableInput.md index 2b50149d54c..9c0c2eb68d0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantClusterVariableInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantClusterVariableInput.md @@ -11,7 +11,7 @@ mdx: type getTenantClusterVariableInput = object; ``` -Defined in: [gen/CamundaClient.ts:546](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L546) +Defined in: [gen/CamundaClient.ts:555](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L555) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:546](https://github.com/camunda/orchestration- name: getTenantClusterVariablePathParam_name; ``` -Defined in: [gen/CamundaClient.ts:546](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L546) +Defined in: [gen/CamundaClient.ts:555](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L555) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:546](https://github.com/camunda/orchestration- tenantId: getTenantClusterVariablePathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:546](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L546) +Defined in: [gen/CamundaClient.ts:555](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L555) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantConsistency.md index d279f7c3882..620506bc1cd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantConsistency.md @@ -11,7 +11,7 @@ mdx: type getTenantConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:539](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L539) +Defined in: [gen/CamundaClient.ts:548](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L548) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:541](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L541) +Defined in: [gen/CamundaClient.ts:550](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L550) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantInput.md index 7ea7a683db5..3f4619e8a9e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTenantInput.md @@ -11,7 +11,7 @@ mdx: type getTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:537](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L537) +Defined in: [gen/CamundaClient.ts:546](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L546) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:537](https://github.com/camunda/orchestration- tenantId: getTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:537](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L537) +Defined in: [gen/CamundaClient.ts:546](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L546) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTopologyInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTopologyInput.md index 6f6ef514098..d9c7610bb39 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getTopologyInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getTopologyInput.md @@ -11,4 +11,4 @@ mdx: type getTopologyInput = void; ``` -Defined in: [gen/CamundaClient.ts:553](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L553) +Defined in: [gen/CamundaClient.ts:562](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L562) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUsageMetricsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUsageMetricsConsistency.md index 5e17626fda7..1ef9188887c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUsageMetricsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUsageMetricsConsistency.md @@ -11,7 +11,7 @@ mdx: type getUsageMetricsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:561](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L561) +Defined in: [gen/CamundaClient.ts:570](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L570) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:563](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L563) +Defined in: [gen/CamundaClient.ts:572](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L572) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUsageMetricsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUsageMetricsInput.md index 96d55f02c88..2c550aa1188 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUsageMetricsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUsageMetricsInput.md @@ -11,7 +11,7 @@ mdx: type getUsageMetricsInput = object; ``` -Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L559) +Defined in: [gen/CamundaClient.ts:568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L568) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration- endTime: getUsageMetricsQueryParam_endTime; ``` -Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L559) +Defined in: [gen/CamundaClient.ts:568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L568) --- @@ -31,7 +31,7 @@ Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration- startTime: getUsageMetricsQueryParam_startTime; ``` -Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L559) +Defined in: [gen/CamundaClient.ts:568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L568) --- @@ -41,7 +41,7 @@ Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration- optional tenantId: getUsageMetricsQueryParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L559) +Defined in: [gen/CamundaClient.ts:568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L568) --- @@ -51,4 +51,4 @@ Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration- optional withTenants: getUsageMetricsQueryParam_withTenants; ``` -Defined in: [gen/CamundaClient.ts:559](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L559) +Defined in: [gen/CamundaClient.ts:568](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L568) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserConsistency.md index 360d3dcf821..b457f763880 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserConsistency.md @@ -11,7 +11,7 @@ mdx: type getUserConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:569](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L569) +Defined in: [gen/CamundaClient.ts:578](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L578) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:571](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L571) +Defined in: [gen/CamundaClient.ts:580](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L580) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserInput.md index 8c9cc5fc87e..11143e6845a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserInput.md @@ -11,7 +11,7 @@ mdx: type getUserInput = object; ``` -Defined in: [gen/CamundaClient.ts:567](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L567) +Defined in: [gen/CamundaClient.ts:576](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L576) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:567](https://github.com/camunda/orchestration- username: getUserPathParam_username; ``` -Defined in: [gen/CamundaClient.ts:567](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L567) +Defined in: [gen/CamundaClient.ts:576](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L576) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskConsistency.md index 0a1bf8f77d8..41b28140cdb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskConsistency.md @@ -11,7 +11,7 @@ mdx: type getUserTaskConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:577](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L577) +Defined in: [gen/CamundaClient.ts:586](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L586) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:579](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L579) +Defined in: [gen/CamundaClient.ts:588](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L588) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskFormConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskFormConsistency.md index 5ac734e7b2b..f576dad6bae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskFormConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskFormConsistency.md @@ -11,7 +11,7 @@ mdx: type getUserTaskFormConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:585](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L585) +Defined in: [gen/CamundaClient.ts:594](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L594) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:587](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L587) +Defined in: [gen/CamundaClient.ts:596](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L596) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskFormInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskFormInput.md index bc4834e7ed7..d91ce5f2092 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskFormInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskFormInput.md @@ -11,7 +11,7 @@ mdx: type getUserTaskFormInput = object; ``` -Defined in: [gen/CamundaClient.ts:583](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L583) +Defined in: [gen/CamundaClient.ts:592](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L592) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:583](https://github.com/camunda/orchestration- userTaskKey: getUserTaskFormPathParam_userTaskKey; ``` -Defined in: [gen/CamundaClient.ts:583](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L583) +Defined in: [gen/CamundaClient.ts:592](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L592) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskInput.md index a37d45e8874..2ed598a51e7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getUserTaskInput.md @@ -11,7 +11,7 @@ mdx: type getUserTaskInput = object; ``` -Defined in: [gen/CamundaClient.ts:575](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L575) +Defined in: [gen/CamundaClient.ts:584](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L584) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:575](https://github.com/camunda/orchestration- userTaskKey: getUserTaskPathParam_userTaskKey; ``` -Defined in: [gen/CamundaClient.ts:575](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L575) +Defined in: [gen/CamundaClient.ts:584](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L584) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getVariableConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getVariableConsistency.md index 93ce50d656a..1fa8809632a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getVariableConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getVariableConsistency.md @@ -11,7 +11,7 @@ mdx: type getVariableConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:593](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L593) +Defined in: [gen/CamundaClient.ts:602](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L602) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:595](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L595) +Defined in: [gen/CamundaClient.ts:604](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L604) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/getVariableInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/getVariableInput.md index 12e42bb6ac2..19e832f1ab9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/getVariableInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/getVariableInput.md @@ -11,7 +11,7 @@ mdx: type getVariableInput = object; ``` -Defined in: [gen/CamundaClient.ts:591](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L591) +Defined in: [gen/CamundaClient.ts:600](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L600) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:591](https://github.com/camunda/orchestration- variableKey: getVariablePathParam_variableKey; ``` -Defined in: [gen/CamundaClient.ts:591](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L591) +Defined in: [gen/CamundaClient.ts:600](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L600) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstanceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstanceInput.md index 93a80a7224e..207a4b1ca28 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstanceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstanceInput.md @@ -11,7 +11,7 @@ mdx: type migrateProcessInstanceInput = migrateProcessInstanceBody & object; ``` -Defined in: [gen/CamundaClient.ts:600](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L600) +Defined in: [gen/CamundaClient.ts:609](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L609) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstancesBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstancesBatchOperationConsistency.md deleted file mode 100644 index ab63f5cd600..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstancesBatchOperationConsistency.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Type Alias: migrateProcessInstancesBatchOperationConsistency" -sidebar_label: "migrateProcessInstancesBatchOperationConsistency" -mdx: - format: md ---- - -# Type Alias: migrateProcessInstancesBatchOperationConsistency - -```ts -type migrateProcessInstancesBatchOperationConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:605](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L605) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions< - _DataOf ->; -``` - -Defined in: [gen/CamundaClient.ts:607](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L607) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstancesBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstancesBatchOperationInput.md index e70d7eded4f..c110a556be6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstancesBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/migrateProcessInstancesBatchOperationInput.md @@ -12,4 +12,4 @@ type migrateProcessInstancesBatchOperationInput = migrateProcessInstancesBatchOperationBody; ``` -Defined in: [gen/CamundaClient.ts:603](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L603) +Defined in: [gen/CamundaClient.ts:612](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L612) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstanceInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstanceInput.md index 95caeea55aa..717e26e13dd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstanceInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstanceInput.md @@ -11,7 +11,7 @@ mdx: type modifyProcessInstanceInput = modifyProcessInstanceBody & object; ``` -Defined in: [gen/CamundaClient.ts:612](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L612) +Defined in: [gen/CamundaClient.ts:616](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L616) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstancesBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstancesBatchOperationConsistency.md deleted file mode 100644 index b4e33bf5dec..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstancesBatchOperationConsistency.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Type Alias: modifyProcessInstancesBatchOperationConsistency" -sidebar_label: "modifyProcessInstancesBatchOperationConsistency" -mdx: - format: md ---- - -# Type Alias: modifyProcessInstancesBatchOperationConsistency - -```ts -type modifyProcessInstancesBatchOperationConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:617](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L617) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions< - _DataOf ->; -``` - -Defined in: [gen/CamundaClient.ts:619](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L619) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstancesBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstancesBatchOperationInput.md index 191a9aeff97..f0aa80d99d2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstancesBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/modifyProcessInstancesBatchOperationInput.md @@ -12,4 +12,4 @@ type modifyProcessInstancesBatchOperationInput = modifyProcessInstancesBatchOperationBody; ``` -Defined in: [gen/CamundaClient.ts:615](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L615) +Defined in: [gen/CamundaClient.ts:619](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L619) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/pinClockInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/pinClockInput.md index 22671034fff..2413c7c031f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/pinClockInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/pinClockInput.md @@ -11,4 +11,4 @@ mdx: type pinClockInput = pinClockBody; ``` -Defined in: [gen/CamundaClient.ts:623](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L623) +Defined in: [gen/CamundaClient.ts:622](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L622) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/publishMessageInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/publishMessageInput.md index f512b6c4189..8f60c253b39 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/publishMessageInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/publishMessageInput.md @@ -11,4 +11,4 @@ mdx: type publishMessageInput = publishMessageBody; ``` -Defined in: [gen/CamundaClient.ts:626](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L626) +Defined in: [gen/CamundaClient.ts:625](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L625) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/resetClockInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/resetClockInput.md index f712c35c9b6..51edb2c1709 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/resetClockInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/resetClockInput.md @@ -11,4 +11,4 @@ mdx: type resetClockInput = void; ``` -Defined in: [gen/CamundaClient.ts:628](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L628) +Defined in: [gen/CamundaClient.ts:627](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L627) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentInput.md index 1f1b4905425..2cf1b0d09fd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentInput.md @@ -11,7 +11,7 @@ mdx: type resolveIncidentInput = resolveIncidentBody & object; ``` -Defined in: [gen/CamundaClient.ts:632](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L632) +Defined in: [gen/CamundaClient.ts:631](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L631) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentsBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentsBatchOperationConsistency.md deleted file mode 100644 index 72c971adc0b..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentsBatchOperationConsistency.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Type Alias: resolveIncidentsBatchOperationConsistency" -sidebar_label: "resolveIncidentsBatchOperationConsistency" -mdx: - format: md ---- - -# Type Alias: resolveIncidentsBatchOperationConsistency - -```ts -type resolveIncidentsBatchOperationConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:637](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L637) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions< - _DataOf ->; -``` - -Defined in: [gen/CamundaClient.ts:639](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L639) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentsBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentsBatchOperationInput.md index 1f157825501..a7bb4acb216 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentsBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveIncidentsBatchOperationInput.md @@ -11,4 +11,4 @@ mdx: type resolveIncidentsBatchOperationInput = resolveIncidentsBatchOperationBody; ``` -Defined in: [gen/CamundaClient.ts:635](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L635) +Defined in: [gen/CamundaClient.ts:634](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L634) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveProcessInstanceIncidentsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveProcessInstanceIncidentsConsistency.md deleted file mode 100644 index 43c4ca39d2e..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveProcessInstanceIncidentsConsistency.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Type Alias: resolveProcessInstanceIncidentsConsistency" -sidebar_label: "resolveProcessInstanceIncidentsConsistency" -mdx: - format: md ---- - -# Type Alias: resolveProcessInstanceIncidentsConsistency - -```ts -type resolveProcessInstanceIncidentsConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:645](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L645) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions< - _DataOf ->; -``` - -Defined in: [gen/CamundaClient.ts:647](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L647) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveProcessInstanceIncidentsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveProcessInstanceIncidentsInput.md index 3e7c6ca0663..02c2941e3d5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveProcessInstanceIncidentsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/resolveProcessInstanceIncidentsInput.md @@ -11,7 +11,7 @@ mdx: type resolveProcessInstanceIncidentsInput = object; ``` -Defined in: [gen/CamundaClient.ts:643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L643) +Defined in: [gen/CamundaClient.ts:637](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L637) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:643](https://github.com/camunda/orchestration- processInstanceKey: resolveProcessInstanceIncidentsPathParam_processInstanceKey; ``` -Defined in: [gen/CamundaClient.ts:643](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L643) +Defined in: [gen/CamundaClient.ts:637](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L637) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/resumeBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/resumeBatchOperationConsistency.md deleted file mode 100644 index 02c0af5ce32..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/resumeBatchOperationConsistency.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Type Alias: resumeBatchOperationConsistency" -sidebar_label: "resumeBatchOperationConsistency" -mdx: - format: md ---- - -# Type Alias: resumeBatchOperationConsistency - -```ts -type resumeBatchOperationConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:654](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L654) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions<_DataOf>; -``` - -Defined in: [gen/CamundaClient.ts:656](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L656) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/resumeBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/resumeBatchOperationInput.md index 6d0bd99b349..5c83c7f9f71 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/resumeBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/resumeBatchOperationInput.md @@ -11,7 +11,7 @@ mdx: type resumeBatchOperationInput = resumeBatchOperationBody & object; ``` -Defined in: [gen/CamundaClient.ts:652](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L652) +Defined in: [gen/CamundaClient.ts:641](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L641) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuditLogsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuditLogsConsistency.md index 3289f28dbb2..735227addc6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuditLogsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuditLogsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchAuditLogsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:662](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L662) +Defined in: [gen/CamundaClient.ts:646](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L646) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:664](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L664) +Defined in: [gen/CamundaClient.ts:648](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L648) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuditLogsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuditLogsInput.md index f2011053aeb..547e6035bb3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuditLogsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuditLogsInput.md @@ -11,4 +11,4 @@ mdx: type searchAuditLogsInput = searchAuditLogsBody; ``` -Defined in: [gen/CamundaClient.ts:660](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L660) +Defined in: [gen/CamundaClient.ts:644](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L644) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuthorizationsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuthorizationsConsistency.md index f81a4c03730..7c6ce2ef849 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuthorizationsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuthorizationsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchAuthorizationsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:670](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L670) +Defined in: [gen/CamundaClient.ts:654](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L654) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:672](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L672) +Defined in: [gen/CamundaClient.ts:656](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L656) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuthorizationsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuthorizationsInput.md index c5f3f5ed5df..3c0c950b32c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuthorizationsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchAuthorizationsInput.md @@ -11,4 +11,4 @@ mdx: type searchAuthorizationsInput = searchAuthorizationsBody; ``` -Defined in: [gen/CamundaClient.ts:668](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L668) +Defined in: [gen/CamundaClient.ts:652](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L652) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationItemsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationItemsConsistency.md index 66a20042c09..185fe428c34 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationItemsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationItemsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchBatchOperationItemsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:678](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L678) +Defined in: [gen/CamundaClient.ts:662](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L662) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:680](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L680) +Defined in: [gen/CamundaClient.ts:664](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L664) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationItemsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationItemsInput.md index 5472fe8284e..a964736b302 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationItemsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationItemsInput.md @@ -11,4 +11,4 @@ mdx: type searchBatchOperationItemsInput = searchBatchOperationItemsBody; ``` -Defined in: [gen/CamundaClient.ts:676](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L676) +Defined in: [gen/CamundaClient.ts:660](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L660) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationsConsistency.md index 401804ffc1d..0632893d348 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchBatchOperationsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:686](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L686) +Defined in: [gen/CamundaClient.ts:670](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L670) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:688](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L688) +Defined in: [gen/CamundaClient.ts:672](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L672) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationsInput.md index e379f47dda0..d78966195bb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchBatchOperationsInput.md @@ -11,4 +11,4 @@ mdx: type searchBatchOperationsInput = searchBatchOperationsBody; ``` -Defined in: [gen/CamundaClient.ts:684](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L684) +Defined in: [gen/CamundaClient.ts:668](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L668) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForGroupConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForGroupConsistency.md index eb405466396..ab3ef2ff84a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForGroupConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForGroupConsistency.md @@ -11,7 +11,7 @@ mdx: type searchClientsForGroupConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:695](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L695) +Defined in: [gen/CamundaClient.ts:679](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L679) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:697](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L697) +Defined in: [gen/CamundaClient.ts:681](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L681) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForGroupInput.md index e8fd1716811..342ab3eb431 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForGroupInput.md @@ -11,7 +11,7 @@ mdx: type searchClientsForGroupInput = searchClientsForGroupBody & object; ``` -Defined in: [gen/CamundaClient.ts:693](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L693) +Defined in: [gen/CamundaClient.ts:677](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L677) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForRoleConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForRoleConsistency.md index 474318407ef..a3898892399 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForRoleConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForRoleConsistency.md @@ -11,7 +11,7 @@ mdx: type searchClientsForRoleConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:704](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L704) +Defined in: [gen/CamundaClient.ts:688](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L688) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:706](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L706) +Defined in: [gen/CamundaClient.ts:690](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L690) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForRoleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForRoleInput.md index 1dc0fc39d31..93c7a75e53d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForRoleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForRoleInput.md @@ -11,7 +11,7 @@ mdx: type searchClientsForRoleInput = searchClientsForRoleBody & object; ``` -Defined in: [gen/CamundaClient.ts:702](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L702) +Defined in: [gen/CamundaClient.ts:686](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L686) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForTenantConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForTenantConsistency.md index f89b7fca3bd..67212b54fa0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForTenantConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForTenantConsistency.md @@ -11,7 +11,7 @@ mdx: type searchClientsForTenantConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:713](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L713) +Defined in: [gen/CamundaClient.ts:697](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L697) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:715](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L715) +Defined in: [gen/CamundaClient.ts:699](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L699) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForTenantInput.md index 7e16039ddd4..ecc77283e61 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClientsForTenantInput.md @@ -11,7 +11,7 @@ mdx: type searchClientsForTenantInput = searchClientsForTenantBody & object; ``` -Defined in: [gen/CamundaClient.ts:711](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L711) +Defined in: [gen/CamundaClient.ts:695](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L695) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClusterVariablesConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClusterVariablesConsistency.md index 34286919bae..654a91f83c8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClusterVariablesConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClusterVariablesConsistency.md @@ -11,7 +11,7 @@ mdx: type searchClusterVariablesConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:722](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L722) +Defined in: [gen/CamundaClient.ts:706](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L706) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:724](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L724) +Defined in: [gen/CamundaClient.ts:708](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L708) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClusterVariablesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClusterVariablesInput.md index cc50aeca369..28c22f6da96 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClusterVariablesInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchClusterVariablesInput.md @@ -11,7 +11,7 @@ mdx: type searchClusterVariablesInput = searchClusterVariablesBody & object; ``` -Defined in: [gen/CamundaClient.ts:720](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L720) +Defined in: [gen/CamundaClient.ts:704](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L704) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchCorrelatedMessageSubscriptionsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchCorrelatedMessageSubscriptionsConsistency.md index d71721f935f..3c6f76266c1 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchCorrelatedMessageSubscriptionsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchCorrelatedMessageSubscriptionsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchCorrelatedMessageSubscriptionsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:730](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L730) +Defined in: [gen/CamundaClient.ts:714](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L714) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:732](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L732) +Defined in: [gen/CamundaClient.ts:716](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L716) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchCorrelatedMessageSubscriptionsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchCorrelatedMessageSubscriptionsInput.md index b5707cafb37..4b03bb7b234 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchCorrelatedMessageSubscriptionsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchCorrelatedMessageSubscriptionsInput.md @@ -12,4 +12,4 @@ type searchCorrelatedMessageSubscriptionsInput = searchCorrelatedMessageSubscriptionsBody; ``` -Defined in: [gen/CamundaClient.ts:728](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L728) +Defined in: [gen/CamundaClient.ts:712](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L712) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionDefinitionsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionDefinitionsConsistency.md index 65d57a84310..e43c23b2335 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionDefinitionsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionDefinitionsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchDecisionDefinitionsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:738](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L738) +Defined in: [gen/CamundaClient.ts:722](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L722) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:740](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L740) +Defined in: [gen/CamundaClient.ts:724](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L724) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionDefinitionsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionDefinitionsInput.md index 61abfad2326..86140664106 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionDefinitionsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionDefinitionsInput.md @@ -11,4 +11,4 @@ mdx: type searchDecisionDefinitionsInput = searchDecisionDefinitionsBody; ``` -Defined in: [gen/CamundaClient.ts:736](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L736) +Defined in: [gen/CamundaClient.ts:720](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L720) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionInstancesConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionInstancesConsistency.md index 08f8dde4d10..d42d2982a45 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionInstancesConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionInstancesConsistency.md @@ -11,7 +11,7 @@ mdx: type searchDecisionInstancesConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:746](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L746) +Defined in: [gen/CamundaClient.ts:730](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L730) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:748](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L748) +Defined in: [gen/CamundaClient.ts:732](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L732) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionInstancesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionInstancesInput.md index c98f3758c98..2b8716e9ecd 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionInstancesInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionInstancesInput.md @@ -11,4 +11,4 @@ mdx: type searchDecisionInstancesInput = searchDecisionInstancesBody; ``` -Defined in: [gen/CamundaClient.ts:744](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L744) +Defined in: [gen/CamundaClient.ts:728](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L728) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionRequirementsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionRequirementsConsistency.md index d0b7e0a320f..882083accac 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionRequirementsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionRequirementsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchDecisionRequirementsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:754](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L754) +Defined in: [gen/CamundaClient.ts:738](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L738) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:756](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L756) +Defined in: [gen/CamundaClient.ts:740](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L740) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionRequirementsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionRequirementsInput.md index 1a677f78a59..acdc1454ba3 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionRequirementsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchDecisionRequirementsInput.md @@ -11,4 +11,4 @@ mdx: type searchDecisionRequirementsInput = searchDecisionRequirementsBody; ``` -Defined in: [gen/CamundaClient.ts:752](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L752) +Defined in: [gen/CamundaClient.ts:736](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L736) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstanceIncidentsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstanceIncidentsConsistency.md index 5fb9539d5df..c211c5cdaac 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstanceIncidentsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstanceIncidentsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchElementInstanceIncidentsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:763](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L763) +Defined in: [gen/CamundaClient.ts:747](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L747) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:765](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L765) +Defined in: [gen/CamundaClient.ts:749](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L749) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstanceIncidentsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstanceIncidentsInput.md index 6a410bdc3c8..a879d8bc729 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstanceIncidentsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstanceIncidentsInput.md @@ -12,7 +12,7 @@ type searchElementInstanceIncidentsInput = searchElementInstanceIncidentsBody & object; ``` -Defined in: [gen/CamundaClient.ts:761](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L761) +Defined in: [gen/CamundaClient.ts:745](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L745) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstancesConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstancesConsistency.md index e9a0fba42d8..0016d9dd69f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstancesConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstancesConsistency.md @@ -11,7 +11,7 @@ mdx: type searchElementInstancesConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:771](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L771) +Defined in: [gen/CamundaClient.ts:755](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L755) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:773](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L773) +Defined in: [gen/CamundaClient.ts:757](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L757) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstancesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstancesInput.md index 3e0f7d442f4..172d296b956 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstancesInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchElementInstancesInput.md @@ -11,4 +11,4 @@ mdx: type searchElementInstancesInput = searchElementInstancesBody; ``` -Defined in: [gen/CamundaClient.ts:769](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L769) +Defined in: [gen/CamundaClient.ts:753](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L753) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGlobalTaskListenersConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGlobalTaskListenersConsistency.md new file mode 100644 index 00000000000..05f6fa54978 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGlobalTaskListenersConsistency.md @@ -0,0 +1,28 @@ +--- +title: "Type Alias: searchGlobalTaskListenersConsistency" +sidebar_label: "searchGlobalTaskListenersConsistency" +mdx: + format: md +--- + +# Type Alias: searchGlobalTaskListenersConsistency + +```ts +type searchGlobalTaskListenersConsistency = object; +``` + +Defined in: [gen/CamundaClient.ts:763](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L763) + +Management of eventual consistency \* + +## Properties + +### consistency + +```ts +consistency: ConsistencyOptions<_DataOf>; +``` + +Defined in: [gen/CamundaClient.ts:765](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L765) + +Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGlobalTaskListenersInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGlobalTaskListenersInput.md new file mode 100644 index 00000000000..a008e7da2d3 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGlobalTaskListenersInput.md @@ -0,0 +1,14 @@ +--- +title: "Type Alias: searchGlobalTaskListenersInput" +sidebar_label: "searchGlobalTaskListenersInput" +mdx: + format: md +--- + +# Type Alias: searchGlobalTaskListenersInput + +```ts +type searchGlobalTaskListenersInput = searchGlobalTaskListenersBody; +``` + +Defined in: [gen/CamundaClient.ts:761](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L761) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupIdsForTenantConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupIdsForTenantConsistency.md index 09240937232..b18f0d8e280 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupIdsForTenantConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupIdsForTenantConsistency.md @@ -11,7 +11,7 @@ mdx: type searchGroupIdsForTenantConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:780](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L780) +Defined in: [gen/CamundaClient.ts:772](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L772) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:782](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L782) +Defined in: [gen/CamundaClient.ts:774](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L774) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupIdsForTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupIdsForTenantInput.md index 6bd42cbf527..3ccaf81a841 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupIdsForTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupIdsForTenantInput.md @@ -11,7 +11,7 @@ mdx: type searchGroupIdsForTenantInput = searchGroupIdsForTenantBody & object; ``` -Defined in: [gen/CamundaClient.ts:778](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L778) +Defined in: [gen/CamundaClient.ts:770](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L770) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsConsistency.md index 7db6d7be997..710f6ed5e3b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchGroupsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:788](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L788) +Defined in: [gen/CamundaClient.ts:780](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L780) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:790](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L790) +Defined in: [gen/CamundaClient.ts:782](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L782) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsForRoleConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsForRoleConsistency.md index 9a1f9d8e902..a8c29184bef 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsForRoleConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsForRoleConsistency.md @@ -11,7 +11,7 @@ mdx: type searchGroupsForRoleConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:797](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L797) +Defined in: [gen/CamundaClient.ts:789](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L789) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:799](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L799) +Defined in: [gen/CamundaClient.ts:791](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L791) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsForRoleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsForRoleInput.md index 1fbac6662d3..1ace73f0596 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsForRoleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsForRoleInput.md @@ -11,7 +11,7 @@ mdx: type searchGroupsForRoleInput = searchGroupsForRoleBody & object; ``` -Defined in: [gen/CamundaClient.ts:795](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L795) +Defined in: [gen/CamundaClient.ts:787](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L787) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsInput.md index 3fd70597833..74ae1b2f851 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchGroupsInput.md @@ -11,4 +11,4 @@ mdx: type searchGroupsInput = searchGroupsBody; ``` -Defined in: [gen/CamundaClient.ts:786](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L786) +Defined in: [gen/CamundaClient.ts:778](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L778) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchIncidentsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchIncidentsConsistency.md index cb01e1f71cd..cc1fc40994f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchIncidentsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchIncidentsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchIncidentsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:805](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L805) +Defined in: [gen/CamundaClient.ts:797](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L797) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:807](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L807) +Defined in: [gen/CamundaClient.ts:799](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L799) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchIncidentsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchIncidentsInput.md index 465eb78739a..07a72af1e43 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchIncidentsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchIncidentsInput.md @@ -11,4 +11,4 @@ mdx: type searchIncidentsInput = searchIncidentsBody; ``` -Defined in: [gen/CamundaClient.ts:803](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L803) +Defined in: [gen/CamundaClient.ts:795](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L795) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchJobsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchJobsConsistency.md index 16fee513e27..60d1cbca75b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchJobsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchJobsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchJobsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:813](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L813) +Defined in: [gen/CamundaClient.ts:805](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L805) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:815](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L815) +Defined in: [gen/CamundaClient.ts:807](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L807) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchJobsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchJobsInput.md index 80169601a34..b4a19c1fb2b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchJobsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchJobsInput.md @@ -11,4 +11,4 @@ mdx: type searchJobsInput = searchJobsBody; ``` -Defined in: [gen/CamundaClient.ts:811](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L811) +Defined in: [gen/CamundaClient.ts:803](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L803) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRuleConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRuleConsistency.md index 3bbd204902d..3ed37533dd0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRuleConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRuleConsistency.md @@ -11,7 +11,7 @@ mdx: type searchMappingRuleConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:821](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L821) +Defined in: [gen/CamundaClient.ts:813](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L813) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:823](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L823) +Defined in: [gen/CamundaClient.ts:815](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L815) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRuleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRuleInput.md index 4cbfb556a8c..d10052d2c4f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRuleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRuleInput.md @@ -11,4 +11,4 @@ mdx: type searchMappingRuleInput = searchMappingRuleBody; ``` -Defined in: [gen/CamundaClient.ts:819](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L819) +Defined in: [gen/CamundaClient.ts:811](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L811) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForGroupConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForGroupConsistency.md index 65827590245..cac354b7e22 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForGroupConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForGroupConsistency.md @@ -11,7 +11,7 @@ mdx: type searchMappingRulesForGroupConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:830](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L830) +Defined in: [gen/CamundaClient.ts:822](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L822) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:832](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L832) +Defined in: [gen/CamundaClient.ts:824](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L824) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForGroupInput.md index fdca5ffbf70..6ddd1d1af4d 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForGroupInput.md @@ -11,7 +11,7 @@ mdx: type searchMappingRulesForGroupInput = searchMappingRulesForGroupBody & object; ``` -Defined in: [gen/CamundaClient.ts:828](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L828) +Defined in: [gen/CamundaClient.ts:820](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L820) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForRoleConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForRoleConsistency.md index 21e0766b174..5daa9b31c4b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForRoleConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForRoleConsistency.md @@ -11,7 +11,7 @@ mdx: type searchMappingRulesForRoleConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:839](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L839) +Defined in: [gen/CamundaClient.ts:831](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L831) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:841](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L841) +Defined in: [gen/CamundaClient.ts:833](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L833) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForRoleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForRoleInput.md index 9bddc23aac3..1456d2a3679 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForRoleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForRoleInput.md @@ -11,7 +11,7 @@ mdx: type searchMappingRulesForRoleInput = searchMappingRulesForRoleBody & object; ``` -Defined in: [gen/CamundaClient.ts:837](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L837) +Defined in: [gen/CamundaClient.ts:829](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L829) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForTenantConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForTenantConsistency.md index 7abee09d55e..fe7c3c5a760 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForTenantConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForTenantConsistency.md @@ -11,7 +11,7 @@ mdx: type searchMappingRulesForTenantConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:848](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L848) +Defined in: [gen/CamundaClient.ts:840](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L840) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:850](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L850) +Defined in: [gen/CamundaClient.ts:842](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L842) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForTenantInput.md index f9f0a0b9d85..f134e5c9018 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMappingRulesForTenantInput.md @@ -12,7 +12,7 @@ type searchMappingRulesForTenantInput = searchMappingRulesForTenantBody & object; ``` -Defined in: [gen/CamundaClient.ts:846](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L846) +Defined in: [gen/CamundaClient.ts:838](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L838) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMessageSubscriptionsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMessageSubscriptionsConsistency.md index fc293f008e7..39773dd5ef9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMessageSubscriptionsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMessageSubscriptionsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchMessageSubscriptionsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:856](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L856) +Defined in: [gen/CamundaClient.ts:848](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L848) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:858](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L858) +Defined in: [gen/CamundaClient.ts:850](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L850) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMessageSubscriptionsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMessageSubscriptionsInput.md index 4fec424e914..b95e45bfa5f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMessageSubscriptionsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchMessageSubscriptionsInput.md @@ -11,4 +11,4 @@ mdx: type searchMessageSubscriptionsInput = searchMessageSubscriptionsBody; ``` -Defined in: [gen/CamundaClient.ts:854](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L854) +Defined in: [gen/CamundaClient.ts:846](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L846) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessDefinitionsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessDefinitionsConsistency.md index ff108a9692c..2372d82e8fb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessDefinitionsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessDefinitionsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchProcessDefinitionsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:864](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L864) +Defined in: [gen/CamundaClient.ts:856](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L856) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:866](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L866) +Defined in: [gen/CamundaClient.ts:858](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L858) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessDefinitionsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessDefinitionsInput.md index 2d845a57216..ab8ffc7e275 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessDefinitionsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessDefinitionsInput.md @@ -11,4 +11,4 @@ mdx: type searchProcessDefinitionsInput = searchProcessDefinitionsBody; ``` -Defined in: [gen/CamundaClient.ts:862](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L862) +Defined in: [gen/CamundaClient.ts:854](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L854) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstanceIncidentsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstanceIncidentsConsistency.md index 1303595000c..9231c6a3107 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstanceIncidentsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstanceIncidentsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchProcessInstanceIncidentsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:873](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L873) +Defined in: [gen/CamundaClient.ts:865](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L865) Management of eventual consistency \* @@ -25,6 +25,6 @@ consistency: ConsistencyOptions< >; ``` -Defined in: [gen/CamundaClient.ts:875](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L875) +Defined in: [gen/CamundaClient.ts:867](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L867) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstanceIncidentsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstanceIncidentsInput.md index 33d6b819e82..f6455bfee7a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstanceIncidentsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstanceIncidentsInput.md @@ -12,7 +12,7 @@ type searchProcessInstanceIncidentsInput = searchProcessInstanceIncidentsBody & object; ``` -Defined in: [gen/CamundaClient.ts:871](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L871) +Defined in: [gen/CamundaClient.ts:863](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L863) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstancesConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstancesConsistency.md index 7d97a17bedd..a04adf83b9b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstancesConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstancesConsistency.md @@ -11,7 +11,7 @@ mdx: type searchProcessInstancesConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:881](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L881) +Defined in: [gen/CamundaClient.ts:873](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L873) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:883](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L883) +Defined in: [gen/CamundaClient.ts:875](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L875) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstancesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstancesInput.md index 558799af578..af0efb955fe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstancesInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchProcessInstancesInput.md @@ -11,4 +11,4 @@ mdx: type searchProcessInstancesInput = searchProcessInstancesBody; ``` -Defined in: [gen/CamundaClient.ts:879](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L879) +Defined in: [gen/CamundaClient.ts:871](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L871) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesConsistency.md index fa0a376411d..ba110008687 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesConsistency.md @@ -11,7 +11,7 @@ mdx: type searchRolesConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:889](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L889) +Defined in: [gen/CamundaClient.ts:881](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L881) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:891](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L891) +Defined in: [gen/CamundaClient.ts:883](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L883) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForGroupConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForGroupConsistency.md index a5118da476b..4545a316e10 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForGroupConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForGroupConsistency.md @@ -11,7 +11,7 @@ mdx: type searchRolesForGroupConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:898](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L898) +Defined in: [gen/CamundaClient.ts:890](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L890) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:900](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L900) +Defined in: [gen/CamundaClient.ts:892](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L892) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForGroupInput.md index d51d00ca3b3..4abac965cfb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForGroupInput.md @@ -11,7 +11,7 @@ mdx: type searchRolesForGroupInput = searchRolesForGroupBody & object; ``` -Defined in: [gen/CamundaClient.ts:896](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L896) +Defined in: [gen/CamundaClient.ts:888](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L888) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForTenantConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForTenantConsistency.md index fa79be550e5..dd49ec0dfa7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForTenantConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForTenantConsistency.md @@ -11,7 +11,7 @@ mdx: type searchRolesForTenantConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:907](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L907) +Defined in: [gen/CamundaClient.ts:899](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L899) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:909](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L909) +Defined in: [gen/CamundaClient.ts:901](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L901) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForTenantInput.md index 78bd3a69b30..77a7ae61e4f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesForTenantInput.md @@ -11,7 +11,7 @@ mdx: type searchRolesForTenantInput = searchRolesForTenantBody & object; ``` -Defined in: [gen/CamundaClient.ts:905](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L905) +Defined in: [gen/CamundaClient.ts:897](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L897) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesInput.md index 779246cce87..6b93b2aadda 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchRolesInput.md @@ -11,4 +11,4 @@ mdx: type searchRolesInput = searchRolesBody; ``` -Defined in: [gen/CamundaClient.ts:887](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L887) +Defined in: [gen/CamundaClient.ts:879](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L879) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchTenantsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchTenantsConsistency.md index 26670892c3c..5d50e8ba97f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchTenantsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchTenantsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchTenantsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:915](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L915) +Defined in: [gen/CamundaClient.ts:907](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L907) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:917](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L917) +Defined in: [gen/CamundaClient.ts:909](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L909) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchTenantsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchTenantsInput.md index 34430a45874..767e33c56d2 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchTenantsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchTenantsInput.md @@ -11,4 +11,4 @@ mdx: type searchTenantsInput = searchTenantsBody; ``` -Defined in: [gen/CamundaClient.ts:913](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L913) +Defined in: [gen/CamundaClient.ts:905](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L905) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskAuditLogsConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskAuditLogsConsistency.md index fd7d386bba1..545b68ed50c 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskAuditLogsConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskAuditLogsConsistency.md @@ -11,7 +11,7 @@ mdx: type searchUserTaskAuditLogsConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:959](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L959) +Defined in: [gen/CamundaClient.ts:951](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L951) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:961](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L961) +Defined in: [gen/CamundaClient.ts:953](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L953) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskAuditLogsInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskAuditLogsInput.md index bc9e789b30e..490c2783c26 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskAuditLogsInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskAuditLogsInput.md @@ -11,7 +11,7 @@ mdx: type searchUserTaskAuditLogsInput = searchUserTaskAuditLogsBody & object; ``` -Defined in: [gen/CamundaClient.ts:957](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L957) +Defined in: [gen/CamundaClient.ts:949](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L949) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskEffectiveVariablesConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskEffectiveVariablesConsistency.md new file mode 100644 index 00000000000..d4eb927b878 --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskEffectiveVariablesConsistency.md @@ -0,0 +1,30 @@ +--- +title: "Type Alias: searchUserTaskEffectiveVariablesConsistency" +sidebar_label: "searchUserTaskEffectiveVariablesConsistency" +mdx: + format: md +--- + +# Type Alias: searchUserTaskEffectiveVariablesConsistency + +```ts +type searchUserTaskEffectiveVariablesConsistency = object; +``` + +Defined in: [gen/CamundaClient.ts:961](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L961) + +Management of eventual consistency \* + +## Properties + +### consistency + +```ts +consistency: ConsistencyOptions< + _DataOf +>; +``` + +Defined in: [gen/CamundaClient.ts:963](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L963) + +Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskEffectiveVariablesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskEffectiveVariablesInput.md new file mode 100644 index 00000000000..6c4014310bb --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskEffectiveVariablesInput.md @@ -0,0 +1,29 @@ +--- +title: "Type Alias: searchUserTaskEffectiveVariablesInput" +sidebar_label: "searchUserTaskEffectiveVariablesInput" +mdx: + format: md +--- + +# Type Alias: searchUserTaskEffectiveVariablesInput + +```ts +type searchUserTaskEffectiveVariablesInput = + searchUserTaskEffectiveVariablesBody & object; +``` + +Defined in: [gen/CamundaClient.ts:959](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L959) + +## Type Declaration + +### truncateValues? + +```ts +optional truncateValues: searchUserTaskEffectiveVariablesQueryParam_truncateValues; +``` + +### userTaskKey + +```ts +userTaskKey: searchUserTaskEffectiveVariablesPathParam_userTaskKey; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskVariablesConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskVariablesConsistency.md index 350630169f4..2a5f59356e8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskVariablesConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskVariablesConsistency.md @@ -11,7 +11,7 @@ mdx: type searchUserTaskVariablesConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:977](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L977) +Defined in: [gen/CamundaClient.ts:979](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L979) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:979](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L979) +Defined in: [gen/CamundaClient.ts:981](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L981) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskVariablesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskVariablesInput.md index 475f8c5ca72..3dc26025c2e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskVariablesInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTaskVariablesInput.md @@ -11,7 +11,7 @@ mdx: type searchUserTaskVariablesInput = searchUserTaskVariablesBody & object; ``` -Defined in: [gen/CamundaClient.ts:975](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L975) +Defined in: [gen/CamundaClient.ts:977](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L977) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTasksConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTasksConsistency.md index e229863bbba..e63c223efd5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTasksConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTasksConsistency.md @@ -11,7 +11,7 @@ mdx: type searchUserTasksConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:967](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L967) +Defined in: [gen/CamundaClient.ts:969](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L969) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:969](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L969) +Defined in: [gen/CamundaClient.ts:971](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L971) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTasksInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTasksInput.md index 92fcec7ce6c..f7a59516251 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTasksInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUserTasksInput.md @@ -11,4 +11,4 @@ mdx: type searchUserTasksInput = searchUserTasksBody; ``` -Defined in: [gen/CamundaClient.ts:965](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L965) +Defined in: [gen/CamundaClient.ts:967](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L967) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersConsistency.md index cad116a5a69..0c9b2d92ff5 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersConsistency.md @@ -11,7 +11,7 @@ mdx: type searchUsersConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:923](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L923) +Defined in: [gen/CamundaClient.ts:915](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L915) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:925](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L925) +Defined in: [gen/CamundaClient.ts:917](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L917) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForGroupConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForGroupConsistency.md index 58d310e2ec9..cea66f8f9f6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForGroupConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForGroupConsistency.md @@ -11,7 +11,7 @@ mdx: type searchUsersForGroupConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:932](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L932) +Defined in: [gen/CamundaClient.ts:924](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L924) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:934](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L934) +Defined in: [gen/CamundaClient.ts:926](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L926) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForGroupInput.md index b53908eb755..2e38cd662fe 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForGroupInput.md @@ -11,7 +11,7 @@ mdx: type searchUsersForGroupInput = searchUsersForGroupBody & object; ``` -Defined in: [gen/CamundaClient.ts:930](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L930) +Defined in: [gen/CamundaClient.ts:922](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L922) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForRoleConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForRoleConsistency.md index 87665d05746..5e5047d46b9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForRoleConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForRoleConsistency.md @@ -11,7 +11,7 @@ mdx: type searchUsersForRoleConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:941](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L941) +Defined in: [gen/CamundaClient.ts:933](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L933) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:943](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L943) +Defined in: [gen/CamundaClient.ts:935](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L935) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForRoleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForRoleInput.md index 56268a3c329..f09b5cd955a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForRoleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForRoleInput.md @@ -11,7 +11,7 @@ mdx: type searchUsersForRoleInput = searchUsersForRoleBody & object; ``` -Defined in: [gen/CamundaClient.ts:939](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L939) +Defined in: [gen/CamundaClient.ts:931](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L931) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForTenantConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForTenantConsistency.md index fb9fcade5ca..c73b07438ae 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForTenantConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForTenantConsistency.md @@ -11,7 +11,7 @@ mdx: type searchUsersForTenantConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:950](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L950) +Defined in: [gen/CamundaClient.ts:942](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L942) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:952](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L952) +Defined in: [gen/CamundaClient.ts:944](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L944) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForTenantInput.md index 61eb50cc610..693fa88238b 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersForTenantInput.md @@ -11,7 +11,7 @@ mdx: type searchUsersForTenantInput = searchUsersForTenantBody & object; ``` -Defined in: [gen/CamundaClient.ts:948](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L948) +Defined in: [gen/CamundaClient.ts:940](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L940) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersInput.md index b8fca54264a..9a06fd31fb8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchUsersInput.md @@ -11,4 +11,4 @@ mdx: type searchUsersInput = searchUsersBody; ``` -Defined in: [gen/CamundaClient.ts:921](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L921) +Defined in: [gen/CamundaClient.ts:913](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L913) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchVariablesConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchVariablesConsistency.md index 2e19cfe1653..6503b01b371 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchVariablesConsistency.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchVariablesConsistency.md @@ -11,7 +11,7 @@ mdx: type searchVariablesConsistency = object; ``` -Defined in: [gen/CamundaClient.ts:986](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L986) +Defined in: [gen/CamundaClient.ts:988](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L988) Management of eventual consistency \* @@ -23,6 +23,6 @@ Management of eventual consistency \* consistency: ConsistencyOptions<_DataOf>; ``` -Defined in: [gen/CamundaClient.ts:988](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L988) +Defined in: [gen/CamundaClient.ts:990](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L990) Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchVariablesInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchVariablesInput.md index 8194b7246df..3fe1acef1cf 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/searchVariablesInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/searchVariablesInput.md @@ -11,7 +11,7 @@ mdx: type searchVariablesInput = searchVariablesBody & object; ``` -Defined in: [gen/CamundaClient.ts:984](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L984) +Defined in: [gen/CamundaClient.ts:986](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L986) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/suspendBatchOperationConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/suspendBatchOperationConsistency.md deleted file mode 100644 index db4e4a4bc76..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/suspendBatchOperationConsistency.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Type Alias: suspendBatchOperationConsistency" -sidebar_label: "suspendBatchOperationConsistency" -mdx: - format: md ---- - -# Type Alias: suspendBatchOperationConsistency - -```ts -type suspendBatchOperationConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:995](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L995) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions<_DataOf>; -``` - -Defined in: [gen/CamundaClient.ts:997](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L997) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/suspendBatchOperationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/suspendBatchOperationInput.md index b5d8e156d48..9d323d88729 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/suspendBatchOperationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/suspendBatchOperationInput.md @@ -11,7 +11,7 @@ mdx: type suspendBatchOperationInput = suspendBatchOperationBody & object; ``` -Defined in: [gen/CamundaClient.ts:993](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L993) +Defined in: [gen/CamundaClient.ts:995](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L995) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/throwJobErrorInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/throwJobErrorInput.md index 84937d0d235..e474ca9abba 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/throwJobErrorInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/throwJobErrorInput.md @@ -11,7 +11,7 @@ mdx: type throwJobErrorInput = throwJobErrorBody & object; ``` -Defined in: [gen/CamundaClient.ts:1002](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1002) +Defined in: [gen/CamundaClient.ts:999](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L999) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignClientFromGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignClientFromGroupInput.md index 02f5b0bf148..8263b0f42d7 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignClientFromGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignClientFromGroupInput.md @@ -11,7 +11,7 @@ mdx: type unassignClientFromGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:1006](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1006) +Defined in: [gen/CamundaClient.ts:1003](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1003) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1006](https://github.com/camunda/orchestration clientId: unassignClientFromGroupPathParam_clientId; ``` -Defined in: [gen/CamundaClient.ts:1006](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1006) +Defined in: [gen/CamundaClient.ts:1003](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1003) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1006](https://github.com/camunda/orchestration groupId: unassignClientFromGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:1006](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1006) +Defined in: [gen/CamundaClient.ts:1003](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1003) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignClientFromTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignClientFromTenantInput.md index 3c01b4f6861..06fa0134544 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignClientFromTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignClientFromTenantInput.md @@ -11,7 +11,7 @@ mdx: type unassignClientFromTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:1010](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1010) +Defined in: [gen/CamundaClient.ts:1007](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1007) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1010](https://github.com/camunda/orchestration clientId: unassignClientFromTenantPathParam_clientId; ``` -Defined in: [gen/CamundaClient.ts:1010](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1010) +Defined in: [gen/CamundaClient.ts:1007](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1007) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1010](https://github.com/camunda/orchestration tenantId: unassignClientFromTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:1010](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1010) +Defined in: [gen/CamundaClient.ts:1007](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1007) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignGroupFromTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignGroupFromTenantInput.md index dd20cd37f54..bee92ad1556 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignGroupFromTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignGroupFromTenantInput.md @@ -11,7 +11,7 @@ mdx: type unassignGroupFromTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:1014](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1014) +Defined in: [gen/CamundaClient.ts:1011](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1011) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1014](https://github.com/camunda/orchestration groupId: unassignGroupFromTenantPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:1014](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1014) +Defined in: [gen/CamundaClient.ts:1011](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1011) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1014](https://github.com/camunda/orchestration tenantId: unassignGroupFromTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:1014](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1014) +Defined in: [gen/CamundaClient.ts:1011](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1011) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignMappingRuleFromGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignMappingRuleFromGroupInput.md index 25450ecdea1..abee90fb861 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignMappingRuleFromGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignMappingRuleFromGroupInput.md @@ -11,7 +11,7 @@ mdx: type unassignMappingRuleFromGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:1018](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1018) +Defined in: [gen/CamundaClient.ts:1015](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1015) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1018](https://github.com/camunda/orchestration groupId: unassignMappingRuleFromGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:1018](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1018) +Defined in: [gen/CamundaClient.ts:1015](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1015) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1018](https://github.com/camunda/orchestration mappingRuleId: unassignMappingRuleFromGroupPathParam_mappingRuleId; ``` -Defined in: [gen/CamundaClient.ts:1018](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1018) +Defined in: [gen/CamundaClient.ts:1015](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1015) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignMappingRuleFromTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignMappingRuleFromTenantInput.md index b4375961419..a828b4c9ef9 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignMappingRuleFromTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignMappingRuleFromTenantInput.md @@ -11,7 +11,7 @@ mdx: type unassignMappingRuleFromTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:1022](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1022) +Defined in: [gen/CamundaClient.ts:1019](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1019) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1022](https://github.com/camunda/orchestration mappingRuleId: unassignMappingRuleFromTenantPathParam_mappingRuleId; ``` -Defined in: [gen/CamundaClient.ts:1022](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1022) +Defined in: [gen/CamundaClient.ts:1019](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1019) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1022](https://github.com/camunda/orchestration tenantId: unassignMappingRuleFromTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:1022](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1022) +Defined in: [gen/CamundaClient.ts:1019](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1019) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromClientInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromClientInput.md index fd97a885566..5ee96f46f76 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromClientInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromClientInput.md @@ -11,7 +11,7 @@ mdx: type unassignRoleFromClientInput = object; ``` -Defined in: [gen/CamundaClient.ts:1026](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1026) +Defined in: [gen/CamundaClient.ts:1023](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1023) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1026](https://github.com/camunda/orchestration clientId: unassignRoleFromClientPathParam_clientId; ``` -Defined in: [gen/CamundaClient.ts:1026](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1026) +Defined in: [gen/CamundaClient.ts:1023](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1023) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1026](https://github.com/camunda/orchestration roleId: unassignRoleFromClientPathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:1026](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1026) +Defined in: [gen/CamundaClient.ts:1023](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1023) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromGroupInput.md index 379dad52d09..0b1d9779efb 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromGroupInput.md @@ -11,7 +11,7 @@ mdx: type unassignRoleFromGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:1030](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1030) +Defined in: [gen/CamundaClient.ts:1027](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1027) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1030](https://github.com/camunda/orchestration groupId: unassignRoleFromGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:1030](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1030) +Defined in: [gen/CamundaClient.ts:1027](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1027) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1030](https://github.com/camunda/orchestration roleId: unassignRoleFromGroupPathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:1030](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1030) +Defined in: [gen/CamundaClient.ts:1027](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1027) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromMappingRuleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromMappingRuleInput.md index 51b7c4b072e..0e58bf4a3a6 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromMappingRuleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromMappingRuleInput.md @@ -11,7 +11,7 @@ mdx: type unassignRoleFromMappingRuleInput = object; ``` -Defined in: [gen/CamundaClient.ts:1034](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1034) +Defined in: [gen/CamundaClient.ts:1031](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1031) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1034](https://github.com/camunda/orchestration mappingRuleId: unassignRoleFromMappingRulePathParam_mappingRuleId; ``` -Defined in: [gen/CamundaClient.ts:1034](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1034) +Defined in: [gen/CamundaClient.ts:1031](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1031) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1034](https://github.com/camunda/orchestration roleId: unassignRoleFromMappingRulePathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:1034](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1034) +Defined in: [gen/CamundaClient.ts:1031](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1031) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromTenantInput.md index 54e96a1c73a..149dac2a7ab 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromTenantInput.md @@ -11,7 +11,7 @@ mdx: type unassignRoleFromTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:1038](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1038) +Defined in: [gen/CamundaClient.ts:1035](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1035) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1038](https://github.com/camunda/orchestration roleId: unassignRoleFromTenantPathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:1038](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1038) +Defined in: [gen/CamundaClient.ts:1035](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1035) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1038](https://github.com/camunda/orchestration tenantId: unassignRoleFromTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:1038](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1038) +Defined in: [gen/CamundaClient.ts:1035](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1035) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromUserInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromUserInput.md index 240e99c25be..9769399a90a 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromUserInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignRoleFromUserInput.md @@ -11,7 +11,7 @@ mdx: type unassignRoleFromUserInput = object; ``` -Defined in: [gen/CamundaClient.ts:1042](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1042) +Defined in: [gen/CamundaClient.ts:1039](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1039) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1042](https://github.com/camunda/orchestration roleId: unassignRoleFromUserPathParam_roleId; ``` -Defined in: [gen/CamundaClient.ts:1042](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1042) +Defined in: [gen/CamundaClient.ts:1039](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1039) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1042](https://github.com/camunda/orchestration username: unassignRoleFromUserPathParam_username; ``` -Defined in: [gen/CamundaClient.ts:1042](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1042) +Defined in: [gen/CamundaClient.ts:1039](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1039) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserFromGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserFromGroupInput.md index c348b603cda..8fe3bb1a20f 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserFromGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserFromGroupInput.md @@ -11,7 +11,7 @@ mdx: type unassignUserFromGroupInput = object; ``` -Defined in: [gen/CamundaClient.ts:1046](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1046) +Defined in: [gen/CamundaClient.ts:1043](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1043) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1046](https://github.com/camunda/orchestration groupId: unassignUserFromGroupPathParam_groupId; ``` -Defined in: [gen/CamundaClient.ts:1046](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1046) +Defined in: [gen/CamundaClient.ts:1043](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1043) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1046](https://github.com/camunda/orchestration username: unassignUserFromGroupPathParam_username; ``` -Defined in: [gen/CamundaClient.ts:1046](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1046) +Defined in: [gen/CamundaClient.ts:1043](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1043) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserFromTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserFromTenantInput.md index d375c2f055e..be2d5e607c8 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserFromTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserFromTenantInput.md @@ -11,7 +11,7 @@ mdx: type unassignUserFromTenantInput = object; ``` -Defined in: [gen/CamundaClient.ts:1050](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1050) +Defined in: [gen/CamundaClient.ts:1047](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1047) ## Properties @@ -21,7 +21,7 @@ Defined in: [gen/CamundaClient.ts:1050](https://github.com/camunda/orchestration tenantId: unassignUserFromTenantPathParam_tenantId; ``` -Defined in: [gen/CamundaClient.ts:1050](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1050) +Defined in: [gen/CamundaClient.ts:1047](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1047) --- @@ -31,4 +31,4 @@ Defined in: [gen/CamundaClient.ts:1050](https://github.com/camunda/orchestration username: unassignUserFromTenantPathParam_username; ``` -Defined in: [gen/CamundaClient.ts:1050](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1050) +Defined in: [gen/CamundaClient.ts:1047](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1047) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserTaskInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserTaskInput.md index 042cdbed392..ce0d58fda13 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserTaskInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/unassignUserTaskInput.md @@ -11,7 +11,7 @@ mdx: type unassignUserTaskInput = object; ``` -Defined in: [gen/CamundaClient.ts:1053](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1053) +Defined in: [gen/CamundaClient.ts:1050](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1050) ## Properties @@ -21,4 +21,4 @@ Defined in: [gen/CamundaClient.ts:1053](https://github.com/camunda/orchestration userTaskKey: unassignUserTaskPathParam_userTaskKey; ``` -Defined in: [gen/CamundaClient.ts:1053](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1053) +Defined in: [gen/CamundaClient.ts:1050](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1050) diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateAuthorizationInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateAuthorizationInput.md index 22e93040880..b0d4467cbf0 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateAuthorizationInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateAuthorizationInput.md @@ -11,7 +11,7 @@ mdx: type updateAuthorizationInput = updateAuthorizationBody & object; ``` -Defined in: [gen/CamundaClient.ts:1057](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1057) +Defined in: [gen/CamundaClient.ts:1054](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1054) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGlobalClusterVariableInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGlobalClusterVariableInput.md index 060d21925e6..4a17f9a1b2e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGlobalClusterVariableInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGlobalClusterVariableInput.md @@ -12,7 +12,7 @@ type updateGlobalClusterVariableInput = updateGlobalClusterVariableBody & object; ``` -Defined in: [gen/CamundaClient.ts:1061](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1061) +Defined in: [gen/CamundaClient.ts:1058](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1058) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGlobalTaskListenerInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGlobalTaskListenerInput.md new file mode 100644 index 00000000000..ae20903dafc --- /dev/null +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGlobalTaskListenerInput.md @@ -0,0 +1,22 @@ +--- +title: "Type Alias: updateGlobalTaskListenerInput" +sidebar_label: "updateGlobalTaskListenerInput" +mdx: + format: md +--- + +# Type Alias: updateGlobalTaskListenerInput + +```ts +type updateGlobalTaskListenerInput = updateGlobalTaskListenerBody & object; +``` + +Defined in: [gen/CamundaClient.ts:1062](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1062) + +## Type Declaration + +### id + +```ts +id: updateGlobalTaskListenerPathParam_id; +``` diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGroupInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGroupInput.md index b819c748110..b7780cd1256 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGroupInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateGroupInput.md @@ -11,7 +11,7 @@ mdx: type updateGroupInput = updateGroupBody & object; ``` -Defined in: [gen/CamundaClient.ts:1065](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1065) +Defined in: [gen/CamundaClient.ts:1066](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1066) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateJobInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateJobInput.md index 32d0147dc6f..fa022beeb78 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateJobInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateJobInput.md @@ -11,7 +11,7 @@ mdx: type updateJobInput = updateJobBody & object; ``` -Defined in: [gen/CamundaClient.ts:1069](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1069) +Defined in: [gen/CamundaClient.ts:1070](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1070) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateMappingRuleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateMappingRuleInput.md index 3f5b6fb1f01..53ca8b02428 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateMappingRuleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateMappingRuleInput.md @@ -11,7 +11,7 @@ mdx: type updateMappingRuleInput = updateMappingRuleBody & object; ``` -Defined in: [gen/CamundaClient.ts:1073](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1073) +Defined in: [gen/CamundaClient.ts:1074](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1074) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateRoleInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateRoleInput.md index de879c36bab..6681b3baa81 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateRoleInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateRoleInput.md @@ -11,7 +11,7 @@ mdx: type updateRoleInput = updateRoleBody & object; ``` -Defined in: [gen/CamundaClient.ts:1077](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1077) +Defined in: [gen/CamundaClient.ts:1078](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1078) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateTenantClusterVariableInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateTenantClusterVariableInput.md index 0e65ad37893..88b8acae991 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateTenantClusterVariableInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateTenantClusterVariableInput.md @@ -12,7 +12,7 @@ type updateTenantClusterVariableInput = updateTenantClusterVariableBody & object; ``` -Defined in: [gen/CamundaClient.ts:1086](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1086) +Defined in: [gen/CamundaClient.ts:1087](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1087) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateTenantInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateTenantInput.md index 1b4dbb89826..82985f5c011 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateTenantInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateTenantInput.md @@ -11,7 +11,7 @@ mdx: type updateTenantInput = updateTenantBody & object; ``` -Defined in: [gen/CamundaClient.ts:1081](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1081) +Defined in: [gen/CamundaClient.ts:1082](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1082) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserConsistency.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserConsistency.md deleted file mode 100644 index 4562143fd5d..00000000000 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserConsistency.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Type Alias: updateUserConsistency" -sidebar_label: "updateUserConsistency" -mdx: - format: md ---- - -# Type Alias: updateUserConsistency - -```ts -type updateUserConsistency = object; -``` - -Defined in: [gen/CamundaClient.ts:1092](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1092) - -Management of eventual consistency \* - -## Properties - -### consistency - -```ts -consistency: ConsistencyOptions<_DataOf>; -``` - -Defined in: [gen/CamundaClient.ts:1094](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1094) - -Management of eventual consistency tolerance. Set waitUpToMs to 0 to ignore eventual consistency. pollInterval is 500ms by default. diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserInput.md index c32fccd0348..9aafb27f23e 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserInput.md @@ -11,7 +11,7 @@ mdx: type updateUserInput = updateUserBody & object; ``` -Defined in: [gen/CamundaClient.ts:1090](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1090) +Defined in: [gen/CamundaClient.ts:1091](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1091) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserTaskInput.md b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserTaskInput.md index 9eb9d93224a..dd1be4c8850 100644 --- a/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserTaskInput.md +++ b/docs/apis-tools/typescript/api-reference/index/type-aliases/updateUserTaskInput.md @@ -11,7 +11,7 @@ mdx: type updateUserTaskInput = updateUserTaskBody & object; ``` -Defined in: [gen/CamundaClient.ts:1099](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/gen/CamundaClient.ts#L1099) +Defined in: [gen/CamundaClient.ts:1095](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/gen/CamundaClient.ts#L1095) ## Type Declaration diff --git a/docs/apis-tools/typescript/api-reference/logger/functions/createLogger.md b/docs/apis-tools/typescript/api-reference/logger/functions/createLogger.md index ff14f467318..d376fa3f4b8 100644 --- a/docs/apis-tools/typescript/api-reference/logger/functions/createLogger.md +++ b/docs/apis-tools/typescript/api-reference/logger/functions/createLogger.md @@ -11,7 +11,7 @@ mdx: function createLogger(opts): Logger; ``` -Defined in: [runtime/logger.ts:44](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L44) +Defined in: [runtime/logger.ts:44](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L44) ## Parameters diff --git a/docs/apis-tools/typescript/api-reference/logger/interfaces/LogEvent.md b/docs/apis-tools/typescript/api-reference/logger/interfaces/LogEvent.md index 70e43daaed8..4774ed750bd 100644 --- a/docs/apis-tools/typescript/api-reference/logger/interfaces/LogEvent.md +++ b/docs/apis-tools/typescript/api-reference/logger/interfaces/LogEvent.md @@ -7,7 +7,7 @@ mdx: # Interface: LogEvent -Defined in: [runtime/logger.ts:5](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L5) +Defined in: [runtime/logger.ts:5](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L5) ## Properties @@ -17,7 +17,7 @@ Defined in: [runtime/logger.ts:5](https://github.com/camunda/orchestration-clust args: any[]; ``` -Defined in: [runtime/logger.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L9) +Defined in: [runtime/logger.ts:9](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L9) --- @@ -27,7 +27,7 @@ Defined in: [runtime/logger.ts:9](https://github.com/camunda/orchestration-clust optional code: string; ``` -Defined in: [runtime/logger.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L10) +Defined in: [runtime/logger.ts:10](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L10) --- @@ -37,7 +37,7 @@ Defined in: [runtime/logger.ts:10](https://github.com/camunda/orchestration-clus optional data: any; ``` -Defined in: [runtime/logger.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L11) +Defined in: [runtime/logger.ts:11](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L11) --- @@ -47,7 +47,7 @@ Defined in: [runtime/logger.ts:11](https://github.com/camunda/orchestration-clus level: LogLevel; ``` -Defined in: [runtime/logger.ts:6](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L6) +Defined in: [runtime/logger.ts:6](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L6) --- @@ -57,7 +57,7 @@ Defined in: [runtime/logger.ts:6](https://github.com/camunda/orchestration-clust scope: string; ``` -Defined in: [runtime/logger.ts:7](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L7) +Defined in: [runtime/logger.ts:7](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L7) --- @@ -67,4 +67,4 @@ Defined in: [runtime/logger.ts:7](https://github.com/camunda/orchestration-clust ts: number; ``` -Defined in: [runtime/logger.ts:8](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L8) +Defined in: [runtime/logger.ts:8](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L8) diff --git a/docs/apis-tools/typescript/api-reference/logger/interfaces/Logger.md b/docs/apis-tools/typescript/api-reference/logger/interfaces/Logger.md index a45cf6abac9..3cb45a14ed0 100644 --- a/docs/apis-tools/typescript/api-reference/logger/interfaces/Logger.md +++ b/docs/apis-tools/typescript/api-reference/logger/interfaces/Logger.md @@ -7,7 +7,7 @@ mdx: # Interface: Logger -Defined in: [runtime/logger.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L24) +Defined in: [runtime/logger.ts:24](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L24) ## Methods @@ -21,7 +21,7 @@ code( data?): void; ``` -Defined in: [runtime/logger.ts:35](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L35) +Defined in: [runtime/logger.ts:35](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L35) #### Parameters @@ -53,7 +53,7 @@ Defined in: [runtime/logger.ts:35](https://github.com/camunda/orchestration-clus debug(...a): void; ``` -Defined in: [runtime/logger.ts:31](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L31) +Defined in: [runtime/logger.ts:31](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L31) #### Parameters @@ -73,7 +73,7 @@ Defined in: [runtime/logger.ts:31](https://github.com/camunda/orchestration-clus error(...a): void; ``` -Defined in: [runtime/logger.ts:28](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L28) +Defined in: [runtime/logger.ts:28](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L28) #### Parameters @@ -93,7 +93,7 @@ Defined in: [runtime/logger.ts:28](https://github.com/camunda/orchestration-clus info(...a): void; ``` -Defined in: [runtime/logger.ts:30](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L30) +Defined in: [runtime/logger.ts:30](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L30) #### Parameters @@ -113,7 +113,7 @@ Defined in: [runtime/logger.ts:30](https://github.com/camunda/orchestration-clus level(): LogLevel; ``` -Defined in: [runtime/logger.ts:25](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L25) +Defined in: [runtime/logger.ts:25](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L25) #### Returns @@ -127,7 +127,7 @@ Defined in: [runtime/logger.ts:25](https://github.com/camunda/orchestration-clus scope(child): Logger; ``` -Defined in: [runtime/logger.ts:34](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L34) +Defined in: [runtime/logger.ts:34](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L34) #### Parameters @@ -147,7 +147,7 @@ Defined in: [runtime/logger.ts:34](https://github.com/camunda/orchestration-clus setLevel(level): void; ``` -Defined in: [runtime/logger.ts:26](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L26) +Defined in: [runtime/logger.ts:26](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L26) #### Parameters @@ -167,7 +167,7 @@ Defined in: [runtime/logger.ts:26](https://github.com/camunda/orchestration-clus setTransport(t?): void; ``` -Defined in: [runtime/logger.ts:27](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L27) +Defined in: [runtime/logger.ts:27](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L27) #### Parameters @@ -187,7 +187,7 @@ Defined in: [runtime/logger.ts:27](https://github.com/camunda/orchestration-clus silly(...a): void; ``` -Defined in: [runtime/logger.ts:33](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L33) +Defined in: [runtime/logger.ts:33](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L33) #### Parameters @@ -207,7 +207,7 @@ Defined in: [runtime/logger.ts:33](https://github.com/camunda/orchestration-clus trace(...a): void; ``` -Defined in: [runtime/logger.ts:32](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L32) +Defined in: [runtime/logger.ts:32](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L32) #### Parameters @@ -227,7 +227,7 @@ Defined in: [runtime/logger.ts:32](https://github.com/camunda/orchestration-clus warn(...a): void; ``` -Defined in: [runtime/logger.ts:29](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L29) +Defined in: [runtime/logger.ts:29](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L29) #### Parameters diff --git a/docs/apis-tools/typescript/api-reference/logger/type-aliases/LogLevel.md b/docs/apis-tools/typescript/api-reference/logger/type-aliases/LogLevel.md index 0cf4e3d4e3b..e1805dae4f2 100644 --- a/docs/apis-tools/typescript/api-reference/logger/type-aliases/LogLevel.md +++ b/docs/apis-tools/typescript/api-reference/logger/type-aliases/LogLevel.md @@ -18,4 +18,4 @@ type LogLevel = | "silly"; ``` -Defined in: [runtime/logger.ts:4](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L4) +Defined in: [runtime/logger.ts:4](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L4) diff --git a/docs/apis-tools/typescript/api-reference/logger/type-aliases/LogTransport.md b/docs/apis-tools/typescript/api-reference/logger/type-aliases/LogTransport.md index f018470f285..f4100f0154d 100644 --- a/docs/apis-tools/typescript/api-reference/logger/type-aliases/LogTransport.md +++ b/docs/apis-tools/typescript/api-reference/logger/type-aliases/LogTransport.md @@ -11,7 +11,7 @@ mdx: type LogTransport = (e) => void; ``` -Defined in: [runtime/logger.ts:13](https://github.com/camunda/orchestration-cluster-api-js/blob/67d45ce4f287cc3401854a637606d7e989daefac/src/runtime/logger.ts#L13) +Defined in: [runtime/logger.ts:13](https://github.com/camunda/orchestration-cluster-api-js/blob/c7e619b3cd4bb2bb6933c5f3eeef3e7689f08358/src/runtime/logger.ts#L13) ## Parameters