@camunda8/sdk 8.7.6 → 8.7.8

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [8.7.8](https://github.com/camunda/camunda-8-js-sdk/compare/v8.7.7...v8.7.8) (2025-05-16)
+
+
+### Features
+
+* add hinting for Rest errors. fixes [#456](https://github.com/camunda/camunda-8-js-sdk/issues/456) ([cf34f57](https://github.com/camunda/camunda-8-js-sdk/commit/cf34f5747f328be3fceba6f588b2cbc8bb32004a))
+* debug and trace support log infrastructure. fixes [#457](https://github.com/camunda/camunda-8-js-sdk/issues/457) ([a8e3234](https://github.com/camunda/camunda-8-js-sdk/commit/a8e3234760edb6e0fa33c9eec5ddbf54b82ea2dd))
+
+## [8.7.7](https://github.com/camunda/camunda-8-js-sdk/compare/v8.7.6...v8.7.7) (2025-05-12)
+
+
+### Bug Fixes
+
+* expose configuration in documentation. fixes [#451](https://github.com/camunda/camunda-8-js-sdk/issues/451) ([55dc5d5](https://github.com/camunda/camunda-8-js-sdk/commit/55dc5d5885c5c30373b930573e783c13b45609fb))
+* refactor tests for configuration change ([4b33ad4](https://github.com/camunda/camunda-8-js-sdk/commit/4b33ad45f3e5bebf02801b535c5bc38252bf938a))
+
 ## [8.7.6](https://github.com/camunda/camunda-8-js-sdk/compare/v8.7.5...v8.7.6) (2025-05-08)
 
 

package/README.md

@@ -52,28 +52,26 @@ const admin = c8.getAdminApiClient()
 
 The configuration for the SDK can be done by any combination of environment variables and explicit configuration passed to the `Camunda8` constructor.
 
-Any configuration passed in to the `Camunda8` constructor is merged over any configuration in the environment.
+The complete documentation of all configuration parameters can be found [here](https://camunda.github.io/camunda-8-js-sdk/variables/index.CamundaSDKConfiguration.html).
 
-The configuration object fields and the environment variables have exactly the same names. See the file [`src/lib/Configuration.ts`](https://github.com/camunda/camunda-8-js-sdk/blob/main/src/lib/Configuration.ts) for a complete list of configuration parameters that can be set via environment variables or constructor parameters.
+Any configuration passed in to the `Camunda8` constructor is merged over any configuration in the environment. The configuration object fields and the environment variables have exactly the same names.
 
 ## A note on how int64 is handled in the JavaScript SDK
 
 Entity keys in Camunda 8 are stored and represented as `int64` numbers. The range of `int64` extends to numbers that cannot be represented by the JavaScript `number` type. To deal with this, `int64` keys are serialised by the SDK to the JavaScript `string` type. See [this issue](https://github.com/camunda/camunda-8-js-sdk/issues/78) for more details.
 
-Some number values - for example: "_total returned results_ " - may be specified as `int64` in the API specifications. Although these numbers will usually not contain unsafe values, they are always serialised to `string`.
-
 For `int64` values whose type is not known ahead of time, such as job variables, you can pass an annotated data transfer object (DTO) to decode them reliably. If no DTO is specified, the default behavior of the SDK is to serialise all numbers to JavaScript `number`, and to throw an exception if a number value is detected at a runtime that cannot be accurately represented as the JavaScript `number` type (that is, a value greater than 2^53-1).
 
 ## Authorization
 
 Calls to APIs can be authorized using a number of strategies. The most common is OAuth - a token that is obtained via a client id/secret pair exchange.
 
-* Camunda SaaS and Self-Managed by default are configured to use OAuth with token exchange. In most cases, you will use the `OAUTH` strategy and provide configuration only. The token exchange and its lifecycle are managed by the SDK in this strategy. This passes the token in the `authorization` header of requests.
-* If you secure the gateway behind an Nginx reverse-proxy secured with basic authentication, you will use the `BASIC` strategy. This adds the login credentials as the `authorization` header on requests.
-* For C8Run 8.7, you will need to use the `COOKIE` strategy. This manages a session cookie obtained from a login endpoint, and adds it as a cookie header to requests.
-* For more customisation, you can use the `BEARER` strategy. This is a strategy that allows you to dynamically provide the `Bearer` token directly. The currently set token is added as the `authorization` header on requests.
-* If you have a even more advanced use-case (for example, the need to add specific headers with specific values to authenticate with a proxy gateway), you can construct your own AuthProvider and pass it to the constructor.
-* You can also disable header auth completely and use mTLS (client certificate) — or no authentication at all — with the `NONE` strategy.
+- Camunda SaaS and Self-Managed by default are configured to use OAuth with token exchange. In most cases, you will use the `OAUTH` strategy and provide configuration only. The token exchange and its lifecycle are managed by the SDK in this strategy. This passes the token in the `authorization` header of requests.
+- If you secure the gateway behind an Nginx reverse-proxy secured with basic authentication, you will use the `BASIC` strategy. This adds the login credentials as the `authorization` header on requests.
+- For C8Run 8.7, you will need to use the `COOKIE` strategy. This manages a session cookie obtained from a login endpoint, and adds it as a cookie header to requests.
+- For more customisation, you can use the `BEARER` strategy. This is a strategy that allows you to dynamically provide the `Bearer` token directly. The currently set token is added as the `authorization` header on requests.
+- If you have a even more advanced use-case (for example, the need to add specific headers with specific values to authenticate with a proxy gateway), you can construct your own AuthProvider and pass it to the constructor.
+- You can also disable header auth completely and use mTLS (client certificate) — or no authentication at all — with the `NONE` strategy.
 
 For more details on each of these scenarios, see the relevant section below.
 
@@ -176,14 +174,14 @@ You can add arbitrary headers to all requests by implementing `IOAuthProvider`:
 import { Camunda8, Auth } from '@camunda8/sdk'
 
 class MyCustomAuthProvider implements Auth.IOAuthProvider {
-    async getToken(audience: string) {
-        // here we give a static example, but this class may read configuration,
-        // exchange credentials with an endpoint, manage token lifecycles, and so forth...
-        // Return an object which will be merged with the headers on the request
-        return {
-           'x-custom-auth-header': 'someCustomValue'
-        }
-    }
+	async getToken(audience: string) {
+		// here we give a static example, but this class may read configuration,
+		// exchange credentials with an endpoint, manage token lifecycles, and so forth...
+		// Return an object which will be merged with the headers on the request
+		return {
+			'x-custom-auth-header': 'someCustomValue',
+		}
+	}
 }
 
 const customAuthProvider = new MyCustomAuthProvider()
@@ -213,7 +211,7 @@ This is the complete environment configuration needed to run against the Dockeri
 
 ```bash
 # Self-Managed
-export ZEEBE_GRPC_ADDRESS='localhost:26500'
+export ZEEBE_ADDRESS='localhost:26500'
 export ZEEBE_REST_ADDRESS='http://localhost:8080'
 export ZEEBE_CLIENT_ID='zeebe'
 export ZEEBE_CLIENT_SECRET='zecret'
@@ -244,7 +242,7 @@ Here is an example of doing this via the constructor, rather than via the enviro
 import { Camunda8 } from '@camunda8/sdk'
 
 const c8 = new Camunda8({
-	ZEEBE_GRPC_ADDRESS: 'localhost:26500',
+	ZEEBE_ADDRESS: 'localhost:26500',
 	ZEEBE_REST_ADDRESS: 'http://localhost:8080',
 	ZEEBE_CLIENT_ID: 'zeebe',
 	ZEEBE_CLIENT_SECRET: 'zecret',
@@ -265,7 +263,7 @@ const c8 = new Camunda8({
 Here is a complete configuration example for connection to Camunda SaaS:
 
 ```bash
-export ZEEBE_GRPC_ADDRESS='5c34c0a7-7f29-4424-8414-125615f7a9b9.syd-1.zeebe.camunda.io:443'
+export ZEEBE_ADDRESS='5c34c0a7-7f29-4424-8414-125615f7a9b9.syd-1.zeebe.camunda.io:443'
 export ZEEBE_REST_ADDRESS='https://syd-1.zeebe.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
 export ZEEBE_CLIENT_ID='yvvURO9TmBnP3zx4Xd8Ho6apgeiZTjn6'
 export ZEEBE_CLIENT_SECRET='iJJu-SHgUtuJTTAMnMLdcb8WGF8s2mHfXhXutEwe8eSbLXn98vUpoxtuLk5uG0en'
@@ -291,6 +289,7 @@ export CAMUNDA_CONSOLE_OAUTH_AUDIENCE='api.cloud.camunda.io'
 The SDK uses a Winston / Pino compatible logging setup. By default it uses Winston.
 
 When using the default logging library, you can set the logging level of the SDK via the environment variable (or constructor configuration property) `CAMUNDA_LOG_LEVEL`. This defaults to 'info'. Values (in order of priority): `error`, `warn`, `info`, `http`, `verbose`, `debug`, `silly`.
+
 ### Custom logger
 
 You can supply a custom logger via the constructor. For example, to use the [Pino](https://getpino.io/) logging library:
@@ -305,7 +304,7 @@ const logger = pino({ level }) // Logging level controlled via the logging libra
 
 logger.info('Pino logger created')
 const c8 = new Camunda8({
-    logger,
+	logger,
 })
 c8.log.info('Using pino logger')
 ```
@@ -316,18 +315,18 @@ The SDK uses the [`debug`](https://github.com/debug-js/debug) library to help yo
 
 To enable debugging output, set a value for the `DEBUG` environment variable. The value is a comma-separated list of debugging namespaces. The SDK has the following namespaces:
 
-| Value                  | Component            |
-| ---------------------- | -------------------- |
-| `camunda:adminconsole` | Administration API   |
-| `camunda:modeler`      | Modeler API          |
-| `camunda:operate`      | Operate API          |
-| `camunda:optimize`     | Optimize API         |
-| `camunda:tasklist`     | Tasklist API         |
-| `camunda:oauth`        | OAuth Token Exchange |
-| `camunda:grpc`         | Zeebe gRPC channel   |
-| `camunda:worker`       | Zeebe Worker         |
-| `camunda:worker:verbose`| Zeebe Worker (additional detail) |
-| `camunda:zeebeclient`  | Zeebe Client         |
+| Value                    | Component                        |
+| ------------------------ | -------------------------------- |
+| `camunda:adminconsole`   | Administration API               |
+| `camunda:modeler`        | Modeler API                      |
+| `camunda:operate`        | Operate API                      |
+| `camunda:optimize`       | Optimize API                     |
+| `camunda:tasklist`       | Tasklist API                     |
+| `camunda:oauth`          | OAuth Token Exchange             |
+| `camunda:grpc`           | Zeebe gRPC channel               |
+| `camunda:worker`         | Zeebe Worker                     |
+| `camunda:worker:verbose` | Zeebe Worker (additional detail) |
+| `camunda:zeebeclient`    | Zeebe Client                     |
 
 Here is an example of turning on debugging for the OAuth and Operate components:
 
@@ -335,6 +334,10 @@ Here is an example of turning on debugging for the OAuth and Operate components:
 DEBUG=camunda:oauth,camunda:operate node app.js
 ```
 
+## Diagnostic Trace file
+
+You can output a diagnostic trace file to use with Camunda technical support by setting the environment variable `CAMUNDA_SUPPORT_LOG_ENABLED` to true. This will output a file `camunda-support.log` containing diagnostic information and tracing calls. This information is useful for debugging. Be aware that this log file will contain secrets such as bearer tokens, as well as exposing urls.
+
 ## Process Variable Typing
 
 Process variables - the `variables` of Zeebe messages, jobs, and process instance creation requests and responses - are stored in the broker as key:value pairs. They are transported as a JSON string. The SDK parses the JSON string into a JavaScript object.
@@ -452,4 +455,3 @@ When a polling worker encounters an error, including not being authenticated, th
 This means that if you start a worker with invalid credentials, then the polling backoff will look like this, by default (times in seconds): 3, 6, 9, 12, 15, 18, 21, 23, 24, 25, 26, 27, 28, 29, 30, 30, 30...
 
 If the worker is backing off for a reason other than invalid credentials - for example a backpressure signal from the gateway - it will be: 2, 4, 6, 8, 10, 12, 14, 15, 15, 15.....
-

package/dist/admin/lib/AdminApiClient.d.ts

@@ -16,14 +16,14 @@ export declare class AdminApiClient {
     private getHeaders;
     /**
      *
-     * @description Get an array of the current API clients for this cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClients) for more details.
+     * Get an array of the current API clients for this cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClients) for more details.
      * @throws {RESTError}
      * @param clusterUuid - The cluster UUID
      *
      */
     getClients(clusterUuid: string): Promise<Dto.ClusterClient[]>;
     /**
-     * @description Create a new API client for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateClient) for more details.
+     * Create a new API client for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateClient) for more details.
      * @throws {RESTError}
      */
     createClient(req: {
@@ -32,7 +32,7 @@ export declare class AdminApiClient {
         permissions: string[];
     }): Promise<Dto.CreatedClusterClient>;
     /**
-     * @description Get the details of an API client. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClient) for more details.
+     * Get the details of an API client. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClient) for more details.
      * @param clusterUuid
      * @param clientId
      * @throws {RESTError}
@@ -40,7 +40,7 @@ export declare class AdminApiClient {
      */
     getClient(clusterUuid: string, clientId: string): Promise<Dto.ClusterClientConnectionDetails>;
     /**
-     * @description See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteClient) for more details.
+     * See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteClient) for more details.
      * @param clusterUuid
      * @param clientId
      * @throws {RESTError}
@@ -48,13 +48,13 @@ export declare class AdminApiClient {
     deleteClient(clusterUuid: string, clientId: string): Promise<null>;
     /**
      *
-     * @description Return an array of clusters. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClusters) for more details.
+     * Return an array of clusters. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClusters) for more details.
      * @throws {RESTError}
      */
     getClusters(): Promise<Dto.Cluster[]>;
     /**
      *
-     * @description Create a new cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateCluster) for more details.
+     * Create a new cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateCluster) for more details.
      * @throws {RESTError}
      */
     createCluster(createClusterRequest: Dto.CreateClusterBody): Promise<{
@@ -62,27 +62,27 @@ export declare class AdminApiClient {
     }>;
     /**
      *
-     * @description Retrieve the metadata for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetCluster) for more details.
+     * Retrieve the metadata for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetCluster) for more details.
      * @throws {RESTError}
      *
      */
     getCluster(clusterUuid: string): Promise<Dto.Cluster>;
     /**
      *
-     * @description Delete a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteCluster) for more details.
+     * Delete a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteCluster) for more details.
      * @throws {RESTError}
      *
      */
     deleteCluster(clusterUuid: string): Promise<null>;
     /**
      *
-     * @description Retrieve the available parameters for cluster creation. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetParameters) for more details.
+     * Retrieve the available parameters for cluster creation. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetParameters) for more details.
      * @throws {RESTError}
      */
     getParameters(): Promise<Dto.Parameters>;
     /**
      *
-     * @description Retrieve the connector secrets. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetSecrets) for more details.
+     * Retrieve the connector secrets. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetSecrets) for more details.
      * @throws {RESTError}
      */
     getSecrets(clusterUuid: string): Promise<{
@@ -90,7 +90,7 @@ export declare class AdminApiClient {
     }>;
     /**
      *
-     * @description Create a new connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateSecret) for more details.
+     * Create a new connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateSecret) for more details.
      * @throws {RESTError}
      */
     createSecret({ clusterUuid, secretName, secretValue, }: {
@@ -100,13 +100,13 @@ export declare class AdminApiClient {
     }): Promise<null>;
     /**
      *
-     * @description Delete a connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteSecret) for more details.
+     * Delete a connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteSecret) for more details.
      * @throws {RESTError}
      */
     deleteSecret(clusterUuid: string, secretName: string): Promise<null>;
     /**
      *
-     * @description Add one or more IPs to the whitelist for the cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/UpdateIpWhitelist) for more details.
+     * Add one or more IPs to the whitelist for the cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/UpdateIpWhitelist) for more details.
      * @throws {RESTError}
      * @param ipwhitelist
      * @returns
@@ -119,20 +119,20 @@ export declare class AdminApiClient {
     ]): Promise<null>;
     /**
      *
-     * @description Retrieve a list of members and pending invites for your organisation. See the [API Documentation]() for more details.
+     * Retrieve a list of members and pending invites for your organisation. See the [API Documentation]() for more details.
      * @throws {RESTError}
      */
     getUsers(): Promise<Dto.Member[]>;
     /**
      *
-     * @description Add a member. See the [API Documentation]() for more details.
+     * Add a member. See the [API Documentation]() for more details.
      * @throws {RESTError}
      *
      */
     createMember(email: string, orgRoles: Dto.OrganizationRole[]): Promise<null>;
     /**
      *
-     * @description Delete a member from your organization. See the [API Documentation]() for more details.
+     * Delete a member from your organization. See the [API Documentation]() for more details.
      * @throws {RESTError}
      *
      */

package/dist/admin/lib/AdminApiClient.js

@@ -25,12 +25,12 @@ class AdminApiClient {
             https: {
                 certificateAuthority,
             },
-            handlers: [lib_1.gotErrorHandler],
+            handlers: [lib_1.beforeCallHook],
             hooks: {
                 beforeRetry: [
                     (0, lib_1.makeBeforeRetryHandlerFor401TokenRetry)(this.getHeaders.bind(this)),
                 ],
-                beforeError: [lib_1.gotBeforeErrorHook],
+                beforeError: [(0, lib_1.gotBeforeErrorHook)(config)],
                 beforeRequest: config.middleware ?? [],
             },
         }));
@@ -48,7 +48,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Get an array of the current API clients for this cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClients) for more details.
+     * Get an array of the current API clients for this cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClients) for more details.
      * @throws {RESTError}
      * @param clusterUuid - The cluster UUID
      *
@@ -61,7 +61,7 @@ class AdminApiClient {
         }).json();
     }
     /**
-     * @description Create a new API client for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateClient) for more details.
+     * Create a new API client for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateClient) for more details.
      * @throws {RESTError}
      */
     async createClient(req) {
@@ -78,7 +78,7 @@ class AdminApiClient {
             .json();
     }
     /**
-     * @description Get the details of an API client. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClient) for more details.
+     * Get the details of an API client. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClient) for more details.
      * @param clusterUuid
      * @param clientId
      * @throws {RESTError}
@@ -92,7 +92,7 @@ class AdminApiClient {
         }).json();
     }
     /**
-     * @description See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteClient) for more details.
+     * See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteClient) for more details.
      * @param clusterUuid
      * @param clientId
      * @throws {RESTError}
@@ -108,7 +108,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Return an array of clusters. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClusters) for more details.
+     * Return an array of clusters. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetClusters) for more details.
      * @throws {RESTError}
      */
     async getClusters() {
@@ -120,7 +120,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Create a new cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateCluster) for more details.
+     * Create a new cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateCluster) for more details.
      * @throws {RESTError}
      */
     async createCluster(createClusterRequest) {
@@ -134,7 +134,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Retrieve the metadata for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetCluster) for more details.
+     * Retrieve the metadata for a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetCluster) for more details.
      * @throws {RESTError}
      *
      */
@@ -147,7 +147,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Delete a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteCluster) for more details.
+     * Delete a cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteCluster) for more details.
      * @throws {RESTError}
      *
      */
@@ -162,7 +162,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Retrieve the available parameters for cluster creation. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetParameters) for more details.
+     * Retrieve the available parameters for cluster creation. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetParameters) for more details.
      * @throws {RESTError}
      */
     async getParameters() {
@@ -174,7 +174,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Retrieve the connector secrets. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetSecrets) for more details.
+     * Retrieve the connector secrets. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/GetSecrets) for more details.
      * @throws {RESTError}
      */
     async getSecrets(clusterUuid) {
@@ -186,7 +186,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Create a new connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateSecret) for more details.
+     * Create a new connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/CreateSecret) for more details.
      * @throws {RESTError}
      */
     async createSecret({ clusterUuid, secretName, secretValue, }) {
@@ -200,7 +200,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Delete a connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteSecret) for more details.
+     * Delete a connector secret. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/DeleteSecret) for more details.
      * @throws {RESTError}
      */
     async deleteSecret(clusterUuid, secretName) {
@@ -214,7 +214,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Add one or more IPs to the whitelist for the cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/UpdateIpWhitelist) for more details.
+     * Add one or more IPs to the whitelist for the cluster. See [the API Documentation](https://console.cloud.camunda.io/customer-api/openapi/docs/#/default/UpdateIpWhitelist) for more details.
      * @throws {RESTError}
      * @param ipwhitelist
      * @returns
@@ -233,7 +233,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Retrieve a list of members and pending invites for your organisation. See the [API Documentation]() for more details.
+     * Retrieve a list of members and pending invites for your organisation. See the [API Documentation]() for more details.
      * @throws {RESTError}
      */
     async getUsers() {
@@ -247,7 +247,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Add a member. See the [API Documentation]() for more details.
+     * Add a member. See the [API Documentation]() for more details.
      * @throws {RESTError}
      *
      */
@@ -263,7 +263,7 @@ class AdminApiClient {
     }
     /**
      *
-     * @description Delete a member from your organization. See the [API Documentation]() for more details.
+     * Delete a member from your organization. See the [API Documentation]() for more details.
      * @throws {RESTError}
      *
      */

package/dist/admin/lib/AdminApiClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"AdminApiClient.js","sourceRoot":"","sources":["../../../src/admin/lib/AdminApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAqB;AACrB,8CAAqB;AAErB,mCAYkB;AAKlB,MAAM,KAAK,GAAG,IAAA,eAAC,EAAC,sBAAsB,CAAC,CAAA;AAEvC;;;GAGG;AACH,MAAa,cAAc;IAK1B,YAAY,OAGX;QACA,MAAM,MAAM,GAAG,oCAA8B,CAAC,0BAA0B,CACvE,OAAO,EAAE,MAAM,IAAI,EAAE,CACrB,CAAA;QACD,MAAM,SAAS,GAAG,IAAA,0BAAoB,EACrC,MAAM,CAAC,wBAAwB,EAC/B,0BAA0B,CAC1B,CAAA;QAED,IAAI,CAAC,aAAa;YACjB,OAAO,EAAE,aAAa,IAAI,IAAA,4BAAsB,EAAC,MAAM,CAAC,CAAA;QAEzD,IAAI,CAAC,eAAe,GAAG,IAAA,2BAAqB,EAAC,MAAM,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,IAAA,gCAA0B,EAAC,MAAM,CAAC,CAAC,IAAI,CAClD,CAAC,oBAAoB,EAAE,EAAE,CACxB,aAAG,CAAC,MAAM,CAAC;YACV,SAAS;YACT,KAAK,EAAE,oBAAc;YACrB,KAAK,EAAE;gBACN,oBAAoB;aACpB;YACD,QAAQ,EAAE,CAAC,qBAAe,CAAC;YAC3B,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,IAAA,4CAAsC,EACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1B;iBACD;gBACD,WAAW,EAAE,CAAC,wBAAkB,CAAC;gBACjC,aAAa,EAAE,MAAM,CAAC,UAAU,IAAI,EAAE;aACtC;SACD,CAAC,CACH,CAAA;QACD,KAAK,CAAC,WAAW,EAAE,GAAG,SAAS,EAAE,CAAC,CAAA;IACnC,CAAC;IAEO,KAAK,CAAC,UAAU;QACvB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAClE,MAAM,OAAO,GAAG;YACf,cAAc,EAAE,kBAAkB;YAClC,GAAG,aAAa;YAChB,YAAY,EAAE,IAAI,CAAC,eAAe;YAClC,MAAM,EAAE,KAAK;SACb,CAAA;QACD,OAAO,OAAO,CAAA;IACf,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE;YAC9C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,GAIlB;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,IAAI,CAAC,YAAY,GAAG,CAAC,WAAW,UAAU,EAAE;YAC5C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,WAAW,EAAE,GAAG,CAAC,WAAW;aAC5B,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACd,WAAmB,EACnB,QAAgB;QAEhB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,YAAY,QAAQ,EAAE,EAAE;YAC1D,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,QAAgB;QACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,YAAY,QAAQ,EAAE,EAAE;YACtD,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,UAAU,EAAE;YACvB,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAClB,oBAA2C;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;YAC1C,OAAO;SACP,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACzC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,EAAE,EAAE;YACtC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,WAAmB;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,EAAE,EAAE;YAClC,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,qBAAqB,EAAE;YAClC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE;YAC9C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAClB,WAAW,EACX,UAAU,EACV,WAAW,GAKX;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;YACjD,OAAO;SACP,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IAChE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,UAAkB;QACzD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,YAAY,UAAU,EAAE,EAAE;YACxD,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CACjB,WAAmB,EACnB,WAKC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,GAAG,CAAC,YAAY,WAAW,cAAc,EAAE;YAC3C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,WAAW;aACX,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ;QACb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,GAAG,CAAC,SAAS,EAAE;YACf,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CACjB,KAAa,EACb,QAAgC;QAEhC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,IAAI,CAAC,WAAW,KAAK,EAAE,EAAE;YACzB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;SAClC,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,KAAa;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,WAAW,KAAK,EAAE,EAAE;YAC3B,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;CACD;AAxUD,wCAwUC"}
+{"version":3,"file":"AdminApiClient.js","sourceRoot":"","sources":["../../../src/admin/lib/AdminApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAqB;AACrB,8CAAqB;AAErB,mCAYkB;AAKlB,MAAM,KAAK,GAAG,IAAA,eAAC,EAAC,sBAAsB,CAAC,CAAA;AAEvC;;;GAGG;AACH,MAAa,cAAc;IAK1B,YAAY,OAGX;QACA,MAAM,MAAM,GAAG,oCAA8B,CAAC,0BAA0B,CACvE,OAAO,EAAE,MAAM,IAAI,EAAE,CACrB,CAAA;QACD,MAAM,SAAS,GAAG,IAAA,0BAAoB,EACrC,MAAM,CAAC,wBAAwB,EAC/B,0BAA0B,CAC1B,CAAA;QAED,IAAI,CAAC,aAAa;YACjB,OAAO,EAAE,aAAa,IAAI,IAAA,4BAAsB,EAAC,MAAM,CAAC,CAAA;QAEzD,IAAI,CAAC,eAAe,GAAG,IAAA,2BAAqB,EAAC,MAAM,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,GAAG,IAAA,gCAA0B,EAAC,MAAM,CAAC,CAAC,IAAI,CAClD,CAAC,oBAAoB,EAAE,EAAE,CACxB,aAAG,CAAC,MAAM,CAAC;YACV,SAAS;YACT,KAAK,EAAE,oBAAc;YACrB,KAAK,EAAE;gBACN,oBAAoB;aACpB;YACD,QAAQ,EAAE,CAAC,oBAAc,CAAC;YAC1B,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,IAAA,4CAAsC,EACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAC1B;iBACD;gBACD,WAAW,EAAE,CAAC,IAAA,wBAAkB,EAAC,MAAM,CAAC,CAAC;gBACzC,aAAa,EAAE,MAAM,CAAC,UAAU,IAAI,EAAE;aACtC;SACD,CAAC,CACH,CAAA;QACD,KAAK,CAAC,WAAW,EAAE,GAAG,SAAS,EAAE,CAAC,CAAA;IACnC,CAAC;IAEO,KAAK,CAAC,UAAU;QACvB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAClE,MAAM,OAAO,GAAG;YACf,cAAc,EAAE,kBAAkB;YAClC,GAAG,aAAa;YAChB,YAAY,EAAE,IAAI,CAAC,eAAe;YAClC,MAAM,EAAE,KAAK;SACb,CAAA;QACD,OAAO,OAAO,CAAA;IACf,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE;YAC9C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,GAIlB;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,IAAI,CAAC,YAAY,GAAG,CAAC,WAAW,UAAU,EAAE;YAC5C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,UAAU,EAAE,GAAG,CAAC,UAAU;gBAC1B,WAAW,EAAE,GAAG,CAAC,WAAW;aAC5B,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CACd,WAAmB,EACnB,QAAgB;QAEhB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,YAAY,QAAQ,EAAE,EAAE;YAC1D,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,QAAgB;QACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,YAAY,QAAQ,EAAE,EAAE;YACtD,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QAChB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,UAAU,EAAE;YACvB,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAClB,oBAA2C;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;YAC1C,OAAO;SACP,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACzC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,EAAE,EAAE;YACtC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,WAAmB;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,EAAE,EAAE;YAClC,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,qBAAqB,EAAE;YAClC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE;YAC9C,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAClB,WAAW,EACX,UAAU,EACV,WAAW,GAKX;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,GAAG,GAAG;YACX,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;YACjD,OAAO;SACP,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,WAAW,UAAU,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IAChE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,WAAmB,EAAE,UAAkB;QACzD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,YAAY,WAAW,YAAY,UAAU,EAAE,EAAE;YACxD,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CACjB,WAAmB,EACnB,WAKC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,GAAG,CAAC,YAAY,WAAW,cAAc,EAAE;YAC3C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACpB,WAAW;aACX,CAAC;YACF,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ;QACb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,GAAG,CAAC,SAAS,EAAE;YACf,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CACjB,KAAa,EACb,QAAgC;QAEhC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,IAAI,CAAC,WAAW,KAAK,EAAE,EAAE;YACzB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;SAClC,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,KAAa;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI;aACT,MAAM,CAAC,WAAW,KAAK,EAAE,EAAE;YAC3B,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;CACD;AAxUD,wCAwUC"}

package/dist/c8/index.d.ts

@@ -11,7 +11,7 @@ import { CamundaRestClient } from './lib/CamundaRestClient';
 /**
  * A single point of configuration for all Camunda Platform 8 clients.
  *
- * This class is a facade for all the clients in the Camunda Platform 8 SDK.
+ * This class is a factory for all the clients in the Camunda Platform 8 SDK. It allows a single point of configuration for all clients.
  *
  * @example
  * ```typescript
@@ -41,8 +41,19 @@ export declare class Camunda8 {
     log: Logger;
     /**
      * All constructor parameters for configuration are optional. If no configuration is provided, the SDK will use environment variables to configure itself.
+     * See {@link CamundaSDKConfiguration} for the complete list of configuration parameters. Values can be passed in explicitly in code, or set via environment variables (recommended: separate configuration and application logic).
+     * Explicitly set values will override environment variables, which are merged into the configuration.
      */
-    constructor(config?: Camunda8ClientConfiguration & {
+    constructor(
+    /**
+     * Optional explicit overrides. With no configuration, the SDK will use environment variables to configure itself.
+     */
+    config?: Camunda8ClientConfiguration & {
+        /**
+         * An optional {@link IOAuthProvider} implementation. This can be used to add headers to REST requests made by the SDK.
+         * In most cases, you will not need to supply this. You can use `CAMUNDA_AUTH_STRATEGY` and appropriate config values to configure
+         * a preconfigured auth strategy. This configuration parameter is provided for advanced use-cases.
+         **/
         oAuthProvider?: IOAuthProvider;
     });
     /**

package/dist/c8/index.js

@@ -13,7 +13,7 @@ const CamundaRestClient_1 = require("./lib/CamundaRestClient");
 /**
  * A single point of configuration for all Camunda Platform 8 clients.
  *
- * This class is a facade for all the clients in the Camunda Platform 8 SDK.
+ * This class is a factory for all the clients in the Camunda Platform 8 SDK. It allows a single point of configuration for all clients.
  *
  * @example
  * ```typescript
@@ -32,8 +32,14 @@ const CamundaRestClient_1 = require("./lib/CamundaRestClient");
 class Camunda8 {
     /**
      * All constructor parameters for configuration are optional. If no configuration is provided, the SDK will use environment variables to configure itself.
+     * See {@link CamundaSDKConfiguration} for the complete list of configuration parameters. Values can be passed in explicitly in code, or set via environment variables (recommended: separate configuration and application logic).
+     * Explicitly set values will override environment variables, which are merged into the configuration.
      */
-    constructor(config = {}) {
+    constructor(
+    /**
+     * Optional explicit overrides. With no configuration, the SDK will use environment variables to configure itself.
+     */
+    config = {}) {
         this.configuration =
             lib_1.CamundaEnvironmentConfigurator.mergeConfigWithEnvironment(config);
         // Allow custom oAuthProvider to be passed in.

package/dist/c8/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/c8/index.ts"],"names":[],"mappings":";;;AAAA,oCAAyC;AACzC,gCAKe;AACf,wCAA6C;AAE7C,wCAA6C;AAC7C,0CAA+C;AAC/C,0CAA+C;AAC/C,oCAA2D;AAE3D,6CAAkD;AAClD,+DAA2D;AAE3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,QAAQ;IAapB;;OAEG;IAEH,YACC,SAEI,EAAE;QAEN,IAAI,CAAC,aAAa;YACjB,oCAA8B,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAA;QAClE,8CAA8C;QAC9C,8DAA8D;QAC9D,IAAI,CAAC,aAAa;YACjB,MAAM,CAAC,aAAa,IAAI,IAAA,4BAAsB,EAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QACnE,IAAI,CAAC,GAAG,GAAG,IAAA,oBAAS,EAAC,MAAM,CAAC,CAAA;QAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,CAAC;IAED;;;OAGG;IACI,mBAAmB,CACzB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAED;;;OAGG;IACI,iBAAiB,CACvB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAc,CAAC;gBACxC,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAA;IAC3B,CAAC;IAED;;;OAGG;IACI,mBAAmB,CACzB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAC1B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAC1B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAC3B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9B,IAAI,CAAC,kBAAkB,GAAG,IAAI,uBAAe,CAAC;gBAC7C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAC/B,CAAC;IAED;;OAEG;IACI,kBAAkB,CACxB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC3B,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAe,CAAC;gBAC1C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAA;IAC5B,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAC1B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,qCAAiB,CAAC;gBAC9C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;CACD;AA9JD,4BA8JC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/c8/index.ts"],"names":[],"mappings":";;;AAAA,oCAAyC;AACzC,gCAKe;AACf,wCAA6C;AAE7C,wCAA6C;AAC7C,0CAA+C;AAC/C,0CAA+C;AAC/C,oCAA2D;AAE3D,6CAAkD;AAClD,+DAA2D;AAE3D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,QAAQ;IAapB;;;;OAIG;IAEH;IACC;;OAEG;IACH,SAOI,EAAE;QAEN,IAAI,CAAC,aAAa;YACjB,oCAA8B,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAA;QAClE,8CAA8C;QAC9C,8DAA8D;QAC9D,IAAI,CAAC,aAAa;YACjB,MAAM,CAAC,aAAa,IAAI,IAAA,4BAAsB,EAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QACnE,IAAI,CAAC,GAAG,GAAG,IAAA,oBAAS,EAAC,MAAM,CAAC,CAAA;QAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,CAAC;IAED;;;OAGG;IACI,mBAAmB,CACzB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAED;;;OAGG;IACI,iBAAiB,CACvB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,sBAAc,CAAC;gBACxC,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAA;IAC3B,CAAC;IAED;;;OAGG;IACI,mBAAmB,CACzB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,IAAI,0BAAgB,CAAC;gBAC5C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAC1B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAC1B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAiB,CAAC;gBAC9C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACI,qBAAqB,CAC3B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9B,IAAI,CAAC,kBAAkB,GAAG,IAAI,uBAAe,CAAC;gBAC7C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAC/B,CAAC;IAED;;OAEG;IACI,kBAAkB,CACxB,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC3B,IAAI,CAAC,eAAe,GAAG,IAAI,uBAAe,CAAC;gBAC1C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAA;IAC5B,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAC1B,SAAsC,EAAE;QAExC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,qCAAiB,CAAC;gBAC9C,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,MAAM,EAAE;gBAC5C,aAAa,EAAE,IAAI,CAAC,aAAa;aACjC,CAAC,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAA;IAC9B,CAAC;CACD;AAxKD,4BAwKC"}

package/dist/c8/lib/C8Logger.d.ts

@@ -1,5 +1,10 @@
 import winston from 'winston';
 import { Camunda8ClientConfiguration } from '../../lib';
+/**
+ * This is the interface for the logger used in the SDK.
+ * It is based on the Winston logger and provides methods for logging at different levels.
+ * You can use this interface to create your own logger that implements the same methods.
+ */
 export type Logger = {
     info: (message: string | undefined, ...meta: any[]) => void;
     warn: (message: string | undefined, ...meta: any[]) => void;

package/dist/c8/lib/C8Logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"C8Logger.js","sourceRoot":"","sources":["../../../src/c8/lib/C8Logger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAA6C,CAAC,iBAAiB;AAE/D,mCAGkB;AAYlB,IAAI,aAAqB,CAAA;AACzB,IAAI,YAAgC,CAAA;AAEpC,SAAgB,SAAS,CAAC,MAAoC;IAC7D,MAAM,aAAa,GAClB,oCAA8B,CAAC,0BAA0B,CAAC,MAAM,IAAI,EAAE,CAAC,CAAA;IACxE,wIAAwI;IACxI,IAAI,MAAM,EAAE,MAAM,IAAI,YAAY,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QACtD,YAAY,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;IAC7C,CAAC;IACD,IAAI,CAAC,aAAa,EAAE,CAAC;QACpB,4BAA4B;QAC5B,MAAM,MAAM,GAAG,YAAY,CAAC;YAC3B,KAAK,EAAE,aAAa,CAAC,iBAAiB;YACtC,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAC7B,iBAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAC1B,iBAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EACzB,iBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CACvB;YACD,UAAU,EAAE,CAAC,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;SAC9C,CAAC,CAAA;QAEF,aAAa,GAAG,MAAM,CAAA;IACvB,CAAC;IACD,IAAI,CAAC,YAAY,EAAE,CAAC;QACnB,aAAa,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAA;QACnD,YAAY,GAAG,aAAa,CAAA;IAC7B,CAAC;IACD,OAAO,MAAM,EAAE,MAAM,IAAI,aAAa,CAAA;AACvC,CAAC;AA3BD,8BA2BC;AAED,SAAgB,YAAY,CAAC,OAA+B;IAC3D,MAAM,MAAM,GAER,iBAAO,CAAC,YAAY,CAAC,OAAO,CAAQ,CAAA,CAAC,yDAAyD;IAClG,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;IAC3B,OAAO,MAAM,CAAA;AACd,CAAC;AAND,oCAMC;AAEY,QAAA,UAAU,GAAG,YAAY,CAAC;IACtC,UAAU,EAAE,CAAC,IAAI,oBAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;CACtD,CAAC,CAAA"}
+{"version":3,"file":"C8Logger.js","sourceRoot":"","sources":["../../../src/c8/lib/C8Logger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAA6C,CAAC,iBAAiB;AAE/D,mCAGkB;AAiBlB,IAAI,aAAqB,CAAA;AACzB,IAAI,YAAgC,CAAA;AAEpC,SAAgB,SAAS,CAAC,MAAoC;IAC7D,MAAM,aAAa,GAClB,oCAA8B,CAAC,0BAA0B,CAAC,MAAM,IAAI,EAAE,CAAC,CAAA;IACxE,wIAAwI;IACxI,IAAI,MAAM,EAAE,MAAM,IAAI,YAAY,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QACtD,YAAY,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;IAC7C,CAAC;IACD,IAAI,CAAC,aAAa,EAAE,CAAC;QACpB,4BAA4B;QAC5B,MAAM,MAAM,GAAG,YAAY,CAAC;YAC3B,KAAK,EAAE,aAAa,CAAC,iBAAiB;YACtC,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAC7B,iBAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAC1B,iBAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EACzB,iBAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CACvB;YACD,UAAU,EAAE,CAAC,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;SAC9C,CAAC,CAAA;QAEF,aAAa,GAAG,MAAM,CAAA;IACvB,CAAC;IACD,IAAI,CAAC,YAAY,EAAE,CAAC;QACnB,aAAa,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAA;QACnD,YAAY,GAAG,aAAa,CAAA;IAC7B,CAAC;IACD,OAAO,MAAM,EAAE,MAAM,IAAI,aAAa,CAAA;AACvC,CAAC;AA3BD,8BA2BC;AAED,SAAgB,YAAY,CAAC,OAA+B;IAC3D,MAAM,MAAM,GAER,iBAAO,CAAC,YAAY,CAAC,OAAO,CAAQ,CAAA,CAAC,yDAAyD;IAClG,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;IAC3B,OAAO,MAAM,CAAA;AACd,CAAC;AAND,oCAMC;AAEY,QAAA,UAAU,GAAG,YAAY,CAAC;IACtC,UAAU,EAAE,CAAC,IAAI,oBAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;CACtD,CAAC,CAAA"}

package/dist/c8/lib/CamundaJobWorker.d.ts

@@ -20,14 +20,27 @@ type CamundaJobWorkerEvents = {
     work: (jobs: RestJob<unknown, unknown>[]) => void;
 };
 export interface CamundaJobWorkerConfig<VariablesDto extends LosslessDto, CustomHeadersDto extends LosslessDto> extends ActivateJobsRequest {
+    /** An optional {@link LosslessDto} class to decode the job variables. This provides both runtime safety for `int64` numbers and design-time type hinting. */
     inputVariableDto?: Ctor<VariablesDto>;
+    /** An optional {@link LosslessDto} class to decode the job custom headers. This provides both runtime safety for `int64` numbers and design-time type hinting. */
     customHeadersDto?: Ctor<CustomHeadersDto>;
-    /** How often the worker will poll for new jobs. Defaults to 300ms */
+    /** How often the worker will poll for new jobs. Defaults to 300ms. */
     pollIntervalMs?: number;
+    /**
+     * A callback function that is invoked for an activated job. All return paths must return the output from one of the job acknowledgement methods.
+     * This is done to ensure that job handlers do not have logic paths that neglect to acknowledge the job.
+     */
     jobHandler: (job: RestJob<VariablesDto, CustomHeadersDto> & JobCompletionInterfaceRest<IProcessVariables>, log: Logger) => MustReturnJobActionAcknowledgement;
+    /** An optional logger instance. */
     logger?: Logger;
     /** Default: true. Start the worker polling immediately. If set to `false`, call the worker's `start()` method to start polling for work. */
     autoStart?: boolean;
+    /**
+     * The worker will back off polling for jobs if the poll request fails. This is to prevent overwhelming the broker with requests.
+     * The backoff time will double with each failed request, up to the maximum backoff time.
+     * The backoff time will be reset to the initial poll interval when a successful request is made.
+     * This can be set explicitly here, or it will be set to the value of `CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS` in the environment.
+     */
     maxBackoffTimeMs?: number;
 }
 declare const CamundaJobWorker_base: new () => TypedEmitter<CamundaJobWorkerEvents>;