diff --git a/classes/index.Admin.AdminApiClient.html b/classes/index.Admin.AdminApiClient.html index 9cdf1cba..6f1bb645 100644 --- a/classes/index.Admin.AdminApiClient.html +++ b/classes/index.Admin.AdminApiClient.html @@ -1,6 +1,6 @@ AdminApiClient | @camunda8/sdk

Class AdminApiClient

This class provides methods to interact with the Camunda Admin API.

Throws

An error that may occur during API operations.

-

Constructors

constructor +

Constructors

constructor

Properties

oAuthProvider rest userAgentString @@ -21,21 +21,21 @@ getSecrets getUsers whitelistIPs -

Constructors

constructor

  • new AdminApiClient(options?): AdminApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns AdminApiClient

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private userAgentString

userAgentString: string

Methods

createClient

createCluster

createMember

createSecret

  • createSecret(__namedParameters): Promise<null>

  • Parameters

    • __namedParameters: {
          clusterUuid: string;
          secretName: string;
          secretValue: string;
      }
      • clusterUuid: string
      • secretName: string
      • secretValue: string

    Returns Promise<null>

    Description

    Create a new connector secret. See the API Documentation for more details.

    -

    Throws

deleteClient

deleteCluster

deleteMember

deleteSecret

getClient

getClients

  • getClients(clusterUuid): Promise<ClusterClient[]>

  • Parameters

    • clusterUuid: string

      The cluster UUID

      +

Constructors

constructor

  • new AdminApiClient(options?): AdminApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns AdminApiClient

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private userAgentString

userAgentString: string

Methods

createClient

createCluster

createMember

createSecret

  • createSecret(__namedParameters): Promise<null>

  • Parameters

    • __namedParameters: {
          clusterUuid: string;
          secretName: string;
          secretValue: string;
      }
      • clusterUuid: string
      • secretName: string
      • secretValue: string

    Returns Promise<null>

    Description

    Create a new connector secret. See the API Documentation for more details.

    +

    Throws

deleteClient

deleteCluster

deleteMember

deleteSecret

getClient

getClients

getCluster

getClusters

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getParameters

getSecrets

  • getSecrets(clusterUuid): Promise<{
        [key: string]: string;
    }>

  • Parameters

    • clusterUuid: string

    Returns Promise<{
        [key: string]: string;
    }>

    Description

    Retrieve the connector secrets. See the API Documentation for more details.

    -

    Throws

getUsers

whitelistIPs

  • whitelistIPs(clusterUuid, ipwhitelist): Promise<null>

  • Parameters

    • clusterUuid: string
    • ipwhitelist: [{
          description: string;
          ip: string;
      }]

    Returns Promise<null>

    Description

    Add one or more IPs to the whitelist for the cluster. See the API Documentation for more details.

    -

    Throws

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Throws

getCluster

getClusters

Private getHeaders

getParameters

getSecrets

getUsers

whitelistIPs

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Auth.NullAuthProvider.html b/classes/index.Auth.NullAuthProvider.html index 712c0dfd..c509b61c 100644 --- a/classes/index.Auth.NullAuthProvider.html +++ b/classes/index.Auth.NullAuthProvider.html @@ -1,3 +1,3 @@ -NullAuthProvider | @camunda8/sdk

Class NullAuthProvider

Implements

Constructors

constructor +NullAuthProvider | @camunda8/sdk

Class NullAuthProvider

Implements

Constructors

constructor

Methods

getToken -

Constructors

constructor

Methods

getToken

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

getToken

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Auth.OAuthProvider.html b/classes/index.Auth.OAuthProvider.html index 630fa538..684e9f18 100644 --- a/classes/index.Auth.OAuthProvider.html +++ b/classes/index.Auth.OAuthProvider.html @@ -1,4 +1,4 @@ -OAuthProvider | @camunda8/sdk

Class OAuthProvider

Implements

Constructors

constructor +OAuthProvider | @camunda8/sdk

Class OAuthProvider

Implements

Constructors

constructor

Properties

audienceMap authServerUrl cacheDir @@ -32,5 +32,5 @@ retrieveFromFileCache sendToFileCache sendToMemoryCache -

Constructors

constructor

  • new OAuthProvider(options?): OAuthProvider

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>

    Returns OAuthProvider

Properties

Private audienceMap

audienceMap: {
    CONSOLE: string;
    MODELER: string;
    OPERATE: string;
    OPTIMIZE: string;
    TASKLIST: string;
    ZEEBE: string;
}

Type declaration

  • CONSOLE: string
  • MODELER: string
  • OPERATE: string
  • OPTIMIZE: string
  • TASKLIST: string
  • ZEEBE: string

Private authServerUrl

authServerUrl: string

Private cacheDir

cacheDir: string

Private camundaModelerOAuthAudience

camundaModelerOAuthAudience: undefined | string

Private clientId

clientId: undefined | string

Private clientSecret

clientSecret: undefined | string

Private consoleClientId

consoleClientId: undefined | string

Private consoleClientSecret

consoleClientSecret: undefined | string

Private failed

failed: boolean = false

Private failureCount

failureCount: number = 0

Private Optional inflightTokenRequest

inflightTokenRequest?: Promise<string>

Private isCamundaSaaS

isCamundaSaaS: boolean

Private refreshWindow

refreshWindow: number

Private rest

rest: Promise<Got>

Private scope

scope: undefined | string

tokenCache

tokenCache: {
    [key: string]: Token;
} = {}

Type declaration

Private useFileCache

useFileCache: boolean

userAgentString

userAgentString: string

Static Private Readonly defaultTokenCache

defaultTokenCache: string = ...

Methods

Private addAudienceIfNeeded

Private evictFromFileCache

Private evictFromMemoryCache

flushFileCache

flushMemoryCache

Private getAudience

Private getCacheKey

Private getCachedTokenFileName

getToken

Private isExpired

Private makeDebouncedTokenRequest

Private retrieveFromFileCache

Private sendToFileCache

Private sendToMemoryCache

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new OAuthProvider(options?): OAuthProvider

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>

    Returns OAuthProvider

Properties

Private audienceMap

audienceMap: {
    CONSOLE: string;
    MODELER: string;
    OPERATE: string;
    OPTIMIZE: string;
    TASKLIST: string;
    ZEEBE: string;
}

Type declaration

  • CONSOLE: string
  • MODELER: string
  • OPERATE: string
  • OPTIMIZE: string
  • TASKLIST: string
  • ZEEBE: string

Private authServerUrl

authServerUrl: string

Private cacheDir

cacheDir: string

Private camundaModelerOAuthAudience

camundaModelerOAuthAudience: undefined | string

Private clientId

clientId: undefined | string

Private clientSecret

clientSecret: undefined | string

Private consoleClientId

consoleClientId: undefined | string

Private consoleClientSecret

consoleClientSecret: undefined | string

Private failed

failed: boolean = false

Private failureCount

failureCount: number = 0

Private Optional inflightTokenRequest

inflightTokenRequest?: Promise<string>

Private isCamundaSaaS

isCamundaSaaS: boolean

Private refreshWindow

refreshWindow: number

Private rest

rest: Promise<Got>

Private scope

scope: undefined | string

tokenCache

tokenCache: {
    [key: string]: Token;
} = {}

Type declaration

Private useFileCache

useFileCache: boolean

userAgentString

userAgentString: string

Static Private Readonly defaultTokenCache

defaultTokenCache: string = ...

Methods

Private addAudienceIfNeeded

Private evictFromFileCache

Private evictFromMemoryCache

flushFileCache

flushMemoryCache

Private getAudience

Private getCacheKey

Private getCachedTokenFileName

getToken

Private isExpired

Private makeDebouncedTokenRequest

Private retrieveFromFileCache

Private sendToFileCache

Private sendToMemoryCache

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Camunda8.html b/classes/index.Camunda8.html index 3b6f6b65..6c80c9e5 100644 --- a/classes/index.Camunda8.html +++ b/classes/index.Camunda8.html @@ -2,7 +2,7 @@

This class is a facade for all the clients in the Camunda Platform 8 SDK.

Example

import { Camunda8 } from '@camunda8/sdk'

const c8 = new Camunda8()
const zeebe = c8.getZeebeGrpcApiClient()
const operate = c8.getOperateApiClient()
const optimize = c8.getOptimizeApiClient()
const tasklist = c8.getTasklistApiClient()
const modeler = c8.getModelerApiClient()
const admin = c8.getAdminApiClient()
-

Constructors

constructor +

Constructors

constructor

Properties

adminApiClient? configuration modelerApiClient? @@ -17,7 +17,7 @@ getOptimizeApiClient getTasklistApiClient getZeebeGrpcApiClient -

Constructors

constructor

  • new Camunda8(config?): Camunda8

  • Parameters

    • config: DeepPartial<{
          CAMUNDA_CONSOLE_BASE_URL: undefined | string;
          CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
          CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
          CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
          CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
          CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
          CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
          CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
          CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
          CAMUNDA_MODELER_BASE_URL: string;
          CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
          CAMUNDA_OAUTH_DISABLED: boolean;
          CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
          CAMUNDA_OAUTH_URL: undefined | string;
          CAMUNDA_OPERATE_BASE_URL: undefined | string;
          CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
          CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
          CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
          CAMUNDA_SECURE_CONNECTION: boolean;
          CAMUNDA_TASKLIST_BASE_URL: undefined | string;
          CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
          CAMUNDA_TENANT_ID: undefined | string;
          CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
          CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
          CAMUNDA_TOKEN_SCOPE: undefined | string;
          CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
          ZEEBE_ADDRESS: string;
          ZEEBE_CLIENT_ID: undefined | string;
          ZEEBE_CLIENT_SECRET: undefined | string;
          zeebeGrpcSettings: {
              GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
              GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
              GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
              GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
              GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
              GRPC_KEEPALIVE_TIMEOUT_MS: number;
              GRPC_KEEPALIVE_TIME_MS: number;
              GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
              GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
              ZEEBE_CLIENT_LOG_LEVEL: string;
              ZEEBE_CLIENT_LOG_TYPE: string;
              ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
              ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
              ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
              ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
              ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
              ZEEBE_GRPC_CLIENT_RETRY: boolean;
              ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
              ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
          };
      }> = {}

    Returns Camunda8

Properties

Private Optional adminApiClient

adminApiClient?: AdminApiClient

Private configuration

configuration: {
    CAMUNDA_CONSOLE_BASE_URL: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
    CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
    CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
    CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
    CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
    CAMUNDA_MODELER_BASE_URL: string;
    CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
    CAMUNDA_OAUTH_DISABLED: boolean;
    CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
    CAMUNDA_OAUTH_URL: undefined | string;
    CAMUNDA_OPERATE_BASE_URL: undefined | string;
    CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
    CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
    CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
    CAMUNDA_SECURE_CONNECTION: boolean;
    CAMUNDA_TASKLIST_BASE_URL: undefined | string;
    CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
    CAMUNDA_TENANT_ID: undefined | string;
    CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
    CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
    CAMUNDA_TOKEN_SCOPE: undefined | string;
    CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
    ZEEBE_ADDRESS: string;
    ZEEBE_CLIENT_ID: undefined | string;
    ZEEBE_CLIENT_SECRET: undefined | string;
    zeebeGrpcSettings: {
        GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
        GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
        GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
        GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
        GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
        GRPC_KEEPALIVE_TIMEOUT_MS: number;
        GRPC_KEEPALIVE_TIME_MS: number;
        GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
        GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
        ZEEBE_CLIENT_LOG_LEVEL: string;
        ZEEBE_CLIENT_LOG_TYPE: string;
        ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
        ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
        ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
        ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
        ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
        ZEEBE_GRPC_CLIENT_RETRY: boolean;
        ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
        ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
    };
}

Type declaration

  • CAMUNDA_CONSOLE_BASE_URL: undefined | string

    The base url for the Admin Console API.

    +

Constructors

constructor

Properties

Private Optional adminApiClient

adminApiClient?: AdminApiClient

Private configuration

configuration: {
    CAMUNDA_CONSOLE_BASE_URL: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
    CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
    CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
    CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
    CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
    CAMUNDA_MODELER_BASE_URL: string;
    CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
    CAMUNDA_OAUTH_DISABLED: boolean;
    CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
    CAMUNDA_OAUTH_URL: undefined | string;
    CAMUNDA_OPERATE_BASE_URL: undefined | string;
    CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
    CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
    CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
    CAMUNDA_SECURE_CONNECTION: boolean;
    CAMUNDA_TASKLIST_BASE_URL: undefined | string;
    CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
    CAMUNDA_TENANT_ID: undefined | string;
    CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
    CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
    CAMUNDA_TOKEN_SCOPE: undefined | string;
    CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
    ZEEBE_ADDRESS: string;
    ZEEBE_CLIENT_ID: undefined | string;
    ZEEBE_CLIENT_SECRET: undefined | string;
    zeebeGrpcSettings: {
        GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
        GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
        GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
        GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
        GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
        GRPC_KEEPALIVE_TIMEOUT_MS: number;
        GRPC_KEEPALIVE_TIME_MS: number;
        GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
        GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
        ZEEBE_CLIENT_LOG_LEVEL: string;
        ZEEBE_CLIENT_LOG_TYPE: string;
        ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
        ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
        ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
        ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
        ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
        ZEEBE_GRPC_CLIENT_RETRY: boolean;
        ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
        ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
    };
}

Type declaration

  • CAMUNDA_CONSOLE_BASE_URL: undefined | string

    The base url for the Admin Console API.

  • CAMUNDA_CONSOLE_CLIENT_ID: undefined | string

    Credentials for Admin Console and Modeler API

  • CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string

    Credentials for Admin Console and Modeler API

  • CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string

    The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

    @@ -84,4 +84,4 @@
  • ZEEBE_GRPC_CLIENT_RETRY: boolean

    Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true

  • ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number

    How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60

  • ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number

    After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300

    -

Private Optional modelerApiClient

modelerApiClient?: ModelerApiClient

Private Optional oAuthProvider

oAuthProvider?: OAuthProvider

Private Optional operateApiClient

operateApiClient?: OperateApiClient

Private Optional optimizeApiClient

optimizeApiClient?: OptimizeApiClient

Private Optional tasklistApiClient

tasklistApiClient?: TasklistApiClient

Private Optional zeebeGrpcApiClient

zeebeGrpcApiClient?: ZeebeGrpcClient

Methods

getAdminApiClient

getModelerApiClient

getOperateApiClient

getOptimizeApiClient

getTasklistApiClient

getZeebeGrpcApiClient

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private Optional modelerApiClient

modelerApiClient?: ModelerApiClient

Private Optional oAuthProvider

oAuthProvider?: OAuthProvider

Private Optional operateApiClient

operateApiClient?: OperateApiClient

Private Optional optimizeApiClient

optimizeApiClient?: OptimizeApiClient

Private Optional tasklistApiClient

tasklistApiClient?: TasklistApiClient

Private Optional zeebeGrpcApiClient

zeebeGrpcApiClient?: ZeebeGrpcClient

Methods

getAdminApiClient

getModelerApiClient

getOperateApiClient

getOptimizeApiClient

getTasklistApiClient

getZeebeGrpcApiClient

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Modeler.ModelerApiClient.html b/classes/index.Modeler.ModelerApiClient.html index beab1b8a..eae89dfc 100644 --- a/classes/index.Modeler.ModelerApiClient.html +++ b/classes/index.Modeler.ModelerApiClient.html @@ -1,4 +1,4 @@ -ModelerApiClient | @camunda8/sdk

Class ModelerApiClient

Constructors

constructor +ModelerApiClient | @camunda8/sdk

Class ModelerApiClient

Constructors

constructor

Properties

oAuthProvider rest userAgentString @@ -27,9 +27,9 @@ searchProjects updateFile updateFolder -

Constructors

constructor

  • new ModelerApiClient(options?): ModelerApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns ModelerApiClient

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private userAgentString

userAgentString: string

Methods

addCollaborator

  • addCollaborator(req): Promise<null>

  • Adds a new collaborator to a project or modifies the permission level of an existing collaborator. +

Constructors

constructor

  • new ModelerApiClient(options?): ModelerApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns ModelerApiClient

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private userAgentString

userAgentString: string

Methods

addCollaborator

  • addCollaborator(req): Promise<null>

  • Adds a new collaborator to a project or modifies the permission level of an existing collaborator. Note: Only users that are part of the authorized organization (see GET /api/v1/info) and logged in to Web Modeler at least once can be added to a project.

    -

    Parameters

    Returns Promise<null>

    Throws

createFile

createFile

  • createFile(req): Promise<FileMetadataDto>

  • This endpoint creates a file.

    To create a file, specify projectId and/or folderId:

    When only folderId is given, the file will be created in that folder. The folder can be in any project of the same organization.

    When projectId is given and folderId is either null or omitted altogether, the file will be created in the root of the project.

    @@ -41,29 +41,29 @@

    The value of content.version is managed by Web Modeler and will be updated automatically.

    Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping facilitates the processing of path-like structures within file and folder names.

    -

    Parameters

    Returns Promise<FileMetadataDto>

    Throws

createFolder

createFolder

  • createFolder(req): Promise<FolderMetadataDto>

  • Creates a new folder.

    When only parentId is given, the folder will be created in that folder. The folder can be in any project of the same organization.

    When projectId is given and parentId is either null or omitted altogether, the folder will be created in the root of the project.

    When projectId and parentId are both given, they must be consistent - i.e. the parent folder is in the project.

    -

    Parameters

    Returns Promise<FolderMetadataDto>

    Throws

createMilestone

createProject

Private decodeResponseOrThrow

deleteCollaborator

  • deleteCollaborator(__namedParameters): Promise<null>

  • Parameters

    • __namedParameters: {
          email: string;
          projectId: string;
      }
      • email: string
      • projectId: string

    Returns Promise<null>

    Throws

deleteFile

createMilestone

createProject

Private decodeResponseOrThrow

deleteCollaborator

  • deleteCollaborator(__namedParameters): Promise<null>

  • Parameters

    • __namedParameters: {
          email: string;
          projectId: string;
      }
      • email: string
      • projectId: string

    Returns Promise<null>

    Throws

deleteFile

  • deleteFile(fileId): Promise<null>

  • Deletes a file. Note: Deleting a file will also delete other resources attached to the file (comments, call activity/business rule task links, milestones and shares) which might have side-effects. Deletion of resources is recursive and cannot be undone.

    -

    Parameters

    • fileId: string

    Returns Promise<null>

    Throws

deleteFolder

  • deleteFolder(folderId): Promise<null>

  • Deletes an empty folder. A folder is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.

    -

    Parameters

    • folderId: string

    Returns Promise<null>

    Throws

deleteMilestone

  • deleteMilestone(milestoneId): Promise<string>

  • Deletion of resources is recursive and cannot be undone.

    -

    Parameters

    • milestoneId: string

    Returns Promise<string>

    Throws

deleteProject

  • deleteProject(projectId): Promise<any>

  • Parameters

    • projectId: string

    Returns Promise<any>

    Description

    This endpoint deletes an empty project. A project is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.

    -

    Throws

getFile

deleteFolder

  • deleteFolder(folderId): Promise<null>

  • Deletes an empty folder. A folder is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.

    +

    Parameters

    • folderId: string

    Returns Promise<null>

    Throws

deleteMilestone

  • deleteMilestone(milestoneId): Promise<string>

  • Deletion of resources is recursive and cannot be undone.

    +

    Parameters

    • milestoneId: string

    Returns Promise<string>

    Throws

deleteProject

  • deleteProject(projectId): Promise<any>

  • Parameters

    • projectId: string

    Returns Promise<any>

    Description

    This endpoint deletes an empty project. A project is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.

    +

    Throws

getFile

  • getFile(fileId): Promise<FileDto>

  • Retrieves a file.

    Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("/"). This form of escaping facilitates the processing of path-like structures within file and folder names.

    Does this throw if it is not found?

    -

    Parameters

    • fileId: string

    Returns Promise<FileDto>

    Throws

getFolder

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getInfo

getMilestone

getMilestoneComparison

  • getMilestoneComparison(milestone1Id, milestone2Id): Promise<string>

  • Returns a link to a visual comparison between two milestones where the milestone referenced by milestone1Id acts as a baseline to compare the milestone referenced by milestone2Id against.

    -

    Parameters

    • milestone1Id: string
    • milestone2Id: string

    Returns Promise<string>

    Throws

getProject

renameProject

searchCollaborators

getFolder

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getInfo

getMilestone

getMilestoneComparison

  • getMilestoneComparison(milestone1Id, milestone2Id): Promise<string>

  • Returns a link to a visual comparison between two milestones where the milestone referenced by milestone1Id acts as a baseline to compare the milestone referenced by milestone2Id against.

    +

    Parameters

    • milestone1Id: string
    • milestone2Id: string

    Returns Promise<string>

    Throws

getProject

renameProject

searchCollaborators

searchFiles

searchFiles

  • searchFiles(req): Promise<PubSearchResultDtoFileMetadataDto>

  • Searches for files. filter specifies which fields should match. Only items that match the given fields will be returned.

    Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.

    You can use suffixes to match date ranges:

    @@ -80,7 +80,7 @@

    Throws

Returns Promise<PubSearchResultDtoFileMetadataDto>

Throws

searchMilestones

searchMilestones

Returns Promise<PubSearchResultDtoMilestoneMetadataDto>

Throws

searchProjects

searchProjects

updateFile

updateFile

updateFolder

updateFolder

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<FolderMetadataDto>

Throws

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateApiClient.html b/classes/index.Operate.OperateApiClient.html index c04aac6a..8cbabb99 100644 --- a/classes/index.Operate.OperateApiClient.html +++ b/classes/index.Operate.OperateApiClient.html @@ -1,7 +1,7 @@ OperateApiClient | @camunda8/sdk

Class OperateApiClient

Description

The high-level client for Operate.

Example

const operate = new OperateApiClient()

operate.searchProcessInstances({
    filter: {
        state: "ACTIVE"
    },
    size: 50
}).then(instances => {
    console.log(instances)
})
-

Constructors

constructor +

Constructors

constructor

Properties

oAuthProvider rest tenantId @@ -35,32 +35,32 @@

Example

const

Constructors

constructor

  • new OperateApiClient(options?): OperateApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns OperateApiClient

    Example

    const operate = new OperateApiClient()

    Throws

    An error that may occur during API operations.

    -

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private tenantId

tenantId: undefined | string

Private userAgentString

userAgentString: string

Methods

Protected addTenantIdToFilter

deleteProcessInstance

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private tenantId

tenantId: undefined | string

Private userAgentString

userAgentString: string

Methods

Protected addTenantIdToFilter

deleteProcessInstance

  • deleteProcessInstance(processInstanceKey): Promise<ChangeStatus>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<ChangeStatus>

    Description

    Delete a specific process instance by key.

    Throws

    Example

    const operate = new OperateApiClient()
    await operate.deleteProcessInstance(2251799819847322)
    -

getDecisionDefinition

getDecisionInstance

getDecisionRequirements

getDecisionRequirementsXML

getFlownodeInstance

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getIncident

getDecisionDefinition

getDecisionInstance

getDecisionRequirements

getDecisionRequirementsXML

getFlownodeInstance

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getIncident

  • getIncident(key): Promise<Incident>

  • Parameters

    • key: string | number

    Returns Promise<Incident>

    Description

    Retrieve an incident by incident key.

    Throws

    Example

    const operate = new OperateApiClient()
    const incident = await operate.getIncident(2251799818436725)
    console.log(incident.message)
    -

getJSONVariablesforProcess

  • getJSONVariablesforProcess<T>(processInstanceKey): Promise<T>

  • Type Parameters

    • T extends {
          [key: string]: JSONDoc;
      }

    Parameters

    • processInstanceKey: string | number

    Returns Promise<T>

    Description

    Retrieve the variables for a Process Instance as an object, given its key

    -

    Throws

getProcessDefinition

getJSONVariablesforProcess

  • getJSONVariablesforProcess<T>(processInstanceKey): Promise<T>

  • Type Parameters

    • T extends {
          [key: string]: JSONDoc;
      }

    Parameters

    • processInstanceKey: string | number

    Returns Promise<T>

    Description

    Retrieve the variables for a Process Instance as an object, given its key

    +

    Throws

getProcessDefinition

getProcessDefinitionXML

getProcessInstance

getProcessDefinitionXML

getProcessInstance

  • getProcessInstance(processInstanceKey): Promise<ProcessInstance>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<ProcessInstance>

    Description

    Retrieve a specific process instance by id.

    Throws

    Example

    const operate = new OperateApiClient()
    const instance = await operate.getProcessInstance(2251799819847322)
    -

getProcessInstanceSequenceFlows

  • getProcessInstanceSequenceFlows(processInstanceKey): Promise<string[]>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<string[]>

    Description

    Get sequence flows of process instance by key

    -

    Throws

getProcessInstanceStatistics

getVariables

getVariablesforProcess

Private safeJSONparse

searchDecisionDefinitions

searchDecisionInstances

searchDecisionRequirements

searchFlownodeInstances

searchIncidents

getProcessInstanceSequenceFlows

  • getProcessInstanceSequenceFlows(processInstanceKey): Promise<string[]>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<string[]>

    Description

    Get sequence flows of process instance by key

    +

    Throws

getProcessInstanceStatistics

getVariables

getVariablesforProcess

Private safeJSONparse

searchDecisionDefinitions

searchDecisionInstances

searchDecisionRequirements

searchFlownodeInstances

searchIncidents

searchProcessDefinitions

searchProcessDefinitions

searchProcessInstances

searchProcessInstances

searchVariables

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

searchVariables

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.ChangeStatus.html b/classes/index.Operate.OperateDto.ChangeStatus.html index 17357d56..90420ad1 100644 --- a/classes/index.Operate.OperateDto.ChangeStatus.html +++ b/classes/index.Operate.OperateDto.ChangeStatus.html @@ -2,7 +2,7 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

deleted message -

Constructors

constructor

Properties

deleted

deleted: string

message

message: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

deleted

deleted: string

message

message: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.DecisionDefinition.html b/classes/index.Operate.OperateDto.DecisionDefinition.html index 4ab46944..650fff90 100644 --- a/classes/index.Operate.OperateDto.DecisionDefinition.html +++ b/classes/index.Operate.OperateDto.DecisionDefinition.html @@ -2,7 +2,7 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

decisionId decisionRequirementsId decisionRequirementsKey @@ -13,4 +13,4 @@ name tenantId version -

Constructors

constructor

Properties

decisionId

decisionId: string

decisionRequirementsId

decisionRequirementsId: string

decisionRequirementsKey

decisionRequirementsKey: string

decisionRequirementsName

decisionRequirementsName: string

decisionRequirementsVersion

decisionRequirementsVersion: number

id

id: string

key

key: string

name

name: string

tenantId

tenantId: undefined | string

version

version: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

decisionId

decisionId: string

decisionRequirementsId

decisionRequirementsId: string

decisionRequirementsKey

decisionRequirementsKey: string

decisionRequirementsName

decisionRequirementsName: string

decisionRequirementsVersion

decisionRequirementsVersion: number

id

id: string

key

key: string

name

name: string

tenantId

tenantId: undefined | string

version

version: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.DecisionInstance.html b/classes/index.Operate.OperateDto.DecisionInstance.html index e5585dd4..a8cd24ef 100644 --- a/classes/index.Operate.OperateDto.DecisionInstance.html +++ b/classes/index.Operate.OperateDto.DecisionInstance.html @@ -2,7 +2,7 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

decisionDefinitionId decisionId decisionName @@ -18,4 +18,4 @@ result state tenantId -

Constructors

constructor

Properties

decisionDefinitionId

decisionDefinitionId: string

decisionId

decisionId: string

decisionName

decisionName: string

decisionType

decisionType: "UNKNOWN" | "UNSPECIFIED" | "DECISION_TABLE" | "LITERAL_EXPRESSION"

decisionVersion

decisionVersion: number

evaluatedInputs

evaluatedInputs: DecisionInstanceInput[]

evaluatedOutputs

evaluatedOutputs: DecisionInstanceOutput[]

evaluationDate

evaluationDate: string

evaluationFailure

evaluationFailure: string

id

id: string

key

key: string

processDefinitionKey

processDefinitionKey: string

result

result: string

state

state: "FAILED" | "EVALUATED" | "UNKNOWN" | "UNSPECIFIED"

tenantId

tenantId: undefined | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

decisionDefinitionId

decisionDefinitionId: string

decisionId

decisionId: string

decisionName

decisionName: string

decisionType

decisionType: "UNKNOWN" | "UNSPECIFIED" | "DECISION_TABLE" | "LITERAL_EXPRESSION"

decisionVersion

decisionVersion: number

evaluatedInputs

evaluatedInputs: DecisionInstanceInput[]

evaluatedOutputs

evaluatedOutputs: DecisionInstanceOutput[]

evaluationDate

evaluationDate: string

evaluationFailure

evaluationFailure: string

id

id: string

key

key: string

processDefinitionKey

processDefinitionKey: string

result

result: string

state

state: "FAILED" | "EVALUATED" | "UNKNOWN" | "UNSPECIFIED"

tenantId

tenantId: undefined | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.DecisionInstanceInput.html b/classes/index.Operate.OperateDto.DecisionInstanceInput.html index ae08ce28..e2b6cfed 100644 --- a/classes/index.Operate.OperateDto.DecisionInstanceInput.html +++ b/classes/index.Operate.OperateDto.DecisionInstanceInput.html @@ -2,8 +2,8 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id name value -

Constructors

constructor

Properties

id

id: string

name

name: string

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

name

name: string

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.DecisionInstanceOutput.html b/classes/index.Operate.OperateDto.DecisionInstanceOutput.html index 978a29a2..b5ec5272 100644 --- a/classes/index.Operate.OperateDto.DecisionInstanceOutput.html +++ b/classes/index.Operate.OperateDto.DecisionInstanceOutput.html @@ -2,10 +2,10 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id name ruleId ruleIndex value -

Constructors

constructor

Properties

id

id: string

name

name: string

ruleId

ruleId: string

ruleIndex

ruleIndex: number

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

name

name: string

ruleId

ruleId: string

ruleIndex

ruleIndex: number

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.DecisionRequirements.html b/classes/index.Operate.OperateDto.DecisionRequirements.html index 8151b954..6aa5baea 100644 --- a/classes/index.Operate.OperateDto.DecisionRequirements.html +++ b/classes/index.Operate.OperateDto.DecisionRequirements.html @@ -2,7 +2,7 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

decisionRequirementsId id key @@ -10,4 +10,4 @@ resourceName tenantId version -

Constructors

constructor

Properties

decisionRequirementsId

decisionRequirementsId: string

id

id: string

key

key: string

name

name: string

resourceName

resourceName: string

tenantId

tenantId: undefined | string

version

version: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

decisionRequirementsId

decisionRequirementsId: string

id

id: string

key

key: string

name

name: string

resourceName

resourceName: string

tenantId

tenantId: undefined | string

version

version: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.FlownodeInstance.html b/classes/index.Operate.OperateDto.FlownodeInstance.html index 9c990213..1e194615 100644 --- a/classes/index.Operate.OperateDto.FlownodeInstance.html +++ b/classes/index.Operate.OperateDto.FlownodeInstance.html @@ -2,7 +2,7 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

endDate incident incidentKey? @@ -12,4 +12,4 @@ state tenantId type -

Constructors

constructor

Properties

endDate

endDate: string

incident

incident: boolean

Optional incidentKey

incidentKey?: string

key

key: string

processInstanceKey

processInstanceKey: string

startDate

startDate: string

state

state: "ACTIVE" | "COMPLETED" | "TERMINATED"

tenantId

tenantId: undefined | string

type

type: "UNKNOWN" | "UNSPECIFIED" | "PROCESS" | "SUB_PROCESS" | "EVENT_SUB_PROCESS" | "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"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

endDate

endDate: string

incident

incident: boolean

Optional incidentKey

incidentKey?: string

key

key: string

processInstanceKey

processInstanceKey: string

startDate

startDate: string

state

state: "ACTIVE" | "COMPLETED" | "TERMINATED"

tenantId

tenantId: undefined | string

type

type: "UNKNOWN" | "UNSPECIFIED" | "PROCESS" | "SUB_PROCESS" | "EVENT_SUB_PROCESS" | "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"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.Incident.html b/classes/index.Operate.OperateDto.Incident.html index 4886634a..0b0f35f7 100644 --- a/classes/index.Operate.OperateDto.Incident.html +++ b/classes/index.Operate.OperateDto.Incident.html @@ -2,7 +2,7 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

creationTime jobKey key @@ -12,4 +12,4 @@ state tenantId type -

Constructors

constructor

Properties

creationTime

creationTime: string

jobKey

jobKey: string

key

key: string

message

message: string

processDefinitionKey

processDefinitionKey: LosslessNumber

processInstanceKey

processInstanceKey: LosslessNumber

state

state: "ACTIVE" | "RESOLVED"

tenantId

tenantId: undefined | string

type

type: "UNKNOWN" | "UNSPECIFIED" | "IO_MAPPING_ERROR" | "JOB_NO_RETRIES" | "CONDITION_ERROR" | "EXTRACT_VALUE_ERROR" | "CALLED_ELEMENT_ERROR" | "UNHANDLED_ERROR_EVENT" | "MESSAGE_SIZE_EXCEEDED" | "CALLED_DECISION_ERROR" | "DECISION_EVALUATION_ERROR"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

creationTime

creationTime: string

jobKey

jobKey: string

key

key: string

message

message: string

processDefinitionKey

processDefinitionKey: LosslessNumber

processInstanceKey

processInstanceKey: LosslessNumber

state

state: "ACTIVE" | "RESOLVED"

tenantId

tenantId: undefined | string

type

type: "UNKNOWN" | "UNSPECIFIED" | "IO_MAPPING_ERROR" | "JOB_NO_RETRIES" | "CONDITION_ERROR" | "EXTRACT_VALUE_ERROR" | "CALLED_ELEMENT_ERROR" | "UNHANDLED_ERROR_EVENT" | "MESSAGE_SIZE_EXCEEDED" | "CALLED_DECISION_ERROR" | "DECISION_EVALUATION_ERROR"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.ProcessDefinition.html b/classes/index.Operate.OperateDto.ProcessDefinition.html index 7ba63bda..84159c6b 100644 --- a/classes/index.Operate.OperateDto.ProcessDefinition.html +++ b/classes/index.Operate.OperateDto.ProcessDefinition.html @@ -2,10 +2,10 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bpmnProcessId key name version -

Constructors

constructor

Properties

bpmnProcessId

bpmnProcessId: string

key

key: string

ProcessDefinition key is a string in the SDK, but it's an int64 number in the database

-

name

name: string

version

version: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

bpmnProcessId

bpmnProcessId: string

key

key: string

ProcessDefinition key is a string in the SDK, but it's an int64 number in the database

+

name

name: string

version

version: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.ProcessInstance.html b/classes/index.Operate.OperateDto.ProcessInstance.html index 65c65f2a..b8e0f139 100644 --- a/classes/index.Operate.OperateDto.ProcessInstance.html +++ b/classes/index.Operate.OperateDto.ProcessInstance.html @@ -2,7 +2,7 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

bpmnProcessId endDate key @@ -13,4 +13,4 @@ startDate state tenantId -

Constructors

constructor

Properties

bpmnProcessId

bpmnProcessId: string

endDate

endDate: string

key

key: string

Optional parentFlowNodeInstanceKey

parentFlowNodeInstanceKey?: string

Optional parentKey

parentKey?: string

processDefinitionKey

processDefinitionKey: string

processVersion

processVersion: number

startDate

startDate: string

state

state: "ACTIVE" | "COMPLETED" | "CANCELED"

tenantId

tenantId: undefined | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

bpmnProcessId

bpmnProcessId: string

endDate

endDate: string

key

key: string

Optional parentFlowNodeInstanceKey

parentFlowNodeInstanceKey?: string

Optional parentKey

parentKey?: string

processDefinitionKey

processDefinitionKey: string

processVersion

processVersion: number

startDate

startDate: string

state

state: "ACTIVE" | "COMPLETED" | "CANCELED"

tenantId

tenantId: undefined | string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html b/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html index b97a8dd0..d82ef6e8 100644 --- a/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html +++ b/classes/index.Operate.OperateDto.ProcessInstanceStatistics.html @@ -2,10 +2,10 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

active activityId canceled completed incidents -

Constructors

constructor

Properties

active

active: string

activityId

activityId: string

canceled

canceled: string

completed

completed: string

incidents

incidents: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

active

active: string

activityId

activityId: string

canceled

canceled: string

completed

completed: string

incidents

incidents: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Operate.OperateDto.Variable.html b/classes/index.Operate.OperateDto.Variable.html index 7f55ec67..d168fd86 100644 --- a/classes/index.Operate.OperateDto.Variable.html +++ b/classes/index.Operate.OperateDto.Variable.html @@ -2,11 +2,11 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

key name processInstanceKey scopeKey truncated value -

Constructors

constructor

Properties

key

key: string

name

name: string

processInstanceKey

processInstanceKey: string

scopeKey

scopeKey: string

truncated

truncated: boolean

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

key

key: string

name

name: string

processInstanceKey

processInstanceKey: string

scopeKey

scopeKey: string

truncated

truncated: boolean

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Optimize.OptimizeApiClient.html b/classes/index.Optimize.OptimizeApiClient.html index c9420367..e3cea0ff 100644 --- a/classes/index.Optimize.OptimizeApiClient.html +++ b/classes/index.Optimize.OptimizeApiClient.html @@ -2,7 +2,7 @@

Throws

If the request fails

Example

const optimize = new OptimizeApiClient()

async function main() {
    await optimize.enableSharing()
    const id = "8a7103a7-c086-48f8-b5b7-a7f83e864688"
    const res = await optimize.exportDashboardDefinitions([id])
    fs.writeFileSync('exported-dashboard.json', JSON.stringify(res, null, 2))
}

main()
-

Constructors

constructor +

Constructors

constructor

Properties

oAuthProvider rest userAgentString @@ -21,27 +21,27 @@

Example

const labelVariables

Constructors

constructor

  • new OptimizeApiClient(options?): OptimizeApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns OptimizeApiClient

    Example

    const optimize = new OptimizeApiClient()
    -

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private userAgentString

userAgentString: string

Methods

deleteReport

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private userAgentString

userAgentString: string

Methods

deleteReport

  • deleteReport(reportId): Promise<string>

  • Parameters

    • reportId: string

      The ID of the report you wish to delete

    Returns Promise<string>

    Description

    The report deletion API allows you to delete reports by ID from Optimize.

    Camunda 8 documentation

    Throws

    If the request fails

    Example

    const client = new OptimizeApiClient()
    client.deleteReport("e6c5aaa1-6a18-44e7-8480-d562d511ba62")
    -

disableSharing

  • disableSharing(): Promise<Response<string>>

  • Returns Promise<Response<string>>

    Description

    This API allows users to disable the sharing functionality for all reports and dashboards in Optimize.

    +

disableSharing

  • disableSharing(): Promise<Response<string>>

  • Returns Promise<Response<string>>

    Description

    This API allows users to disable the sharing functionality for all reports and dashboards in Optimize.

    Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).

    When sharing is disabled, previously shared URLs will no longer be accessible. Upon re-enabling sharing, the previously shared URLs will work once again under the same address as before. Calling this endpoint when sharing is already disabled will have no effect.

    Camunda 8 Documentation

    Throws

    If the request fails

    Example

    const client = new OptimizeApiClient()
    client.disableSharing()
    -

enableSharing

  • enableSharing(): Promise<Response<string>>

  • Returns Promise<Response<string>>

    Description

    This API allows users to enable the sharing functionality for all reports and dashboards in Optimize.

    +

enableSharing

  • enableSharing(): Promise<Response<string>>

  • Returns Promise<Response<string>>

    Description

    This API allows users to enable the sharing functionality for all reports and dashboards in Optimize.

    Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).

    If sharing had been previously enabled and then disabled, re-enabling sharing will allow users to access previously shared URLs under the same address as before. Calling this endpoint when sharing is already enabled will have no effect.

    Camunda 8 Documentation

    Throws

    If the request fails

    Example

    const client = new OptimizeApiClient()
    client.enableSharing()
    -

exportDashboardDefinitions

exportDashboardDefinitions

  • exportDashboardDefinitions(dashboardIds): Promise<unknown[]>

  • Parameters

    • dashboardIds: string[]

      Array of dashboard ids

    Returns Promise<unknown[]>

    Description

    This API allows users to export dashboard definitions which can later be imported into another Optimize system.

    Note that exporting a dashboard also exports all reports contained within the dashboard. The dashboards to be exported may be within a Collection or private entities, the API has access to both.

    The obtained list of entity exports can be imported into other Optimize systems either using the dedicated import API or via UI.

    @@ -49,48 +49,48 @@

    Example

    const<
 
    Throws
    If the request fails
    
 
    Example
    const client = new OptimizeApiClient()
    const dashboardDefs = await client.exportDashboardDefinitions(["123", "456"])
 
    
-

exportReportDefinitions

exportReportDefinitions

  • exportReportDefinitions(reportIds): Promise<unknown[]>

  • Parameters

    • reportIds: string[]

      array of report IDs

    Returns Promise<unknown[]>

    Description

    This API allows users to export report definitions which can later be imported into another Optimize system. The reports to be exported may be within a collection or private entities, the API has access to both.

    The obtained list of entity exports can be imported into other Optimize systems either using the dedicated import API or via UI.

    Camunda 8 Documentation

    Throws

    If the request fails

    Example

    const client = new OptimizeApiClient()
    const reportDefs = await client.exportReportDefinitions(["123", "456"])
    -

exportReportResultData

exportReportResultData

  • exportReportResultData(reportId, limit?, paginationTimeoutSec?): ReportDataExporter

  • Parameters

    • reportId: string
    • limit: number = 2
    • paginationTimeoutSec: number = 60

    Returns ReportDataExporter

    Description

    The data export API allows users to export large amounts of data in a machine-readable format (JSON) from Optimize.

    Throws

    If the request fails

    Example

    const client = new OptimizeApiClient()
    const exporter = client.exportReportResultData("e6c5aaa1-6a18-44e7-8480-d562d511ba62")
    const page1 = await exporter.next()
    -

getDashboardIds

getDashboardIds

  • getDashboardIds(collectionId): Promise<DashboardCollection>

  • Parameters

    • collectionId: number

      The ID of the collection for which to retrieve the dashboard IDs.

    Returns Promise<DashboardCollection>

    Description

    This API allows users to retrieve all dashboard IDs from a given collection.

    The response contains a list of IDs of the dashboards existing in the collection with the given collection ID.

    Camunda 8 Documentation

    Throws

    If the request fails

    Example

    const client = new OptimizeApiClient()
    const dashboardIds = await client.getDashboardIds(1234)
    -

Private getHeaders

  • getHeaders(auth?): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    } | {
        accept: string;
        content-type: string;
        user-agent: string;
    }>

  • Parameters

    • auth: boolean = true

    Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    } | {
        accept: string;
        content-type: string;
        user-agent: string;
    }>

getReadiness

  • getReadiness(): Promise<unknown>

  • Returns Promise<unknown>

    Description

    The purpose of Health-Readiness REST API is to return information indicating whether Optimize is ready to be used.

    +

Private getHeaders

  • getHeaders(auth?): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    } | {
        accept: string;
        content-type: string;
        user-agent: string;
    }>

  • Parameters

    • auth: boolean = true

    Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    } | {
        accept: string;
        content-type: string;
        user-agent: string;
    }>

getReadiness

  • getReadiness(): Promise<unknown>

  • Returns Promise<unknown>

    Description

    The purpose of Health-Readiness REST API is to return information indicating whether Optimize is ready to be used.

    Camunda 8 Documentation

    Throws

    If the request fails

    Example

    const client = new OptimizeApiClient()
    try {
       await client.getReadiness()
       console.log('Ready!')
    } catch (e: any) {
       console.log('Error calling readiness point: ' + e.code)
    }
    -

getReportIds

getReportIds

  • getReportIds(collectionId): Promise<ReportCollection>

  • Parameters

    • collectionId: number

      the id of the collection

    Returns Promise<ReportCollection>

    Description

    This API allows users to retrieve all report IDs from a given collection. The response contains a list of IDs of the reports existing in the collection with the given collection ID.

    Camunda 8 Documentation

    Throws

    If the request fails

    Example

    const client = new OptimizeApiClient()
    const reports =  await client.getReportIds(1234)
    -

importEntities

  • importEntities(collectionId, entities): Promise<EntityImportResponse>

  • Parameters

    • collectionId: number
    • entities: unknown

    Returns Promise<EntityImportResponse>

    Description

    This API allows users to import entity definitions such as reports and dashboards into existing collections. These entity definitions may be obtained either using the report or dashboard export API or via the UI.

    +

importEntities

  • importEntities(collectionId, entities): Promise<EntityImportResponse>

  • Parameters

    • collectionId: number
    • entities: unknown

    Returns Promise<EntityImportResponse>

    Description

    This API allows users to import entity definitions such as reports and dashboards into existing collections. These entity definitions may be obtained either using the report or dashboard export API or via the UI.

    Camunda 8 Documentation

    Throws

    If the request fails

    Example

    const entities = [
       {
           "id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
           "exportEntityType": "single_process_report",
           "name": "Number: Process instance duration",
           "sourceIndexVersion": 8,
           "collectionId": null,
           "data": {...}
       },
       {
           "id": "b0eb845-e8ed-4824-bd85-8cd69038f2f5",
           "exportEntityType": "dashboard",
           "name": "Dashboard 1",
           "sourceIndexVersion": 5,
           "reports": [
               {
                   "id": "61ae2232-51e1-4c35-b72c-c7152ba264f9",
                   ...
               }
           ],
           "availableFilters": [...],
           "collectionId": null
       }
    ]
    const client = new OptimizeApiClient()
    await client.importEntities(123, entities)
    -

ingestExternalVariable

  • ingestExternalVariable(variables): Promise<unknown>

  • Parameters

    Returns Promise<unknown>

    Description

    With the external variable ingestion API, variable data held in external systems can be ingested into Optimize directly, without the need for these variables to be present in your Camunda platform data. This can be useful when external business data, which is relevant for process analysis in Optimize, is to be associated with specific process instances.

    +

ingestExternalVariable

  • ingestExternalVariable(variables): Promise<unknown>

  • Parameters

    Returns Promise<unknown>

    Description

    With the external variable ingestion API, variable data held in external systems can be ingested into Optimize directly, without the need for these variables to be present in your Camunda platform data. This can be useful when external business data, which is relevant for process analysis in Optimize, is to be associated with specific process instances.

    Especially if this data changes over time, it is advisable to use this REST API to persist external variable updates to Optimize, as otherwise Optimize may not be aware of data changes in the external system.

    Throws

    If the request fails

    Example

    const variables = [
     {
       "id": "7689fced-2639-4408-9de1-cf8f72769f43",
       "name": "address",
       "type": "string",
       "value": "Main Street 1",
       "processInstanceId": "c6393461-02bb-4f62-a4b7-f2f8d9bbbac1",
       "processDefinitionKey": "shippingProcess"
     },
     {
       "id": "993f4e73-7f6a-46a6-bd45-f4f8e3470ba1",
       "name": "amount",
       "type": "integer",
       "value": "500",
       "processInstanceId": "8282ed49-2243-44df-be5e-1bf893755d8f",
       "processDefinitionKey": "orderProcess"
     }
    ]
    const client = new OptimizeApiClient()
    client.ingestExternalVariable(variables)
    -

labelVariables

  • labelVariables(variableLabels): Promise<unknown>

  • Parameters

    Returns Promise<unknown>

    Description

    With the variable labeling endpoint, variable labels can be added, updated, and deleted from Optimize.

    +

labelVariables

  • labelVariables(variableLabels): Promise<unknown>

  • Parameters

    Returns Promise<unknown>

    Description

    With the variable labeling endpoint, variable labels can be added, updated, and deleted from Optimize.

    Camunda 8 Documentation

    Throws

    If the request fails

    Example

    const variableLabels =  {
      "definitionKey": "bookrequest-1-tenant",
      "labels" : [
        {
          "variableName": "bookAvailable",
          "variableType": "Boolean",
          "variableLabel": "book availability"
        },
        {
          "variableName": "person.name",
          "variableType": "String",
          "variableLabel": "first and last name"
        },
        {
          "variableName": "person.hobbies._listSize",
          "variableType": "Long",
          "variableLabel": "amount of hobbies"
        }
      ]
    }
    const client = new OptimizeApiClient()
    await client.labelVariables(variableLabels)
    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Tasklist.TasklistApiClient.html b/classes/index.Tasklist.TasklistApiClient.html index 59ca1172..cc64bf27 100644 --- a/classes/index.Tasklist.TasklistApiClient.html +++ b/classes/index.Tasklist.TasklistApiClient.html @@ -1,7 +1,7 @@ TasklistApiClient | @camunda8/sdk

Class TasklistApiClient

Description

The high-level client for the Tasklist REST API

Example
-

Constructors

constructor +

Constructors

constructor

Properties

oAuthProvider rest userAgentString @@ -17,29 +17,29 @@

Example


 unassignTask

Constructors

constructor

  • new TasklistApiClient(options?): TasklistApiClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns TasklistApiClient

    Example

    const tasklist = new TasklistApiClient()
    const tasks = await tasklist.getTasks({ state: TaskState.CREATED })
    -

    Description

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private userAgentString

userAgentString: string

Methods

assignTask

  • assignTask(__namedParameters): Promise<TaskResponse>

  • Parameters

    • __namedParameters: {
          allowOverrideAssignment?: boolean;
          assignee?: string;
          taskId: string;
      }
      • Optional allowOverrideAssignment?: boolean
      • Optional assignee?: string
      • taskId: string

    Returns Promise<TaskResponse>

    Description

    Assign a task with taskId to assignee or the active user.

    +

    Description

Properties

Private oAuthProvider

oAuthProvider: IOAuthProvider

Private rest

rest: Promise<Got>

Private userAgentString

userAgentString: string

Methods

assignTask

  • assignTask(__namedParameters): Promise<TaskResponse>

  • Parameters

    • __namedParameters: {
          allowOverrideAssignment?: boolean;
          assignee?: string;
          taskId: string;
      }
      • Optional allowOverrideAssignment?: boolean
      • Optional assignee?: string
      • taskId: string

    Returns Promise<TaskResponse>

    Description

    Assign a task with taskId to assignee or the active user.

    Throws

    Throws

    Status 400 - An error is returned when the task is not active (not in the CREATED state). Status 400 - An error is returned when task was already assigned, except the case when JWT authentication token used and allowOverrideAssignment = true. Status 403 - An error is returned when user doesn't have the permission to assign another user to this task. Status 404 - An error is returned when the task with the taskId is not found.

    -

completeTask

completeTask

  • completeTask(taskId, variables?): Promise<TaskResponse>

  • Parameters

    • taskId: string
    • Optional variables: JSONDoc

    Returns Promise<TaskResponse>

    Description

    Complete a task with taskId and optional variables

    Throws

    Throws

    Status 400 An error is returned when the task is not active (not in the CREATED state).

    Throws

    Status 400 An error is returned if the task was not claimed (assigned) before.

    Throws

    Status 400 An error is returned if the task is not assigned to the current user.

    Throws

    Status 403 User has no permission to access the task (Self-managed only).

    Throws

    Status 404 An error is returned when the task with the taskId is not found.

    -

getForm

  • getForm(formId, processDefinitionKey, version?): Promise<Form>

  • Parameters

    • formId: string
    • processDefinitionKey: string
    • Optional version: string | number

    Returns Promise<Form>

    Description

    Get the form details by form id and processDefinitionKey.

    -

    Throws

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getTask

getForm

  • getForm(formId, processDefinitionKey, version?): Promise<Form>

  • Parameters

    • formId: string
    • processDefinitionKey: string
    • Optional version: string | number

    Returns Promise<Form>

    Description

    Get the form details by form id and processDefinitionKey.

    +

    Throws

Private getHeaders

  • getHeaders(): Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

  • Returns Promise<{
        accept: string;
        authorization: string;
        content-type: string;
        user-agent: string;
    }>

getTask

getVariable

getVariable

getVariables

  • getVariables(__namedParameters): Promise<VariableSearchResponse[]>

  • Parameters

    • __namedParameters: {
          includeVariables?: {
              alwaysReturnFullValue: boolean;
              name: string;
          }[];
          taskId: string;
          variableNames?: string[];
      }
      • Optional includeVariables?: {
            alwaysReturnFullValue: boolean;
            name: string;
        }[]
      • taskId: string
      • Optional variableNames?: string[]

    Returns Promise<VariableSearchResponse[]>

    Description

    This method returns a list of task variables for the specified taskId and variableNames. If the variableNames parameter is empty, all variables associated with the task will be returned.

    -

    Throws

Private replaceDatesWithString

searchTasks

getVariables

  • getVariables(__namedParameters): Promise<VariableSearchResponse[]>

  • Parameters

    • __namedParameters: {
          includeVariables?: {
              alwaysReturnFullValue: boolean;
              name: string;
          }[];
          taskId: string;
          variableNames?: string[];
      }
      • Optional includeVariables?: {
            alwaysReturnFullValue: boolean;
            name: string;
        }[]
      • taskId: string
      • Optional variableNames?: string[]

    Returns Promise<VariableSearchResponse[]>

    Description

    This method returns a list of task variables for the specified taskId and variableNames. If the variableNames parameter is empty, all variables associated with the task will be returned.

    +

    Throws

Private replaceDatesWithString

searchTasks

unassignTask

unassignTask

  • unassignTask(taskId): Promise<TaskResponse>

  • Parameters

    • taskId: string

    Returns Promise<TaskResponse>

    Description

    Unassign a task with taskId

    Throws

    Status 400 An error is returned when the task is not active (not in the CREATED state).

    Throws

    Status 400 An error is returned if the task was not claimed (assigned) before.

    Throws

    Status 404 An error is returned when the task with the taskId is not found.

    -

    Throws

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Throws

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Tasklist.TasklistDto.Form.html b/classes/index.Tasklist.TasklistDto.Form.html index 2765ea69..f8af3d5c 100644 --- a/classes/index.Tasklist.TasklistDto.Form.html +++ b/classes/index.Tasklist.TasklistDto.Form.html @@ -2,11 +2,11 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id isDeleted processDefinitionId schema tenantId version -

Constructors

constructor

Properties

id

id: string

isDeleted

isDeleted: boolean

processDefinitionId

processDefinitionId: string

schema

schema: string

tenantId

tenantId: string

version

version: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

isDeleted

isDeleted: boolean

processDefinitionId

processDefinitionId: string

schema

schema: string

tenantId

tenantId: string

version

version: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Tasklist.TasklistDto.TaskResponse.html b/classes/index.Tasklist.TasklistDto.TaskResponse.html index 7af4d6c3..b8a071ae 100644 --- a/classes/index.Tasklist.TasklistDto.TaskResponse.html +++ b/classes/index.Tasklist.TasklistDto.TaskResponse.html @@ -2,7 +2,7 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assignee candidateGroups candidateUsers @@ -23,4 +23,4 @@ taskDefinitionId taskState tenantId -

Constructors

constructor

Properties

assignee

assignee: string

candidateGroups

candidateGroups: string[]

candidateUsers

candidateUsers: string[]

completionDate

completionDate: string

creationDate

creationDate: string

dueDate

dueDate: string

followUpDate

followUpDate: string

formId

formId: string

formKey

formKey: string

Optional formVersion

formVersion?: string

id

id: string

implementation

implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"

Optional isFormEmbedded

isFormEmbedded?: boolean

name

name: string

processDefinitionKey

processDefinitionKey: string

processInstanceKey

processInstanceKey: string

processName

processName: string

taskDefinitionId

taskDefinitionId: string

taskState

taskState: "FAILED" | "COMPLETED" | "CANCELED" | "CREATED"

tenantId

tenantId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

assignee

assignee: string

candidateGroups

candidateGroups: string[]

candidateUsers

candidateUsers: string[]

completionDate

completionDate: string

creationDate

creationDate: string

dueDate

dueDate: string

followUpDate

followUpDate: string

formId

formId: string

formKey

formKey: string

Optional formVersion

formVersion?: string

id

id: string

implementation

implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"

Optional isFormEmbedded

isFormEmbedded?: boolean

name

name: string

processDefinitionKey

processDefinitionKey: string

processInstanceKey

processInstanceKey: string

processName

processName: string

taskDefinitionId

taskDefinitionId: string

taskState

taskState: "FAILED" | "COMPLETED" | "CANCELED" | "CREATED"

tenantId

tenantId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html b/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html index f28fc4ed..72c037d8 100644 --- a/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html +++ b/classes/index.Tasklist.TasklistDto.TaskSearchResponse.html @@ -2,7 +2,7 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

assignee candidateGroups candidateUsers @@ -26,4 +26,4 @@ taskState tenantId variables -

Constructors

constructor

Properties

assignee

assignee: string

candidateGroups

candidateGroups: string[]

candidateUsers

candidateUsers: string[]

completionDate

completionDate: string

creationDate

creationDate: string

dueDate

dueDate: string

followUpDate

followUpDate: string

formId

formId: string

formKey

formKey: string

Optional formVersion

formVersion?: string

id

id: string

implementation

implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"

isFirst

isFirst: boolean

Optional isFormEmbedded

isFormEmbedded?: boolean

name

name: string

processDefinitionKey

processDefinitionKey: string

processInstanceKey

processInstanceKey: string

processName

processName: string

sortValues

sortValues: string[]

taskDefinitionId

taskDefinitionId: string

taskState

taskState: "FAILED" | "COMPLETED" | "CANCELED" | "CREATED"

tenantId

tenantId: string

variables

variables: VariableSearchResponseWithoutDraft[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

assignee

assignee: string

candidateGroups

candidateGroups: string[]

candidateUsers

candidateUsers: string[]

completionDate

completionDate: string

creationDate

creationDate: string

dueDate

dueDate: string

followUpDate

followUpDate: string

formId

formId: string

formKey

formKey: string

Optional formVersion

formVersion?: string

id

id: string

implementation

implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"

isFirst

isFirst: boolean

Optional isFormEmbedded

isFormEmbedded?: boolean

name

name: string

processDefinitionKey

processDefinitionKey: string

processInstanceKey

processInstanceKey: string

processName

processName: string

sortValues

sortValues: string[]

taskDefinitionId

taskDefinitionId: string

taskState

taskState: "FAILED" | "COMPLETED" | "CANCELED" | "CREATED"

tenantId

tenantId: string

variables

variables: VariableSearchResponseWithoutDraft[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Zeebe.BpmnParser.html b/classes/index.Zeebe.BpmnParser.html index 7afdc0b8..24f9fb6b 100644 --- a/classes/index.Zeebe.BpmnParser.html +++ b/classes/index.Zeebe.BpmnParser.html @@ -1,4 +1,4 @@ -BpmnParser | @camunda8/sdk

Class BpmnParser

Constructors

constructor +BpmnParser | @camunda8/sdk

Class BpmnParser

Constructors

constructor

Properties

parser parserOptions taskTypes @@ -11,16 +11,16 @@ scaffold scanBpmnObjectForMessages scanBpmnObjectForTasks -

Constructors

constructor

Properties

Static Private parser

parser: XMLParser = ...

Static Private parserOptions

parserOptions: {
    allowBooleanAttributes: boolean;
    attrNodeName: string;
    attributeNamePrefix: string;
    cdataPositionChar: string;
    cdataTagName: string;
    ignoreAttributes: boolean;
    ignoreNameSpace: boolean;
    localeRange: string;
    parseAttributeValue: boolean;
    parseNodeValue: boolean;
    parseTrueNumberOnly: boolean;
    textNodeName: string;
    trimValues: boolean;
} = ...

Type declaration

  • allowBooleanAttributes: boolean
  • attrNodeName: string
  • attributeNamePrefix: string
  • cdataPositionChar: string
  • cdataTagName: string
  • ignoreAttributes: boolean
  • ignoreNameSpace: boolean
  • localeRange: string
  • parseAttributeValue: boolean
  • parseNodeValue: boolean
  • parseTrueNumberOnly: boolean
  • textNodeName: string
  • trimValues: boolean

Static taskTypes

taskTypes: any

Methods

Static generateConstantsForBpmnFiles

  • generateConstantsForBpmnFiles(filenames): Promise<string>

  • Generate TypeScript constants for task types and message names in BPMN files

    +

Constructors

constructor

Properties

Static Private parser

parser: XMLParser = ...

Static Private parserOptions

parserOptions: {
    allowBooleanAttributes: boolean;
    attrNodeName: string;
    attributeNamePrefix: string;
    cdataPositionChar: string;
    cdataTagName: string;
    ignoreAttributes: boolean;
    ignoreNameSpace: boolean;
    localeRange: string;
    parseAttributeValue: boolean;
    parseNodeValue: boolean;
    parseTrueNumberOnly: boolean;
    textNodeName: string;
    trimValues: boolean;
} = ...

Type declaration

  • allowBooleanAttributes: boolean
  • attrNodeName: string
  • attributeNamePrefix: string
  • cdataPositionChar: string
  • cdataTagName: string
  • ignoreAttributes: boolean
  • ignoreNameSpace: boolean
  • localeRange: string
  • parseAttributeValue: boolean
  • parseNodeValue: boolean
  • parseTrueNumberOnly: boolean
  • textNodeName: string
  • trimValues: boolean

Static taskTypes

taskTypes: any

Methods

Static generateConstantsForBpmnFiles

  • generateConstantsForBpmnFiles(filenames): Promise<string>

  • Generate TypeScript constants for task types and message names in BPMN files

    Parameters

    • filenames: string | string[]

      a BPMN file path or array of BPMN file paths

      -

    Returns Promise<string>

Static getMessageNames

  • getMessageNames(processes): Promise<string[]>

  • Take one or more parsed BPMN objects and return an array of unique message names.

    +

Returns Promise<string>

Static getMessageNames

  • getMessageNames(processes): Promise<string[]>

  • Take one or more parsed BPMN objects and return an array of unique message names.

    Parameters

    • processes: object | object[]

      A parsed BPMN object, or an array of parsed BPMN objects.

      -

    Returns Promise<string[]>

Static getProcessId

Static getTaskTypes

  • getTaskTypes(processes): Promise<string[]>

  • Take one or more parsed BPMN objects and return an array of unique task types.

    +

Returns Promise<string[]>

Static getProcessId

Static getTaskTypes

  • getTaskTypes(processes): Promise<string[]>

  • Take one or more parsed BPMN objects and return an array of unique task types.

    Parameters

    • processes: object | object[]

      A parsed BPMN object, or an array of parsed BPMN objects.

      -

    Returns Promise<string[]>

Static Private mergeDedupeAndSort

Static parseBpmn

  • parseBpmn(filenames): object

  • Read BPMN files and return an array of one or more parsed BPMN objects.

    +

Returns Promise<string[]>

Static Private mergeDedupeAndSort

Static parseBpmn

  • parseBpmn(filenames): object

  • Read BPMN files and return an array of one or more parsed BPMN objects.

    Parameters

    • filenames: string | string[]

      A single BPMN file path, or array of BPMN file paths.

      -

    Returns object

Static scaffold

Static Private scanBpmnObjectForMessages

  • scanBpmnObjectForMessages(bpmnObject): Promise<string[]>

  • Return an array of message names.

    +

Returns object

Static scaffold

Static Private scanBpmnObjectForMessages

  • scanBpmnObjectForMessages(bpmnObject): Promise<string[]>

  • Return an array of message names.

    Parameters

    • bpmnObject: object

      A parsed Bpmn object.

      -

    Returns Promise<string[]>

Static Private scanBpmnObjectForTasks

  • scanBpmnObjectForTasks(bpmnObject): Promise<string[]>

  • Return an array of task types.

    +

Returns Promise<string[]>

Static Private scanBpmnObjectForTasks

  • scanBpmnObjectForTasks(bpmnObject): Promise<string[]>

  • Return an array of task types.

    Parameters

    • bpmnObject: object

      A parsed Bpmn object.

      -

    Returns Promise<string[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<string[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Zeebe.ZBWorker.html b/classes/index.Zeebe.ZBWorker.html index 67a3ed0b..8b80b1e7 100644 --- a/classes/index.Zeebe.ZBWorker.html +++ b/classes/index.Zeebe.ZBWorker.html @@ -1,4 +1,4 @@ -ZBWorker | @camunda8/sdk

Class ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Type Parameters

  • WorkerInputVariables
  • CustomHeaderShape
  • WorkerOutputVariables

Hierarchy (view full)

Constructors

constructor +ZBWorker | @camunda8/sdk

Class ZBWorker<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Type Parameters

  • WorkerInputVariables
  • CustomHeaderShape
  • WorkerOutputVariables

Hierarchy (view full)

Constructors

constructor

Properties

activeJobs cancelWorkflowOnException grpcClient @@ -21,6 +21,6 @@ off on removeAllListeners -

Constructors

constructor

Properties

activeJobs

activeJobs: number = 0

Protected cancelWorkflowOnException

cancelWorkflowOnException: boolean = false

grpcClient

grpcClient: ZBGrpc

Protected logger

logger: StatefulLogInterceptor

maxJobsToActivate

maxJobsToActivate: number

pollCount

pollCount: number = 0

Protected taskHandler

taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

taskType

taskType: string

timeout

timeout: MaybeTimeDuration

Protected zbClient

zbClient: ZeebeGrpcClient

Methods

close

  • close(timeout?): Promise<null>

  • Returns a promise that the worker has stopped accepting tasks and +

Constructors

constructor

Properties

activeJobs

activeJobs: number = 0

Protected cancelWorkflowOnException

cancelWorkflowOnException: boolean = false

grpcClient

grpcClient: ZBGrpc

Protected logger

logger: StatefulLogInterceptor

maxJobsToActivate

maxJobsToActivate: number

pollCount

pollCount: number = 0

Protected taskHandler

taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

taskType

taskType: string

timeout

timeout: MaybeTimeDuration

Protected zbClient

zbClient: ZeebeGrpcClient

Methods

close

  • close(timeout?): Promise<null>

  • Returns a promise that the worker has stopped accepting tasks and has drained all current active tasks. Will reject if you try to call it more than once.

    -

    Parameters

    • Optional timeout: number

    Returns Promise<null>

debug

Protected drainOne

emit

  • emit<K>(eventName, params?): void

  • Type Parameters

    • K extends EventKey<{
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }>

    Parameters

    • eventName: K
    • Optional params: {
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }[K]

    Returns void

error

Protected handleJob

Protected handleJobs

log

Protected makeCompleteHandlers

off

on

removeAllListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • Optional timeout: number

Returns Promise<null>

debug

Protected drainOne

emit

  • emit<K>(eventName, params?): void

  • Type Parameters

    • K extends EventKey<{
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }>

    Parameters

    • eventName: K
    • Optional params: {
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }[K]

    Returns void

error

Protected handleJob

Protected handleJobs

log

Protected makeCompleteHandlers

off

on

removeAllListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.Zeebe.ZeebeGrpcClient.html b/classes/index.Zeebe.ZeebeGrpcClient.html index ccdf1f51..ac1b7774 100644 --- a/classes/index.Zeebe.ZeebeGrpcClient.html +++ b/classes/index.Zeebe.ZeebeGrpcClient.html @@ -1,7 +1,7 @@ ZeebeGrpcClient | @camunda8/sdk

Class ZeebeGrpcClient

Description

A client for interacting with a Zeebe broker. With the connection credentials set in the environment, you can use a "zero-conf" constructor with no arguments.

Example

const zbc = new ZeebeGrpcClient()
zbc.topology().then(info =>
    console.log(JSON.stringify(info, null, 2))
)
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

closePromise? closing config @@ -55,7 +55,7 @@

Example

const throwError
 topology
 updateJobRetries
-

Constructors

constructor

  • new ZeebeGrpcClient(options?): ZeebeGrpcClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns ZeebeGrpcClient

Properties

Private Optional closePromise

closePromise?: Promise<null>

Private closing

closing: boolean = false

Private config

config: {
    CAMUNDA_CONSOLE_BASE_URL: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
    CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
    CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
    CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
    CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
    CAMUNDA_MODELER_BASE_URL: string;
    CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
    CAMUNDA_OAUTH_DISABLED: boolean;
    CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
    CAMUNDA_OAUTH_URL: undefined | string;
    CAMUNDA_OPERATE_BASE_URL: undefined | string;
    CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
    CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
    CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
    CAMUNDA_SECURE_CONNECTION: boolean;
    CAMUNDA_TASKLIST_BASE_URL: undefined | string;
    CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
    CAMUNDA_TENANT_ID: undefined | string;
    CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
    CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
    CAMUNDA_TOKEN_SCOPE: undefined | string;
    CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
    ZEEBE_ADDRESS: string;
    ZEEBE_CLIENT_ID: undefined | string;
    ZEEBE_CLIENT_SECRET: undefined | string;
    zeebeGrpcSettings: {
        GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
        GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
        GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
        GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
        GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
        GRPC_KEEPALIVE_TIMEOUT_MS: number;
        GRPC_KEEPALIVE_TIME_MS: number;
        GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
        GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
        ZEEBE_CLIENT_LOG_LEVEL: string;
        ZEEBE_CLIENT_LOG_TYPE: string;
        ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
        ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
        ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
        ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
        ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
        ZEEBE_GRPC_CLIENT_RETRY: boolean;
        ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
        ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
    };
}

Type declaration

  • CAMUNDA_CONSOLE_BASE_URL: undefined | string

    The base url for the Admin Console API.

    +

Constructors

constructor

  • new ZeebeGrpcClient(options?): ZeebeGrpcClient

  • Parameters

    • Optional options: {
          config?: DeepPartial<{
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: boolean;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
              ZEEBE_ADDRESS: string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                  ZEEBE_CLIENT_LOG_LEVEL: string;
                  ZEEBE_CLIENT_LOG_TYPE: string;
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
              };
          }>;
          oAuthProvider?: IOAuthProvider;
      }
      • Optional config?: DeepPartial<{
            CAMUNDA_CONSOLE_BASE_URL: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
            CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
            CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
            CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
            CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
            CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
            CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
            CAMUNDA_MODELER_BASE_URL: string;
            CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
            CAMUNDA_OAUTH_DISABLED: boolean;
            CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
            CAMUNDA_OAUTH_URL: undefined | string;
            CAMUNDA_OPERATE_BASE_URL: undefined | string;
            CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
            CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
            CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
            CAMUNDA_SECURE_CONNECTION: boolean;
            CAMUNDA_TASKLIST_BASE_URL: undefined | string;
            CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
            CAMUNDA_TENANT_ID: undefined | string;
            CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
            CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
            CAMUNDA_TOKEN_SCOPE: undefined | string;
            CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
            ZEEBE_ADDRESS: string;
            ZEEBE_CLIENT_ID: undefined | string;
            ZEEBE_CLIENT_SECRET: undefined | string;
            zeebeGrpcSettings: {
                GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
                GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                GRPC_KEEPALIVE_TIMEOUT_MS: number;
                GRPC_KEEPALIVE_TIME_MS: number;
                GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
                GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
                ZEEBE_CLIENT_LOG_LEVEL: string;
                ZEEBE_CLIENT_LOG_TYPE: string;
                ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                ZEEBE_GRPC_CLIENT_RETRY: boolean;
                ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
            };
        }>
      • Optional oAuthProvider?: IOAuthProvider

    Returns ZeebeGrpcClient

Properties

Private Optional closePromise

closePromise?: Promise<null>

Private closing

closing: boolean = false

Private config

config: {
    CAMUNDA_CONSOLE_BASE_URL: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
    CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
    CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
    CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
    CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
    CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
    CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
    CAMUNDA_MODELER_BASE_URL: string;
    CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
    CAMUNDA_OAUTH_DISABLED: boolean;
    CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
    CAMUNDA_OAUTH_URL: undefined | string;
    CAMUNDA_OPERATE_BASE_URL: undefined | string;
    CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
    CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
    CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
    CAMUNDA_SECURE_CONNECTION: boolean;
    CAMUNDA_TASKLIST_BASE_URL: undefined | string;
    CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
    CAMUNDA_TENANT_ID: undefined | string;
    CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
    CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
    CAMUNDA_TOKEN_SCOPE: undefined | string;
    CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
    ZEEBE_ADDRESS: string;
    ZEEBE_CLIENT_ID: undefined | string;
    ZEEBE_CLIENT_SECRET: undefined | string;
    zeebeGrpcSettings: {
        GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
        GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
        GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
        GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
        GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
        GRPC_KEEPALIVE_TIMEOUT_MS: number;
        GRPC_KEEPALIVE_TIME_MS: number;
        GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
        GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
        ZEEBE_CLIENT_LOG_LEVEL: string;
        ZEEBE_CLIENT_LOG_TYPE: string;
        ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
        ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
        ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
        ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
        ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
        ZEEBE_GRPC_CLIENT_RETRY: boolean;
        ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
        ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
    };
}

Type declaration

  • CAMUNDA_CONSOLE_BASE_URL: undefined | string

    The base url for the Admin Console API.

  • CAMUNDA_CONSOLE_CLIENT_ID: undefined | string

    Credentials for Admin Console and Modeler API

  • CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string

    Credentials for Admin Console and Modeler API

  • CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string

    The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

    @@ -122,33 +122,33 @@

    Example

    const
  • ZEEBE_GRPC_CLIENT_RETRY: boolean

    Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true

  • ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number

    How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60

  • ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number

    After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300

    -

Optional connected

connected?: boolean = undefined

connectionTolerance

connectionTolerance: MaybeTimeDuration

Private Optional customSSL

customSSL?: CustomSSL

gatewayAddress

gatewayAddress: string

Private grpc

grpc: Promise<ZBGrpc>

Private logger

logger: StatefulLogInterceptor

loglevel

loglevel: Loglevel

Private maxRetries

maxRetries: number

Private maxRetryTimeout

maxRetryTimeout: MaybeTimeDuration

Private oAuthProvider

oAuthProvider: IOAuthProvider

Optional onConnectionError

onConnectionError?: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      • err: Error

      Returns void

Optional onReady

onReady?: (() => void)

Type declaration

    • (): void

    • Returns void

Private options

options: ZBClientOptions

readied

readied: boolean = false

Private retry

retry: boolean

Private stdout

stdout: ZBCustomLogger

Private Optional tenantId

tenantId?: string

Private useTLS

useTLS: boolean

Private workerCount

workerCount: number = 0

Private workers

workers: ZBWorker<any, any, any>[] = []

Methods

Private _onConnectionError

activateJobs

Optional connected

connected?: boolean = undefined

connectionTolerance

connectionTolerance: MaybeTimeDuration

Private Optional customSSL

customSSL?: CustomSSL

gatewayAddress

gatewayAddress: string

Private grpc

grpc: Promise<ZBGrpc>

Private logger

logger: StatefulLogInterceptor

loglevel

loglevel: Loglevel

Private maxRetries

maxRetries: number

Private maxRetryTimeout

maxRetryTimeout: MaybeTimeDuration

Private oAuthProvider

oAuthProvider: IOAuthProvider

Optional onConnectionError

onConnectionError?: ((err) => void)

Type declaration

    • (err): void

    • Parameters

      • err: Error

      Returns void

Optional onReady

onReady?: (() => void)

Type declaration

    • (): void

    • Returns void

Private options

options: ZBClientOptions

readied

readied: boolean = false

Private retry

retry: boolean

Private stdout

stdout: ZBCustomLogger

Private Optional tenantId

tenantId?: string

Private useTLS

useTLS: boolean

Private workerCount

workerCount: number = 0

Private workers

workers: ZBWorker<any, any, any>[] = []

Methods

Private _onConnectionError

activateJobs

broadcastSignal

broadcastSignal

cancelProcessInstance

  • cancelProcessInstance(processInstanceKey): Promise<void>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<void>

    Description

    Cancel a process instance by process instance key.

    +

cancelProcessInstance

  • cancelProcessInstance(processInstanceKey): Promise<void>

  • Parameters

    • processInstanceKey: string | number

    Returns Promise<void>

    Description

    Cancel a process instance by process instance key.

    Example

    const zbc = new ZeebeGrpcClient()

    zbc.cancelProcessInstance(processInstanceId)
        .catch(
            (e: any) => console.log(`Error cancelling instance: ${e.message}`)
    )
    -

close

  • close(timeout?): Promise<null>

  • Parameters

    • Optional timeout: number

    Returns Promise<null>

    Description

    Gracefully shut down all workers, draining existing tasks, and return when it is safe to exit.

    +

close

  • close(timeout?): Promise<null>

  • Parameters

    • Optional timeout: number

    Returns Promise<null>

    Description

    Gracefully shut down all workers, draining existing tasks, and return when it is safe to exit.

    Example

    const zbc = new ZeebeGrpcClient()

    zbc.createWorker({
      taskType:
    })

    setTimeout(async () => {
      await zbc.close()
      console.log('All work completed.')
    }),
      5 * 60 * 1000 // 5 mins
    )
    -

completeJob

completeJob

  • completeJob(completeJobRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Explicitly complete a job. The method is useful for manually constructing a worker.

    Example

    const zbc = new ZeebeGrpcClient()
    zbc.activateJobs({
      maxJobsToActivate: 5,
      requestTimeout: 6000,
      timeout: 5 * 60 * 1000,
      type: 'process-payment',
      worker: 'my-worker-uuid'
    }).then(jobs =>
         jobs.forEach(job =>
        // business logic
        zbc.completeJob({
          jobKey: job.key,
          variables: {}
        ))
      )
    })
    -

Private constructGrpcClient

  • constructGrpcClient(__namedParameters): {
        grpcClient: ZBGrpc;
        log: StatefulLogInterceptor;
    }

  • Parameters

    • __namedParameters: {
          grpcConfig: {
              namespace: string;
              onConnectionError?: (() => void);
              onReady?: (() => void);
              tasktype?: string;
          };
          logConfig: ZBLoggerConfig;
      }
      • grpcConfig: {
            namespace: string;
            onConnectionError?: (() => void);
            onReady?: (() => void);
            tasktype?: string;
        }
        • namespace: string
        • Optional onConnectionError?: (() => void)
            • (): void

            • Returns void

        • Optional onReady?: (() => void)
            • (): void

            • Returns void

        • Optional tasktype?: string
      • logConfig: ZBLoggerConfig

    Returns {
        grpcClient: ZBGrpc;
        log: StatefulLogInterceptor;
    }

createProcessInstance

Private constructGrpcClient

  • constructGrpcClient(__namedParameters): {
        grpcClient: ZBGrpc;
        log: StatefulLogInterceptor;
    }

  • Parameters

    • __namedParameters: {
          grpcConfig: {
              namespace: string;
              onConnectionError?: (() => void);
              onReady?: (() => void);
              tasktype?: string;
          };
          logConfig: ZBLoggerConfig;
      }
      • grpcConfig: {
            namespace: string;
            onConnectionError?: (() => void);
            onReady?: (() => void);
            tasktype?: string;
        }
        • namespace: string
        • Optional onConnectionError?: (() => void)
            • (): void

            • Returns void

        • Optional onReady?: (() => void)
            • (): void

            • Returns void

        • Optional tasktype?: string
      • logConfig: ZBLoggerConfig

    Returns {
        grpcClient: ZBGrpc;
        log: StatefulLogInterceptor;
    }

createProcessInstance

  • createProcessInstance<Variables>(config): Promise<CreateProcessInstanceResponse>

  • Type Parameters

    Parameters

    Returns Promise<CreateProcessInstanceResponse>

    Description

    Create a new process instance. Asynchronously returns a process instance id.

    Example

    const zbc = new ZeebeGrpcClient()

    zbc.createProcessInstance({
      bpmnProcessId: 'onboarding-process',
      variables: {
        customerId: 'uuid-3455'
      },
      version: 5 // optional, will use latest by default
    }).then(res => console.log(JSON.stringify(res, null, 2)))

    zbc.createProcessInstance({
      bpmnProcessId: 'SkipFirstTask',
      variables: { id: random },
      startInstructions: [{elementId: 'second_service_task'}]
    }).then(res => (id = res.processInstanceKey))
    -

createProcessInstanceWithResult

createProcessInstanceWithResult

createWorker

createWorker

deleteResource

deleteResource

  • deleteResource(resourceId): Promise<Record<string, never>>

  • Delete a resource.

    Parameters

    • resourceId: {
          resourceKey: string;
      }

      The key of the resource that should be deleted. This can either be the key of a process definition, the key of a decision requirements definition or the key of a form.

      -
      • resourceKey: string

    Returns Promise<Record<string, never>>

deployResource

  • deployResource(resource): Promise<DeployResourceResponse<ProcessDeployment>>

  • Parameters

    • resource: {
          processFilename: string;
          tenantId?: string;
      } | {
          name: string;
          process: Buffer;
          tenantId?: string;
      }

    Returns Promise<DeployResourceResponse<ProcessDeployment>>

    Description

    Deploys one or more resources (e.g. processes or decision models) to Zeebe. +

    • resourceKey: string

Returns Promise<Record<string, never>>

deployResource

emit

  • emit<K>(eventName, params?): void

  • Type Parameters

    • K extends EventKey<{
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }>

    Parameters

    • eventName: K
    • Optional params: {
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }[K]

    Returns void

evaluateDecision

emit

  • emit<K>(eventName, params?): void

  • Type Parameters

    • K extends EventKey<{
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }>

    Parameters

    • eventName: K
    • Optional params: {
          close: "close";
          connectionError: "connectionError";
          ready: "ready";
          unknown: "unknown";
      }[K]

    Returns void

evaluateDecision

  • evaluateDecision(evaluateDecisionRequest): Promise<EvaluateDecisionResponse>

  • Parameters

    Returns Promise<EvaluateDecisionResponse>

    Description

    Evaluates a decision. The decision to evaluate can be specified either by using its unique key (as returned by DeployResource), or using the decision ID. When using the decision ID, the latest deployed version of the decision is used.

    Example

    const zbc = new ZeebeGrpcClient()
    zbc.evaluateDecision({
      decisionId: 'my-decision',
      variables: { season: "Fall" }
    }).then(res => console.log(JSON.stringify(res, null, 2)))
    -

Private executeOperation

  • executeOperation<T>(operationName, operation, retries?): Promise<T>

  • If this.retry is set true, the operation will be wrapped in an configurable retry on exceptions +

Private executeOperation

  • executeOperation<T>(operationName, operation, retries?): Promise<T>

  • If this.retry is set true, the operation will be wrapped in an configurable retry on exceptions of gRPC error code 14 - Transient Network Failure. See: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md If this.retry is false, it will be executed with no retry, and the application should handle the exception.

    Type Parameters

    • T

    Parameters

    • operationName: string
    • operation: (() => Promise<T>)

      A gRPC command operation

      -
        • (): Promise<T>

        • Returns Promise<T>

    • Optional retries: number

    Returns Promise<T>

failJob

  • failJob(failJobRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Fail a job. This is useful if you are using the decoupled completion pattern or building your own worker. +

      • (): Promise<T>

      • Returns Promise<T>

  • Optional retries: number

Returns Promise<T>

failJob

  • failJob(failJobRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Fail a job. This is useful if you are using the decoupled completion pattern or building your own worker. For the retry count, the current count is available in the job metadata.

    Example

    const zbc = new ZeebeGrpcClient()
    zbc.failJob( {
      jobKey: '345424343451',
      retries: 3,
      errorMessage: 'Could not get a response from the order invoicing API',
      retryBackOff: 30 * 1000 // optional, otherwise available for reactivation immediately
    })
    -

getServiceTypesFromBpmn

  • getServiceTypesFromBpmn(files): Promise<string[]>

  • Parameters

    • files: string | string[]

    Returns Promise<string[]>

    Description

    Return an array of task types contained in a BPMN file or array of BPMN files. This can be useful, for example, to do

    +

getServiceTypesFromBpmn

  • getServiceTypesFromBpmn(files): Promise<string[]>

  • Parameters

    • files: string | string[]

    Returns Promise<string[]>

    Description

    Return an array of task types contained in a BPMN file or array of BPMN files. This can be useful, for example, to do

    Example

    const zbc = new ZeebeGrpcClient()
    zbc.getServiceTypesFromBpmn(['bpmn/onboarding.bpmn', 'bpmn/process-sale.bpmn'])
      .then(tasktypes => console.log('The task types are:', tasktypes))
    -

migrateProcessInstance

modifyProcessInstance

migrateProcessInstance

modifyProcessInstance

off

on

publishMessage

off

on

publishMessage

publishStartMessage

publishStartMessage

  • publishStartMessage<ProcessVariables>(publishStartMessageRequest): Promise<PublishMessageResponse>

  • Type Parameters

    Parameters

    Returns Promise<PublishMessageResponse>

    Description

    Publish a message to the broker for correlation with a workflow message start event. For a message targeting a start event, the correlation key is not needed to target a specific running process instance. However, the hash of the correlationKey is used to determine the partition where this workflow will start. So we assign a random uuid to balance workflow instances created via start message across partitions.

    @@ -203,26 +203,26 @@

    Example

    const https://github.com/zeebe-io/zeebe/issues/1012 and https://github.com/zeebe-io/zeebe/issues/1022
    
 
    Example
    const zbc = new ZeebeGrpcClient()
    zbc.publishStartMessage({
      name: 'Start_New_Onboarding_Flow',
      variables: {
        customerId: 'uuid-348-234-8908'
      }
    })

    // To do the same in an idempotent fashion - note: only idempotent during the lifetime of the created instance.
    zbc.publishStartMessage({
      name: 'Start_New_Onboarding_Flow',
      messageId: 'uuid-348-234-8908', // use customerId to make process idempotent per customer
      variables: {
        customerId: 'uuid-348-234-8908'
      }
    })
 
    
-

removeAllListeners

resolveIncident

removeAllListeners

resolveIncident

  • resolveIncident(resolveIncidentRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Resolve an incident by incident key.

    Example

    type JSONObject = {[key: string]: string | number | boolean | JSONObject}

    const zbc = new ZeebeGrpcClient()

    async updateAndResolveIncident({
      processInstanceId,
      incidentKey,
      variables
    } : {
      processInstanceId: string,
      incidentKey: string,
      variables: JSONObject
    }) {
      await zbc.setVariables({
        elementInstanceKey: processInstanceId,
        variables
      })
      await zbc.updateRetries()
      zbc.resolveIncident({
        incidentKey
      })
      zbc.resolveIncident(incidentKey)
    }
    -

Private retryOnFailure

Private retryOnFailure

  • retryOnFailure<T>(operation): Promise<T>

  • This function takes a gRPC operation that returns a Promise as a function, and invokes it. If the operation throws gRPC error 14, this function will continue to try it until it succeeds or retries are exhausted.

    Type Parameters

    • T

    Parameters

    • operation: {
          operation: (() => Promise<T>);
          operationName: string;
          retries?: number;
      }

      A gRPC command operation that may fail if the broker is not available

      -
      • operation: (() => Promise<T>)
          • (): Promise<T>

          • Returns Promise<T>

      • operationName: string
      • Optional retries?: number

    Returns Promise<T>

setVariables

  • setVariables<Variables>(request): Promise<void>

  • Type Parameters

    Parameters

    Returns Promise<void>

    Description

    Directly modify the variables is a process instance. This can be used with resolveIncident to update the process and resolve an incident.

    +
    • operation: (() => Promise<T>)
        • (): Promise<T>

        • Returns Promise<T>

    • operationName: string
    • Optional retries?: number

Returns Promise<T>

setVariables

  • setVariables<Variables>(request): Promise<void>

  • Type Parameters

    Parameters

    Returns Promise<void>

    Description

    Directly modify the variables is a process instance. This can be used with resolveIncident to update the process and resolve an incident.

    Example

    type JSONObject = {[key: string]: string | number | boolean | JSONObject}

    const zbc = new ZeebeGrpcClient()

    async function updateAndResolveIncident({
      incidentKey,
      processInstanceKey,
      jobKey,
      variableUpdate
    } : {
      incidentKey: string
      processInstanceKey: string
      jobKey: string
      variableUpdate: JSONObject
    }) {
      await zbc.setVariables({
        elementInstanceKey: processInstanceKey,
        variables: variableUpdate
      })
      await zbc.updateJobRetries({
        jobKey,
        retries: 1
      })
      return zbc.resolveIncident({
        incidentKey
      })
    }
    -

throwError

  • throwError(throwErrorRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Fail a job by throwing a business error (i.e. non-technical) that occurs while processing a job. +

throwError

  • throwError(throwErrorRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Fail a job by throwing a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the workflow by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead. This method is useful when building a worker, for example for the decoupled completion pattern.

    Example

    type JSONObject = {[key: string]: string | number | boolean | JSONObject}

    interface errorResult {
      resultType: 'ERROR' as 'ERROR'
         errorCode: string
      errorMessage: string
    }

    interface successResult {
      resultType: 'SUCCESS' as 'SUCCESS'
      variableUpdate: JSONObject
    }

    type Result = errorResult | successResult

    const zbc = new ZeebeGrpcClient()


    // This could be a listener on a return queue from an external system
    async function handleJob(jobKey: string, result: Result) {
      if (resultType === 'ERROR') {
        const { errorMessage, errorCode } = result
            zbc.throwError({
           jobKey,
           errorCode,
              errorMessage
        })
      } else {
        zbc.completeJob({
          jobKey,
          variables: result.variableUpdate
        })
      }
    }
    -

topology

topology

updateJobRetries

  • updateJobRetries(updateJobRetriesRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Update the number of retries for a Job. This is useful if a job has zero remaining retries and fails, raising an incident.

    +

updateJobRetries

  • updateJobRetries(updateJobRetriesRequest): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    Update the number of retries for a Job. This is useful if a job has zero remaining retries and fails, raising an incident.

    Example

    type JSONObject = {[key: string]: string | number | boolean | JSONObject}

    const zbc = new ZeebeGrpcClient()

    async function updateAndResolveIncident({
      incidentKey,
      processInstanceKey,
      jobKey,
      variableUpdate
    } : {
      incidentKey: string
      processInstanceKey: string
      jobKey: string
      variableUpdate: JSONObject
    }) {
      await zbc.setVariables({
        elementInstanceKey: processInstanceKey,
        variables: variableUpdate
      })
      await zbc.updateJobRetries({
        jobKey,
        retries: 1
      })
      return zbc.resolveIncident({
        incidentKey
      })
    }
    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index._internal_.HTTPError.html b/classes/index._internal_.HTTPError.html index 4abb58e3..9daa6bd6 100644 --- a/classes/index._internal_.HTTPError.html +++ b/classes/index._internal_.HTTPError.html @@ -1,3 +1,3 @@ -HTTPError | @camunda8/sdk

Class HTTPError

Hierarchy

  • HTTPError
    • HTTPError

Constructors

constructor +HTTPError | @camunda8/sdk

Class HTTPError

Hierarchy

  • HTTPError
    • HTTPError

Constructors

constructor

Properties

statusCode -

Constructors

constructor

Properties

statusCode

statusCode: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

statusCode

statusCode: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index._internal_.LosslessDto.html b/classes/index._internal_.LosslessDto.html index 7d72c362..3affe63a 100644 --- a/classes/index._internal_.LosslessDto.html +++ b/classes/index._internal_.LosslessDto.html @@ -2,5 +2,5 @@ Decorate fields with @Int64String or @BigIntValue to specify how int64 JSON numbers should be parsed.

Example

class MyDto extends LosslessDto {
  @Int64String
  int64NumberField: string
  @BigIntValue
  bigintField: bigint
  @ChildDto(MyChildDto)
  childDtoField: MyChildDto
  normalField: string
  normalNumberField: number
}
-

Hierarchy (view full)

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Hierarchy (view full)

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index._internal_.StatefulLogInterceptor.html b/classes/index._internal_.StatefulLogInterceptor.html index 61d66563..b6811090 100644 --- a/classes/index._internal_.StatefulLogInterceptor.html +++ b/classes/index._internal_.StatefulLogInterceptor.html @@ -1,4 +1,4 @@ -StatefulLogInterceptor | @camunda8/sdk

Class StatefulLogInterceptor

Constructors

constructor +StatefulLogInterceptor | @camunda8/sdk

Class StatefulLogInterceptor

Constructors

constructor

Properties

blocking blockingTimer? characteristics @@ -19,4 +19,4 @@ logInfo ready wrap -

Constructors

constructor

Properties

blocking

blocking: boolean

Private Optional blockingTimer

blockingTimer?: Timeout

characteristics

characteristics: Characteristics

Private error

error: ((msg) => void) = ...

Type declaration

    • (msg): void

    • Parameters

      • msg: string

      Returns void

errors

errors: never[] = []

Private info

info: ((msg) => void) = ...

Type declaration

    • (msg): void

    • Parameters

      • msg: string

      Returns void

initialConnection

initialConnection: boolean

log

log: ZBLogger

logs

logs: never[] = []

state

state: State = 'ERROR'

Methods

close

connectionError

Private emptyErrors

Private emptyLogs

logDebug

logDirect

logError

logInfo

ready

Private wrap

  • wrap(store): ((logmethod) => ((msg) => void))

  • Parameters

    • store: string[]

    Returns ((logmethod) => ((msg) => void))

      • (logmethod): ((msg) => void)

      • Parameters

        • logmethod: ((msg, ...optionalParameters) => void)
            • (msg, ...optionalParameters): void

            • Parameters

              • msg: string
              • Rest ...optionalParameters: unknown[]

              Returns void

        Returns ((msg) => void)

          • (msg): void

          • Parameters

            • msg: string

            Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

blocking

blocking: boolean

Private Optional blockingTimer

blockingTimer?: Timeout

characteristics

characteristics: Characteristics

Private error

error: ((msg) => void) = ...

Type declaration

    • (msg): void

    • Parameters

      • msg: string

      Returns void

errors

errors: never[] = []

Private info

info: ((msg) => void) = ...

Type declaration

    • (msg): void

    • Parameters

      • msg: string

      Returns void

initialConnection

initialConnection: boolean

log

log: ZBLogger

logs

logs: never[] = []

state

state: State = 'ERROR'

Methods

close

connectionError

Private emptyErrors

Private emptyLogs

logDebug

logDirect

logError

logInfo

ready

Private wrap

  • wrap(store): ((logmethod) => ((msg) => void))

  • Parameters

    • store: string[]

    Returns ((logmethod) => ((msg) => void))

      • (logmethod): ((msg) => void)

      • Parameters

        • logmethod: ((msg, ...optionalParameters) => void)
            • (msg, ...optionalParameters): void

            • Parameters

              • msg: string
              • Rest ...optionalParameters: unknown[]

              Returns void

        Returns ((msg) => void)

          • (msg): void

          • Parameters

            • msg: string

            Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index._internal_.TypedEmitter.html b/classes/index._internal_.TypedEmitter.html index 63032b9e..0a3432db 100644 --- a/classes/index._internal_.TypedEmitter.html +++ b/classes/index._internal_.TypedEmitter.html @@ -1,7 +1,7 @@ -TypedEmitter | @camunda8/sdk

Class TypedEmitter<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +TypedEmitter | @camunda8/sdk

Class TypedEmitter<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

emitter

Methods

emit off on removeAllListeners -

Constructors

constructor

Properties

Private emitter

emitter: EventEmitter = ...

Methods

emit

off

on

removeAllListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private emitter

emitter: EventEmitter = ...

Methods

emit

off

on

removeAllListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index._internal_.ZBLogger.html b/classes/index._internal_.ZBLogger.html index dc32f84e..facd5b52 100644 --- a/classes/index._internal_.ZBLogger.html +++ b/classes/index._internal_.ZBLogger.html @@ -1,4 +1,4 @@ -ZBLogger | @camunda8/sdk

Class ZBLogger

Constructors

constructor +ZBLogger | @camunda8/sdk

Class ZBLogger

Constructors

constructor

Properties

_tag colorFn colorise @@ -14,4 +14,4 @@ info log makeMessage -

Constructors

constructor

Properties

_tag

_tag: "ZBCLIENT" | "ZBWORKER"

Private colorFn

colorFn: Chalk | (<T>(input) => string)

Type declaration

    • <T>(input): string

    • Type Parameters

      • T extends string

      Parameters

      • input: T

      Returns string

Private colorise

colorise: boolean

Private Optional id

id?: string

loglevel

loglevel: Loglevel

Private namespace

namespace: undefined | string

Private Optional pollInterval

pollInterval?: MaybeTimeDuration

Private stdout

stdout: ZBCustomLogger

Private Optional taskType

taskType?: string

Methods

Private _colorise

debug

  • debug(message, ...optionalParameters): void

  • Parameters

    • message: string
    • Rest ...optionalParameters: unknown[]

    Returns void

error

  • error(message, ...optionalParameters): void

  • Parameters

    • message: any
    • Rest ...optionalParameters: unknown[]

    Returns void

info

  • info(message, ...optionalParameters): void

  • Parameters

    • message: unknown
    • Rest ...optionalParameters: any[]

    Returns void

log

  • log(message, ...optionalParameters): void

  • Parameters

    • message: string
    • Rest ...optionalParameters: unknown[]

    Returns void

Private makeMessage

  • makeMessage(frame, level, message, ...optionalParameters): string

  • Parameters

    • frame: StackFrame
    • level: number
    • message: any
    • Rest ...optionalParameters: any[]

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

_tag

_tag: "ZBCLIENT" | "ZBWORKER"

Private colorFn

colorFn: Chalk | (<T>(input) => string)

Type declaration

    • <T>(input): string

    • Type Parameters

      • T extends string

      Parameters

      • input: T

      Returns string

Private colorise

colorise: boolean

Private Optional id

id?: string

loglevel

loglevel: Loglevel

Private namespace

namespace: undefined | string

Private Optional pollInterval

pollInterval?: MaybeTimeDuration

Private stdout

stdout: ZBCustomLogger

Private Optional taskType

taskType?: string

Methods

Private _colorise

debug

  • debug(message, ...optionalParameters): void

  • Parameters

    • message: string
    • Rest ...optionalParameters: unknown[]

    Returns void

error

  • error(message, ...optionalParameters): void

  • Parameters

    • message: any
    • Rest ...optionalParameters: unknown[]

    Returns void

info

  • info(message, ...optionalParameters): void

  • Parameters

    • message: unknown
    • Rest ...optionalParameters: any[]

    Returns void

log

  • log(message, ...optionalParameters): void

  • Parameters

    • message: string
    • Rest ...optionalParameters: unknown[]

    Returns void

Private makeMessage

  • makeMessage(frame, level, message, ...optionalParameters): string

  • Parameters

    • frame: StackFrame
    • level: number
    • message: any
    • Rest ...optionalParameters: any[]

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index._internal_.ZBWorkerBase.html b/classes/index._internal_.ZBWorkerBase.html index 7a09b0d4..994fe838 100644 --- a/classes/index._internal_.ZBWorkerBase.html +++ b/classes/index._internal_.ZBWorkerBase.html @@ -1,4 +1,4 @@ -ZBWorkerBase | @camunda8/sdk

Class ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Type Parameters

  • WorkerInputVariables = any
  • CustomHeaderShape = any
  • WorkerOutputVariables = any

Hierarchy (view full)

Constructors

constructor +ZBWorkerBase | @camunda8/sdk

Class ZBWorkerBase<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

Type Parameters

  • WorkerInputVariables = any
  • CustomHeaderShape = any
  • WorkerOutputVariables = any

Hierarchy (view full)

Constructors

constructor

Properties

activeJobs activeJobsThresholdForReactivation backPressureRetryCount @@ -50,6 +50,6 @@ on poll removeAllListeners -

Constructors

constructor

Properties

activeJobs

activeJobs: number = 0

Private activeJobsThresholdForReactivation

activeJobsThresholdForReactivation: number

Private backPressureRetryCount

backPressureRetryCount: number = 0

Protected cancelWorkflowOnException

cancelWorkflowOnException: boolean = false

Private capacityEmitter

capacityEmitter: EventEmitter

Private Optional closeCallback

closeCallback?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional closePromise

closePromise?: Promise<null>

Private closed

closed: boolean = false

Private closing

closing: boolean = false

Private connected

connected: boolean = true

Private customHeadersDto

customHeadersDto: (new (...args) => CustomHeaderShape)

Type declaration

Private debugMode

debugMode: boolean

Private fetchVariable

fetchVariable: undefined | (keyof WorkerInputVariables)[]

grpcClient

grpcClient: ZBGrpc

Private id

id: string = ...

Private inputVariableDto

inputVariableDto: (new (obj) => WorkerInputVariables)

Type declaration

Private Optional jobStream

jobStream?: ClientReadableStreamImpl<unknown>

Protected logger

logger: StatefulLogInterceptor

Private longPoll

longPoll: MaybeTimeDuration

maxJobsToActivate

maxJobsToActivate: number

pollCount

pollCount: number = 0

Private pollInterval

pollInterval: MaybeTimeDuration

Private pollLoop

pollLoop: Timeout

Private pollMutex

pollMutex: boolean = false

Private readied

readied: boolean = false

Private stalled

stalled: boolean = false

Protected taskHandler

taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

taskType

taskType: string

Private Optional tenantId

tenantId?: string

timeout

timeout: MaybeTimeDuration

Protected zbClient

zbClient: ZeebeGrpcClient

Static Private Readonly DEFAULT_JOB_ACTIVATION_TIMEOUT

DEFAULT_JOB_ACTIVATION_TIMEOUT: Seconds = ...

Static Private Readonly DEFAULT_MAX_ACTIVE_JOBS

DEFAULT_MAX_ACTIVE_JOBS: 32 = 32

Methods

Private activateJobs

  • activateJobs(id): Promise<{
        closing?: undefined;
        error?: undefined;
        stalled: true;
        stream: undefined;
    } | {
        closing: true;
        error?: undefined;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error: Error;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error?: undefined;
        stalled?: undefined;
        stream: {} & {} & EmitterAugmentation1<"metadata", Metadata> & EmitterAugmentation1<"status", StatusObject> & EventEmitter & {} & EmitterAugmentation1<"data", unknown> & IntermediateObjectReadable<unknown> & {
            error?: Error;
        };
    }>

  • Parameters

    • id: string

    Returns Promise<{
        closing?: undefined;
        error?: undefined;
        stalled: true;
        stream: undefined;
    } | {
        closing: true;
        error?: undefined;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error: Error;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error?: undefined;
        stalled?: undefined;
        stream: {} & {} & EmitterAugmentation1<"metadata", Metadata> & EmitterAugmentation1<"status", StatusObject> & EventEmitter & {} & EmitterAugmentation1<"data", unknown> & IntermediateObjectReadable<unknown> & {
            error?: Error;
        };
    }>

close

  • close(timeout?): Promise<null>

  • Returns a promise that the worker has stopped accepting tasks and +

Constructors

constructor

Properties

activeJobs

activeJobs: number = 0

Private activeJobsThresholdForReactivation

activeJobsThresholdForReactivation: number

Private backPressureRetryCount

backPressureRetryCount: number = 0

Protected cancelWorkflowOnException

cancelWorkflowOnException: boolean = false

Private capacityEmitter

capacityEmitter: EventEmitter

Private Optional closeCallback

closeCallback?: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional closePromise

closePromise?: Promise<null>

Private closed

closed: boolean = false

Private closing

closing: boolean = false

Private connected

connected: boolean = true

Private customHeadersDto

customHeadersDto: (new (...args) => CustomHeaderShape)

Type declaration

Private debugMode

debugMode: boolean

Private fetchVariable

fetchVariable: undefined | (keyof WorkerInputVariables)[]

grpcClient

grpcClient: ZBGrpc

Private id

id: string = ...

Private inputVariableDto

inputVariableDto: (new (obj) => WorkerInputVariables)

Type declaration

Private Optional jobStream

jobStream?: ClientReadableStreamImpl<unknown>

Protected logger

logger: StatefulLogInterceptor

Private longPoll

longPoll: MaybeTimeDuration

maxJobsToActivate

maxJobsToActivate: number

pollCount

pollCount: number = 0

Private pollInterval

pollInterval: MaybeTimeDuration

Private pollLoop

pollLoop: Timeout

Private pollMutex

pollMutex: boolean = false

Private readied

readied: boolean = false

Private stalled

stalled: boolean = false

Protected taskHandler

taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

taskType

taskType: string

Private Optional tenantId

tenantId?: string

timeout

timeout: MaybeTimeDuration

Protected zbClient

zbClient: ZeebeGrpcClient

Static Private Readonly DEFAULT_JOB_ACTIVATION_TIMEOUT

DEFAULT_JOB_ACTIVATION_TIMEOUT: Seconds = ...

Static Private Readonly DEFAULT_MAX_ACTIVE_JOBS

DEFAULT_MAX_ACTIVE_JOBS: 32 = 32

Methods

Private activateJobs

  • activateJobs(id): Promise<{
        closing?: undefined;
        error?: undefined;
        stalled: true;
        stream: undefined;
    } | {
        closing: true;
        error?: undefined;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error: Error;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error?: undefined;
        stalled?: undefined;
        stream: {} & {} & EmitterAugmentation1<"metadata", Metadata> & EmitterAugmentation1<"status", StatusObject> & EventEmitter & {} & EmitterAugmentation1<"data", unknown> & IntermediateObjectReadable<unknown> & {
            error?: Error;
        };
    }>

  • Parameters

    • id: string

    Returns Promise<{
        closing?: undefined;
        error?: undefined;
        stalled: true;
        stream: undefined;
    } | {
        closing: true;
        error?: undefined;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error: Error;
        stalled?: undefined;
        stream: undefined;
    } | {
        closing?: undefined;
        error?: undefined;
        stalled?: undefined;
        stream: {} & {} & EmitterAugmentation1<"metadata", Metadata> & EmitterAugmentation1<"status", StatusObject> & EventEmitter & {} & EmitterAugmentation1<"data", unknown> & IntermediateObjectReadable<unknown> & {
            error?: Error;
        };
    }>

close

  • close(timeout?): Promise<null>

  • Returns a promise that the worker has stopped accepting tasks and has drained all current active tasks. Will reject if you try to call it more than once.

    -

    Parameters

    • Optional timeout: number

    Returns Promise<null>

Private completeJob

  • completeJob(jobKey, completedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

  • Parameters

    • jobKey: string
    • completedVariables: {} = {}

      Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    debug

    Protected drainOne

    emit

    • emit<K>(eventName, params?): void

    • Type Parameters

      • K extends EventKey<{
            close: "close";
            connectionError: "connectionError";
            ready: "ready";
            unknown: "unknown";
        }>

      Parameters

      • eventName: K
      • Optional params: {
            close: "close";
            connectionError: "connectionError";
            ready: "ready";
            unknown: "unknown";
        }[K]

      Returns void

    error

    Private errorJob

    Private failJob

    Private handleJobResponse

    Protected handleJobs

    Private handleStreamEnd

    log

    Protected makeCompleteHandlers

    off

    on

    Private poll

    removeAllListeners

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • Optional timeout: number

    Returns Promise<null>

    Private completeJob

    • completeJob(jobKey, completedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    • Parameters

      • jobKey: string
      • completedVariables: {} = {}

        Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

      debug

      Protected drainOne

      emit

      • emit<K>(eventName, params?): void

      • Type Parameters

        • K extends EventKey<{
              close: "close";
              connectionError: "connectionError";
              ready: "ready";
              unknown: "unknown";
          }>

        Parameters

        • eventName: K
        • Optional params: {
              close: "close";
              connectionError: "connectionError";
              ready: "ready";
              unknown: "unknown";
          }[K]

        Returns void

      error

      Private errorJob

      Private failJob

      Private handleJobResponse

      Protected handleJobs

      Private handleStreamEnd

      log

      Protected makeCompleteHandlers

      off

      on

      Private poll

      removeAllListeners

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/classes/zeebe_types._internal_.GrpcClient.html b/classes/zeebe_types._internal_.GrpcClient.html index bc04ad9e..257e799d 100644 --- a/classes/zeebe_types._internal_.GrpcClient.html +++ b/classes/zeebe_types._internal_.GrpcClient.html @@ -1,4 +1,4 @@ -GrpcClient | @camunda8/sdk

      Class GrpcClient

      Hierarchy (view full)

      Constructors

      constructor +GrpcClient | @camunda8/sdk

      Class GrpcClient

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      channelClosed channelState client @@ -23,7 +23,7 @@ setNotReady setReady waitForGrpcChannelReconnect -

      Constructors

      constructor

      Properties

      channelClosed

      channelClosed: boolean = false

      Private channelState

      channelState: number = 0

      client

      client: Client

      Private closing

      closing: boolean = false

      Private config

      config: {
          CAMUNDA_CONSOLE_BASE_URL: undefined | string;
          CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
          CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
          CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
          CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
          CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
          CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
          CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
          CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
          CAMUNDA_MODELER_BASE_URL: string;
          CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
          CAMUNDA_OAUTH_DISABLED: boolean;
          CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
          CAMUNDA_OAUTH_URL: undefined | string;
          CAMUNDA_OPERATE_BASE_URL: undefined | string;
          CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
          CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
          CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
          CAMUNDA_SECURE_CONNECTION: boolean;
          CAMUNDA_TASKLIST_BASE_URL: undefined | string;
          CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
          CAMUNDA_TENANT_ID: undefined | string;
          CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
          CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
          CAMUNDA_TOKEN_SCOPE: undefined | string;
          CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
          ZEEBE_ADDRESS: string;
          ZEEBE_CLIENT_ID: undefined | string;
          ZEEBE_CLIENT_SECRET: undefined | string;
          zeebeGrpcSettings: {
              GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
              GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
              GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
              GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
              GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
              GRPC_KEEPALIVE_TIMEOUT_MS: number;
              GRPC_KEEPALIVE_TIME_MS: number;
              GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
              GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
              ZEEBE_CLIENT_LOG_LEVEL: string;
              ZEEBE_CLIENT_LOG_TYPE: string;
              ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
              ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
              ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
              ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
              ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
              ZEEBE_GRPC_CLIENT_RETRY: boolean;
              ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
              ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
          };
      }

      Type declaration

      • CAMUNDA_CONSOLE_BASE_URL: undefined | string

        The base url for the Admin Console API.

        +

      Constructors

      constructor

      Properties

      channelClosed

      channelClosed: boolean = false

      Private channelState

      channelState: number = 0

      client

      client: Client

      Private closing

      closing: boolean = false

      Private config

      config: {
          CAMUNDA_CONSOLE_BASE_URL: undefined | string;
          CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
          CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
          CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
          CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
          CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
          CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
          CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
          CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
          CAMUNDA_MODELER_BASE_URL: string;
          CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string;
          CAMUNDA_OAUTH_DISABLED: boolean;
          CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
          CAMUNDA_OAUTH_URL: undefined | string;
          CAMUNDA_OPERATE_BASE_URL: undefined | string;
          CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
          CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
          CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
          CAMUNDA_SECURE_CONNECTION: boolean;
          CAMUNDA_TASKLIST_BASE_URL: undefined | string;
          CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
          CAMUNDA_TENANT_ID: undefined | string;
          CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
          CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
          CAMUNDA_TOKEN_SCOPE: undefined | string;
          CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string;
          ZEEBE_ADDRESS: string;
          ZEEBE_CLIENT_ID: undefined | string;
          ZEEBE_CLIENT_SECRET: undefined | string;
          zeebeGrpcSettings: {
              GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
              GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
              GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
              GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number;
              GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
              GRPC_KEEPALIVE_TIMEOUT_MS: number;
              GRPC_KEEPALIVE_TIME_MS: number;
              GRPC_MAX_RECONNECT_BACKOFF_MS: string | number;
              GRPC_MIN_RECONNECT_BACKOFF_MS: string | number;
              ZEEBE_CLIENT_LOG_LEVEL: string;
              ZEEBE_CLIENT_LOG_TYPE: string;
              ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
              ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
              ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
              ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
              ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
              ZEEBE_GRPC_CLIENT_RETRY: boolean;
              ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
              ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
          };
      }

      Type declaration

      • CAMUNDA_CONSOLE_BASE_URL: undefined | string

        The base url for the Admin Console API.

      • CAMUNDA_CONSOLE_CLIENT_ID: undefined | string

        Credentials for Admin Console and Modeler API

      • CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string

        Credentials for Admin Console and Modeler API

      • CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string

        The audience parameter for an Admin Console OAuth token request. Defaults to api.cloud.camunda.io when connecting to Camunda SaaS, and '' otherwise

        @@ -90,4 +90,4 @@
      • ZEEBE_GRPC_CLIENT_RETRY: boolean

        Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true

      • ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number

        How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60

      • ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number

        After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300

        -

      connected

      connected: boolean = false

      Private connectionTolerance

      connectionTolerance: number

      Private Optional failTimer

      failTimer?: Timeout

      Private gRPCRetryCount

      gRPCRetryCount: number = 0

      host

      host: string

      Private listNameMethods

      listNameMethods: string[]

      Optional longPoll

      longPoll?: MaybeTimeDuration

      Private Optional oAuth

      oAuth?: IOAuthProvider

      Private packageDefinition

      packageDefinition: PackageDefinition

      Private Optional readyTimer

      readyTimer?: Timeout

      Private userAgentString

      userAgentString: string

      Methods

      close

      Private getAuthToken

      Private interceptor

      listMethods

      runService

      Private setNotReady

      Private setReady

      Private waitForGrpcChannelReconnect

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      connected

      connected: boolean = false

      Private connectionTolerance

      connectionTolerance: number

      Private Optional failTimer

      failTimer?: Timeout

      Private gRPCRetryCount

      gRPCRetryCount: number = 0

      host

      host: string

      Private listNameMethods

      listNameMethods: string[]

      Optional longPoll

      longPoll?: MaybeTimeDuration

      Private Optional oAuth

      oAuth?: IOAuthProvider

      Private packageDefinition

      packageDefinition: PackageDefinition

      Private Optional readyTimer

      readyTimer?: Timeout

      Private userAgentString

      userAgentString: string

      Methods

      close

      Private getAuthToken

      Private interceptor

      listMethods

      runService

      Private setNotReady

      Private setReady

      Private waitForGrpcChannelReconnect

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/enums/index.Zeebe.Types.PartitionBrokerHealth.html b/enums/index.Zeebe.Types.PartitionBrokerHealth.html index 20f44964..94656610 100644 --- a/enums/index.Zeebe.Types.PartitionBrokerHealth.html +++ b/enums/index.Zeebe.Types.PartitionBrokerHealth.html @@ -1,5 +1,5 @@ PartitionBrokerHealth | @camunda8/sdk

      Enumeration PartitionBrokerHealth

      Describes the current health of the partition

      -

      Enumeration Members

      DEAD +

      Enumeration Members

      DEAD HEALTHY UNHEALTHY -

      Enumeration Members

      DEAD

      DEAD: 2

      HEALTHY

      HEALTHY: 0

      UNHEALTHY

      UNHEALTHY: 1

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Enumeration Members

      DEAD

      DEAD: 2

      HEALTHY

      HEALTHY: 0

      UNHEALTHY

      UNHEALTHY: 1

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/enums/index.Zeebe.Types.PartitionBrokerRole.html b/enums/index.Zeebe.Types.PartitionBrokerRole.html index 939b16b3..1f26f784 100644 --- a/enums/index.Zeebe.Types.PartitionBrokerRole.html +++ b/enums/index.Zeebe.Types.PartitionBrokerRole.html @@ -1,5 +1,5 @@ PartitionBrokerRole | @camunda8/sdk

      Enumeration PartitionBrokerRole

      Describes the Raft role of the broker for a given partition

      -

      Enumeration Members

      BROKER +

      Enumeration Members

      BROKER INACTIVE LEADER -

      Enumeration Members

      BROKER

      BROKER: 1

      INACTIVE

      INACTIVE: 2

      LEADER

      LEADER: 0

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Enumeration Members

      BROKER

      BROKER: 1

      INACTIVE

      INACTIVE: 2

      LEADER

      LEADER: 0

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/index.html b/index.html index 0442e138..5cf4dfc9 100644 --- a/index.html +++ b/index.html @@ -32,7 +32,7 @@

      You can turn off the disk caching by setting CAMUNDA_TOKEN_DISK_CACHE_DISABLE to true. This will cache tokens in-memory only.

      By default, the token cache directory is $HOME/.camunda. You can specify a different directory by providing a full file path value for CAMUNDA_TOKEN_CACHE_DIR.

      Here is an example of specifying a different cache directory via the constructor:

      -
      import { Camunda8 } from '@camunda8/sdk'

      const c8 = new Camunda8({
          config: {
              CAMUNDA_TOKEN_CACHE_DIR: '/tmp/cache',
          },
      })
+
      import { Camunda8 } from '@camunda8/sdk'

      const c8 = new Camunda8({
          CAMUNDA_TOKEN_CACHE_DIR: '/tmp/cache',
      })
 
      
 
      If the cache directory does not exist, the SDK will attempt to create it (recursively). If the SDK is unable to create it, or the directory exists but is not writeable by your application, the SDK will throw an exception.
      
 
      Connection configuration examples
      Self-Managed
      This is the complete environment configuration needed to run against the Dockerised Self-Managed stack in the docker subdirectory:
      
@@ -42,7 +42,7 @@
 
      CAMUNDA_TOKEN_SCOPE
 
      
 
      Here is an example of doing this via the constructor, rather than via the environment:
      
-
      import { Camunda8 } from '@camunda8/sdk'

      const c8 = new Camunda8({
        config: {
          ZEEBE_ADDRESS: 'localhost:26500'
          ZEEBE_CLIENT_ID: 'zeebe'
          ZEEBE_CLIENT_SECRET: 'zecret'
          CAMUNDA_OAUTH_URL: 'http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token'
          CAMUNDA_TASKLIST_BASE_URL: 'http://localhost:8082'
          CAMUNDA_OPERATE_BASE_URL: 'http://localhost:8081'
          CAMUNDA_OPTIMIZE_BASE_URL: 'http://localhost:8083'
          CAMUNDA_MODELER_BASE_URL: 'http://localhost:8070/api'
          CAMUNDA_TENANT_ID: '' // We can override values in the env by passing an empty string value
          CAMUNDA_SECURE_CONNECTION: false
        }
      })
+
      import { Camunda8 } from '@camunda8/sdk'

      const c8 = new Camunda8({
          ZEEBE_ADDRESS: 'localhost:26500'
          ZEEBE_CLIENT_ID: 'zeebe'
          ZEEBE_CLIENT_SECRET: 'zecret'
          CAMUNDA_OAUTH_URL: 'http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token'
          CAMUNDA_TASKLIST_BASE_URL: 'http://localhost:8082'
          CAMUNDA_OPERATE_BASE_URL: 'http://localhost:8081'
          CAMUNDA_OPTIMIZE_BASE_URL: 'http://localhost:8083'
          CAMUNDA_MODELER_BASE_URL: 'http://localhost:8070/api'
          CAMUNDA_TENANT_ID: '' // We can override values in the env by passing an empty string value
          CAMUNDA_SECURE_CONNECTION: false
      })
 
      
 
      Camunda SaaS
      Here is a complete configuration example for connection to Camunda SaaS:
      
 
      export ZEEBE_ADDRESS='5c34c0a7-7f29-4424-8414-125615f7a9b9.syd-1.zeebe.camunda.io:443'
      export ZEEBE_CLIENT_ID='yvvURO9TmBnP3zx4Xd8Ho6apgeiZTjn6'
      export ZEEBE_CLIENT_SECRET='iJJu-SHgUtuJTTAMnMLdcb8WGF8s2mHfXhXutEwe8eSbLXn98vUpoxtuLk5uG0en'
      # export CAMUNDA_CREDENTIALS_SCOPES='Zeebe,Tasklist,Operate,Optimize' # What APIs these client creds are authorised for
      export CAMUNDA_TASKLIST_BASE_URL='https://syd-1.tasklist.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
      export CAMUNDA_OPTIMIZE_BASE_URL='https://syd-1.optimize.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
      export CAMUNDA_OPERATE_BASE_URL='https://syd-1.operate.camunda.io/5c34c0a7-7f29-4424-8414-125615f7a9b9'
      export CAMUNDA_OAUTH_URL='https://login.cloud.camunda.io/oauth/token'

      # This is on by default, but we include it in case it got turned off for local tests
      export CAMUNDA_SECURE_CONNECTION=true

      # Admin Console and Modeler API Client
      export CAMUNDA_CONSOLE_CLIENT_ID='e-JdgKfJy9hHSXzi'
      export CAMUNDA_CONSOLE_CLIENT_SECRET='DT8Pe-ANC6e3Je_ptLyzZvBNS0aFwaIV'
      export CAMUNDA_CONSOLE_BASE_URL='https://api.cloud.camunda.io'
      export CAMUNDA_CONSOLE_OAUTH_AUDIENCE='api.cloud.camunda.io'
diff --git a/interfaces/index.Admin.AdminDto.Cluster.html b/interfaces/index.Admin.AdminDto.Cluster.html
index ca8124c2..856afb3f 100644
--- a/interfaces/index.Admin.AdminDto.Cluster.html
+++ b/interfaces/index.Admin.AdminDto.Cluster.html
@@ -1,4 +1,4 @@
-Cluster | @camunda8/sdk
      Interface Cluster
      interface Cluster { 
          channel: { 
              name: string; 
              uuid: string; 
          }; 
          created: string; 
          generation: { 
              name: string; 
              uuid: string; 
          }; 
          links: { 
              connectors: string; 
              console: string; 
              operate: string; 
              optimize: string; 
              tasklist: string; 
              zeebe: string; 
          }; 
          name: string; 
          ownerId: string; 
          planType: { 
              name: string; 
              uuid: string; 
          }; 
          region: { 
              name: string; 
              uuid: string; 
          }; 
          status: { 
              operateStatus: ClusterStatusstring; 
              optimizeStatus: ClusterStatusstring; 
              ready: ClusterStatusstring; 
              tasklistStatus: ClusterStatusstring; 
              zeebeStatus: ClusterStatusstring; 
          }; 
          uuid: string; 
      }
      Properties
      channel
+Cluster | @camunda8/sdk
      Interface Cluster
      interface Cluster { 
          channel: { 
              name: string; 
              uuid: string; 
          }; 
          created: string; 
          generation: { 
              name: string; 
              uuid: string; 
          }; 
          links: { 
              connectors: string; 
              console: string; 
              operate: string; 
              optimize: string; 
              tasklist: string; 
              zeebe: string; 
          }; 
          name: string; 
          ownerId: string; 
          planType: { 
              name: string; 
              uuid: string; 
          }; 
          region: { 
              name: string; 
              uuid: string; 
          }; 
          status: { 
              operateStatus: ClusterStatusstring; 
              optimizeStatus: ClusterStatusstring; 
              ready: ClusterStatusstring; 
              tasklistStatus: ClusterStatusstring; 
              zeebeStatus: ClusterStatusstring; 
          }; 
          uuid: string; 
      }
      Properties
      channel
 created
 generation
 links
@@ -8,4 +8,4 @@
 region
 status
 uuid
-
      Properties
      channel
      channel: { 
          name: string; 
          uuid: string; 
      }
      Type declaration
      • name: string
      • uuid: string
      created
      created: string
      generation
      generation: { 
          name: string; 
          uuid: string; 
      }
      Type declaration
      • name: string
      • uuid: string
      links
      links: { 
          connectors: string; 
          console: string; 
          operate: string; 
          optimize: string; 
          tasklist: string; 
          zeebe: string; 
      }
      Type declaration
      • connectors: string
      • console: string
      • operate: string
      • optimize: string
      • tasklist: string
      • zeebe: string
      name
      name: string
      ownerId
      ownerId: string
      planType
      planType: { 
          name: string; 
          uuid: string; 
      }
      Type declaration
      • name: string
      • uuid: string
      region
      region: { 
          name: string; 
          uuid: string; 
      }
      Type declaration
      • name: string
      • uuid: string
      status
      status: { 
          operateStatus: ClusterStatusstring; 
          optimizeStatus: ClusterStatusstring; 
          ready: ClusterStatusstring; 
          tasklistStatus: ClusterStatusstring; 
          zeebeStatus: ClusterStatusstring; 
      }
      Type declaration
      uuid
      uuid: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      channel
      channel: { 
          name: string; 
          uuid: string; 
      }
      Type declaration
      • name: string
      • uuid: string
      created
      created: string
      generation
      generation: { 
          name: string; 
          uuid: string; 
      }
      Type declaration
      • name: string
      • uuid: string
      links
      links: { 
          connectors: string; 
          console: string; 
          operate: string; 
          optimize: string; 
          tasklist: string; 
          zeebe: string; 
      }
      Type declaration
      • connectors: string
      • console: string
      • operate: string
      • optimize: string
      • tasklist: string
      • zeebe: string
      name
      name: string
      ownerId
      ownerId: string
      planType
      planType: { 
          name: string; 
          uuid: string; 
      }
      Type declaration
      • name: string
      • uuid: string
      region
      region: { 
          name: string; 
          uuid: string; 
      }
      Type declaration
      • name: string
      • uuid: string
      status
      status: { 
          operateStatus: ClusterStatusstring; 
          optimizeStatus: ClusterStatusstring; 
          ready: ClusterStatusstring; 
          tasklistStatus: ClusterStatusstring; 
          zeebeStatus: ClusterStatusstring; 
      }
      Type declaration
      uuid
      uuid: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Admin.AdminDto.ClusterClient.html b/interfaces/index.Admin.AdminDto.ClusterClient.html
index 197dce95..9f2c6fc3 100644
--- a/interfaces/index.Admin.AdminDto.ClusterClient.html
+++ b/interfaces/index.Admin.AdminDto.ClusterClient.html
@@ -1,4 +1,4 @@
-ClusterClient | @camunda8/sdk
      Interface ClusterClient
      interface ClusterClient { 
          clientId: string; 
          name: string; 
          permissions: ("Zeebe" | "Operate" | "Tasklist")[]; 
      }
      Properties
      clientId
+ClusterClient | @camunda8/sdk
      Interface ClusterClient
      interface ClusterClient { 
          clientId: string; 
          name: string; 
          permissions: ("Zeebe" | "Operate" | "Tasklist")[]; 
      }
      Properties
      clientId
 name
 permissions
-
      Properties
      clientId
      clientId: string
      name
      name: string
      permissions
      permissions: ("Zeebe" | "Operate" | "Tasklist")[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      clientId
      clientId: string
      name
      name: string
      permissions
      permissions: ("Zeebe" | "Operate" | "Tasklist")[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Admin.AdminDto.ClusterClientConnectionDetails.html b/interfaces/index.Admin.AdminDto.ClusterClientConnectionDetails.html
index 7d0a6e6d..58455df3 100644
--- a/interfaces/index.Admin.AdminDto.ClusterClientConnectionDetails.html
+++ b/interfaces/index.Admin.AdminDto.ClusterClientConnectionDetails.html
@@ -1,5 +1,5 @@
-ClusterClientConnectionDetails | @camunda8/sdk
      Interface ClusterClientConnectionDetails
      interface ClusterClientConnectionDetails { 
          ZEEBE_ADDRESS: string; 
          ZEEBE_AUTHORIZATION_SERVER_URL: string; 
          ZEEBE_CLIENT_ID: string; 
          name: string; 
      }
      Properties
      ZEEBE_ADDRESS
+ClusterClientConnectionDetails | @camunda8/sdk
      Interface ClusterClientConnectionDetails
      interface ClusterClientConnectionDetails { 
          ZEEBE_ADDRESS: string; 
          ZEEBE_AUTHORIZATION_SERVER_URL: string; 
          ZEEBE_CLIENT_ID: string; 
          name: string; 
      }
      Properties
      ZEEBE_ADDRESS
 ZEEBE_AUTHORIZATION_SERVER_URL
 ZEEBE_CLIENT_ID
 name
-
      Properties
      ZEEBE_ADDRESS
      ZEEBE_ADDRESS: string
      ZEEBE_AUTHORIZATION_SERVER_URL
      ZEEBE_AUTHORIZATION_SERVER_URL: string
      ZEEBE_CLIENT_ID
      ZEEBE_CLIENT_ID: string
      name
      name: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      ZEEBE_ADDRESS
      ZEEBE_ADDRESS: string
      ZEEBE_AUTHORIZATION_SERVER_URL
      ZEEBE_AUTHORIZATION_SERVER_URL: string
      ZEEBE_CLIENT_ID
      ZEEBE_CLIENT_ID: string
      name
      name: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Admin.AdminDto.CreateClusterBody.html b/interfaces/index.Admin.AdminDto.CreateClusterBody.html
index 3b8e07e5..13eb07ab 100644
--- a/interfaces/index.Admin.AdminDto.CreateClusterBody.html
+++ b/interfaces/index.Admin.AdminDto.CreateClusterBody.html
@@ -1,6 +1,6 @@
-CreateClusterBody | @camunda8/sdk
      Interface CreateClusterBody
      interface CreateClusterBody { 
          channelId: string; 
          generationId: string; 
          name: string; 
          planTypeId: string; 
          regionId: string; 
      }
      Properties
      channelId
+CreateClusterBody | @camunda8/sdk
      Interface CreateClusterBody
      interface CreateClusterBody { 
          channelId: string; 
          generationId: string; 
          name: string; 
          planTypeId: string; 
          regionId: string; 
      }
      Properties
      channelId
 generationId
 name
 planTypeId
 regionId
-
      Properties
      channelId
      channelId: string
      generationId
      generationId: string
      name
      name: string
      planTypeId
      planTypeId: string
      regionId
      regionId: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      channelId
      channelId: string
      generationId
      generationId: string
      name
      name: string
      planTypeId
      planTypeId: string
      regionId
      regionId: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Admin.AdminDto.CreatedClusterClient.html b/interfaces/index.Admin.AdminDto.CreatedClusterClient.html
index 2eaf887a..9822761c 100644
--- a/interfaces/index.Admin.AdminDto.CreatedClusterClient.html
+++ b/interfaces/index.Admin.AdminDto.CreatedClusterClient.html
@@ -1,4 +1,4 @@
-CreatedClusterClient | @camunda8/sdk
      Interface CreatedClusterClient
      interface CreatedClusterClient { 
          clientId: string; 
          clientSecret: string; 
          uuid: string; 
      }
      Properties
      clientId
+CreatedClusterClient | @camunda8/sdk
      Interface CreatedClusterClient
      interface CreatedClusterClient { 
          clientId: string; 
          clientSecret: string; 
          uuid: string; 
      }
      Properties
      clientId
 clientSecret
 uuid
-
      Properties
      clientId
      clientId: string
      clientSecret
      clientSecret: string
      uuid
      uuid: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      clientId
      clientId: string
      clientSecret
      clientSecret: string
      uuid
      uuid: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Admin.AdminDto.Member.html b/interfaces/index.Admin.AdminDto.Member.html
index afe85bf9..c40c4e59 100644
--- a/interfaces/index.Admin.AdminDto.Member.html
+++ b/interfaces/index.Admin.AdminDto.Member.html
@@ -1,5 +1,5 @@
-Member | @camunda8/sdk
      Interface Member
      interface Member { 
          email: string; 
          invitePending: boolean; 
          name: string; 
          roles: OrganizationRole[]; 
      }
      Properties
      email
+Member | @camunda8/sdk
      Interface Member
      interface Member { 
          email: string; 
          invitePending: boolean; 
          name: string; 
          roles: OrganizationRole[]; 
      }
      Properties
      email
 invitePending
 name
 roles
-
      Properties
      email
      email: string
      invitePending
      invitePending: boolean
      name
      name: string
      roles
      roles: OrganizationRole[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      email
      email: string
      invitePending
      invitePending: boolean
      name
      name: string
      roles
      roles: OrganizationRole[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Admin.AdminDto.Parameters.html b/interfaces/index.Admin.AdminDto.Parameters.html
index ebc5d614..20da2eab 100644
--- a/interfaces/index.Admin.AdminDto.Parameters.html
+++ b/interfaces/index.Admin.AdminDto.Parameters.html
@@ -1,4 +1,4 @@
-Parameters | @camunda8/sdk
      Interface Parameters
      interface Parameters { 
          channels: [{ 
              allowedGenerations: [{ 
                  name: string; 
                  uuid: string; 
              }]; 
              defaultGeneration: { 
                  name: string; 
                  uuid: string; 
              }; 
              name: string; 
              uuid: string; 
          }]; 
          clusterPlanTypes: [{ 
              name: string; 
              uuid: string; 
          }]; 
          regions: [{ 
              name: string; 
              uuid: string; 
          }]; 
      }
      Properties
      channels
+Parameters | @camunda8/sdk
      Interface Parameters
      interface Parameters { 
          channels: [{ 
              allowedGenerations: [{ 
                  name: string; 
                  uuid: string; 
              }]; 
              defaultGeneration: { 
                  name: string; 
                  uuid: string; 
              }; 
              name: string; 
              uuid: string; 
          }]; 
          clusterPlanTypes: [{ 
              name: string; 
              uuid: string; 
          }]; 
          regions: [{ 
              name: string; 
              uuid: string; 
          }]; 
      }
      Properties
      channels
 clusterPlanTypes
 regions
-
      Properties
      channels
      channels: [{ 
          allowedGenerations: [{ 
              name: string; 
              uuid: string; 
          }]; 
          defaultGeneration: { 
              name: string; 
              uuid: string; 
          }; 
          name: string; 
          uuid: string; 
      }]
      Type declaration
      • allowedGenerations: [{ 
            name: string; 
            uuid: string; 
        }]
      • defaultGeneration: { 
            name: string; 
            uuid: string; 
        }
        • name: string
        • uuid: string
      • name: string
      • uuid: string
      clusterPlanTypes
      clusterPlanTypes: [{ 
          name: string; 
          uuid: string; 
      }]
      Type declaration
      • name: string
      • uuid: string
      regions
      regions: [{ 
          name: string; 
          uuid: string; 
      }]
      Type declaration
      • name: string
      • uuid: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      channels
      channels: [{ 
          allowedGenerations: [{ 
              name: string; 
              uuid: string; 
          }]; 
          defaultGeneration: { 
              name: string; 
              uuid: string; 
          }; 
          name: string; 
          uuid: string; 
      }]
      Type declaration
      • allowedGenerations: [{ 
            name: string; 
            uuid: string; 
        }]
      • defaultGeneration: { 
            name: string; 
            uuid: string; 
        }
        • name: string
        • uuid: string
      • name: string
      • uuid: string
      clusterPlanTypes
      clusterPlanTypes: [{ 
          name: string; 
          uuid: string; 
      }]
      Type declaration
      • name: string
      • uuid: string
      regions
      regions: [{ 
          name: string; 
          uuid: string; 
      }]
      Type declaration
      • name: string
      • uuid: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Auth.IOAuthProvider.html b/interfaces/index.Auth.IOAuthProvider.html
index 1433b0f0..955c11f4 100644
--- a/interfaces/index.Auth.IOAuthProvider.html
+++ b/interfaces/index.Auth.IOAuthProvider.html
@@ -1,2 +1,2 @@
-IOAuthProvider | @camunda8/sdk
      Interface IOAuthProvider
      interface IOAuthProvider { 
          getToken(audience): Promise<string>; 
      }
      Implemented by
      Methods
      getToken
-
      Methods
      getToken
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+IOAuthProvider | @camunda8/sdk
      Interface IOAuthProvider
      interface IOAuthProvider { 
          getToken(audience): Promise<string>; 
      }
      Implemented by
      Methods
      getToken
+
      Methods
      getToken
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Auth.Token.html b/interfaces/index.Auth.Token.html
index fa17e497..fa953a6d 100644
--- a/interfaces/index.Auth.Token.html
+++ b/interfaces/index.Auth.Token.html
@@ -1,7 +1,7 @@
-Token | @camunda8/sdk
      Interface Token
      interface Token { 
          access_token: string; 
          audience: string; 
          expires_in: number; 
          expiry: number; 
          scope: string; 
          token_type: string; 
      }
      Properties
      access_token
+Token | @camunda8/sdk
      Interface Token
      interface Token { 
          access_token: string; 
          audience: string; 
          expires_in: number; 
          expiry: number; 
          scope: string; 
          token_type: string; 
      }
      Properties
      access_token
 audience
 expires_in
 expiry
 scope
 token_type
-
      Properties
      access_token
      access_token: string
      audience
      audience: string
      expires_in
      expires_in: number
      expiry
      expiry: number
      scope
      scope: string
      token_type
      token_type: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      access_token
      access_token: string
      audience
      audience: string
      expires_in
      expires_in: number
      expiry
      expiry: number
      scope
      scope: string
      token_type
      token_type: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Auth.TokenError.html b/interfaces/index.Auth.TokenError.html
index 946dc654..143b2415 100644
--- a/interfaces/index.Auth.TokenError.html
+++ b/interfaces/index.Auth.TokenError.html
@@ -1,3 +1,3 @@
-TokenError | @camunda8/sdk
      Interface TokenError
      interface TokenError { 
          error: string; 
          error_description: string; 
      }
      Properties
      error
+TokenError | @camunda8/sdk
      Interface TokenError
      interface TokenError { 
          error: string; 
          error_description: string; 
      }
      Properties
      error
 error_description
-
      Properties
      error
      error: string
      error_description
      error_description: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      error
      error: string
      error_description
      error_description: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.CreateCollaboratorDto.html b/interfaces/index.Modeler.ModelerDto.CreateCollaboratorDto.html
index 81362193..6046ef3c 100644
--- a/interfaces/index.Modeler.ModelerDto.CreateCollaboratorDto.html
+++ b/interfaces/index.Modeler.ModelerDto.CreateCollaboratorDto.html
@@ -1,4 +1,4 @@
-CreateCollaboratorDto | @camunda8/sdk
      Interface CreateCollaboratorDto
      interface CreateCollaboratorDto { 
          email: string; 
          projectId: string; 
          role: "project_admin" | "editor" | "viewer" | "commenter"; 
      }
      Properties
      email
+CreateCollaboratorDto | @camunda8/sdk
      Interface CreateCollaboratorDto
      interface CreateCollaboratorDto { 
          email: string; 
          projectId: string; 
          role: "project_admin" | "editor" | "viewer" | "commenter"; 
      }
      Properties
      email
 projectId
 role
-
      Properties
      email
      email: string
      projectId
      projectId: string
      role
      role: "project_admin" | "editor" | "viewer" | "commenter"
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      email
      email: string
      projectId
      projectId: string
      role
      role: "project_admin" | "editor" | "viewer" | "commenter"
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.CreateFileDto.html b/interfaces/index.Modeler.ModelerDto.CreateFileDto.html
index 1d817e21..dd1aecb7 100644
--- a/interfaces/index.Modeler.ModelerDto.CreateFileDto.html
+++ b/interfaces/index.Modeler.ModelerDto.CreateFileDto.html
@@ -1,10 +1,10 @@
-CreateFileDto | @camunda8/sdk
      Interface CreateFileDto
      interface CreateFileDto { 
          content: string; 
          fileType: string; 
          folderId: string; 
          name: string; 
          pattern: "form" | "bpmn" | "dmn" | "connector_template"; 
          projectId: string; 
      }
      Properties
      content
+CreateFileDto | @camunda8/sdk
      Interface CreateFileDto
      interface CreateFileDto { 
          content: string; 
          fileType: string; 
          folderId: string; 
          name: string; 
          pattern: "form" | "bpmn" | "dmn" | "connector_template"; 
          projectId: string; 
      }
      Properties
      content
 fileType
 folderId
 name
 pattern
 projectId
-
      Properties
      content
      content: string
      fileType
      fileType: string
      folderId
      folderId: string
      maxLength: 255, minLength: 1
      
-
      name
      name: string
      maxLength: 255, minLength: 1
      
-
      pattern
      pattern: "form" | "bpmn" | "dmn" | "connector_template"
      projectId
      projectId: string
      maxLength: 255, minLength: 1
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      content
      content: string
      fileType
      fileType: string
      folderId
      folderId: string
      maxLength: 255, minLength: 1
      
+
      name
      name: string
      maxLength: 255, minLength: 1
      
+
      pattern
      pattern: "form" | "bpmn" | "dmn" | "connector_template"
      projectId
      projectId: string
      maxLength: 255, minLength: 1
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.CreateFolderDto.html b/interfaces/index.Modeler.ModelerDto.CreateFolderDto.html
index 9df7cd71..016cd020 100644
--- a/interfaces/index.Modeler.ModelerDto.CreateFolderDto.html
+++ b/interfaces/index.Modeler.ModelerDto.CreateFolderDto.html
@@ -1,7 +1,7 @@
-CreateFolderDto | @camunda8/sdk
      Interface CreateFolderDto
      interface CreateFolderDto { 
          name: string; 
          parentId: string; 
          projectId: string; 
      }
      Properties
      name
+CreateFolderDto | @camunda8/sdk
      Interface CreateFolderDto
      interface CreateFolderDto { 
          name: string; 
          parentId: string; 
          projectId: string; 
      }
      Properties
      name
 parentId
 projectId
 
      Properties
      name
      name: string
      maxLength: 255 minLength: 1
      
-
      parentId
      parentId: string
      maxLength: 255 minLength: 1
      
-
      projectId
      projectId: string
      maxLength: 255 minLength: 1
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      parentId
      parentId: string
      maxLength: 255 minLength: 1
      
+
      projectId
      projectId: string
      maxLength: 255 minLength: 1
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.CreateMilestoneDto.html b/interfaces/index.Modeler.ModelerDto.CreateMilestoneDto.html
index 015ee3ff..49c4fabd 100644
--- a/interfaces/index.Modeler.ModelerDto.CreateMilestoneDto.html
+++ b/interfaces/index.Modeler.ModelerDto.CreateMilestoneDto.html
@@ -1,5 +1,5 @@
-CreateMilestoneDto | @camunda8/sdk
      Interface CreateMilestoneDto
      interface CreateMilestoneDto { 
          fileId: string; 
          name: string; 
      }
      Properties
      fileId
+CreateMilestoneDto | @camunda8/sdk
      Interface CreateMilestoneDto
      interface CreateMilestoneDto { 
          fileId: string; 
          name: string; 
      }
      Properties
      fileId
 name
 
      Properties
      fileId
      fileId: string
      maxLength: 255 minLength: 1
      
-
      name
      name: string
      maxLength: 255 minLength: 1
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      name
      name: string
      maxLength: 255 minLength: 1
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.FileDto.html b/interfaces/index.Modeler.ModelerDto.FileDto.html
index d395f0af..ee407b0d 100644
--- a/interfaces/index.Modeler.ModelerDto.FileDto.html
+++ b/interfaces/index.Modeler.ModelerDto.FileDto.html
@@ -1,3 +1,3 @@
-FileDto | @camunda8/sdk
      Interface FileDto
      interface FileDto { 
          content: string; 
          metadata: FileMetadataDto; 
      }
      Properties
      content
+FileDto | @camunda8/sdk
      Interface FileDto
      interface FileDto { 
          content: string; 
          metadata: FileMetadataDto; 
      }
      Properties
      content
 metadata
-
      Properties
      content
      content: string
      metadata
      metadata: FileMetadataDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      content
      content: string
      metadata
      metadata: FileMetadataDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.FileMetadataDto.html b/interfaces/index.Modeler.ModelerDto.FileMetadataDto.html
index f29763fe..a168ba97 100644
--- a/interfaces/index.Modeler.ModelerDto.FileMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.FileMetadataDto.html
@@ -1,4 +1,4 @@
-FileMetadataDto | @camunda8/sdk
      Interface FileMetadataDto
      interface FileMetadataDto { 
          canonicalPath: PathElementDto[]; 
          created: string; 
          createdBy: UserDto; 
          folderId: string; 
          id: string; 
          name: string; 
          projectId: string; 
          revision: number; 
          simplePath: string; 
          type: string; 
          updated: string; 
          updatedBy: UserDto; 
      }
      Properties
      canonicalPath
+FileMetadataDto | @camunda8/sdk
      Interface FileMetadataDto
      interface FileMetadataDto { 
          canonicalPath: PathElementDto[]; 
          created: string; 
          createdBy: UserDto; 
          folderId: string; 
          id: string; 
          name: string; 
          projectId: string; 
          revision: number; 
          simplePath: string; 
          type: string; 
          updated: string; 
          updatedBy: UserDto; 
      }
      Properties
      canonicalPath
 created
 createdBy
 folderId
@@ -10,4 +10,4 @@
 type
 updated
 updatedBy
-
      Properties
      canonicalPath
      canonicalPath: PathElementDto[]
      created
      created: string
      createdBy
      createdBy: UserDto
      folderId
      folderId: string
      id
      id: string
      name
      name: string
      projectId
      projectId: string
      revision
      revision: number
      simplePath
      simplePath: string
      type
      type: string
      updated
      updated: string
      updatedBy
      updatedBy: UserDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      canonicalPath
      canonicalPath: PathElementDto[]
      created
      created: string
      createdBy
      createdBy: UserDto
      folderId
      folderId: string
      id
      id: string
      name
      name: string
      projectId
      projectId: string
      revision
      revision: number
      simplePath
      simplePath: string
      type
      type: string
      updated
      updated: string
      updatedBy
      updatedBy: UserDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.FolderContentDto.html b/interfaces/index.Modeler.ModelerDto.FolderContentDto.html
index c3ceed40..aa78003b 100644
--- a/interfaces/index.Modeler.ModelerDto.FolderContentDto.html
+++ b/interfaces/index.Modeler.ModelerDto.FolderContentDto.html
@@ -1,3 +1,3 @@
-FolderContentDto | @camunda8/sdk
      Interface FolderContentDto
      interface FolderContentDto { 
          files: FileMetadataDto[]; 
          folders: FolderMetadataDto[]; 
      }
      Properties
      files
+FolderContentDto | @camunda8/sdk
      Interface FolderContentDto
      interface FolderContentDto { 
          files: FileMetadataDto[]; 
          folders: FolderMetadataDto[]; 
      }
      Properties
      files
 folders
-
      Properties
      files
      files: FileMetadataDto[]
      folders
      folders: FolderMetadataDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      files
      files: FileMetadataDto[]
      folders
      folders: FolderMetadataDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.FolderDto.html b/interfaces/index.Modeler.ModelerDto.FolderDto.html
index af959308..7417066f 100644
--- a/interfaces/index.Modeler.ModelerDto.FolderDto.html
+++ b/interfaces/index.Modeler.ModelerDto.FolderDto.html
@@ -1,3 +1,3 @@
-FolderDto | @camunda8/sdk
      Interface FolderDto
      interface FolderDto { 
          content: FolderContentDto; 
          metadata: FolderMetadataDto; 
      }
      Properties
      content
+FolderDto | @camunda8/sdk
      Interface FolderDto
      interface FolderDto { 
          content: FolderContentDto; 
          metadata: FolderMetadataDto; 
      }
      Properties
      content
 metadata
-
      Properties
      content
      content: FolderContentDto
      metadata
      metadata: FolderMetadataDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      content
      content: FolderContentDto
      metadata
      metadata: FolderMetadataDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.FolderMetadataDto.html b/interfaces/index.Modeler.ModelerDto.FolderMetadataDto.html
index e296f2d7..35e64de9 100644
--- a/interfaces/index.Modeler.ModelerDto.FolderMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.FolderMetadataDto.html
@@ -1,4 +1,4 @@
-FolderMetadataDto | @camunda8/sdk
      Interface FolderMetadataDto
      interface FolderMetadataDto { 
          created: string; 
          createdBy: UserDto; 
          id: string; 
          name: string; 
          parentId: string; 
          projectId: string; 
          updated: string; 
          updatedBy: UserDto; 
      }
      Properties
      created
+FolderMetadataDto | @camunda8/sdk
      Interface FolderMetadataDto
      interface FolderMetadataDto { 
          created: string; 
          createdBy: UserDto; 
          id: string; 
          name: string; 
          parentId: string; 
          projectId: string; 
          updated: string; 
          updatedBy: UserDto; 
      }
      Properties
      created
 createdBy
 id
 name
@@ -6,4 +6,4 @@
 projectId
 updated
 updatedBy
-
      Properties
      created
      created: string
      createdBy
      createdBy: UserDto
      id
      id: string
      name
      name: string
      parentId
      parentId: string
      projectId
      projectId: string
      updated
      updated: string
      updatedBy
      updatedBy: UserDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      created
      created: string
      createdBy
      createdBy: UserDto
      id
      id: string
      name
      name: string
      parentId
      parentId: string
      projectId
      projectId: string
      updated
      updated: string
      updatedBy
      updatedBy: UserDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.InfoDto.html b/interfaces/index.Modeler.ModelerDto.InfoDto.html
index 1788045e..ad5fb4b5 100644
--- a/interfaces/index.Modeler.ModelerDto.InfoDto.html
+++ b/interfaces/index.Modeler.ModelerDto.InfoDto.html
@@ -1,7 +1,7 @@
-InfoDto | @camunda8/sdk
      Interface InfoDto
      interface InfoDto { 
          authorizedOrganization: string; 
          createPermission: boolean; 
          deletePermission: boolean; 
          readPermission: boolean; 
          updatePermission: boolean; 
          version: string; 
      }
      Properties
      authorizedOrganization
+InfoDto | @camunda8/sdk
      Interface InfoDto
      interface InfoDto { 
          authorizedOrganization: string; 
          createPermission: boolean; 
          deletePermission: boolean; 
          readPermission: boolean; 
          updatePermission: boolean; 
          version: string; 
      }
      Properties
      authorizedOrganization
 createPermission
 deletePermission
 readPermission
 updatePermission
 version
-
      Properties
      authorizedOrganization
      authorizedOrganization: string
      createPermission
      createPermission: boolean
      deletePermission
      deletePermission: boolean
      readPermission
      readPermission: boolean
      updatePermission
      updatePermission: boolean
      version
      version: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      authorizedOrganization
      authorizedOrganization: string
      createPermission
      createPermission: boolean
      deletePermission
      deletePermission: boolean
      readPermission
      readPermission: boolean
      updatePermission
      updatePermission: boolean
      version
      version: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.MilestoneDto.html b/interfaces/index.Modeler.ModelerDto.MilestoneDto.html
index c37fadfb..5d92875f 100644
--- a/interfaces/index.Modeler.ModelerDto.MilestoneDto.html
+++ b/interfaces/index.Modeler.ModelerDto.MilestoneDto.html
@@ -1,3 +1,3 @@
-MilestoneDto | @camunda8/sdk
      Interface MilestoneDto
      interface MilestoneDto { 
          content: string; 
          metadata: MilestoneMetadataDto; 
      }
      Properties
      content
+MilestoneDto | @camunda8/sdk
      Interface MilestoneDto
      interface MilestoneDto { 
          content: string; 
          metadata: MilestoneMetadataDto; 
      }
      Properties
      content
 metadata
-
      Properties
      content
      content: string
      metadata
      metadata: MilestoneMetadataDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      content
      content: string
      metadata
      metadata: MilestoneMetadataDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.MilestoneMetadataDto.html b/interfaces/index.Modeler.ModelerDto.MilestoneMetadataDto.html
index 5a2b9fc0..1e8c88ba 100644
--- a/interfaces/index.Modeler.ModelerDto.MilestoneMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.MilestoneMetadataDto.html
@@ -1,8 +1,8 @@
-MilestoneMetadataDto | @camunda8/sdk
      Interface MilestoneMetadataDto
      interface MilestoneMetadataDto { 
          created: string; 
          createdBy: UserDto; 
          fileId: string; 
          id: string; 
          name: string; 
          updated: string; 
          updatedBy: UserDto; 
      }
      Properties
      created
+MilestoneMetadataDto | @camunda8/sdk
      Interface MilestoneMetadataDto
      interface MilestoneMetadataDto { 
          created: string; 
          createdBy: UserDto; 
          fileId: string; 
          id: string; 
          name: string; 
          updated: string; 
          updatedBy: UserDto; 
      }
      Properties
      created
 createdBy
 fileId
 id
 name
 updated
 updatedBy
-
      Properties
      created
      created: string
      createdBy
      createdBy: UserDto
      fileId
      fileId: string
      id
      id: string
      name
      name: string
      updated
      updated: string
      updatedBy
      updatedBy: UserDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      created
      created: string
      createdBy
      createdBy: UserDto
      fileId
      fileId: string
      id
      id: string
      name
      name: string
      updated
      updated: string
      updatedBy
      updatedBy: UserDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.PathElementDto.html b/interfaces/index.Modeler.ModelerDto.PathElementDto.html
index ecddfa5b..23a19843 100644
--- a/interfaces/index.Modeler.ModelerDto.PathElementDto.html
+++ b/interfaces/index.Modeler.ModelerDto.PathElementDto.html
@@ -1,3 +1,3 @@
-PathElementDto | @camunda8/sdk
      Interface PathElementDto
      interface PathElementDto { 
          id: string; 
          name: string; 
      }
      Properties
      id
+PathElementDto | @camunda8/sdk
      Interface PathElementDto
      interface PathElementDto { 
          id: string; 
          name: string; 
      }
      Properties
      id
 name
-
      Properties
      id
      id: string
      name
      name: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      id
      id: string
      name
      name: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.ProjectCollaboratorDto.html b/interfaces/index.Modeler.ModelerDto.ProjectCollaboratorDto.html
index 02b0fb4b..edb1b9a7 100644
--- a/interfaces/index.Modeler.ModelerDto.ProjectCollaboratorDto.html
+++ b/interfaces/index.Modeler.ModelerDto.ProjectCollaboratorDto.html
@@ -1,5 +1,5 @@
-ProjectCollaboratorDto | @camunda8/sdk
      Interface ProjectCollaboratorDto
      interface ProjectCollaboratorDto { 
          email: string; 
          name: string; 
          projectId: string; 
          role: string; 
      }
      Properties
      email
+ProjectCollaboratorDto | @camunda8/sdk
      Interface ProjectCollaboratorDto
      interface ProjectCollaboratorDto { 
          email: string; 
          name: string; 
          projectId: string; 
          role: string; 
      }
      Properties
      email
 name
 projectId
 role
-
      Properties
      email
      email: string
      name
      name: string
      projectId
      projectId: string
      role
      role: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      email
      email: string
      name
      name: string
      projectId
      projectId: string
      role
      role: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.ProjectContent.html b/interfaces/index.Modeler.ModelerDto.ProjectContent.html
index 784c717b..08cf9101 100644
--- a/interfaces/index.Modeler.ModelerDto.ProjectContent.html
+++ b/interfaces/index.Modeler.ModelerDto.ProjectContent.html
@@ -1,3 +1,3 @@
-ProjectContent | @camunda8/sdk
      Interface ProjectContent
      interface ProjectContent { 
          files: FileMetadataDto[]; 
          folders: FolderMetadataDto[]; 
      }
      Properties
      files
+ProjectContent | @camunda8/sdk
      Interface ProjectContent
      interface ProjectContent { 
          files: FileMetadataDto[]; 
          folders: FolderMetadataDto[]; 
      }
      Properties
      files
 folders
-
      Properties
      files
      files: FileMetadataDto[]
      folders
      folders: FolderMetadataDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      files
      files: FileMetadataDto[]
      folders
      folders: FolderMetadataDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.ProjectDto.html b/interfaces/index.Modeler.ModelerDto.ProjectDto.html
index 4f240762..e18adbe7 100644
--- a/interfaces/index.Modeler.ModelerDto.ProjectDto.html
+++ b/interfaces/index.Modeler.ModelerDto.ProjectDto.html
@@ -1,3 +1,3 @@
-ProjectDto | @camunda8/sdk
      Interface ProjectDto
      interface ProjectDto { 
          content: ProjectContent; 
          metadata: ProjectMetadataDto; 
      }
      Properties
      content
+ProjectDto | @camunda8/sdk
      Interface ProjectDto
      interface ProjectDto { 
          content: ProjectContent; 
          metadata: ProjectMetadataDto; 
      }
      Properties
      content
 metadata
-
      Properties
      content
      content: ProjectContent
      metadata
      metadata: ProjectMetadataDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      content
      content: ProjectContent
      metadata
      metadata: ProjectMetadataDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.ProjectMetadataDto.html b/interfaces/index.Modeler.ModelerDto.ProjectMetadataDto.html
index c1ef5cd7..b5bc613b 100644
--- a/interfaces/index.Modeler.ModelerDto.ProjectMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.ProjectMetadataDto.html
@@ -1,7 +1,7 @@
-ProjectMetadataDto | @camunda8/sdk
      Interface ProjectMetadataDto
      interface ProjectMetadataDto { 
          created: string; 
          createdBy: UserDto; 
          id: string; 
          name: string; 
          updated: string; 
          updatedBy: UserDto; 
      }
      Properties
      created
+ProjectMetadataDto | @camunda8/sdk
      Interface ProjectMetadataDto
      interface ProjectMetadataDto { 
          created: string; 
          createdBy: UserDto; 
          id: string; 
          name: string; 
          updated: string; 
          updatedBy: UserDto; 
      }
      Properties
      created
 createdBy
 id
 name
 updated
 updatedBy
-
      Properties
      created
      created: string
      createdBy
      createdBy: UserDto
      id
      id: string
      name
      name: string
      updated
      updated: string
      updatedBy
      updatedBy: UserDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      created
      created: string
      createdBy
      createdBy: UserDto
      id
      id: string
      name
      name: string
      updated
      updated: string
      updatedBy
      updatedBy: UserDto
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.PubSearchDtoFileMetadataDto.html b/interfaces/index.Modeler.ModelerDto.PubSearchDtoFileMetadataDto.html
index 886497c5..d6efab45 100644
--- a/interfaces/index.Modeler.ModelerDto.PubSearchDtoFileMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.PubSearchDtoFileMetadataDto.html
@@ -1,7 +1,7 @@
-PubSearchDtoFileMetadataDto | @camunda8/sdk
      Interface PubSearchDtoFileMetadataDto
      interface PubSearchDtoFileMetadataDto { 
          filter: Partial<FileMetadataDto>; 
          page?: number; 
          size?: number; 
          sort?: SortDto[]; 
      }
      Properties
      filter
+PubSearchDtoFileMetadataDto | @camunda8/sdk
      Interface PubSearchDtoFileMetadataDto
      interface PubSearchDtoFileMetadataDto { 
          filter: Partial<FileMetadataDto>; 
          page?: number; 
          size?: number; 
          sort?: SortDto[]; 
      }
      Properties
      filter
 page?
 size?
 sort?
-
      Properties
      filter
      filter: Partial<FileMetadataDto>
      Optional page
      page?: number
      minimum: 0
      
-
      Optional size
      size?: number
      maximum: 50 minimum: 0
      
-
      Optional sort
      sort?: SortDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      filter
      filter: Partial<FileMetadataDto>
      Optional page
      page?: number
      minimum: 0
      
+
      Optional size
      size?: number
      maximum: 50 minimum: 0
      
+
      Optional sort
      sort?: SortDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.PubSearchDtoMilestoneMetadataDto.html b/interfaces/index.Modeler.ModelerDto.PubSearchDtoMilestoneMetadataDto.html
index fd40c828..d5d224bd 100644
--- a/interfaces/index.Modeler.ModelerDto.PubSearchDtoMilestoneMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.PubSearchDtoMilestoneMetadataDto.html
@@ -1,7 +1,7 @@
-PubSearchDtoMilestoneMetadataDto | @camunda8/sdk
      Interface PubSearchDtoMilestoneMetadataDto
      interface PubSearchDtoMilestoneMetadataDto { 
          filter: Partial<MilestoneMetadataDto>; 
          page?: number; 
          size?: number; 
          sort?: SortDto[]; 
      }
      Properties
      filter
+PubSearchDtoMilestoneMetadataDto | @camunda8/sdk
      Interface PubSearchDtoMilestoneMetadataDto
      interface PubSearchDtoMilestoneMetadataDto { 
          filter: Partial<MilestoneMetadataDto>; 
          page?: number; 
          size?: number; 
          sort?: SortDto[]; 
      }
      Properties
      filter
 page?
 size?
 sort?
-
      Properties
      filter
      filter: Partial<MilestoneMetadataDto>
      Optional page
      page?: number
      minimum: 0
      
-
      Optional size
      size?: number
      maximum: 50 minimum: 0
      
-
      Optional sort
      sort?: SortDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      filter
      filter: Partial<MilestoneMetadataDto>
      Optional page
      page?: number
      minimum: 0
      
+
      Optional size
      size?: number
      maximum: 50 minimum: 0
      
+
      Optional sort
      sort?: SortDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectCollaboratorDto.html b/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectCollaboratorDto.html
index bb5124f7..5256f2f0 100644
--- a/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectCollaboratorDto.html
+++ b/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectCollaboratorDto.html
@@ -1,7 +1,7 @@
-PubSearchDtoProjectCollaboratorDto | @camunda8/sdk
      Interface PubSearchDtoProjectCollaboratorDto
      interface PubSearchDtoProjectCollaboratorDto { 
          filter: Partial<ProjectCollaboratorDto>; 
          page?: number; 
          size?: number; 
          sort?: SortDto[]; 
      }
      Properties
      filter
+PubSearchDtoProjectCollaboratorDto | @camunda8/sdk
      Interface PubSearchDtoProjectCollaboratorDto
      interface PubSearchDtoProjectCollaboratorDto { 
          filter: Partial<ProjectCollaboratorDto>; 
          page?: number; 
          size?: number; 
          sort?: SortDto[]; 
      }
      Properties
      filter
 page?
 size?
 sort?
-
      Properties
      filter
      filter: Partial<ProjectCollaboratorDto>
      Optional page
      page?: number
      minimum 0
      
-
      Optional size
      size?: number
      minumum 0, maximum 50
      
-
      Optional sort
      sort?: SortDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      filter
      filter: Partial<ProjectCollaboratorDto>
      Optional page
      page?: number
      minimum 0
      
+
      Optional size
      size?: number
      minumum 0, maximum 50
      
+
      Optional sort
      sort?: SortDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectMetadataDto.html b/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectMetadataDto.html
index 43eb1593..5af4b377 100644
--- a/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.PubSearchDtoProjectMetadataDto.html
@@ -1,7 +1,7 @@
-PubSearchDtoProjectMetadataDto | @camunda8/sdk
      Interface PubSearchDtoProjectMetadataDto
      interface PubSearchDtoProjectMetadataDto { 
          filter: Partial<ProjectMetadataDto>; 
          page?: number; 
          size?: number; 
          sort?: SortDto[]; 
      }
      Properties
      filter
+PubSearchDtoProjectMetadataDto | @camunda8/sdk
      Interface PubSearchDtoProjectMetadataDto
      interface PubSearchDtoProjectMetadataDto { 
          filter: Partial<ProjectMetadataDto>; 
          page?: number; 
          size?: number; 
          sort?: SortDto[]; 
      }
      Properties
      filter
 page?
 size?
 sort?
-
      Properties
      filter
      filter: Partial<ProjectMetadataDto>
      Optional page
      page?: number
      minimum: 0
      
-
      Optional size
      size?: number
      maximum: 50, minimum: 0
      
-
      Optional sort
      sort?: SortDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      filter
      filter: Partial<ProjectMetadataDto>
      Optional page
      page?: number
      minimum: 0
      
+
      Optional size
      size?: number
      maximum: 50, minimum: 0
      
+
      Optional sort
      sort?: SortDto[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoFileMetadataDto.html b/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoFileMetadataDto.html
index 4c2b631d..0be708e8 100644
--- a/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoFileMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoFileMetadataDto.html
@@ -1,3 +1,3 @@
-PubSearchResultDtoFileMetadataDto | @camunda8/sdk
      Interface PubSearchResultDtoFileMetadataDto
      interface PubSearchResultDtoFileMetadataDto { 
          items: FileMetadataDto[]; 
          total: number; 
      }
      Properties
      items
+PubSearchResultDtoFileMetadataDto | @camunda8/sdk
      Interface PubSearchResultDtoFileMetadataDto
      interface PubSearchResultDtoFileMetadataDto { 
          items: FileMetadataDto[]; 
          total: number; 
      }
      Properties
      items
 total
-
      Properties
      items
      items: FileMetadataDto[]
      total
      total: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      items
      items: FileMetadataDto[]
      total
      total: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoMilestoneMetadataDto.html b/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoMilestoneMetadataDto.html
index 3fba44e4..bf2692bf 100644
--- a/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoMilestoneMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoMilestoneMetadataDto.html
@@ -1,3 +1,3 @@
-PubSearchResultDtoMilestoneMetadataDto | @camunda8/sdk
      Interface PubSearchResultDtoMilestoneMetadataDto
      interface PubSearchResultDtoMilestoneMetadataDto { 
          items: MilestoneMetadataDto[]; 
          total: number; 
      }
      Properties
      items
+PubSearchResultDtoMilestoneMetadataDto | @camunda8/sdk
      Interface PubSearchResultDtoMilestoneMetadataDto
      interface PubSearchResultDtoMilestoneMetadataDto { 
          items: MilestoneMetadataDto[]; 
          total: number; 
      }
      Properties
      items
 total
-
      Properties
      items
      items: MilestoneMetadataDto[]
      total
      total: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      items
      items: MilestoneMetadataDto[]
      total
      total: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectCollaboratorDto.html b/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectCollaboratorDto.html
index aaa93234..a9a0a4fc 100644
--- a/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectCollaboratorDto.html
+++ b/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectCollaboratorDto.html
@@ -1,3 +1,3 @@
-PubSearchResultDtoProjectCollaboratorDto | @camunda8/sdk
      Interface PubSearchResultDtoProjectCollaboratorDto
      interface PubSearchResultDtoProjectCollaboratorDto { 
          items: ProjectCollaboratorDto[]; 
          total: number; 
      }
      Properties
      items
+PubSearchResultDtoProjectCollaboratorDto | @camunda8/sdk
      Interface PubSearchResultDtoProjectCollaboratorDto
      interface PubSearchResultDtoProjectCollaboratorDto { 
          items: ProjectCollaboratorDto[]; 
          total: number; 
      }
      Properties
      items
 total
-
      Properties
      items
      items: ProjectCollaboratorDto[]
      total
      total: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      items
      items: ProjectCollaboratorDto[]
      total
      total: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectMetadataDto.html b/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectMetadataDto.html
index 0a36492f..c389aa2d 100644
--- a/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectMetadataDto.html
+++ b/interfaces/index.Modeler.ModelerDto.PubSearchResultDtoProjectMetadataDto.html
@@ -1,3 +1,3 @@
-PubSearchResultDtoProjectMetadataDto | @camunda8/sdk
      Interface PubSearchResultDtoProjectMetadataDto
      interface PubSearchResultDtoProjectMetadataDto { 
          items: ProjectMetadataDto[]; 
          total: number; 
      }
      Properties
      items
+PubSearchResultDtoProjectMetadataDto | @camunda8/sdk
      Interface PubSearchResultDtoProjectMetadataDto
      interface PubSearchResultDtoProjectMetadataDto { 
          items: ProjectMetadataDto[]; 
          total: number; 
      }
      Properties
      items
 total
-
      Properties
      items
      items: ProjectMetadataDto[]
      total
      total: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      items
      items: ProjectMetadataDto[]
      total
      total: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.SortDto.html b/interfaces/index.Modeler.ModelerDto.SortDto.html
index 1f87d5fe..1c92b5b6 100644
--- a/interfaces/index.Modeler.ModelerDto.SortDto.html
+++ b/interfaces/index.Modeler.ModelerDto.SortDto.html
@@ -1,3 +1,3 @@
-SortDto | @camunda8/sdk
      Interface SortDto
      interface SortDto { 
          direction: "ASC" | "DESC"; 
          field: string; 
      }
      Properties
      direction
+SortDto | @camunda8/sdk
      Interface SortDto
      interface SortDto { 
          direction: "ASC" | "DESC"; 
          field: string; 
      }
      Properties
      direction
 field
-
      Properties
      direction
      direction: "ASC" | "DESC"
      field
      field: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      direction
      direction: "ASC" | "DESC"
      field
      field: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.UpdateFileDto.html b/interfaces/index.Modeler.ModelerDto.UpdateFileDto.html
index 9e823bbf..659800d7 100644
--- a/interfaces/index.Modeler.ModelerDto.UpdateFileDto.html
+++ b/interfaces/index.Modeler.ModelerDto.UpdateFileDto.html
@@ -1,9 +1,9 @@
-UpdateFileDto | @camunda8/sdk
      Interface UpdateFileDto
      interface UpdateFileDto { 
          content: string; 
          folderId: string; 
          name: string; 
          projectId: string; 
          revision: number; 
      }
      Properties
      content
+UpdateFileDto | @camunda8/sdk
      Interface UpdateFileDto
      interface UpdateFileDto { 
          content: string; 
          folderId: string; 
          name: string; 
          projectId: string; 
          revision: number; 
      }
      Properties
      content
 folderId
 name
 projectId
 revision
-
      Properties
      content
      content: string
      folderId
      folderId: string
      maxLength: 255, minLength: 1
      
-
      name
      name: string
      maxLength: 255, minLength: 1
      
-
      projectId
      projectId: string
      maxLength: 255, minLength: 1
      
-
      revision
      revision: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      content
      content: string
      folderId
      folderId: string
      maxLength: 255, minLength: 1
      
+
      name
      name: string
      maxLength: 255, minLength: 1
      
+
      projectId
      projectId: string
      maxLength: 255, minLength: 1
      
+
      revision
      revision: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.UpdateFolderDto.html b/interfaces/index.Modeler.ModelerDto.UpdateFolderDto.html
index b6a8a12c..9f6e5b62 100644
--- a/interfaces/index.Modeler.ModelerDto.UpdateFolderDto.html
+++ b/interfaces/index.Modeler.ModelerDto.UpdateFolderDto.html
@@ -1,7 +1,7 @@
-UpdateFolderDto | @camunda8/sdk
      Interface UpdateFolderDto
      interface UpdateFolderDto { 
          name: string; 
          parentId: string; 
          projectId: string; 
      }
      Properties
      name
+UpdateFolderDto | @camunda8/sdk
      Interface UpdateFolderDto
      interface UpdateFolderDto { 
          name: string; 
          parentId: string; 
          projectId: string; 
      }
      Properties
      name
 parentId
 projectId
 
      Properties
      name
      name: string
      maxLength: 255 minLength: 1
      
-
      parentId
      parentId: string
      maxLength: 255 minLength: 1
      
-
      projectId
      projectId: string
      maxLength: 255 minLength: 1
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      parentId
      parentId: string
      maxLength: 255 minLength: 1
      
+
      projectId
      projectId: string
      maxLength: 255 minLength: 1
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Modeler.ModelerDto.UserDto.html b/interfaces/index.Modeler.ModelerDto.UserDto.html
index e75487f8..a0d2da85 100644
--- a/interfaces/index.Modeler.ModelerDto.UserDto.html
+++ b/interfaces/index.Modeler.ModelerDto.UserDto.html
@@ -1,3 +1,3 @@
-UserDto | @camunda8/sdk
      Interface UserDto
      interface UserDto { 
          email: string; 
          name: string; 
      }
      Properties
      email
+UserDto | @camunda8/sdk
      Interface UserDto
      interface UserDto { 
          email: string; 
          name: string; 
      }
      Properties
      email
 name
-
      Properties
      email
      email: string
      name
      name: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      email
      email: string
      name
      name: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Operate.OperateDto.Query.html b/interfaces/index.Operate.OperateDto.Query.html
index 4c60f603..959cd417 100644
--- a/interfaces/index.Operate.OperateDto.Query.html
+++ b/interfaces/index.Operate.OperateDto.Query.html
@@ -1,5 +1,5 @@
-Query | @camunda8/sdk
      Interface Query<T>
      interface Query<T> { 
          filter?: Partial<T>; 
          searchAfter?: unknown[]; 
          size?: number; 
          sort?: [{ 
              field: keyof T; 
              order: "ASC" | "DESC"; 
          }]; 
      }
       
      Type Parameters
      • T
       
      Properties
      filter?
+Query | @camunda8/sdk
      Interface Query<T>
      interface Query<T> { 
          filter?: Partial<T>; 
          searchAfter?: unknown[]; 
          size?: number; 
          sort?: [{ 
              field: keyof T; 
              order: "ASC" | "DESC"; 
          }]; 
      }
       
      Type Parameters
      • T
       
      Properties
      filter?
 searchAfter?
 size?
 sort?
-
      Properties
      Optional filter
      filter?: Partial<T>
      Optional searchAfter
      searchAfter?: unknown[]
      Optional size
      size?: number
      Optional sort
      sort?: [{ 
          field: keyof T; 
          order: "ASC" | "DESC"; 
      }]
      Type declaration
      • field: keyof T
      • order: "ASC" | "DESC"
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Optional filter
      filter?: Partial<T>
      Optional searchAfter
      searchAfter?: unknown[]
      Optional size
      size?: number
      Optional sort
      sort?: [{ 
          field: keyof T; 
          order: "ASC" | "DESC"; 
      }]
      Type declaration
      • field: keyof T
      • order: "ASC" | "DESC"
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Operate.OperateDto.SearchResults.html b/interfaces/index.Operate.OperateDto.SearchResults.html
index 57144b72..167732f7 100644
--- a/interfaces/index.Operate.OperateDto.SearchResults.html
+++ b/interfaces/index.Operate.OperateDto.SearchResults.html
@@ -1,4 +1,4 @@
-SearchResults | @camunda8/sdk
      Interface SearchResults<T>
      interface SearchResults<T> { 
          items: T[]; 
          sortValues: unknown[]; 
          total: string; 
      }
       
      Type Parameters
      • T
       
      Properties
      items
+SearchResults | @camunda8/sdk
      Interface SearchResults<T>
      interface SearchResults<T> { 
          items: T[]; 
          sortValues: unknown[]; 
          total: string; 
      }
       
      Type Parameters
      • T
       
      Properties
      items
 sortValues
 total
-
      Properties
      items
      items: T[]
      sortValues
      sortValues: unknown[]
      total
      total: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      items
      items: T[]
      sortValues
      sortValues: unknown[]
      total
      total: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.CloudEventV1.html b/interfaces/index.Optimize.OptimizeDto.CloudEventV1.html
index d5367afa..243a5ae4 100644
--- a/interfaces/index.Optimize.OptimizeDto.CloudEventV1.html
+++ b/interfaces/index.Optimize.OptimizeDto.CloudEventV1.html
@@ -1,6 +1,6 @@
 CloudEventV1 | @camunda8/sdk
      Interface CloudEventV1<T>
      The object interface for CloudEvents 1.0.
      
 
      See
      https://github.com/cloudevents/spec/blob/v1.0/spec.md
      
-
      interface CloudEventV1<T> { 
          data?: T; 
          data_base64?: string; 
          datacontenttype?: string; 
          dataschema?: string; 
          id: string; 
          source: string; 
          specversion: string; 
          subject?: string; 
          time?: string; 
          type: string; 
      }
       
      Type Parameters
      • T
       
      Hierarchy (view full)
      Properties
      data?
+
      interface CloudEventV1<T> { 
          data?: T; 
          data_base64?: string; 
          datacontenttype?: string; 
          dataschema?: string; 
          id: string; 
          source: string; 
          specversion: string; 
          subject?: string; 
          time?: string; 
          type: string; 
      }
       
      Type Parameters
      • T
       
      Hierarchy (view full)
      Properties
      data?
 data_base64?
 datacontenttype?
 dataschema?
@@ -14,10 +14,10 @@
 on the type of this information. It is encoded into a media format which is
 specified by the datacontenttype attribute (e.g. application/json), and adheres
 to the dataschema format when those respective attributes are present.
      
-
      Optional data_base64
      data_base64?: string
      [OPTIONAL] The event payload encoded as base64 data. This is used when the
+
      Optional data_base64
      data_base64?: string
      [OPTIONAL] The event payload encoded as base64 data. This is used when the
 data is in binary form.
      
 
      See
      https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data
      
-
      Optional datacontenttype
      datacontenttype?: string
      [OPTIONAL] Content type of data value. This attribute enables data to
+
      Optional datacontenttype
      datacontenttype?: string
      [OPTIONAL] Content type of data value. This attribute enables data to
 carry any type of content, whereby format and encoding might differ from that
 of the chosen event format. For example, an event rendered using the
 JSON envelope format might carry an XML payload
@@ -26,12 +26,12 @@
 datacontenttype values are defined in the event format specifications; for
 example, the JSON event format defines the relationship in
 section 3.1.
      
-
      Optional dataschema
      dataschema?: string
      [OPTIONAL] Identifies the schema that data adheres to. Incompatible
+
      Optional dataschema
      dataschema?: string
      [OPTIONAL] Identifies the schema that data adheres to. Incompatible
 changes to the schema SHOULD be reflected by a different URI. See
 Versioning of Attributes in the Primer
 for more information.
 If present, MUST be a non-empty URI.
      
-
      id
      id: string
      [REQUIRED] Identifies the event. Producers MUST ensure that source + id
+
      id
      id: string
      [REQUIRED] Identifies the event. Producers MUST ensure that source + id
 is unique for each distinct event. If a duplicate event is re-sent (e.g. due
 to a network error) it MAY have the same id. Consumers MAY assume that
 Events with identical source and id are duplicates.
      
@@ -40,7 +40,7 @@ 
      Example
      An
      
 
      Example
      A UUID
 
      
-
      source
      source: string
      [REQUIRED] Identifies the context in which an event happened. Often this
+
      source
      source: string
      [REQUIRED] Identifies the context in which an event happened. Often this
 will include information such as the type of the event source, the
 organization publishing the event or the process that produced the event. The
 exact syntax and semantics behind the data encoded in the URI is defined by
@@ -53,12 +53,12 @@ 
      Example
      Asource + id is unique for each distinct event.
      
 
      Required
      Non-empty URI-reference
      
-
      specversion
      specversion: string
      [REQUIRED] The version of the CloudEvents specification which the event
+
      specversion
      specversion: string
      [REQUIRED] The version of the CloudEvents specification which the event
 uses. This enables the interpretation of the context. Compliant event
 producers MUST use a value of 1.0 when referring to this version of the
 specification.
      
 
      Required
      MUST be a non-empty string.
      
-
      Optional subject
      subject?: string
      [OPTIONAL] This describes the subject of the event in the context of the
+
      Optional subject
      subject?: string
      [OPTIONAL] This describes the subject of the event in the context of the
 event producer (identified by source). In publish-subscribe scenarios, a
 subscriber will typically subscribe to events emitted by a source, but the
 source identifier alone might not be sufficient as a qualifier for any
@@ -75,7 +75,7 @@ 
      Example
      A
      
 
      Example
      "mynewfile.jpg"
 
      
-
      Optional time
      time?: string
      [OPTIONAL] Timestamp of when the occurrence happened. If the time of the
+
      Optional time
      time?: string
      [OPTIONAL] Timestamp of when the occurrence happened. If the time of the
 occurrence cannot be determined then this attribute MAY be set to some other
 time (such as the current time) by the CloudEvents producer, however all
 producers for the same source MUST be consistent in this respect. In other
@@ -83,7 +83,7 @@ 
      Example
      "mynewfil
 the same algorithm to determine the value used.
      
 
      Example
      "2020-08-08T14:48:09.769Z"
 
      
-
      type
      type: string
      [REQUIRED] This attribute contains a value describing the type of event
+
      type
      type: string
      [REQUIRED] This attribute contains a value describing the type of event
 related to the originating occurrence. Often this attribute is used for
 routing, observability, policy enforcement, etc. The format of this is
 producer defined and might include information such as the version of the
@@ -97,4 +97,4 @@ 
      Example
      com
      
 
      Example
      com.example.object.delete.v2
 
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.CloudEventV1Attributes.html b/interfaces/index.Optimize.OptimizeDto.CloudEventV1Attributes.html
index 167e022a..d5532e8c 100644
--- a/interfaces/index.Optimize.OptimizeDto.CloudEventV1Attributes.html
+++ b/interfaces/index.Optimize.OptimizeDto.CloudEventV1Attributes.html
@@ -1,4 +1,4 @@
-CloudEventV1Attributes | @camunda8/sdk
      Interface CloudEventV1Attributes<T>
      interface CloudEventV1Attributes<T> { 
          data?: T; 
          data_base64?: string; 
          datacontenttype?: string; 
          dataschema?: string; 
          source: string; 
          subject?: string; 
          time?: string; 
          type: string; 
      }
       
      Type Parameters
      • T
       
      Hierarchy (view full)
      Properties
      data?
+CloudEventV1Attributes | @camunda8/sdk
      Interface CloudEventV1Attributes<T>
      interface CloudEventV1Attributes<T> { 
          data?: T; 
          data_base64?: string; 
          datacontenttype?: string; 
          dataschema?: string; 
          source: string; 
          subject?: string; 
          time?: string; 
          type: string; 
      }
       
      Type Parameters
      • T
       
      Hierarchy (view full)
      Properties
      data?
 data_base64?
 datacontenttype?
 dataschema?
@@ -10,10 +10,10 @@
 on the type of this information. It is encoded into a media format which is
 specified by the datacontenttype attribute (e.g. application/json), and adheres
 to the dataschema format when those respective attributes are present.
      
-
      Optional data_base64
      data_base64?: string
      [OPTIONAL] The event payload encoded as base64 data. This is used when the
+
      Optional data_base64
      data_base64?: string
      [OPTIONAL] The event payload encoded as base64 data. This is used when the
 data is in binary form.
      
 
      See
      https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data
      
-
      Optional datacontenttype
      datacontenttype?: string
      [OPTIONAL] Content type of data value. This attribute enables data to
+
      Optional datacontenttype
      datacontenttype?: string
      [OPTIONAL] Content type of data value. This attribute enables data to
 carry any type of content, whereby format and encoding might differ from that
 of the chosen event format. For example, an event rendered using the
 JSON envelope format might carry an XML payload
@@ -22,12 +22,12 @@
 datacontenttype values are defined in the event format specifications; for
 example, the JSON event format defines the relationship in
 section 3.1.
      
-
      Optional dataschema
      dataschema?: string
      [OPTIONAL] Identifies the schema that data adheres to. Incompatible
+
      Optional dataschema
      dataschema?: string
      [OPTIONAL] Identifies the schema that data adheres to. Incompatible
 changes to the schema SHOULD be reflected by a different URI. See
 Versioning of Attributes in the Primer
 for more information.
 If present, MUST be a non-empty URI.
      
-
      source
      source: string
      [REQUIRED] Identifies the context in which an event happened. Often this
+
      source
      source: string
      [REQUIRED] Identifies the context in which an event happened. Often this
 will include information such as the type of the event source, the
 organization publishing the event or the process that produced the event. The
 exact syntax and semantics behind the data encoded in the URI is defined by
@@ -40,7 +40,7 @@
 A source MAY include more than one producer. In that case the producers MUST
 collaborate to ensure that source + id is unique for each distinct event.
      
 
      Required
      Non-empty URI-reference
      
-
      Optional subject
      subject?: string
      [OPTIONAL] This describes the subject of the event in the context of the
+
      Optional subject
      subject?: string
      [OPTIONAL] This describes the subject of the event in the context of the
 event producer (identified by source). In publish-subscribe scenarios, a
 subscriber will typically subscribe to events emitted by a source, but the
 source identifier alone might not be sufficient as a qualifier for any
@@ -57,7 +57,7 @@
 
      
 
      Example
      "mynewfile.jpg"
 
      
-
      Optional time
      time?: string
      [OPTIONAL] Timestamp of when the occurrence happened. If the time of the
+
      Optional time
      time?: string
      [OPTIONAL] Timestamp of when the occurrence happened. If the time of the
 occurrence cannot be determined then this attribute MAY be set to some other
 time (such as the current time) by the CloudEvents producer, however all
 producers for the same source MUST be consistent in this respect. In other
@@ -65,7 +65,7 @@ 
      Example
      "mynewfil
 the same algorithm to determine the value used.
      
 
      Example
      "2020-08-08T14:48:09.769Z"
 
      
-
      type
      type: string
      [REQUIRED] This attribute contains a value describing the type of event
+
      type
      type: string
      [REQUIRED] This attribute contains a value describing the type of event
 related to the originating occurrence. Often this attribute is used for
 routing, observability, policy enforcement, etc. The format of this is
 producer defined and might include information such as the version of the
@@ -79,4 +79,4 @@ 
      Example
      com
      
 
      Example
      com.example.object.delete.v2
 
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.CloudEventV1OptionalAttributes.html b/interfaces/index.Optimize.OptimizeDto.CloudEventV1OptionalAttributes.html
index 77238a14..a07bca05 100644
--- a/interfaces/index.Optimize.OptimizeDto.CloudEventV1OptionalAttributes.html
+++ b/interfaces/index.Optimize.OptimizeDto.CloudEventV1OptionalAttributes.html
@@ -1,5 +1,5 @@
 CloudEventV1OptionalAttributes | @camunda8/sdk
      Interface CloudEventV1OptionalAttributes<T>
      interface CloudEventV1OptionalAttributes<T> { 
          data?: T; 
          data_base64?: string; 
          datacontenttype?: string; 
          dataschema?: string; 
          subject?: string; 
          time?: string; 
          [key: string]: unknown; 
      }
       
      Type Parameters
      • T
       
      Hierarchy (view full)
      Indexable
      [key: string]: unknown
      [OPTIONAL] CloudEvents extension attributes.
      
-
      Properties
      data?
+
      Properties
      data?
 data_base64?
 datacontenttype?
 dataschema?
@@ -9,10 +9,10 @@
 on the type of this information. It is encoded into a media format which is
 specified by the datacontenttype attribute (e.g. application/json), and adheres
 to the dataschema format when those respective attributes are present.
      
-
      Optional data_base64
      data_base64?: string
      [OPTIONAL] The event payload encoded as base64 data. This is used when the
+
      Optional data_base64
      data_base64?: string
      [OPTIONAL] The event payload encoded as base64 data. This is used when the
 data is in binary form.
      
 
      See
      https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data
      
-
      Optional datacontenttype
      datacontenttype?: string
      [OPTIONAL] Content type of data value. This attribute enables data to
+
      Optional datacontenttype
      datacontenttype?: string
      [OPTIONAL] Content type of data value. This attribute enables data to
 carry any type of content, whereby format and encoding might differ from that
 of the chosen event format. For example, an event rendered using the
 JSON envelope format might carry an XML payload
@@ -21,12 +21,12 @@
 datacontenttype values are defined in the event format specifications; for
 example, the JSON event format defines the relationship in
 section 3.1.
      
-
      Optional dataschema
      dataschema?: string
      [OPTIONAL] Identifies the schema that data adheres to. Incompatible
+
      Optional dataschema
      dataschema?: string
      [OPTIONAL] Identifies the schema that data adheres to. Incompatible
 changes to the schema SHOULD be reflected by a different URI. See
 Versioning of Attributes in the Primer
 for more information.
 If present, MUST be a non-empty URI.
      
-
      Optional subject
      subject?: string
      [OPTIONAL] This describes the subject of the event in the context of the
+
      Optional subject
      subject?: string
      [OPTIONAL] This describes the subject of the event in the context of the
 event producer (identified by source). In publish-subscribe scenarios, a
 subscriber will typically subscribe to events emitted by a source, but the
 source identifier alone might not be sufficient as a qualifier for any
@@ -43,7 +43,7 @@
 
      
 
      Example
      "mynewfile.jpg"
 
      
-
      Optional time
      time?: string
      [OPTIONAL] Timestamp of when the occurrence happened. If the time of the
+
      Optional time
      time?: string
      [OPTIONAL] Timestamp of when the occurrence happened. If the time of the
 occurrence cannot be determined then this attribute MAY be set to some other
 time (such as the current time) by the CloudEvents producer, however all
 producers for the same source MUST be consistent in this respect. In other
@@ -51,4 +51,4 @@ 
      Example
      "mynewfil
 the same algorithm to determine the value used.
      
 
      Example
      "2020-08-08T14:48:09.769Z"
 
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.DashboardDefinition.html b/interfaces/index.Optimize.OptimizeDto.DashboardDefinition.html
index 232fc14e..3231266b 100644
--- a/interfaces/index.Optimize.OptimizeDto.DashboardDefinition.html
+++ b/interfaces/index.Optimize.OptimizeDto.DashboardDefinition.html
@@ -1,8 +1,8 @@
-DashboardDefinition | @camunda8/sdk
      Interface DashboardDefinition
      interface DashboardDefinition { 
          availableFilters: unknown[]; 
          collectionId: null | string; 
          exportEntityType: "dashboard"; 
          id: string; 
          name: string; 
          reports: { 
              id: string; 
          }[]; 
          sourceIndexVersion: number; 
      }
      Properties
      availableFilters
+DashboardDefinition | @camunda8/sdk
      Interface DashboardDefinition
      interface DashboardDefinition { 
          availableFilters: unknown[]; 
          collectionId: null | string; 
          exportEntityType: "dashboard"; 
          id: string; 
          name: string; 
          reports: { 
              id: string; 
          }[]; 
          sourceIndexVersion: number; 
      }
      Properties
      availableFilters
 collectionId
 exportEntityType
 id
 name
 reports
 sourceIndexVersion
-
      Properties
      availableFilters
      availableFilters: unknown[]
      collectionId
      collectionId: null | string
      exportEntityType
      exportEntityType: "dashboard"
      id
      id: string
      name
      name: string
      reports
      reports: { 
          id: string; 
      }[]
      Type declaration
      • id: string
      sourceIndexVersion
      sourceIndexVersion: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      availableFilters
      availableFilters: unknown[]
      collectionId
      collectionId: null | string
      exportEntityType
      exportEntityType: "dashboard"
      id
      id: string
      name
      name: string
      reports
      reports: { 
          id: string; 
      }[]
      Type declaration
      • id: string
      sourceIndexVersion
      sourceIndexVersion: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.ReportData.html b/interfaces/index.Optimize.OptimizeDto.ReportData.html
index 8567011a..d3b6d062 100644
--- a/interfaces/index.Optimize.OptimizeDto.ReportData.html
+++ b/interfaces/index.Optimize.OptimizeDto.ReportData.html
@@ -1,4 +1,4 @@
-ReportData | @camunda8/sdk
      Interface ReportData
      interface ReportData { 
          businessKey: string; 
          duration: number; 
          endDate: string; 
          engineName: string; 
          processDefinitionId: string; 
          processDefinitionKey: string; 
          processInstanceId: string; 
          startDate: string; 
          tenantId: null; 
          variables: unknown; 
      }
      Properties
      businessKey
+ReportData | @camunda8/sdk
      Interface ReportData
      interface ReportData { 
          businessKey: string; 
          duration: number; 
          endDate: string; 
          engineName: string; 
          processDefinitionId: string; 
          processDefinitionKey: string; 
          processInstanceId: string; 
          startDate: string; 
          tenantId: null; 
          variables: unknown; 
      }
      Properties
      businessKey
 duration
 endDate
 engineName
@@ -8,4 +8,4 @@
 startDate
 tenantId
 variables
-
      Properties
      businessKey
      businessKey: string
      duration
      duration: number
      endDate
      endDate: string
      engineName
      engineName: string
      processDefinitionId
      processDefinitionId: string
      processDefinitionKey
      processDefinitionKey: string
      processInstanceId
      processInstanceId: string
      startDate
      startDate: string
      tenantId
      tenantId: null
      variables
      variables: unknown
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      businessKey
      businessKey: string
      duration
      duration: number
      endDate
      endDate: string
      engineName
      engineName: string
      processDefinitionId
      processDefinitionId: string
      processDefinitionKey
      processDefinitionKey: string
      processInstanceId
      processInstanceId: string
      startDate
      startDate: string
      tenantId
      tenantId: null
      variables
      variables: unknown
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.ReportDataExporter.html b/interfaces/index.Optimize.OptimizeDto.ReportDataExporter.html
index 1cd812f4..ceaf9cc7 100644
--- a/interfaces/index.Optimize.OptimizeDto.ReportDataExporter.html
+++ b/interfaces/index.Optimize.OptimizeDto.ReportDataExporter.html
@@ -1,2 +1,2 @@
-ReportDataExporter | @camunda8/sdk
      Interface ReportDataExporter
      interface ReportDataExporter { 
          next: (() => Promise<ReportDataPage>); 
      }
      Properties
      next
-
      Properties
      next
      next: (() => Promise<ReportDataPage>)
      Type declaration
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+ReportDataExporter | @camunda8/sdk
      Interface ReportDataExporter
      interface ReportDataExporter { 
          next: (() => Promise<ReportDataPage>); 
      }
      Properties
      next
+
      Properties
      next
      next: (() => Promise<ReportDataPage>)
      Type declaration
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.ReportDataPage.html b/interfaces/index.Optimize.OptimizeDto.ReportDataPage.html
index ba0bf2b7..e593063e 100644
--- a/interfaces/index.Optimize.OptimizeDto.ReportDataPage.html
+++ b/interfaces/index.Optimize.OptimizeDto.ReportDataPage.html
@@ -1,6 +1,6 @@
-ReportDataPage | @camunda8/sdk
      Interface ReportDataPage
      interface ReportDataPage { 
          data: ReportData[]; 
          numberOfRecordsInResponse: number; 
          reportId: string; 
          searchRequestId: string; 
          totalNumberOfRecords: number; 
      }
      Properties
      data
+ReportDataPage | @camunda8/sdk
      Interface ReportDataPage
      interface ReportDataPage { 
          data: ReportData[]; 
          numberOfRecordsInResponse: number; 
          reportId: string; 
          searchRequestId: string; 
          totalNumberOfRecords: number; 
      }
      Properties
      data
 numberOfRecordsInResponse
 reportId
 searchRequestId
 totalNumberOfRecords
-
      Properties
      data
      data: ReportData[]
      numberOfRecordsInResponse
      numberOfRecordsInResponse: number
      reportId
      reportId: string
      searchRequestId
      searchRequestId: string
      totalNumberOfRecords
      totalNumberOfRecords: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      data
      data: ReportData[]
      numberOfRecordsInResponse
      numberOfRecordsInResponse: number
      reportId
      reportId: string
      searchRequestId
      searchRequestId: string
      totalNumberOfRecords
      totalNumberOfRecords: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.Variable.html b/interfaces/index.Optimize.OptimizeDto.Variable.html
index 3ed0eeaa..592fe168 100644
--- a/interfaces/index.Optimize.OptimizeDto.Variable.html
+++ b/interfaces/index.Optimize.OptimizeDto.Variable.html
@@ -1,7 +1,7 @@
-Variable | @camunda8/sdk
      Interface Variable
      interface Variable { 
          id: string; 
          name: string; 
          processDefinitionKey: string; 
          processInstanceId: string; 
          type: VariableType; 
          value: string; 
      }
      Properties
      id
+Variable | @camunda8/sdk
      Interface Variable
      interface Variable { 
          id: string; 
          name: string; 
          processDefinitionKey: string; 
          processInstanceId: string; 
          type: VariableType; 
          value: string; 
      }
      Properties
      id
 name
 processDefinitionKey
 processInstanceId
 type
 value
-
      Properties
      id
      id: string
      name
      name: string
      processDefinitionKey
      processDefinitionKey: string
      processInstanceId
      processInstanceId: string
      type
      type: VariableType
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      id
      id: string
      name
      name: string
      processDefinitionKey
      processDefinitionKey: string
      processInstanceId
      processInstanceId: string
      type
      type: VariableType
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.VariableLabel.html b/interfaces/index.Optimize.OptimizeDto.VariableLabel.html
index a017b4d7..94372d34 100644
--- a/interfaces/index.Optimize.OptimizeDto.VariableLabel.html
+++ b/interfaces/index.Optimize.OptimizeDto.VariableLabel.html
@@ -1,4 +1,4 @@
-VariableLabel | @camunda8/sdk
      Interface VariableLabel
      interface VariableLabel { 
          variableLabel: string; 
          variableName: string; 
          variableType: VariableType; 
      }
      Properties
      variableLabel
+VariableLabel | @camunda8/sdk
      Interface VariableLabel
      interface VariableLabel { 
          variableLabel: string; 
          variableName: string; 
          variableType: VariableType; 
      }
      Properties
      variableLabel
 variableName
 variableType
-
      Properties
      variableLabel
      variableLabel: string
      variableName
      variableName: string
      variableType
      variableType: VariableType
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      variableLabel
      variableLabel: string
      variableName
      variableName: string
      variableType
      variableType: VariableType
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Optimize.OptimizeDto.VariableLabels.html b/interfaces/index.Optimize.OptimizeDto.VariableLabels.html
index 6315c0be..7ac25b36 100644
--- a/interfaces/index.Optimize.OptimizeDto.VariableLabels.html
+++ b/interfaces/index.Optimize.OptimizeDto.VariableLabels.html
@@ -1,3 +1,3 @@
-VariableLabels | @camunda8/sdk
      Interface VariableLabels
      interface VariableLabels { 
          definitionKey: string; 
          labels: VariableLabel[]; 
      }
      Properties
      definitionKey
+VariableLabels | @camunda8/sdk
      Interface VariableLabels
      interface VariableLabels { 
          definitionKey: string; 
          labels: VariableLabel[]; 
      }
      Properties
      definitionKey
 labels
-
      Properties
      definitionKey
      definitionKey: string
      labels
      labels: VariableLabel[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      definitionKey
      definitionKey: string
      labels
      labels: VariableLabel[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.DateFilter.html b/interfaces/index.Tasklist.TasklistDto.DateFilter.html
index c2ea71ac..216972ba 100644
--- a/interfaces/index.Tasklist.TasklistDto.DateFilter.html
+++ b/interfaces/index.Tasklist.TasklistDto.DateFilter.html
@@ -1,3 +1,3 @@
-DateFilter | @camunda8/sdk
      Interface DateFilter
      interface DateFilter { 
          from: string | Date; 
          to: string | Date; 
      }
      Properties
      from
+DateFilter | @camunda8/sdk
      Interface DateFilter
      interface DateFilter { 
          from: string | Date; 
          to: string | Date; 
      }
      Properties
      from
 to
-
      Properties
      from
      from: string | Date
      to
      to: string | Date
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      from
      from: string | Date
      to
      to: string | Date
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.DraftSearchVariableValue.html b/interfaces/index.Tasklist.TasklistDto.DraftSearchVariableValue.html
index bff52e20..41626e6d 100644
--- a/interfaces/index.Tasklist.TasklistDto.DraftSearchVariableValue.html
+++ b/interfaces/index.Tasklist.TasklistDto.DraftSearchVariableValue.html
@@ -1,4 +1,4 @@
-DraftSearchVariableValue | @camunda8/sdk
      Interface DraftSearchVariableValue
      interface DraftSearchVariableValue { 
          isValueTruncated: boolean; 
          previewValue: string; 
          value: string; 
      }
      Properties
      isValueTruncated
+DraftSearchVariableValue | @camunda8/sdk
      Interface DraftSearchVariableValue
      interface DraftSearchVariableValue { 
          isValueTruncated: boolean; 
          previewValue: string; 
          value: string; 
      }
      Properties
      isValueTruncated
 previewValue
 value
-
      Properties
      isValueTruncated
      isValueTruncated: boolean
      previewValue
      previewValue: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      isValueTruncated
      isValueTruncated: boolean
      previewValue
      previewValue: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.TaskByVariables.html b/interfaces/index.Tasklist.TasklistDto.TaskByVariables.html
index eb300796..3f4ab668 100644
--- a/interfaces/index.Tasklist.TasklistDto.TaskByVariables.html
+++ b/interfaces/index.Tasklist.TasklistDto.TaskByVariables.html
@@ -1,4 +1,4 @@
-TaskByVariables | @camunda8/sdk
      Interface TaskByVariables
      interface TaskByVariables { 
          name: string; 
          operator: "eq"; 
          value: string; 
      }
      Properties
      name
+TaskByVariables | @camunda8/sdk
      Interface TaskByVariables
      interface TaskByVariables { 
          name: string; 
          operator: "eq"; 
          value: string; 
      }
      Properties
      name
 operator
 value
-
      Properties
      name
      name: string
      operator
      operator: "eq"
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      name
      name: string
      operator
      operator: "eq"
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterOrEqualRequest.html b/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterOrEqualRequest.html
index 8580d022..7de5a6ca 100644
--- a/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterOrEqualRequest.html
+++ b/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterOrEqualRequest.html
@@ -1,4 +1,4 @@
-TaskSearchAfterOrEqualRequest | @camunda8/sdk
      Interface TaskSearchAfterOrEqualRequest
      interface TaskSearchAfterOrEqualRequest { 
          assigned?: boolean; 
          assignee?: string; 
          assignees?: string[]; 
          candidateGroup?: string; 
          candidateGroups?: string[]; 
          candidateUser?: string; 
          candidateUsers?: string[]; 
          dueDate?: DateFilter; 
          followUpDate?: DateFilter; 
          implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables?: IncludeVariable[]; 
          pageSize?: number; 
          processDefinitionKey?: string; 
          processInstanceKey?: string; 
          searchAfterOrEqual: string[]; 
          sort?: TaskOrderBy[]; 
          state?: TaskState; 
          taskDefinitionId?: string; 
          taskVariables?: TaskByVariables[]; 
          tenantIds?: string[]; 
      }
      Hierarchy
      Properties
      assigned?
+TaskSearchAfterOrEqualRequest | @camunda8/sdk
      Interface TaskSearchAfterOrEqualRequest
      interface TaskSearchAfterOrEqualRequest { 
          assigned?: boolean; 
          assignee?: string; 
          assignees?: string[]; 
          candidateGroup?: string; 
          candidateGroups?: string[]; 
          candidateUser?: string; 
          candidateUsers?: string[]; 
          dueDate?: DateFilter; 
          followUpDate?: DateFilter; 
          implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables?: IncludeVariable[]; 
          pageSize?: number; 
          processDefinitionKey?: string; 
          processInstanceKey?: string; 
          searchAfterOrEqual: string[]; 
          sort?: TaskOrderBy[]; 
          state?: TaskState; 
          taskDefinitionId?: string; 
          taskVariables?: TaskByVariables[]; 
          tenantIds?: string[]; 
      }
      Hierarchy
      Properties
      assigned?
 assignee?
 assignees?
 candidateGroup?
@@ -18,14 +18,14 @@
 taskDefinitionId?
 taskVariables?
 tenantIds?
-
      Properties
      Optional assigned
      assigned?: boolean
      Optional assignee
      assignee?: string
      Optional assignees
      assignees?: string[]
      Optional candidateGroup
      candidateGroup?: string
      Optional candidateGroups
      candidateGroups?: string[]
      Optional candidateUser
      candidateUser?: string
      Optional candidateUsers
      candidateUsers?: string[]
      Optional dueDate
      dueDate?: DateFilter
      Optional followUpDate
      followUpDate?: DateFilter
      Optional implementation
      implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
      Optional includeVariables
      includeVariables?: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
+
      Properties
      Optional assigned
      assigned?: boolean
      Optional assignee
      assignee?: string
      Optional assignees
      assignees?: string[]
      Optional candidateGroup
      candidateGroup?: string
      Optional candidateGroups
      candidateGroups?: string[]
      Optional candidateUser
      candidateUser?: string
      Optional candidateUsers
      candidateUsers?: string[]
      Optional dueDate
      dueDate?: DateFilter
      Optional followUpDate
      followUpDate?: DateFilter
      Optional implementation
      implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
      Optional includeVariables
      includeVariables?: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
 This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
      
-
      Optional pageSize
      pageSize?: number
      Optional processDefinitionKey
      processDefinitionKey?: string
      Optional processInstanceKey
      processInstanceKey?: string
      searchAfterOrEqual
      searchAfterOrEqual: string[]
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
+
      Optional pageSize
      pageSize?: number
      Optional processDefinitionKey
      processDefinitionKey?: string
      Optional processInstanceKey
      processInstanceKey?: string
      searchAfterOrEqual
      searchAfterOrEqual: string[]
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
 It enables the API to return a page of tasks that directly follow or are equal to the task identified by the provided values, with respect to the sorting order.
      
-
      Optional sort
      sort?: TaskOrderBy[]
      Optional state
      state?: TaskState
      Optional taskDefinitionId
      taskDefinitionId?: string
      Optional taskVariables
      taskVariables?: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
+
      Optional sort
      sort?: TaskOrderBy[]
      Optional state
      state?: TaskState
      Optional taskDefinitionId
      taskDefinitionId?: string
      Optional taskVariables
      taskVariables?: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
 If defined, the query returns only tasks to which all clauses apply.
 However, it's important to note that this filtering mechanism is
 designed to work exclusively with truncated variables. This means
 variables of a larger size are not compatible with this filter, and
 attempts to use them may result in inaccurate or incomplete query results.
      
-
      Optional tenantIds
      tenantIds?: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional tenantIds
      tenantIds?: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterRequest.html b/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterRequest.html
index 5a022830..c26d07b4 100644
--- a/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterRequest.html
+++ b/interfaces/index.Tasklist.TasklistDto.TaskSearchAfterRequest.html
@@ -1,4 +1,4 @@
-TaskSearchAfterRequest | @camunda8/sdk
      Interface TaskSearchAfterRequest
      interface TaskSearchAfterRequest { 
          assigned?: boolean; 
          assignee?: string; 
          assignees?: string[]; 
          candidateGroup?: string; 
          candidateGroups?: string[]; 
          candidateUser?: string; 
          candidateUsers?: string[]; 
          dueDate?: DateFilter; 
          followUpDate?: DateFilter; 
          implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables?: IncludeVariable[]; 
          pageSize?: number; 
          processDefinitionKey?: string; 
          processInstanceKey?: string; 
          searchAfter: string[]; 
          sort?: TaskOrderBy[]; 
          state?: TaskState; 
          taskDefinitionId?: string; 
          taskVariables?: TaskByVariables[]; 
          tenantIds?: string[]; 
      }
      Hierarchy
      Properties
      assigned?
+TaskSearchAfterRequest | @camunda8/sdk
      Interface TaskSearchAfterRequest
      interface TaskSearchAfterRequest { 
          assigned?: boolean; 
          assignee?: string; 
          assignees?: string[]; 
          candidateGroup?: string; 
          candidateGroups?: string[]; 
          candidateUser?: string; 
          candidateUsers?: string[]; 
          dueDate?: DateFilter; 
          followUpDate?: DateFilter; 
          implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables?: IncludeVariable[]; 
          pageSize?: number; 
          processDefinitionKey?: string; 
          processInstanceKey?: string; 
          searchAfter: string[]; 
          sort?: TaskOrderBy[]; 
          state?: TaskState; 
          taskDefinitionId?: string; 
          taskVariables?: TaskByVariables[]; 
          tenantIds?: string[]; 
      }
      Hierarchy
      Properties
      assigned?
 assignee?
 assignees?
 candidateGroup?
@@ -18,14 +18,14 @@
 taskDefinitionId?
 taskVariables?
 tenantIds?
-
      Properties
      Optional assigned
      assigned?: boolean
      Optional assignee
      assignee?: string
      Optional assignees
      assignees?: string[]
      Optional candidateGroup
      candidateGroup?: string
      Optional candidateGroups
      candidateGroups?: string[]
      Optional candidateUser
      candidateUser?: string
      Optional candidateUsers
      candidateUsers?: string[]
      Optional dueDate
      dueDate?: DateFilter
      Optional followUpDate
      followUpDate?: DateFilter
      Optional implementation
      implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
      Optional includeVariables
      includeVariables?: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
+
      Properties
      Optional assigned
      assigned?: boolean
      Optional assignee
      assignee?: string
      Optional assignees
      assignees?: string[]
      Optional candidateGroup
      candidateGroup?: string
      Optional candidateGroups
      candidateGroups?: string[]
      Optional candidateUser
      candidateUser?: string
      Optional candidateUsers
      candidateUsers?: string[]
      Optional dueDate
      dueDate?: DateFilter
      Optional followUpDate
      followUpDate?: DateFilter
      Optional implementation
      implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
      Optional includeVariables
      includeVariables?: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
 This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
      
-
      Optional pageSize
      pageSize?: number
      Optional processDefinitionKey
      processDefinitionKey?: string
      Optional processInstanceKey
      processInstanceKey?: string
      searchAfter
      searchAfter: string[]
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
+
      Optional pageSize
      pageSize?: number
      Optional processDefinitionKey
      processDefinitionKey?: string
      Optional processInstanceKey
      processInstanceKey?: string
      searchAfter
      searchAfter: string[]
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
 It enables the API to return a page of tasks that directly follow the task identified by the provided values, with respect to the sorting order.
      
-
      Optional sort
      sort?: TaskOrderBy[]
      Optional state
      state?: TaskState
      Optional taskDefinitionId
      taskDefinitionId?: string
      Optional taskVariables
      taskVariables?: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
+
      Optional sort
      sort?: TaskOrderBy[]
      Optional state
      state?: TaskState
      Optional taskDefinitionId
      taskDefinitionId?: string
      Optional taskVariables
      taskVariables?: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
 If defined, the query returns only tasks to which all clauses apply.
 However, it's important to note that this filtering mechanism is
 designed to work exclusively with truncated variables. This means
 variables of a larger size are not compatible with this filter, and
 attempts to use them may result in inaccurate or incomplete query results.
      
-
      Optional tenantIds
      tenantIds?: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional tenantIds
      tenantIds?: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeOrEqualRequest.html b/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeOrEqualRequest.html
index 36a67e68..61dc88c0 100644
--- a/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeOrEqualRequest.html
+++ b/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeOrEqualRequest.html
@@ -1,4 +1,4 @@
-TaskSearchBeforeOrEqualRequest | @camunda8/sdk
      Interface TaskSearchBeforeOrEqualRequest
      interface TaskSearchBeforeOrEqualRequest { 
          assigned?: boolean; 
          assignee?: string; 
          assignees?: string[]; 
          candidateGroup?: string; 
          candidateGroups?: string[]; 
          candidateUser?: string; 
          candidateUsers?: string[]; 
          dueDate?: DateFilter; 
          followUpDate?: DateFilter; 
          implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables?: IncludeVariable[]; 
          pageSize?: number; 
          processDefinitionKey?: string; 
          processInstanceKey?: string; 
          searchBeforeOrEqual: string[]; 
          sort?: TaskOrderBy[]; 
          state?: TaskState; 
          taskDefinitionId?: string; 
          taskVariables?: TaskByVariables[]; 
          tenantIds?: string[]; 
      }
      Hierarchy
      Properties
      assigned?
+TaskSearchBeforeOrEqualRequest | @camunda8/sdk
      Interface TaskSearchBeforeOrEqualRequest
      interface TaskSearchBeforeOrEqualRequest { 
          assigned?: boolean; 
          assignee?: string; 
          assignees?: string[]; 
          candidateGroup?: string; 
          candidateGroups?: string[]; 
          candidateUser?: string; 
          candidateUsers?: string[]; 
          dueDate?: DateFilter; 
          followUpDate?: DateFilter; 
          implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables?: IncludeVariable[]; 
          pageSize?: number; 
          processDefinitionKey?: string; 
          processInstanceKey?: string; 
          searchBeforeOrEqual: string[]; 
          sort?: TaskOrderBy[]; 
          state?: TaskState; 
          taskDefinitionId?: string; 
          taskVariables?: TaskByVariables[]; 
          tenantIds?: string[]; 
      }
      Hierarchy
      Properties
      assigned?
 assignee?
 assignees?
 candidateGroup?
@@ -18,14 +18,14 @@
 taskDefinitionId?
 taskVariables?
 tenantIds?
-
      Properties
      Optional assigned
      assigned?: boolean
      Optional assignee
      assignee?: string
      Optional assignees
      assignees?: string[]
      Optional candidateGroup
      candidateGroup?: string
      Optional candidateGroups
      candidateGroups?: string[]
      Optional candidateUser
      candidateUser?: string
      Optional candidateUsers
      candidateUsers?: string[]
      Optional dueDate
      dueDate?: DateFilter
      Optional followUpDate
      followUpDate?: DateFilter
      Optional implementation
      implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
      Optional includeVariables
      includeVariables?: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
+
      Properties
      Optional assigned
      assigned?: boolean
      Optional assignee
      assignee?: string
      Optional assignees
      assignees?: string[]
      Optional candidateGroup
      candidateGroup?: string
      Optional candidateGroups
      candidateGroups?: string[]
      Optional candidateUser
      candidateUser?: string
      Optional candidateUsers
      candidateUsers?: string[]
      Optional dueDate
      dueDate?: DateFilter
      Optional followUpDate
      followUpDate?: DateFilter
      Optional implementation
      implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
      Optional includeVariables
      includeVariables?: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
 This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
      
-
      Optional pageSize
      pageSize?: number
      Optional processDefinitionKey
      processDefinitionKey?: string
      Optional processInstanceKey
      processInstanceKey?: string
      searchBeforeOrEqual
      searchBeforeOrEqual: string[]
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
+
      Optional pageSize
      pageSize?: number
      Optional processDefinitionKey
      processDefinitionKey?: string
      Optional processInstanceKey
      processInstanceKey?: string
      searchBeforeOrEqual
      searchBeforeOrEqual: string[]
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
 It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.
      
-
      Optional sort
      sort?: TaskOrderBy[]
      Optional state
      state?: TaskState
      Optional taskDefinitionId
      taskDefinitionId?: string
      Optional taskVariables
      taskVariables?: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
+
      Optional sort
      sort?: TaskOrderBy[]
      Optional state
      state?: TaskState
      Optional taskDefinitionId
      taskDefinitionId?: string
      Optional taskVariables
      taskVariables?: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
 If defined, the query returns only tasks to which all clauses apply.
 However, it's important to note that this filtering mechanism is
 designed to work exclusively with truncated variables. This means
 variables of a larger size are not compatible with this filter, and
 attempts to use them may result in inaccurate or incomplete query results.
      
-
      Optional tenantIds
      tenantIds?: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional tenantIds
      tenantIds?: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeRequest.html b/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeRequest.html
index e017c7a2..d1175a36 100644
--- a/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeRequest.html
+++ b/interfaces/index.Tasklist.TasklistDto.TaskSearchBeforeRequest.html
@@ -1,4 +1,4 @@
-TaskSearchBeforeRequest | @camunda8/sdk
      Interface TaskSearchBeforeRequest
      interface TaskSearchBeforeRequest { 
          assigned?: boolean; 
          assignee?: string; 
          assignees?: string[]; 
          candidateGroup?: string; 
          candidateGroups?: string[]; 
          candidateUser?: string; 
          candidateUsers?: string[]; 
          dueDate?: DateFilter; 
          followUpDate?: DateFilter; 
          implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables?: IncludeVariable[]; 
          pageSize?: number; 
          processDefinitionKey?: string; 
          processInstanceKey?: string; 
          searchBefore: string[]; 
          sort?: TaskOrderBy[]; 
          state?: TaskState; 
          taskDefinitionId?: string; 
          taskVariables?: TaskByVariables[]; 
          tenantIds?: string[]; 
      }
      Hierarchy
      Properties
      assigned?
+TaskSearchBeforeRequest | @camunda8/sdk
      Interface TaskSearchBeforeRequest
      interface TaskSearchBeforeRequest { 
          assigned?: boolean; 
          assignee?: string; 
          assignees?: string[]; 
          candidateGroup?: string; 
          candidateGroups?: string[]; 
          candidateUser?: string; 
          candidateUsers?: string[]; 
          dueDate?: DateFilter; 
          followUpDate?: DateFilter; 
          implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables?: IncludeVariable[]; 
          pageSize?: number; 
          processDefinitionKey?: string; 
          processInstanceKey?: string; 
          searchBefore: string[]; 
          sort?: TaskOrderBy[]; 
          state?: TaskState; 
          taskDefinitionId?: string; 
          taskVariables?: TaskByVariables[]; 
          tenantIds?: string[]; 
      }
      Hierarchy
      Properties
      assigned?
 assignee?
 assignees?
 candidateGroup?
@@ -18,14 +18,14 @@
 taskDefinitionId?
 taskVariables?
 tenantIds?
-
      Properties
      Optional assigned
      assigned?: boolean
      Optional assignee
      assignee?: string
      Optional assignees
      assignees?: string[]
      Optional candidateGroup
      candidateGroup?: string
      Optional candidateGroups
      candidateGroups?: string[]
      Optional candidateUser
      candidateUser?: string
      Optional candidateUsers
      candidateUsers?: string[]
      Optional dueDate
      dueDate?: DateFilter
      Optional followUpDate
      followUpDate?: DateFilter
      Optional implementation
      implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
      Optional includeVariables
      includeVariables?: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
+
      Properties
      Optional assigned
      assigned?: boolean
      Optional assignee
      assignee?: string
      Optional assignees
      assignees?: string[]
      Optional candidateGroup
      candidateGroup?: string
      Optional candidateGroups
      candidateGroups?: string[]
      Optional candidateUser
      candidateUser?: string
      Optional candidateUsers
      candidateUsers?: string[]
      Optional dueDate
      dueDate?: DateFilter
      Optional followUpDate
      followUpDate?: DateFilter
      Optional implementation
      implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"
      Optional includeVariables
      includeVariables?: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
 This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
      
-
      Optional pageSize
      pageSize?: number
      Optional processDefinitionKey
      processDefinitionKey?: string
      Optional processInstanceKey
      processInstanceKey?: string
      searchBefore
      searchBefore: string[]
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
+
      Optional pageSize
      pageSize?: number
      Optional processDefinitionKey
      processDefinitionKey?: string
      Optional processInstanceKey
      processInstanceKey?: string
      searchBefore
      searchBefore: string[]
      Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page.
 It enables the API to return a page of tasks that directly precede the task identified by the provided values, with respect to the sorting order.
      
-
      Optional sort
      sort?: TaskOrderBy[]
      Optional state
      state?: TaskState
      Optional taskDefinitionId
      taskDefinitionId?: string
      Optional taskVariables
      taskVariables?: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
+
      Optional sort
      sort?: TaskOrderBy[]
      Optional state
      state?: TaskState
      Optional taskDefinitionId
      taskDefinitionId?: string
      Optional taskVariables
      taskVariables?: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
 If defined, the query returns only tasks to which all clauses apply.
 However, it's important to note that this filtering mechanism is
 designed to work exclusively with truncated variables. This means
 variables of a larger size are not compatible with this filter, and
 attempts to use them may result in inaccurate or incomplete query results.
      
-
      Optional tenantIds
      tenantIds?: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional tenantIds
      tenantIds?: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.TaskSearchRequestBase.html b/interfaces/index.Tasklist.TasklistDto.TaskSearchRequestBase.html
index e1abba14..ceb200c7 100644
--- a/interfaces/index.Tasklist.TasklistDto.TaskSearchRequestBase.html
+++ b/interfaces/index.Tasklist.TasklistDto.TaskSearchRequestBase.html
@@ -1,4 +1,4 @@
-TaskSearchRequestBase | @camunda8/sdk
      Interface TaskSearchRequestBase
      interface TaskSearchRequestBase { 
          assigned: boolean; 
          assignee: string; 
          assignees: string[]; 
          candidateGroup: string; 
          candidateGroups: string[]; 
          candidateUser: string; 
          candidateUsers: string[]; 
          dueDate: DateFilter; 
          followUpDate: DateFilter; 
          implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables: IncludeVariable[]; 
          pageSize: number; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          sort: TaskOrderBy[]; 
          state: TaskState; 
          taskDefinitionId: string; 
          taskVariables: TaskByVariables[]; 
          tenantIds: string[]; 
      }
      Properties
      assigned
+TaskSearchRequestBase | @camunda8/sdk
      Interface TaskSearchRequestBase
      interface TaskSearchRequestBase { 
          assigned: boolean; 
          assignee: string; 
          assignees: string[]; 
          candidateGroup: string; 
          candidateGroups: string[]; 
          candidateUser: string; 
          candidateUsers: string[]; 
          dueDate: DateFilter; 
          followUpDate: DateFilter; 
          implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"; 
          includeVariables: IncludeVariable[]; 
          pageSize: number; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          sort: TaskOrderBy[]; 
          state: TaskState; 
          taskDefinitionId: string; 
          taskVariables: TaskByVariables[]; 
          tenantIds: string[]; 
      }
      Properties
      assigned
 assignee
 assignees
 candidateGroup
@@ -17,12 +17,12 @@
 taskDefinitionId
 taskVariables
 tenantIds
-
      Properties
      assigned
      assigned: boolean
      assignee
      assignee: string
      assignees
      assignees: string[]
      candidateGroup
      candidateGroup: string
      candidateGroups
      candidateGroups: string[]
      candidateUser
      candidateUser: string
      candidateUsers
      candidateUsers: string[]
      dueDate
      dueDate: DateFilter
      followUpDate
      followUpDate: DateFilter
      implementation
      implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"
      includeVariables
      includeVariables: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
+
      Properties
      assigned
      assigned: boolean
      assignee
      assignee: string
      assignees
      assignees: string[]
      candidateGroup
      candidateGroup: string
      candidateGroups
      candidateGroups: string[]
      candidateUser
      candidateUser: string
      candidateUsers
      candidateUsers: string[]
      dueDate
      dueDate: DateFilter
      followUpDate
      followUpDate: DateFilter
      implementation
      implementation: "JOB_WORKER" | "ZEEBE_USER_TASK"
      includeVariables
      includeVariables: IncludeVariable[]
      An array used to specify a list of variable names that should be included in the response when querying tasks.
 This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.
      
-
      pageSize
      pageSize: number
      processDefinitionKey
      processDefinitionKey: string
      processInstanceKey
      processInstanceKey: string
      sort
      sort: TaskOrderBy[]
      state
      state: TaskState
      taskDefinitionId
      taskDefinitionId: string
      taskVariables
      taskVariables: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
+
      pageSize
      pageSize: number
      processDefinitionKey
      processDefinitionKey: string
      processInstanceKey
      processInstanceKey: string
      sort
      sort: TaskOrderBy[]
      state
      state: TaskState
      taskDefinitionId
      taskDefinitionId: string
      taskVariables
      taskVariables: TaskByVariables[]
      An array of filter clauses specifying the variables to filter for.
 If defined, the query returns only tasks to which all clauses apply.
 However, it's important to note that this filtering mechanism is
 designed to work exclusively with truncated variables. This means
 variables of a larger size are not compatible with this filter, and
 attempts to use them may result in inaccurate or incomplete query results.
      
-
      tenantIds
      tenantIds: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      tenantIds
      tenantIds: string[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.User.html b/interfaces/index.Tasklist.TasklistDto.User.html
index 300bed3c..d723e9f4 100644
--- a/interfaces/index.Tasklist.TasklistDto.User.html
+++ b/interfaces/index.Tasklist.TasklistDto.User.html
@@ -1,6 +1,6 @@
-User | @camunda8/sdk
      Interface User
      interface User { 
          displayName: string; 
          permissions: string[]; 
          roles: string[]; 
          salesPlanType: string; 
          userId: string; 
      }
      Properties
      displayName
+User | @camunda8/sdk
      Interface User
      interface User { 
          displayName: string; 
          permissions: string[]; 
          roles: string[]; 
          salesPlanType: string; 
          userId: string; 
      }
      Properties
      displayName
 permissions
 roles
 salesPlanType
 userId
-
      Properties
      displayName
      displayName: string
      permissions
      permissions: string[]
      roles
      roles: string[]
      salesPlanType
      salesPlanType: string
      userId
      userId: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      displayName
      displayName: string
      permissions
      permissions: string[]
      roles
      roles: string[]
      salesPlanType
      salesPlanType: string
      userId
      userId: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.Variable.html b/interfaces/index.Tasklist.TasklistDto.Variable.html
index 81bacea1..32dc1d25 100644
--- a/interfaces/index.Tasklist.TasklistDto.Variable.html
+++ b/interfaces/index.Tasklist.TasklistDto.Variable.html
@@ -1,6 +1,6 @@
-Variable | @camunda8/sdk
      Interface Variable
      interface Variable { 
          draft: DraftSearchVariableValue; 
          id: string; 
          name: string; 
          tenantId: string; 
          value: string; 
      }
      Properties
      draft
+Variable | @camunda8/sdk
      Interface Variable
      interface Variable { 
          draft: DraftSearchVariableValue; 
          id: string; 
          name: string; 
          tenantId: string; 
          value: string; 
      }
      Properties
      draft
 id
 name
 tenantId
 value
-
      Properties
      draft
      draft: DraftSearchVariableValue
      id
      id: string
      name
      name: string
      tenantId
      tenantId: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      draft
      draft: DraftSearchVariableValue
      id
      id: string
      name
      name: string
      tenantId
      tenantId: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.VariableInput.html b/interfaces/index.Tasklist.TasklistDto.VariableInput.html
index 7cf88bb4..3477d315 100644
--- a/interfaces/index.Tasklist.TasklistDto.VariableInput.html
+++ b/interfaces/index.Tasklist.TasklistDto.VariableInput.html
@@ -1,3 +1,3 @@
-VariableInput | @camunda8/sdk
      Interface VariableInput
      interface VariableInput { 
          name: string; 
          value: string; 
      }
      Properties
      name
+VariableInput | @camunda8/sdk
      Interface VariableInput
      interface VariableInput { 
          name: string; 
          value: string; 
      }
      Properties
      name
 value
-
      Properties
      name
      name: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      name
      name: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.VariableSearchResponse.html b/interfaces/index.Tasklist.TasklistDto.VariableSearchResponse.html
index 756eb490..8bc279cf 100644
--- a/interfaces/index.Tasklist.TasklistDto.VariableSearchResponse.html
+++ b/interfaces/index.Tasklist.TasklistDto.VariableSearchResponse.html
@@ -1,6 +1,6 @@
-VariableSearchResponse | @camunda8/sdk
      Interface VariableSearchResponse
      interface VariableSearchResponse { 
          draft: DraftSearchVariableValue; 
          id: string; 
          name: string; 
          previewValue: string; 
          value: string; 
      }
      Hierarchy (view full)
      Properties
      draft
+VariableSearchResponse | @camunda8/sdk
      Interface VariableSearchResponse
      interface VariableSearchResponse { 
          draft: DraftSearchVariableValue; 
          id: string; 
          name: string; 
          previewValue: string; 
          value: string; 
      }
      Hierarchy (view full)
      Properties
      draft
 id
 name
 previewValue
 value
-
      Properties
      draft
      draft: DraftSearchVariableValue
      id
      id: string
      name
      name: string
      previewValue
      previewValue: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      draft
      draft: DraftSearchVariableValue
      id
      id: string
      name
      name: string
      previewValue
      previewValue: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index.Tasklist.TasklistDto.VariableSearchResponseWithoutDraft.html b/interfaces/index.Tasklist.TasklistDto.VariableSearchResponseWithoutDraft.html
index 92b70dcd..2bdd3ca7 100644
--- a/interfaces/index.Tasklist.TasklistDto.VariableSearchResponseWithoutDraft.html
+++ b/interfaces/index.Tasklist.TasklistDto.VariableSearchResponseWithoutDraft.html
@@ -1,5 +1,5 @@
-VariableSearchResponseWithoutDraft | @camunda8/sdk
      Interface VariableSearchResponseWithoutDraft
      interface VariableSearchResponseWithoutDraft { 
          id: string; 
          name: string; 
          previewValue: string; 
          value: string; 
      }
      Hierarchy (view full)
      Properties
      id
+VariableSearchResponseWithoutDraft | @camunda8/sdk
      Interface VariableSearchResponseWithoutDraft
      interface VariableSearchResponseWithoutDraft { 
          id: string; 
          name: string; 
          previewValue: string; 
          value: string; 
      }
      Hierarchy (view full)
      Properties
      id
 name
 previewValue
 value
-
      Properties
      id
      id: string
      name
      name: string
      previewValue
      previewValue: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      id
      id: string
      name
      name: string
      previewValue
      previewValue: string
      value
      value: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.Characteristics.html b/interfaces/index._internal_.Characteristics.html
index 95a96b37..13bb5d40 100644
--- a/interfaces/index._internal_.Characteristics.html
+++ b/interfaces/index._internal_.Characteristics.html
@@ -1,3 +1,3 @@
-Characteristics | @camunda8/sdk
      Interface Characteristics
      interface Characteristics { 
          _tag: GrpcConnectionProfile; 
          startupTime: number; 
      }
      Properties
      _tag
+Characteristics | @camunda8/sdk
      Interface Characteristics
      interface Characteristics { 
          _tag: GrpcConnectionProfile; 
          startupTime: number; 
      }
      Properties
      _tag
 startupTime
-
      Properties
      _tag
      _tag: GrpcConnectionProfile
      startupTime
      startupTime: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      _tag
      _tag: GrpcConnectionProfile
      startupTime
      startupTime: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.Emitter.html b/interfaces/index._internal_.Emitter.html
index fdd55215..f6b8e04a 100644
--- a/interfaces/index._internal_.Emitter.html
+++ b/interfaces/index._internal_.Emitter.html
@@ -1,4 +1,4 @@
-Emitter | @camunda8/sdk
      Interface Emitter<T>
      interface Emitter<T> { 
          emit<K>(eventName, params?): void; 
          off<K>(eventName, fn): void; 
          on<K>(eventName, fn): void; 
      }
       
      Type Parameters
       
      Implemented by
      Methods
      emit
+Emitter | @camunda8/sdk
      Interface Emitter<T>
      interface Emitter<T> { 
          emit<K>(eventName, params?): void; 
          off<K>(eventName, fn): void; 
          on<K>(eventName, fn): void; 
      }
       
      Type Parameters
       
      Implemented by
      Methods
      emit
 off
 on
-
      Methods
      emit
      off
      on
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Methods
      emit
      off
      on
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.IncludeVariable.html b/interfaces/index._internal_.IncludeVariable.html
index 36a50e7a..10d500a4 100644
--- a/interfaces/index._internal_.IncludeVariable.html
+++ b/interfaces/index._internal_.IncludeVariable.html
@@ -1,3 +1,3 @@
-IncludeVariable | @camunda8/sdk
      Interface IncludeVariable
      interface IncludeVariable { 
          alwaysReturnFullValue?: boolean; 
          name: string; 
      }
      Properties
      alwaysReturnFullValue?
+IncludeVariable | @camunda8/sdk
      Interface IncludeVariable
      interface IncludeVariable { 
          alwaysReturnFullValue?: boolean; 
          name: string; 
      }
      Properties
      alwaysReturnFullValue?
 name
-
      Properties
      Optional alwaysReturnFullValue
      alwaysReturnFullValue?: boolean
      name
      name: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Optional alwaysReturnFullValue
      alwaysReturnFullValue?: boolean
      name
      name: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.JSONDoc.html b/interfaces/index._internal_.JSONDoc.html
index 63070f9b..88192db8 100644
--- a/interfaces/index._internal_.JSONDoc.html
+++ b/interfaces/index._internal_.JSONDoc.html
@@ -1 +1 @@
-JSONDoc | @camunda8/sdk
      Interface JSONDoc
      interface JSONDoc { 
          [key: string]: JSON; 
      }
      Indexable
      [key: string]: JSON
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+JSONDoc | @camunda8/sdk
      Interface JSONDoc
      interface JSONDoc { 
          [key: string]: JSON; 
      }
      Indexable
      [key: string]: JSON
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.Logger.html b/interfaces/index._internal_.Logger.html
index 5e15e87b..0319dfa8 100644
--- a/interfaces/index._internal_.Logger.html
+++ b/interfaces/index._internal_.Logger.html
@@ -1,4 +1,4 @@
-Logger | @camunda8/sdk
      Interface Logger
      interface Logger { 
          debug: LogFn; 
          error: LogFn; 
          info: LogFn; 
      }
      Properties
      debug
+Logger | @camunda8/sdk
      Interface Logger
      interface Logger { 
          debug: LogFn; 
          error: LogFn; 
          info: LogFn; 
      }
      Properties
      debug
 error
 info
-
      Properties
      debug
      debug: LogFn
      error
      error: LogFn
      info
      info: LogFn
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      debug
      debug: LogFn
      error
      error: LogFn
      info
      info: LogFn
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.TaskOrderBy.html b/interfaces/index._internal_.TaskOrderBy.html
index bd6e3024..349ddfb7 100644
--- a/interfaces/index._internal_.TaskOrderBy.html
+++ b/interfaces/index._internal_.TaskOrderBy.html
@@ -1,3 +1,3 @@
-TaskOrderBy | @camunda8/sdk
      Interface TaskOrderBy
      interface TaskOrderBy { 
          field: "completionTime" | "creationTime" | "followUpDate" | "dueDate"; 
          order: "ASC" | "DESC"; 
      }
      Properties
      field
+TaskOrderBy | @camunda8/sdk
      Interface TaskOrderBy
      interface TaskOrderBy { 
          field: "completionTime" | "creationTime" | "followUpDate" | "dueDate"; 
          order: "ASC" | "DESC"; 
      }
      Properties
      field
 order
-
      Properties
      field
      field: "completionTime" | "creationTime" | "followUpDate" | "dueDate"
      order
      order: "ASC" | "DESC"
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      field
      field: "completionTime" | "creationTime" | "followUpDate" | "dueDate"
      order
      order: "ASC" | "DESC"
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/index._internal_.ZBWorkerConstructorConfig.html b/interfaces/index._internal_.ZBWorkerConstructorConfig.html
index e60f09f3..efd2d827 100644
--- a/interfaces/index._internal_.ZBWorkerConstructorConfig.html
+++ b/interfaces/index._internal_.ZBWorkerConstructorConfig.html
@@ -1,4 +1,4 @@
-ZBWorkerConstructorConfig | @camunda8/sdk
      Interface ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      interface ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> { 
          customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>); 
          grpcClient: ZBGrpc; 
          id: null | string; 
          idColor: Chalk; 
          inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>); 
          log: StatefulLogInterceptor; 
          options: ZBWorkerOptions<WorkerInputVariables> & ZBClientOptions; 
          taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>; 
          taskType: string; 
          zbClient: ZeebeGrpcClient; 
      }
       
      Type Parameters
      • WorkerInputVariables
      • CustomHeaderShape
      • WorkerOutputVariables
       
      Properties
      customHeadersDto?
+ZBWorkerConstructorConfig | @camunda8/sdk
      Interface ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      interface ZBWorkerConstructorConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> { 
          customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>); 
          grpcClient: ZBGrpc; 
          id: null | string; 
          idColor: Chalk; 
          inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>); 
          log: StatefulLogInterceptor; 
          options: ZBWorkerOptions<WorkerInputVariables> & ZBClientOptions; 
          taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>; 
          taskType: string; 
          zbClient: ZeebeGrpcClient; 
      }
       
      Type Parameters
      • WorkerInputVariables
      • CustomHeaderShape
      • WorkerOutputVariables
       
      Properties
      customHeadersDto?
 grpcClient
 id
 idColor
@@ -8,4 +8,4 @@
 taskHandler
 taskType
 zbClient
-
      Properties
      Optional customHeadersDto
      customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>)
      Type declaration
      grpcClient
      grpcClient: ZBGrpc
      id
      id: null | string
      idColor
      idColor: Chalk
      Optional inputVariableDto
      inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>)
      Type declaration
      log
      log: StatefulLogInterceptor
      options
      options: ZBWorkerOptions<WorkerInputVariables> & ZBClientOptions
      taskHandler
      taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      taskType
      taskType: string
      zbClient
      zbClient: ZeebeGrpcClient
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Optional customHeadersDto
      customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>)
      Type declaration
      grpcClient
      grpcClient: ZBGrpc
      id
      id: null | string
      idColor
      idColor: Chalk
      Optional inputVariableDto
      inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>)
      Type declaration
      log
      log: StatefulLogInterceptor
      options
      options: ZBWorkerOptions<WorkerInputVariables> & ZBClientOptions
      taskHandler
      taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      taskType
      taskType: string
      zbClient
      zbClient: ZeebeGrpcClient
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ActivateInstruction.html b/interfaces/zeebe_types.ActivateInstruction.html
index 2f512207..b33cec1f 100644
--- a/interfaces/zeebe_types.ActivateInstruction.html
+++ b/interfaces/zeebe_types.ActivateInstruction.html
@@ -1,9 +1,9 @@
-ActivateInstruction | @camunda8/sdk
      Interface ActivateInstruction
      interface ActivateInstruction { 
          ancestorElementInstanceKey: string; 
          elementId: string; 
          variableInstructions: VariableInstruction[]; 
      }
      Properties
      ancestorElementInstanceKey
+ActivateInstruction | @camunda8/sdk
      Interface ActivateInstruction
      interface ActivateInstruction { 
          ancestorElementInstanceKey: string; 
          elementId: string; 
          variableInstructions: VariableInstruction[]; 
      }
      Properties
      ancestorElementInstanceKey
 elementId
 variableInstructions
 
      Properties
      ancestorElementInstanceKey
      ancestorElementInstanceKey: string
      the key of the ancestor scope the element instance should be created in;
 set to -1 to create the new element instance within an existing element
 instance of the flow scope
      
-
      elementId
      elementId: string
      the id of the element that should be activated
      
-
      variableInstructions
      variableInstructions: VariableInstruction[]
      instructions describing which variables should be created
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      elementId
      elementId: string
      the id of the element that should be activated
      
+
      variableInstructions
      variableInstructions: VariableInstruction[]
      instructions describing which variables should be created
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ActivateJobsRequest.html b/interfaces/zeebe_types.ActivateJobsRequest.html
index 208b8b73..a48024a2 100644
--- a/interfaces/zeebe_types.ActivateJobsRequest.html
+++ b/interfaces/zeebe_types.ActivateJobsRequest.html
@@ -1,5 +1,5 @@
 ActivateJobsRequest | @camunda8/sdk
      Interface ActivateJobsRequest
      Request object to send the broker to request jobs for the worker.
      
-
      interface ActivateJobsRequest { 
          fetchVariable?: string[]; 
          maxJobsToActivate: number; 
          requestTimeout: MaybeTimeDuration; 
          tenantIds?: string[]; 
          timeout: MaybeTimeDuration; 
          type: string; 
          worker: string; 
      }
      Properties
      fetchVariable?
+
      interface ActivateJobsRequest { 
          fetchVariable?: string[]; 
          maxJobsToActivate: number; 
          requestTimeout: MaybeTimeDuration; 
          tenantIds?: string[]; 
          timeout: MaybeTimeDuration; 
          type: string; 
          worker: string; 
      }
      Properties
      fetchVariable?
 maxJobsToActivate
 requestTimeout
 tenantIds?
@@ -8,16 +8,16 @@
 worker
 
      Properties
      Optional fetchVariable
      fetchVariable?: string[]
      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
      
-
      maxJobsToActivate
      maxJobsToActivate: number
      The maximum jobs to activate by this request
      
-
      requestTimeout
      requestTimeout: MaybeTimeDuration
      The request will be completed when atleast one job is activated or after the requestTimeout.
+
      maxJobsToActivate
      maxJobsToActivate: number
      The maximum jobs to activate by this request
      
+
      requestTimeout
      requestTimeout: MaybeTimeDuration
      The request will be completed when atleast 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
      
-
      Optional tenantIds
      tenantIds?: string[]
      a list of IDs of tenants for which to activate jobs
      
-
      timeout
      timeout: MaybeTimeDuration
      The duration the broker allows for jobs activated by this call to complete
+
      Optional tenantIds
      tenantIds?: string[]
      a list of IDs of tenants for which to activate jobs
      
+
      timeout
      timeout: MaybeTimeDuration
      The duration the broker allows for jobs activated by this call to complete
 before timing them out releasing them for retry on the broker.
 The broker checks time outs every 30 seconds, so the broker timeout is guaranteed in at-most timeout + 29s
 be guaranteed.
      
-
      type
      type: string
      The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
+
      type
      type: string
      The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
 type="payment-service" />)
      
-
      worker
      worker: string
      The name of the worker activating the jobs, mostly used for logging purposes
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      worker
      worker: string
      The name of the worker activating the jobs, mostly used for logging purposes
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ActivateJobsResponse.html b/interfaces/zeebe_types.ActivateJobsResponse.html
index 9716fd8a..1190f20b 100644
--- a/interfaces/zeebe_types.ActivateJobsResponse.html
+++ b/interfaces/zeebe_types.ActivateJobsResponse.html
@@ -1,2 +1,2 @@
-ActivateJobsResponse | @camunda8/sdk
      Interface ActivateJobsResponse
      interface ActivateJobsResponse { 
          jobs: ActivatedJob[]; 
      }
      Properties
      jobs
-
      Properties
      jobs
      jobs: ActivatedJob[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+ActivateJobsResponse | @camunda8/sdk
      Interface ActivateJobsResponse
      interface ActivateJobsResponse { 
          jobs: ActivatedJob[]; 
      }
      Properties
      jobs
+
      Properties
      jobs
      jobs: ActivatedJob[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ActivatedJob.html b/interfaces/zeebe_types.ActivatedJob.html
index 79f8aaba..72f6bc8f 100644
--- a/interfaces/zeebe_types.ActivatedJob.html
+++ b/interfaces/zeebe_types.ActivatedJob.html
@@ -1,4 +1,4 @@
-ActivatedJob | @camunda8/sdk
      Interface ActivatedJob
      interface ActivatedJob { 
          bpmnProcessId: string; 
          customHeaders: string; 
          deadline: string; 
          elementId: string; 
          elementInstanceKey: string; 
          key: string; 
          processDefinitionKey: string; 
          processDefinitionVersion: number; 
          processInstanceKey: string; 
          retries: number; 
          tenantId: string; 
          type: string; 
          variables: string; 
          worker: string; 
      }
      Properties
      bpmnProcessId
+ActivatedJob | @camunda8/sdk
      Interface ActivatedJob
      interface ActivatedJob { 
          bpmnProcessId: string; 
          customHeaders: string; 
          deadline: string; 
          elementId: string; 
          elementInstanceKey: string; 
          key: string; 
          processDefinitionKey: string; 
          processDefinitionVersion: number; 
          processInstanceKey: string; 
          retries: number; 
          tenantId: string; 
          type: string; 
          variables: string; 
          worker: string; 
      }
      Properties
      bpmnProcessId
 customHeaders
 deadline
 elementId
@@ -13,20 +13,20 @@
 variables
 worker
 
      Properties
      Readonly bpmnProcessId
      bpmnProcessId: string
      The bpmn process ID of the job process definition
      
-
      Readonly customHeaders
      customHeaders: string
      A set of custom headers defined during modelling
      
-
      Readonly deadline
      deadline: string
      When the job will timeout on the broker if it is not completed by this worker.
+
      Readonly customHeaders
      customHeaders: string
      A set of custom headers defined during modelling
      
+
      Readonly deadline
      deadline: string
      When the job will timeout on the broker if it is not completed by this worker.
 In epoch milliseconds
      
-
      Readonly elementId
      elementId: string
      The associated task element ID
      
-
      Readonly elementInstanceKey
      elementInstanceKey: string
      The unique key identifying the associated task, unique within the scope of the
+
      Readonly elementId
      elementId: string
      The associated task element ID
      
+
      Readonly elementInstanceKey
      elementInstanceKey: string
      The unique key identifying the associated task, unique within the scope of the
 process instance
      
-
      Readonly key
      key: string
      The key, a unique identifier for the job
      
-
      Readonly processDefinitionKey
      processDefinitionKey: string
      The key of the job process definition
      
-
      Readonly processDefinitionVersion
      processDefinitionVersion: number
      The version of the job process definition
      
-
      Readonly processInstanceKey
      processInstanceKey: string
      The job's process instance key
      
-
      Readonly retries
      retries: number
      Readonly tenantId
      tenantId: string
      the id of the tenant that owns the job
      
-
      Readonly type
      type: string
      The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
+
      Readonly key
      key: string
      The key, a unique identifier for the job
      
+
      Readonly processDefinitionKey
      processDefinitionKey: string
      The key of the job process definition
      
+
      Readonly processDefinitionVersion
      processDefinitionVersion: number
      The version of the job process definition
      
+
      Readonly processInstanceKey
      processInstanceKey: string
      The job's process instance key
      
+
      Readonly retries
      retries: number
      Readonly tenantId
      tenantId: string
      the id of the tenant that owns the job
      
+
      Readonly type
      type: string
      The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
 type="payment-service" />)
      
-
      Readonly variables
      variables: string
      All visible variables in the task scope, computed at activation time, constrained by any
+
      Readonly variables
      variables: string
      All visible variables in the task scope, computed at activation time, constrained by any
 fetchVariables value in the ActivateJobRequest.
      
-
      Readonly worker
      worker: string
      The name of the worker that activated this job
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Readonly worker
      worker: string
      The name of the worker that activated this job
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.BroadcastSignalReq.html b/interfaces/zeebe_types.BroadcastSignalReq.html
index 0ca005ab..32188666 100644
--- a/interfaces/zeebe_types.BroadcastSignalReq.html
+++ b/interfaces/zeebe_types.BroadcastSignalReq.html
@@ -1,4 +1,4 @@
-BroadcastSignalReq | @camunda8/sdk
      Interface BroadcastSignalReq
      interface BroadcastSignalReq { 
          signalName: string; 
          tenantId?: string; 
          variables?: JSONDoc; 
      }
      Properties
      signalName
+BroadcastSignalReq | @camunda8/sdk
      Interface BroadcastSignalReq
      interface BroadcastSignalReq { 
          signalName: string; 
          tenantId?: string; 
          variables?: JSONDoc; 
      }
      Properties
      signalName
 tenantId?
 variables?
-
      Properties
      signalName
      signalName: string
      Optional tenantId
      tenantId?: string
      Optional variables
      variables?: JSONDoc
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      signalName
      signalName: string
      Optional tenantId
      tenantId?: string
      Optional variables
      variables?: JSONDoc
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.BroadcastSignalRequest.html b/interfaces/zeebe_types.BroadcastSignalRequest.html
index 8a0defd3..1bd1e755 100644
--- a/interfaces/zeebe_types.BroadcastSignalRequest.html
+++ b/interfaces/zeebe_types.BroadcastSignalRequest.html
@@ -1,8 +1,8 @@
-BroadcastSignalRequest | @camunda8/sdk
      Interface BroadcastSignalRequest
      interface BroadcastSignalRequest { 
          signalName: string; 
          tenantId?: string; 
          variables: string; 
      }
      Properties
      signalName
+BroadcastSignalRequest | @camunda8/sdk
      Interface BroadcastSignalRequest
      interface BroadcastSignalRequest { 
          signalName: string; 
          tenantId?: string; 
          variables: string; 
      }
      Properties
      signalName
 tenantId?
 variables
 
      Properties
      signalName
      signalName: string
      The name of the signal
      
-
      Optional tenantId
      tenantId?: string
      the id of the tenant that owns the signal.
      
-
      variables
      variables: string
      the signal variables as a JSON document; to be valid, the root of the document must be an
+
      Optional tenantId
      tenantId?: string
      the id of the tenant that owns the signal.
      
+
      variables
      variables: string
      the signal variables as a JSON document; to be valid, the root of the document must be an
 object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.BroadcastSignalRes.html b/interfaces/zeebe_types.BroadcastSignalRes.html
index 456fdfa1..f02032d6 100644
--- a/interfaces/zeebe_types.BroadcastSignalRes.html
+++ b/interfaces/zeebe_types.BroadcastSignalRes.html
@@ -1,2 +1,2 @@
-BroadcastSignalRes | @camunda8/sdk
      Interface BroadcastSignalRes
      interface BroadcastSignalRes { 
          key: string; 
      }
      Properties
      key
-
      Properties
      key
      key: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+BroadcastSignalRes | @camunda8/sdk
      Interface BroadcastSignalRes
      interface BroadcastSignalRes { 
          key: string; 
      }
      Properties
      key
+
      Properties
      key
      key: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.BroadcastSignalResponse.html b/interfaces/zeebe_types.BroadcastSignalResponse.html
index dc22f701..fb3742ce 100644
--- a/interfaces/zeebe_types.BroadcastSignalResponse.html
+++ b/interfaces/zeebe_types.BroadcastSignalResponse.html
@@ -1,3 +1,3 @@
-BroadcastSignalResponse | @camunda8/sdk
      Interface BroadcastSignalResponse
      interface BroadcastSignalResponse { 
          key: string; 
      }
      Properties
      key
+BroadcastSignalResponse | @camunda8/sdk
      Interface BroadcastSignalResponse
      interface BroadcastSignalResponse { 
          key: string; 
      }
      Properties
      key
 
      Properties
      key
      key: string
      the unique ID of the signal that was broadcasted.
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.BrokerInfo.html b/interfaces/zeebe_types.BrokerInfo.html
index 700ee984..995b0c1a 100644
--- a/interfaces/zeebe_types.BrokerInfo.html
+++ b/interfaces/zeebe_types.BrokerInfo.html
@@ -1,5 +1,5 @@
-BrokerInfo | @camunda8/sdk
      Interface BrokerInfo
      interface BrokerInfo { 
          host: string; 
          nodeId: number; 
          partitions: Partition[]; 
          port: number; 
      }
      Properties
      host
+BrokerInfo | @camunda8/sdk
      Interface BrokerInfo
      interface BrokerInfo { 
          host: string; 
          nodeId: number; 
          partitions: Partition[]; 
          port: number; 
      }
      Properties
      host
 nodeId
 partitions
 port
-
      Properties
      host
      host: string
      nodeId
      nodeId: number
      partitions
      partitions: Partition[]
      port
      port: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      host
      host: string
      nodeId
      nodeId: number
      partitions
      partitions: Partition[]
      port
      port: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CamundaCloudConfig.html b/interfaces/zeebe_types.CamundaCloudConfig.html
index bcf9dce6..d34709f1 100644
--- a/interfaces/zeebe_types.CamundaCloudConfig.html
+++ b/interfaces/zeebe_types.CamundaCloudConfig.html
@@ -1,9 +1,9 @@
-CamundaCloudConfig | @camunda8/sdk
      Interface CamundaCloudConfig
      interface CamundaCloudConfig { 
          cacheDir?: string; 
          cacheOnDisk?: boolean; 
          clientId: string; 
          clientSecret: string; 
          clusterId: string; 
          clusterRegion?: string; 
      }
      Properties
      cacheDir?
+CamundaCloudConfig | @camunda8/sdk
      Interface CamundaCloudConfig
      interface CamundaCloudConfig { 
          cacheDir?: string; 
          cacheOnDisk?: boolean; 
          clientId: string; 
          clientSecret: string; 
          clusterId: string; 
          clusterRegion?: string; 
      }
      Properties
      cacheDir?
 cacheOnDisk?
 clientId
 clientSecret
 clusterId
 clusterRegion?
-
      Properties
      Optional cacheDir
      cacheDir?: string
      Optional cacheOnDisk
      cacheOnDisk?: boolean
      clientId
      clientId: string
      Just the UUID of the cluster
      
-
      clientSecret
      clientSecret: string
      clusterId
      clusterId: string
      Optional clusterRegion
      clusterRegion?: string
      Defaults to bru-2
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Optional cacheDir
      cacheDir?: string
      Optional cacheOnDisk
      cacheOnDisk?: boolean
      clientId
      clientId: string
      Just the UUID of the cluster
      
+
      clientSecret
      clientSecret: string
      clusterId
      clusterId: string
      Optional clusterRegion
      clusterRegion?: string
      Defaults to bru-2
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CompleteJobRequest.html b/interfaces/zeebe_types.CompleteJobRequest.html
index 989732d1..1f8b1c4f 100644
--- a/interfaces/zeebe_types.CompleteJobRequest.html
+++ b/interfaces/zeebe_types.CompleteJobRequest.html
@@ -1,3 +1,3 @@
-CompleteJobRequest | @camunda8/sdk
      Interface CompleteJobRequest<Variables>
      interface CompleteJobRequest<Variables> { 
          jobKey: string; 
          variables: Variables; 
      }
       
      Type Parameters
       
      Properties
      jobKey
+CompleteJobRequest | @camunda8/sdk
      Interface CompleteJobRequest<Variables>
      interface CompleteJobRequest<Variables> { 
          jobKey: string; 
          variables: Variables; 
      }
       
      Type Parameters
       
      Properties
      jobKey
 variables
-
      Properties
      Readonly jobKey
      jobKey: string
      variables
      variables: Variables
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Readonly jobKey
      jobKey: string
      variables
      variables: Variables
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CreateProcessBaseRequest.html b/interfaces/zeebe_types.CreateProcessBaseRequest.html
index bb24c7d2..ea8539fd 100644
--- a/interfaces/zeebe_types.CreateProcessBaseRequest.html
+++ b/interfaces/zeebe_types.CreateProcessBaseRequest.html
@@ -1,10 +1,10 @@
-CreateProcessBaseRequest | @camunda8/sdk
      Interface CreateProcessBaseRequest<V>
      interface CreateProcessBaseRequest<V> { 
          bpmnProcessId: string; 
          tenantId?: string; 
          variables: V; 
          version?: number; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
+CreateProcessBaseRequest | @camunda8/sdk
      Interface CreateProcessBaseRequest<V>
      interface CreateProcessBaseRequest<V> { 
          bpmnProcessId: string; 
          tenantId?: string; 
          variables: V; 
          version?: number; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
 tenantId?
 variables
 version?
 
      Properties
      bpmnProcessId
      bpmnProcessId: string
      the BPMN process ID of the process definition
      
-
      Optional tenantId
      tenantId?: string
      The tenantId for a multi-tenant enabled cluster.
      
-
      variables
      variables: V
      JSON document that will instantiate the variables for the root variable scope of the
+
      Optional tenantId
      tenantId?: string
      The tenantId for a multi-tenant enabled cluster.
      
+
      variables
      variables: V
      JSON document that will instantiate the variables for the root variable scope of the
 process instance.
      
-
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CreateProcessInstanceBaseRequest.html b/interfaces/zeebe_types.CreateProcessInstanceBaseRequest.html
index d0e8f2b1..ac91ffca 100644
--- a/interfaces/zeebe_types.CreateProcessInstanceBaseRequest.html
+++ b/interfaces/zeebe_types.CreateProcessInstanceBaseRequest.html
@@ -1,10 +1,10 @@
-CreateProcessInstanceBaseRequest | @camunda8/sdk
      Interface CreateProcessInstanceBaseRequest
      interface CreateProcessInstanceBaseRequest { 
          bpmnProcessId: string; 
          tenantId?: string; 
          variables: string; 
          version?: number; 
      }
      Hierarchy (view full)
      Properties
      bpmnProcessId
+CreateProcessInstanceBaseRequest | @camunda8/sdk
      Interface CreateProcessInstanceBaseRequest
      interface CreateProcessInstanceBaseRequest { 
          bpmnProcessId: string; 
          tenantId?: string; 
          variables: string; 
          version?: number; 
      }
      Hierarchy (view full)
      Properties
      bpmnProcessId
 tenantId?
 variables
 version?
 
      Properties
      bpmnProcessId
      bpmnProcessId: string
      the BPMN process ID of the process definition
      
-
      Optional tenantId
      tenantId?: string
      the tenant id of the process definition
      
-
      variables
      variables: string
      JSON document that will instantiate the variables for the root variable scope of the
+
      Optional tenantId
      tenantId?: string
      the tenant id of the process definition
      
+
      variables
      variables: string
      JSON document that will instantiate the variables for the root variable scope of the
 process instance.
      
-
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CreateProcessInstanceReq.html b/interfaces/zeebe_types.CreateProcessInstanceReq.html
index aa2114c5..1da65d53 100644
--- a/interfaces/zeebe_types.CreateProcessInstanceReq.html
+++ b/interfaces/zeebe_types.CreateProcessInstanceReq.html
@@ -1,14 +1,14 @@
-CreateProcessInstanceReq | @camunda8/sdk
      Interface CreateProcessInstanceReq<V>
      interface CreateProcessInstanceReq<V> { 
          bpmnProcessId: string; 
          startInstructions?: ProcessInstanceCreationStartInstruction[]; 
          tenantId?: string; 
          variables: V; 
          version?: number; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
+CreateProcessInstanceReq | @camunda8/sdk
      Interface CreateProcessInstanceReq<V>
      interface CreateProcessInstanceReq<V> { 
          bpmnProcessId: string; 
          startInstructions?: ProcessInstanceCreationStartInstruction[]; 
          tenantId?: string; 
          variables: V; 
          version?: number; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
 startInstructions?
 tenantId?
 variables
 version?
 
      Properties
      bpmnProcessId
      bpmnProcessId: string
      the BPMN process ID of the process definition
      
-
      Optional startInstructions
      startInstructions?: ProcessInstanceCreationStartInstruction[]
      List of start instructions. If empty (default) the process instance
+
      Optional startInstructions
      startInstructions?: ProcessInstanceCreationStartInstruction[]
      List of start instructions. If empty (default) the process instance
 will start at the start event. If non-empty the process instance will apply start
 instructions after it has been created
      
-
      Optional tenantId
      tenantId?: string
      The tenantId for a multi-tenant enabled cluster.
      
-
      variables
      variables: V
      JSON document that will instantiate the variables for the root variable scope of the
+
      Optional tenantId
      tenantId?: string
      The tenantId for a multi-tenant enabled cluster.
      
+
      variables
      variables: V
      JSON document that will instantiate the variables for the root variable scope of the
 process instance.
      
-
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CreateProcessInstanceRequest.html b/interfaces/zeebe_types.CreateProcessInstanceRequest.html
index 8cd5c503..36fb8254 100644
--- a/interfaces/zeebe_types.CreateProcessInstanceRequest.html
+++ b/interfaces/zeebe_types.CreateProcessInstanceRequest.html
@@ -1,14 +1,14 @@
-CreateProcessInstanceRequest | @camunda8/sdk
      Interface CreateProcessInstanceRequest
      interface CreateProcessInstanceRequest { 
          bpmnProcessId: string; 
          startInstructions: ProcessInstanceCreationStartInstruction[]; 
          tenantId?: string; 
          variables: string; 
          version?: number; 
      }
      Hierarchy (view full)
      Properties
      bpmnProcessId
+CreateProcessInstanceRequest | @camunda8/sdk
      Interface CreateProcessInstanceRequest
      interface CreateProcessInstanceRequest { 
          bpmnProcessId: string; 
          startInstructions: ProcessInstanceCreationStartInstruction[]; 
          tenantId?: string; 
          variables: string; 
          version?: number; 
      }
      Hierarchy (view full)
      Properties
      bpmnProcessId
 startInstructions
 tenantId?
 variables
 version?
 
      Properties
      bpmnProcessId
      bpmnProcessId: string
      the BPMN process ID of the process definition
      
-
      startInstructions
      startInstructions: ProcessInstanceCreationStartInstruction[]
      List of start instructions. If empty (default) the process instance
+
      startInstructions
      startInstructions: ProcessInstanceCreationStartInstruction[]
      List of start instructions. If empty (default) the process instance
 will start at the start event. If non-empty the process instance will apply start
 instructions after it has been created
      
-
      Optional tenantId
      tenantId?: string
      the tenant id of the process definition
      
-
      variables
      variables: string
      JSON document that will instantiate the variables for the root variable scope of the
+
      Optional tenantId
      tenantId?: string
      the tenant id of the process definition
      
+
      variables
      variables: string
      JSON document that will instantiate the variables for the root variable scope of the
 process instance.
      
-
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CreateProcessInstanceResponse.html b/interfaces/zeebe_types.CreateProcessInstanceResponse.html
index d138d61d..0460a9ef 100644
--- a/interfaces/zeebe_types.CreateProcessInstanceResponse.html
+++ b/interfaces/zeebe_types.CreateProcessInstanceResponse.html
@@ -1,15 +1,15 @@
-CreateProcessInstanceResponse | @camunda8/sdk
      Interface CreateProcessInstanceResponse
      interface CreateProcessInstanceResponse { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      bpmnProcessId
+CreateProcessInstanceResponse | @camunda8/sdk
      Interface CreateProcessInstanceResponse
      interface CreateProcessInstanceResponse { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      bpmnProcessId
 processDefinitionKey
 processInstanceKey
 tenantId
 version
 
      Properties
      Readonly bpmnProcessId
      bpmnProcessId: string
      The BPMN process ID of the process definition
      
-
      Readonly processDefinitionKey
      processDefinitionKey: string
      The unique key identifying the process definition (e.g. returned from a process
+
      Readonly processDefinitionKey
      processDefinitionKey: string
      The unique key identifying the process definition (e.g. returned from a process
 in the DeployResourceResponse message)
      
-
      Readonly processInstanceKey
      processInstanceKey: string
      Stringified JSON document that will instantiate the variables for the root variable scope of the
+
      Readonly processInstanceKey
      processInstanceKey: string
      Stringified JSON document that will instantiate the variables for the root variable scope of the
 process instance; it must be a JSON object, as variables will be mapped in a
 key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
 "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
      valid argument, as the root of the JSON document is an array and not an object.
      
-
      Readonly tenantId
      tenantId: string
      the tenant identifier of the created process instance
      
-
      Readonly version
      version: number
      The version of the process; set to -1 to use the latest version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Readonly tenantId
      tenantId: string
      the tenant identifier of the created process instance
      
+
      Readonly version
      version: number
      The version of the process; set to -1 to use the latest version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CreateProcessInstanceWithResultReq.html b/interfaces/zeebe_types.CreateProcessInstanceWithResultReq.html
index 8bda1ea9..acb371d4 100644
--- a/interfaces/zeebe_types.CreateProcessInstanceWithResultReq.html
+++ b/interfaces/zeebe_types.CreateProcessInstanceWithResultReq.html
@@ -1,16 +1,16 @@
-CreateProcessInstanceWithResultReq | @camunda8/sdk
      Interface CreateProcessInstanceWithResultReq<T>
      interface CreateProcessInstanceWithResultReq<T> { 
          bpmnProcessId: string; 
          fetchVariables?: string[]; 
          requestTimeout?: number; 
          tenantId?: string; 
          variables: T; 
          version?: number; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
+CreateProcessInstanceWithResultReq | @camunda8/sdk
      Interface CreateProcessInstanceWithResultReq<T>
      interface CreateProcessInstanceWithResultReq<T> { 
          bpmnProcessId: string; 
          fetchVariables?: string[]; 
          requestTimeout?: number; 
          tenantId?: string; 
          variables: T; 
          version?: number; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
 fetchVariables?
 requestTimeout?
 tenantId?
 variables
 version?
 
      Properties
      bpmnProcessId
      bpmnProcessId: string
      the BPMN process ID of the process definition
      
-
      Optional fetchVariables
      fetchVariables?: string[]
      list of names of variables to be included in CreateProcessInstanceWithResultResponse.variables.
+
      Optional fetchVariables
      fetchVariables?: string[]
      list of names of variables to be included in CreateProcessInstanceWithResultResponse.variables.
 If empty, all visible variables in the root scope will be returned.
      
-
      Optional requestTimeout
      requestTimeout?: number
      timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout.
+
      Optional requestTimeout
      requestTimeout?: number
      timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout.
 if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.
      
-
      Optional tenantId
      tenantId?: string
      The tenantId for a multi-tenant enabled cluster.
      
-
      variables
      variables: T
      JSON document that will instantiate the variables for the root variable scope of the
+
      Optional tenantId
      tenantId?: string
      The tenantId for a multi-tenant enabled cluster.
      
+
      variables
      variables: T
      JSON document that will instantiate the variables for the root variable scope of the
 process instance.
      
-
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional version
      version?: number
      the version of the process; if not specified it will use the latest version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CreateProcessInstanceWithResultRequest.html b/interfaces/zeebe_types.CreateProcessInstanceWithResultRequest.html
index 9337da22..80a6e259 100644
--- a/interfaces/zeebe_types.CreateProcessInstanceWithResultRequest.html
+++ b/interfaces/zeebe_types.CreateProcessInstanceWithResultRequest.html
@@ -1,8 +1,8 @@
-CreateProcessInstanceWithResultRequest | @camunda8/sdk
      Interface CreateProcessInstanceWithResultRequest
      interface CreateProcessInstanceWithResultRequest { 
          fetchVariables?: string[]; 
          request: CreateProcessInstanceBaseRequest; 
          requestTimeout: number; 
      }
      Properties
      fetchVariables?
+CreateProcessInstanceWithResultRequest | @camunda8/sdk
      Interface CreateProcessInstanceWithResultRequest
      interface CreateProcessInstanceWithResultRequest { 
          fetchVariables?: string[]; 
          request: CreateProcessInstanceBaseRequest; 
          requestTimeout: number; 
      }
      Properties
      fetchVariables?
 request
 requestTimeout
 
      Properties
      Optional fetchVariables
      fetchVariables?: string[]
      list of names of variables to be included in CreateProcessInstanceWithResultResponse.variables.
 If empty, all visible variables in the root scope will be returned.
      
-
      request
      request: CreateProcessInstanceBaseRequest
      requestTimeout
      requestTimeout: number
      timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout.
+
      request
      request: CreateProcessInstanceBaseRequest
      requestTimeout
      requestTimeout: number
      timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout.
 if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CreateProcessInstanceWithResultResponse.html b/interfaces/zeebe_types.CreateProcessInstanceWithResultResponse.html
index 22fe61c1..41598b06 100644
--- a/interfaces/zeebe_types.CreateProcessInstanceWithResultResponse.html
+++ b/interfaces/zeebe_types.CreateProcessInstanceWithResultResponse.html
@@ -1,4 +1,4 @@
-CreateProcessInstanceWithResultResponse | @camunda8/sdk
      Interface CreateProcessInstanceWithResultResponse<Result>
      interface CreateProcessInstanceWithResultResponse<Result> { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          tenantId: string; 
          variables: Result; 
          version: number; 
      }
       
      Type Parameters
      • Result
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
+CreateProcessInstanceWithResultResponse | @camunda8/sdk
      Interface CreateProcessInstanceWithResultResponse<Result>
      interface CreateProcessInstanceWithResultResponse<Result> { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          tenantId: string; 
          variables: Result; 
          version: number; 
      }
       
      Type Parameters
      • Result
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
 processDefinitionKey
 processInstanceKey
 tenantId
@@ -6,10 +6,10 @@
 version
 
      Properties
      Readonly bpmnProcessId
      bpmnProcessId: string
      the BPMN process ID of the process definition which was used to create the process
 instance
      
-
      Readonly processDefinitionKey
      processDefinitionKey: string
      the key of the process definition which was used to create the process instance
      
-
      Readonly processInstanceKey
      processInstanceKey: string
      the unique identifier of the created process instance; to be used wherever a request
+
      Readonly processDefinitionKey
      processDefinitionKey: string
      the key of the process definition which was used to create the process instance
      
+
      Readonly processInstanceKey
      processInstanceKey: string
      the unique identifier of the created process instance; to be used wherever a request
 needs a process instance key (e.g. CancelProcessInstanceRequest)
      
-
      Readonly tenantId
      tenantId: string
      the tenant identifier of the process definition
      
-
      Readonly variables
      variables: Result
      consisting of all visible variables to the root scope
      
-
      Readonly version
      version: number
      the version of the process definition which was used to create the process instance
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Readonly tenantId
      tenantId: string
      the tenant identifier of the process definition
      
+
      Readonly variables
      variables: Result
      consisting of all visible variables to the root scope
      
+
      Readonly version
      version: number
      the version of the process definition which was used to create the process instance
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.CreateProcessInstanceWithResultResponseOnWire.html b/interfaces/zeebe_types.CreateProcessInstanceWithResultResponseOnWire.html
index d62ff29d..c044ce15 100644
--- a/interfaces/zeebe_types.CreateProcessInstanceWithResultResponseOnWire.html
+++ b/interfaces/zeebe_types.CreateProcessInstanceWithResultResponseOnWire.html
@@ -1,4 +1,4 @@
-CreateProcessInstanceWithResultResponseOnWire | @camunda8/sdk
      Interface CreateProcessInstanceWithResultResponseOnWire
      interface CreateProcessInstanceWithResultResponseOnWire { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          tenantId: string; 
          variables: string; 
          version: number; 
      }
      Hierarchy (view full)
      Properties
      bpmnProcessId
+CreateProcessInstanceWithResultResponseOnWire | @camunda8/sdk
      Interface CreateProcessInstanceWithResultResponseOnWire
      interface CreateProcessInstanceWithResultResponseOnWire { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          tenantId: string; 
          variables: string; 
          version: number; 
      }
      Hierarchy (view full)
      Properties
      bpmnProcessId
 processDefinitionKey
 processInstanceKey
 tenantId
@@ -6,10 +6,10 @@
 version
 
      Properties
      Readonly bpmnProcessId
      bpmnProcessId: string
      the BPMN process ID of the process definition which was used to create the process
 instance
      
-
      Readonly processDefinitionKey
      processDefinitionKey: string
      the key of the process definition which was used to create the process instance
      
-
      Readonly processInstanceKey
      processInstanceKey: string
      the unique identifier of the created process instance; to be used wherever a request
+
      Readonly processDefinitionKey
      processDefinitionKey: string
      the key of the process definition which was used to create the process instance
      
+
      Readonly processInstanceKey
      processInstanceKey: string
      the unique identifier of the created process instance; to be used wherever a request
 needs a process instance key (e.g. CancelProcessInstanceRequest)
      
-
      Readonly tenantId
      tenantId: string
      the tenant identifier of the process definition
      
-
      Readonly variables
      variables: string
      consisting of all visible variables to the root scope
      
-
      Readonly version
      version: number
      the version of the process definition which was used to create the process instance
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Readonly tenantId
      tenantId: string
      the tenant identifier of the process definition
      
+
      Readonly variables
      variables: string
      consisting of all visible variables to the root scope
      
+
      Readonly version
      version: number
      the version of the process definition which was used to create the process instance
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.DecisionDeployment.html b/interfaces/zeebe_types.DecisionDeployment.html
index bc178340..376f33d1 100644
--- a/interfaces/zeebe_types.DecisionDeployment.html
+++ b/interfaces/zeebe_types.DecisionDeployment.html
@@ -1,2 +1,2 @@
-DecisionDeployment | @camunda8/sdk
      Interface DecisionDeployment
      interface DecisionDeployment { 
          decision: DecisionMetadata; 
      }
      Properties
      decision
-
      Properties
      decision
      decision: DecisionMetadata
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+DecisionDeployment | @camunda8/sdk
      Interface DecisionDeployment
      interface DecisionDeployment { 
          decision: DecisionMetadata; 
      }
      Properties
      decision
+
      Properties
      decision
      decision: DecisionMetadata
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.DecisionMetadata.html b/interfaces/zeebe_types.DecisionMetadata.html
index 5b42e954..78686b03 100644
--- a/interfaces/zeebe_types.DecisionMetadata.html
+++ b/interfaces/zeebe_types.DecisionMetadata.html
@@ -1,4 +1,4 @@
-DecisionMetadata | @camunda8/sdk
      Interface DecisionMetadata
      interface DecisionMetadata { 
          decisionKey: string; 
          decisionRequirementsKey: string; 
          dmnDecisionId: string; 
          dmnDecisionName: string; 
          dmnDecisionRequirementsId: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      decisionKey
+DecisionMetadata | @camunda8/sdk
      Interface DecisionMetadata
      interface DecisionMetadata { 
          decisionKey: string; 
          decisionRequirementsKey: string; 
          dmnDecisionId: string; 
          dmnDecisionName: string; 
          dmnDecisionRequirementsId: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      decisionKey
 decisionRequirementsKey
 dmnDecisionId
 dmnDecisionName
@@ -7,13 +7,13 @@
 version
 
      Properties
      decisionKey
      decisionKey: string
      the assigned decision key, which acts as a unique identifier for this
 decision
      
-
      decisionRequirementsKey
      decisionRequirementsKey: string
      the assigned key of the decision requirements graph that this decision is
+
      decisionRequirementsKey
      decisionRequirementsKey: string
      the assigned key of the decision requirements graph that this decision is
 part of
      
-
      dmnDecisionId
      dmnDecisionId: string
      the dmn decision ID, as parsed during deployment; together with the
+
      dmnDecisionId
      dmnDecisionId: string
      the dmn decision ID, as parsed during deployment; together with the
 versions forms a unique identifier for a specific decision
      
-
      dmnDecisionName
      dmnDecisionName: string
      the dmn name of the decision, as parsed during deployment
      
-
      dmnDecisionRequirementsId
      dmnDecisionRequirementsId: string
      the dmn ID of the decision requirements graph that this decision is part
+
      dmnDecisionName
      dmnDecisionName: string
      the dmn name of the decision, as parsed during deployment
      
+
      dmnDecisionRequirementsId
      dmnDecisionRequirementsId: string
      the dmn ID of the decision requirements graph that this decision is part
 of, as parsed during deployment
      
-
      tenantId
      tenantId: string
      the tenant id of the deployed decision
      
-
      version
      version: number
      the assigned decision version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      tenantId
      tenantId: string
      the tenant id of the deployed decision
      
+
      version
      version: number
      the assigned decision version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.DecisionRequirementsDeployment.html b/interfaces/zeebe_types.DecisionRequirementsDeployment.html
index 8265d88a..853e9a55 100644
--- a/interfaces/zeebe_types.DecisionRequirementsDeployment.html
+++ b/interfaces/zeebe_types.DecisionRequirementsDeployment.html
@@ -1,2 +1,2 @@
-DecisionRequirementsDeployment | @camunda8/sdk
      Interface DecisionRequirementsDeployment
      interface DecisionRequirementsDeployment { 
          decisionRequirements: DecisionRequirementsMetadata; 
      }
      Properties
      decisionRequirements
-
      Properties
      decisionRequirements
      decisionRequirements: DecisionRequirementsMetadata
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+DecisionRequirementsDeployment | @camunda8/sdk
      Interface DecisionRequirementsDeployment
      interface DecisionRequirementsDeployment { 
          decisionRequirements: DecisionRequirementsMetadata; 
      }
      Properties
      decisionRequirements
+
      Properties
      decisionRequirements
      decisionRequirements: DecisionRequirementsMetadata
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.DecisionRequirementsMetadata.html b/interfaces/zeebe_types.DecisionRequirementsMetadata.html
index 9149ac19..4f49ee06 100644
--- a/interfaces/zeebe_types.DecisionRequirementsMetadata.html
+++ b/interfaces/zeebe_types.DecisionRequirementsMetadata.html
@@ -1,4 +1,4 @@
-DecisionRequirementsMetadata | @camunda8/sdk
      Interface DecisionRequirementsMetadata
      interface DecisionRequirementsMetadata { 
          decisionRequirementsKey: string; 
          dmnDecisionRequirementsId: string; 
          dmnDecisionRequirementsName: string; 
          resourceName: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      decisionRequirementsKey
+DecisionRequirementsMetadata | @camunda8/sdk
      Interface DecisionRequirementsMetadata
      interface DecisionRequirementsMetadata { 
          decisionRequirementsKey: string; 
          dmnDecisionRequirementsId: string; 
          dmnDecisionRequirementsName: string; 
          resourceName: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      decisionRequirementsKey
 dmnDecisionRequirementsId
 dmnDecisionRequirementsName
 resourceName
@@ -6,11 +6,11 @@
 version
 
      Properties
      decisionRequirementsKey
      decisionRequirementsKey: string
      the assigned decision requirements key, which acts as a unique identifier
 for this decision requirements
      
-
      dmnDecisionRequirementsId
      dmnDecisionRequirementsId: string
      the dmn decision requirements ID, as parsed during deployment; together
+
      dmnDecisionRequirementsId
      dmnDecisionRequirementsId: string
      the dmn decision requirements ID, as parsed during deployment; together
 with the versions forms a unique identifier for a specific decision
      
-
      dmnDecisionRequirementsName
      dmnDecisionRequirementsName: string
      the dmn name of the decision requirements, as parsed during deployment
      
-
      resourceName
      resourceName: string
      the resource name (see: Resource.name) from which this decision
+
      dmnDecisionRequirementsName
      dmnDecisionRequirementsName: string
      the dmn name of the decision requirements, as parsed during deployment
      
+
      resourceName
      resourceName: string
      the resource name (see: Resource.name) from which this decision
 requirements was parsed
      
-
      tenantId
      tenantId: string
      the tenant id of the deployed decision requirements
      
-
      version
      version: number
      the assigned decision requirements version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      tenantId
      tenantId: string
      the tenant id of the deployed decision requirements
      
+
      version
      version: number
      the assigned decision requirements version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.DeleteResourceRequest.html b/interfaces/zeebe_types.DeleteResourceRequest.html
index fa9fffec..fee6eb9a 100644
--- a/interfaces/zeebe_types.DeleteResourceRequest.html
+++ b/interfaces/zeebe_types.DeleteResourceRequest.html
@@ -1,4 +1,4 @@
-DeleteResourceRequest | @camunda8/sdk
      Interface DeleteResourceRequest
      interface DeleteResourceRequest { 
          resourceKey: string; 
      }
      Properties
      resourceKey
+DeleteResourceRequest | @camunda8/sdk
      Interface DeleteResourceRequest
      interface DeleteResourceRequest { 
          resourceKey: string; 
      }
      Properties
      resourceKey
 
      Properties
      resourceKey
      resourceKey: string
      The key of the resource that should be deleted. This can either be the key
 of a process definition, the key of a decision requirements definition or the key of a form.
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.DeployResourceRequest.html b/interfaces/zeebe_types.DeployResourceRequest.html
index 00015a83..923888fb 100644
--- a/interfaces/zeebe_types.DeployResourceRequest.html
+++ b/interfaces/zeebe_types.DeployResourceRequest.html
@@ -1,5 +1,5 @@
-DeployResourceRequest | @camunda8/sdk
      Interface DeployResourceRequest
      interface DeployResourceRequest { 
          resources: Resource[]; 
          tenantId?: string; 
      }
      Properties
      resources
+DeployResourceRequest | @camunda8/sdk
      Interface DeployResourceRequest
      interface DeployResourceRequest { 
          resources: Resource[]; 
          tenantId?: string; 
      }
      Properties
      resources
 tenantId?
 
      Properties
      resources
      resources: Resource[]
      list of resources to deploy
      
-
      Optional tenantId
      tenantId?: string
      the tenant id of the resources to deploy
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional tenantId
      tenantId?: string
      the tenant id of the resources to deploy
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.DeployResourceResponse.html b/interfaces/zeebe_types.DeployResourceResponse.html
index a85a7890..53f71431 100644
--- a/interfaces/zeebe_types.DeployResourceResponse.html
+++ b/interfaces/zeebe_types.DeployResourceResponse.html
@@ -1,7 +1,7 @@
-DeployResourceResponse | @camunda8/sdk
      Interface DeployResourceResponse<T>
      interface DeployResourceResponse<T> { 
          deployments: T[]; 
          key: string; 
          tenantId: string; 
      }
       
      Type Parameters
      • T
       
      Properties
      deployments
+DeployResourceResponse | @camunda8/sdk
      Interface DeployResourceResponse<T>
      interface DeployResourceResponse<T> { 
          deployments: T[]; 
          key: string; 
          tenantId: string; 
      }
       
      Type Parameters
      • T
       
      Properties
      deployments
 key
 tenantId
 
      Properties
      Readonly deployments
      deployments: T[]
      a list of deployed resources, e.g. processes
      
-
      Readonly key
      key: string
      the unique key identifying the deployment
      
-
      tenantId
      tenantId: string
      the tenant id of the deployed resources
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Readonly key
      key: string
      the unique key identifying the deployment
      
+
      tenantId
      tenantId: string
      the tenant id of the deployed resources
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ErrorJobWithVariables.html b/interfaces/zeebe_types.ErrorJobWithVariables.html
index 6fac13e3..75536a9a 100644
--- a/interfaces/zeebe_types.ErrorJobWithVariables.html
+++ b/interfaces/zeebe_types.ErrorJobWithVariables.html
@@ -1,4 +1,4 @@
-ErrorJobWithVariables | @camunda8/sdk
      Interface ErrorJobWithVariables
      interface ErrorJobWithVariables { 
          errorCode: string; 
          errorMessage?: string; 
          variables: JSONDoc; 
      }
      Properties
      errorCode
+ErrorJobWithVariables | @camunda8/sdk
      Interface ErrorJobWithVariables
      interface ErrorJobWithVariables { 
          errorCode: string; 
          errorMessage?: string; 
          variables: JSONDoc; 
      }
      Properties
      errorCode
 errorMessage?
 variables
-
      Properties
      errorCode
      errorCode: string
      Optional errorMessage
      errorMessage?: string
      variables
      variables: JSONDoc
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      errorCode
      errorCode: string
      Optional errorMessage
      errorMessage?: string
      variables
      variables: JSONDoc
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.EvaluateDecisionResponse.html b/interfaces/zeebe_types.EvaluateDecisionResponse.html
index e53f7ebf..7ea8e5a2 100644
--- a/interfaces/zeebe_types.EvaluateDecisionResponse.html
+++ b/interfaces/zeebe_types.EvaluateDecisionResponse.html
@@ -1,4 +1,4 @@
-EvaluateDecisionResponse | @camunda8/sdk
      Interface EvaluateDecisionResponse
      interface EvaluateDecisionResponse { 
          decisionId: string; 
          decisionKey: string; 
          decisionName: string; 
          decisionOutput: string; 
          decisionRequirementsId: string; 
          decisionRequirementsKey: string; 
          decisionVersion: number; 
          evaluatedDecisions: EvaluatedDecision[]; 
          failedDecisionId: string; 
          failureMessage: string; 
          tenantId?: string; 
      }
      Properties
      decisionId
+EvaluateDecisionResponse | @camunda8/sdk
      Interface EvaluateDecisionResponse
      interface EvaluateDecisionResponse { 
          decisionId: string; 
          decisionKey: string; 
          decisionName: string; 
          decisionOutput: string; 
          decisionRequirementsId: string; 
          decisionRequirementsKey: string; 
          decisionVersion: number; 
          evaluatedDecisions: EvaluatedDecision[]; 
          failedDecisionId: string; 
          failureMessage: string; 
          tenantId?: string; 
      }
      Properties
      decisionId
 decisionKey
 decisionName
 decisionOutput
@@ -10,20 +10,20 @@
 failureMessage
 tenantId?
 
      Properties
      decisionId
      decisionId: string
      the ID of the decision which was evaluated
      
-
      decisionKey
      decisionKey: string
      the unique key identifying the decision which was evaluated (e.g. returned
+
      decisionKey
      decisionKey: string
      the unique key identifying the decision which was evaluated (e.g. returned
 from a decision in the DeployResourceResponse message)
      
-
      decisionName
      decisionName: string
      the name of the decision which was evaluated
      
-
      decisionOutput
      decisionOutput: string
      JSON document that will instantiate the result of the decision which was
+
      decisionName
      decisionName: string
      the name of the decision which was evaluated
      
+
      decisionOutput
      decisionOutput: string
      JSON document that will instantiate the result of the decision which was
 evaluated; it will be a JSON object, as the result output will be mapped
 in a key-value fashion, e.g. { "a": 1 }.
      
-
      decisionRequirementsId
      decisionRequirementsId: string
      the ID of the decision requirements graph that the decision which was
+
      decisionRequirementsId
      decisionRequirementsId: string
      the ID of the decision requirements graph that the decision which was
 evaluated is part of.
      
-
      decisionRequirementsKey
      decisionRequirementsKey: string
      the unique key identifying the decision requirements graph that the
+
      decisionRequirementsKey
      decisionRequirementsKey: string
      the unique key identifying the decision requirements graph that the
 decision which was evaluated is part of.
      
-
      decisionVersion
      decisionVersion: number
      the version of the decision which was evaluated
      
-
      evaluatedDecisions
      evaluatedDecisions: EvaluatedDecision[]
      a list of decisions that were evaluated within the requested decision evaluation
      
-
      failedDecisionId
      failedDecisionId: string
      an optional string indicating the ID of the decision which
+
      decisionVersion
      decisionVersion: number
      the version of the decision which was evaluated
      
+
      evaluatedDecisions
      evaluatedDecisions: EvaluatedDecision[]
      a list of decisions that were evaluated within the requested decision evaluation
      
+
      failedDecisionId
      failedDecisionId: string
      an optional string indicating the ID of the decision which
 failed during evaluation
      
-
      failureMessage
      failureMessage: string
      an optional message describing why the decision which was evaluated failed
      
-
      Optional tenantId
      tenantId?: string
      the tenant identifier of the decision
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      failureMessage
      failureMessage: string
      an optional message describing why the decision which was evaluated failed
      
+
      Optional tenantId
      tenantId?: string
      the tenant identifier of the decision
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.EvaluatedDecision.html b/interfaces/zeebe_types.EvaluatedDecision.html
index 4c2c82bd..c8ba9909 100644
--- a/interfaces/zeebe_types.EvaluatedDecision.html
+++ b/interfaces/zeebe_types.EvaluatedDecision.html
@@ -1,4 +1,4 @@
-EvaluatedDecision | @camunda8/sdk
      Interface EvaluatedDecision
      interface EvaluatedDecision { 
          decisionId: string; 
          decisionKey: string; 
          decisionName: string; 
          decisionOutput: string; 
          decisionType: string; 
          decisionVersion: number; 
          evaluatedInputs: EvaluatedDecisionInput[]; 
          matchedRules: MatchedDecisionRule[]; 
          tenantId: string; 
      }
      Properties
      decisionId
+EvaluatedDecision | @camunda8/sdk
      Interface EvaluatedDecision
      interface EvaluatedDecision { 
          decisionId: string; 
          decisionKey: string; 
          decisionName: string; 
          decisionOutput: string; 
          decisionType: string; 
          decisionVersion: number; 
          evaluatedInputs: EvaluatedDecisionInput[]; 
          matchedRules: MatchedDecisionRule[]; 
          tenantId: string; 
      }
      Properties
      decisionId
 decisionKey
 decisionName
 decisionOutput
@@ -8,15 +8,15 @@
 matchedRules
 tenantId
 
      Properties
      decisionId
      decisionId: string
      the ID of the decision which was evaluated
      
-
      decisionKey
      decisionKey: string
      the unique key identifying the decision which was evaluated (e.g. returned
+
      decisionKey
      decisionKey: string
      the unique key identifying the decision which was evaluated (e.g. returned
 from a decision in the DeployResourceResponse message)
      
-
      decisionName
      decisionName: string
      the name of the decision which was evaluated
      
-
      decisionOutput
      decisionOutput: string
      JSON document that will instantiate the result of the decision which was
+
      decisionName
      decisionName: string
      the name of the decision which was evaluated
      
+
      decisionOutput
      decisionOutput: string
      JSON document that will instantiate the result of the decision which was
 evaluated; it will be a JSON object, as the result output will be mapped
 in a key-value fashion, e.g. { "a": 1 }.
      
-
      decisionType
      decisionType: string
      the type of the decision which was evaluated
      
-
      decisionVersion
      decisionVersion: number
      the version of the decision which was evaluated
      
-
      evaluatedInputs
      evaluatedInputs: EvaluatedDecisionInput[]
      the decision inputs that were evaluated within this decision evaluation
      
-
      matchedRules
      matchedRules: MatchedDecisionRule[]
      the decision rules that matched within this decision evaluation
      
-
      tenantId
      tenantId: string
      the tenant identifier of the evaluated decision
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      decisionType
      decisionType: string
      the type of the decision which was evaluated
      
+
      decisionVersion
      decisionVersion: number
      the version of the decision which was evaluated
      
+
      evaluatedInputs
      evaluatedInputs: EvaluatedDecisionInput[]
      the decision inputs that were evaluated within this decision evaluation
      
+
      matchedRules
      matchedRules: MatchedDecisionRule[]
      the decision rules that matched within this decision evaluation
      
+
      tenantId
      tenantId: string
      the tenant identifier of the evaluated decision
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.EvaluatedDecisionInput.html b/interfaces/zeebe_types.EvaluatedDecisionInput.html
index 5becc5c7..a2ba1abb 100644
--- a/interfaces/zeebe_types.EvaluatedDecisionInput.html
+++ b/interfaces/zeebe_types.EvaluatedDecisionInput.html
@@ -1,7 +1,7 @@
-EvaluatedDecisionInput | @camunda8/sdk
      Interface EvaluatedDecisionInput
      interface EvaluatedDecisionInput { 
          inputId: string; 
          inputName: string; 
          inputValue: string; 
      }
      Properties
      inputId
+EvaluatedDecisionInput | @camunda8/sdk
      Interface EvaluatedDecisionInput
      interface EvaluatedDecisionInput { 
          inputId: string; 
          inputName: string; 
          inputValue: string; 
      }
      Properties
      inputId
 inputName
 inputValue
 
      Properties
      inputId
      inputId: string
      the id of the evaluated decision input
      
-
      inputName
      inputName: string
      the name of the evaluated decision input
      
-
      inputValue
      inputValue: string
      the value of the evaluated decision input
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      inputName
      inputName: string
      the name of the evaluated decision input
      
+
      inputValue
      inputValue: string
      the value of the evaluated decision input
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.EvaluatedDecisionOutput.html b/interfaces/zeebe_types.EvaluatedDecisionOutput.html
index aa2d3a92..1b6ba36b 100644
--- a/interfaces/zeebe_types.EvaluatedDecisionOutput.html
+++ b/interfaces/zeebe_types.EvaluatedDecisionOutput.html
@@ -1,7 +1,7 @@
-EvaluatedDecisionOutput | @camunda8/sdk
      Interface EvaluatedDecisionOutput
      interface EvaluatedDecisionOutput { 
          outputId: string; 
          outputName: string; 
          outputValue: string; 
      }
      Properties
      outputId
+EvaluatedDecisionOutput | @camunda8/sdk
      Interface EvaluatedDecisionOutput
      interface EvaluatedDecisionOutput { 
          outputId: string; 
          outputName: string; 
          outputValue: string; 
      }
      Properties
      outputId
 outputName
 outputValue
 
      Properties
      outputId
      outputId: string
      the id of the evaluated decision output
      
-
      outputName
      outputName: string
      the name of the evaluated decision output
      
-
      outputValue
      outputValue: string
      the value of the evaluated decision output
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      outputName
      outputName: string
      the name of the evaluated decision output
      
+
      outputValue
      outputValue: string
      the value of the evaluated decision output
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.FailJobRequest.html b/interfaces/zeebe_types.FailJobRequest.html
index 65d427b3..d8307d0e 100644
--- a/interfaces/zeebe_types.FailJobRequest.html
+++ b/interfaces/zeebe_types.FailJobRequest.html
@@ -1,5 +1,5 @@
-FailJobRequest | @camunda8/sdk
      Interface FailJobRequest
      interface FailJobRequest { 
          errorMessage: string; 
          jobKey: string; 
          retries: number; 
          retryBackOff: number; 
      }
      Properties
      errorMessage
+FailJobRequest | @camunda8/sdk
      Interface FailJobRequest
      interface FailJobRequest { 
          errorMessage: string; 
          jobKey: string; 
          retries: number; 
          retryBackOff: number; 
      }
      Properties
      errorMessage
 jobKey
 retries
 retryBackOff
-
      Properties
      errorMessage
      errorMessage: string
      Readonly jobKey
      jobKey: string
      retries
      retries: number
      retryBackOff
      retryBackOff: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      errorMessage
      errorMessage: string
      Readonly jobKey
      jobKey: string
      retries
      retries: number
      retryBackOff
      retryBackOff: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.FormDeployment.html b/interfaces/zeebe_types.FormDeployment.html
index c68de227..fb3999d8 100644
--- a/interfaces/zeebe_types.FormDeployment.html
+++ b/interfaces/zeebe_types.FormDeployment.html
@@ -1,2 +1,2 @@
-FormDeployment | @camunda8/sdk
      Interface FormDeployment
      interface FormDeployment { 
          form: FormMetadata; 
      }
      Properties
      form
-
      Properties
      form
      form: FormMetadata
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+FormDeployment | @camunda8/sdk
      Interface FormDeployment
      interface FormDeployment { 
          form: FormMetadata; 
      }
      Properties
      form
+
      Properties
      form
      form: FormMetadata
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.FormMetadata.html b/interfaces/zeebe_types.FormMetadata.html
index f2544f7b..12e9a730 100644
--- a/interfaces/zeebe_types.FormMetadata.html
+++ b/interfaces/zeebe_types.FormMetadata.html
@@ -1,12 +1,12 @@
-FormMetadata | @camunda8/sdk
      Interface FormMetadata
      interface FormMetadata { 
          formId: string; 
          formKey: string; 
          resourceName: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      formId
+FormMetadata | @camunda8/sdk
      Interface FormMetadata
      interface FormMetadata { 
          formId: string; 
          formKey: string; 
          resourceName: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      formId
 formKey
 resourceName
 tenantId
 version
 
      Properties
      Readonly formId
      formId: string
      the form ID, as parsed during deployment; together with the
 versions forms a unique identifier for a specific form
      
-
      Readonly formKey
      formKey: string
      the assigned key, which acts as a unique identifier for this form
      
-
      Readonly resourceName
      resourceName: string
      the resource name
      
-
      Readonly tenantId
      tenantId: string
      the tenant id of the deployed form
      
-
      Readonly version
      version: number
      the assigned form version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Readonly formKey
      formKey: string
      the assigned key, which acts as a unique identifier for this form
      
+
      Readonly resourceName
      resourceName: string
      the resource name
      
+
      Readonly tenantId
      tenantId: string
      the tenant id of the deployed form
      
+
      Readonly version
      version: number
      the assigned form version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ICustomHeaders.html b/interfaces/zeebe_types.ICustomHeaders.html
index 7e5b49e5..1894787d 100644
--- a/interfaces/zeebe_types.ICustomHeaders.html
+++ b/interfaces/zeebe_types.ICustomHeaders.html
@@ -1 +1 @@
-ICustomHeaders | @camunda8/sdk
      Interface ICustomHeaders
      interface ICustomHeaders { 
          [key: string]: string | number; 
      }
      Indexable
      [key: string]: string | number
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+ICustomHeaders | @camunda8/sdk
      Interface ICustomHeaders
      interface ICustomHeaders { 
          [key: string]: string | number; 
      }
      Indexable
      [key: string]: string | number
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.IInputVariables.html b/interfaces/zeebe_types.IInputVariables.html
index a82a2cb6..3d27d3b0 100644
--- a/interfaces/zeebe_types.IInputVariables.html
+++ b/interfaces/zeebe_types.IInputVariables.html
@@ -1 +1 @@
-IInputVariables | @camunda8/sdk
      Interface IInputVariables
      interface IInputVariables { 
          [key: string]: JSON; 
      }
      Indexable
      [key: string]: JSON
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+IInputVariables | @camunda8/sdk
      Interface IInputVariables
      interface IInputVariables { 
          [key: string]: JSON; 
      }
      Indexable
      [key: string]: JSON
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.IOutputVariables.html b/interfaces/zeebe_types.IOutputVariables.html
index 0b31cdba..309f4333 100644
--- a/interfaces/zeebe_types.IOutputVariables.html
+++ b/interfaces/zeebe_types.IOutputVariables.html
@@ -1 +1 @@
-IOutputVariables | @camunda8/sdk
      Interface IOutputVariables
      interface IOutputVariables { 
          [key: string]: JSON; 
      }
      Indexable
      [key: string]: JSON
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+IOutputVariables | @camunda8/sdk
      Interface IOutputVariables
      interface IOutputVariables { 
          [key: string]: JSON; 
      }
      Indexable
      [key: string]: JSON
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.IProcessVariables.html b/interfaces/zeebe_types.IProcessVariables.html
index efa866af..4bd128c1 100644
--- a/interfaces/zeebe_types.IProcessVariables.html
+++ b/interfaces/zeebe_types.IProcessVariables.html
@@ -1 +1 @@
-IProcessVariables | @camunda8/sdk
      Interface IProcessVariables
      interface IProcessVariables { 
          [key: string]: JSON; 
      }
      Indexable
      [key: string]: JSON
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+IProcessVariables | @camunda8/sdk
      Interface IProcessVariables
      interface IProcessVariables { 
          [key: string]: JSON; 
      }
      Indexable
      [key: string]: JSON
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.JSONDoc.html b/interfaces/zeebe_types.JSONDoc.html
index 3c794465..210d4f42 100644
--- a/interfaces/zeebe_types.JSONDoc.html
+++ b/interfaces/zeebe_types.JSONDoc.html
@@ -1 +1 @@
-JSONDoc | @camunda8/sdk
      Interface JSONDoc
      interface JSONDoc { 
          [key: string]: JSON | undefined; 
      }
      Indexable
      [key: string]: JSON | undefined
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
+JSONDoc | @camunda8/sdk
      Interface JSONDoc
      interface JSONDoc { 
          [key: string]: JSON | undefined; 
      }
      Indexable
      [key: string]: JSON | undefined
      Settings
      Member Visibility
      Theme
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.Job.html b/interfaces/zeebe_types.Job.html
index ce784b23..e361ca49 100644
--- a/interfaces/zeebe_types.Job.html
+++ b/interfaces/zeebe_types.Job.html
@@ -1,4 +1,4 @@
-Job | @camunda8/sdk
      Interface Job<Variables, CustomHeaderShape>
      interface Job<Variables, CustomHeaderShape> { 
          bpmnProcessId: string; 
          customHeaders: Readonly<CustomHeaderShape>; 
          deadline: string; 
          elementId: string; 
          elementInstanceKey: string; 
          key: string; 
          processDefinitionVersion: number; 
          processInstanceKey: string; 
          retries: number; 
          type: string; 
          variables: Readonly<Variables>; 
          worker: string; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
+Job | @camunda8/sdk
      Interface Job<Variables, CustomHeaderShape>
      interface Job<Variables, CustomHeaderShape> { 
          bpmnProcessId: string; 
          customHeaders: Readonly<CustomHeaderShape>; 
          deadline: string; 
          elementId: string; 
          elementInstanceKey: string; 
          key: string; 
          processDefinitionVersion: number; 
          processInstanceKey: string; 
          retries: number; 
          type: string; 
          variables: Readonly<Variables>; 
          worker: string; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
 customHeaders
 deadline
 elementId
@@ -11,15 +11,15 @@
 variables
 worker
 
      Properties
      Readonly bpmnProcessId
      bpmnProcessId: string
      The bpmn process ID of the job process definition
      
-
      Readonly customHeaders
      customHeaders: Readonly<CustomHeaderShape>
      A set of custom headers defined during modelling
      
-
      Readonly deadline
      deadline: string
      Readonly elementId
      elementId: string
      The associated task element ID
      
-
      Readonly elementInstanceKey
      elementInstanceKey: string
      The unique key identifying the associated task, unique within the scope of the
+
      Readonly customHeaders
      customHeaders: Readonly<CustomHeaderShape>
      A set of custom headers defined during modelling
      
+
      Readonly deadline
      deadline: string
      Readonly elementId
      elementId: string
      The associated task element ID
      
+
      Readonly elementInstanceKey
      elementInstanceKey: string
      The unique key identifying the associated task, unique within the scope of the
 process instance
      
-
      Readonly key
      key: string
      The key, a unique identifier for the job
      
-
      Readonly processDefinitionVersion
      processDefinitionVersion: number
      The version of the job process definition
      
-
      Readonly processInstanceKey
      processInstanceKey: string
      The job's process instance key
      
-
      Readonly retries
      retries: number
      Readonly type
      type: string
      The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
+
      Readonly key
      key: string
      The key, a unique identifier for the job
      
+
      Readonly processDefinitionVersion
      processDefinitionVersion: number
      The version of the job process definition
      
+
      Readonly processInstanceKey
      processInstanceKey: string
      The job's process instance key
      
+
      Readonly retries
      retries: number
      Readonly type
      type: string
      The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
 type="payment-service" />)
      
-
      Readonly variables
      variables: Readonly<Variables>
      All visible variables in the task scope, computed at activation time.
      
-
      Readonly worker
      worker: string
      The name of the worker that activated this job
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Readonly variables
      variables: Readonly<Variables>
      All visible variables in the task scope, computed at activation time.
      
+
      Readonly worker
      worker: string
      The name of the worker that activated this job
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.JobCompletionInterface.html b/interfaces/zeebe_types.JobCompletionInterface.html
index 303d7488..99a51439 100644
--- a/interfaces/zeebe_types.JobCompletionInterface.html
+++ b/interfaces/zeebe_types.JobCompletionInterface.html
@@ -1,19 +1,19 @@
-JobCompletionInterface | @camunda8/sdk
      Interface JobCompletionInterface<WorkerOutputVariables>
      interface JobCompletionInterface<WorkerOutputVariables> { 
          cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">); 
          complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">); 
          error: ErrorJobOutcome; 
          fail: { 
              (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
              (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
          }; 
          forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT"); 
      }
       
      Type Parameters
      • WorkerOutputVariables
       
      Hierarchy (view full)
      Properties
      cancelWorkflow
+JobCompletionInterface | @camunda8/sdk
      Interface JobCompletionInterface<WorkerOutputVariables>
      interface JobCompletionInterface<WorkerOutputVariables> { 
          cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">); 
          complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">); 
          error: ErrorJobOutcome; 
          fail: { 
              (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
              (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
          }; 
          forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT"); 
      }
       
      Type Parameters
      • WorkerOutputVariables
       
      Hierarchy (view full)
      Properties
      cancelWorkflow
 complete
 error
 fail
 forward
 
      Properties
      cancelWorkflow
      cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)
      Cancel the workflow.
      
-
      Type declaration
        • (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
        • Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
      complete
      complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)
      Complete the job with a success, optionally passing in a state update to merge
+
      Type declaration
        • (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
        • Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
      complete
      complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)
      Complete the job with a success, optionally passing in a state update to merge
 with the process variables on the broker.
      
-
      Type declaration
        • (updatedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
        • Parameters
          Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
      error
      error: ErrorJobOutcome
      Report a business error (i.e. non-technical) that occurs while processing a job.
+
      Type declaration
        • (updatedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
        • Parameters
          Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
      error
      error: ErrorJobOutcome
      Report a business error (i.e. non-technical) that occurs while processing a job.
 The error is handled in the process by an error catch event.
 If there is no error catch event with the specified errorCode then an incident will be raised instead.
      
-
      fail
      fail: { 
          (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
          (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
      }
      Fail the job with an informative message as to the cause. Optionally, pass in a
+
      fail
      fail: { 
          (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
          (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
      }
      Fail the job with an informative message as to the cause. Optionally, pass in a
 value remaining retries. If no value is passed for retries then the current retry
 count is decremented. Pass in 0for retries to raise an incident in Operate. Optionally,
 specify a retry backoff period in milliseconds. Default is 0ms (immediate retry) if not
 specified.
      
-
      Type declaration
      forward
      forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")
      Mark this job as forwarded to another system for completion. No action is taken by the broker.
+
      Type declaration
      forward
      forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")
      Mark this job as forwarded to another system for completion. No action is taken by the broker.
 This method releases worker capacity to handle another job.
      
-
      Type declaration
        • (): "JOB_ACTION_ACKNOWLEDGEMENT"
        • Returns "JOB_ACTION_ACKNOWLEDGEMENT"
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Type declaration
        • (): "JOB_ACTION_ACKNOWLEDGEMENT"
        • Returns "JOB_ACTION_ACKNOWLEDGEMENT"
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.JobFailureConfiguration.html b/interfaces/zeebe_types.JobFailureConfiguration.html
index 4d7b82b2..b9daf0ac 100644
--- a/interfaces/zeebe_types.JobFailureConfiguration.html
+++ b/interfaces/zeebe_types.JobFailureConfiguration.html
@@ -1,6 +1,6 @@
-JobFailureConfiguration | @camunda8/sdk
      Interface JobFailureConfiguration
      interface JobFailureConfiguration { 
          errorMessage: string; 
          retries?: number; 
          retryBackOff?: number; 
      }
      Properties
      errorMessage
+JobFailureConfiguration | @camunda8/sdk
      Interface JobFailureConfiguration
      interface JobFailureConfiguration { 
          errorMessage: string; 
          retries?: number; 
          retryBackOff?: number; 
      }
      Properties
      errorMessage
 retries?
 retryBackOff?
-
      Properties
      errorMessage
      errorMessage: string
      Optional retries
      retries?: number
      If not specified, the library will decrement the "current remaining retries" count by one
      
-
      Optional retryBackOff
      retryBackOff?: number
      Optional backoff for subsequent retries, in milliseconds. If not specified, it is zero.
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      errorMessage
      errorMessage: string
      Optional retries
      retries?: number
      If not specified, the library will decrement the "current remaining retries" count by one
      
+
      Optional retryBackOff
      retryBackOff?: number
      Optional backoff for subsequent retries, in milliseconds. If not specified, it is zero.
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ListProcessResponse.html b/interfaces/zeebe_types.ListProcessResponse.html
index c70e16d2..7ba57db0 100644
--- a/interfaces/zeebe_types.ListProcessResponse.html
+++ b/interfaces/zeebe_types.ListProcessResponse.html
@@ -1,2 +1,2 @@
-ListProcessResponse | @camunda8/sdk
      Interface ListProcessResponse
      interface ListProcessResponse { 
          processes: ProcessMetadata[]; 
      }
      Properties
      processes
-
      Properties
      Readonly processes
      processes: ProcessMetadata[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+ListProcessResponse | @camunda8/sdk
      Interface ListProcessResponse
      interface ListProcessResponse { 
          processes: ProcessMetadata[]; 
      }
      Properties
      processes
+
      Properties
      Readonly processes
      processes: ProcessMetadata[]
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.MatchedDecisionRule.html b/interfaces/zeebe_types.MatchedDecisionRule.html
index e90b3f7d..1a4f3ee3 100644
--- a/interfaces/zeebe_types.MatchedDecisionRule.html
+++ b/interfaces/zeebe_types.MatchedDecisionRule.html
@@ -1,7 +1,7 @@
-MatchedDecisionRule | @camunda8/sdk
      Interface MatchedDecisionRule
      interface MatchedDecisionRule { 
          evaluatedOutputs: EvaluatedDecisionOutput[]; 
          ruleId: string; 
          ruleIndex: number; 
      }
      Properties
      evaluatedOutputs
+MatchedDecisionRule | @camunda8/sdk
      Interface MatchedDecisionRule
      interface MatchedDecisionRule { 
          evaluatedOutputs: EvaluatedDecisionOutput[]; 
          ruleId: string; 
          ruleIndex: number; 
      }
      Properties
      evaluatedOutputs
 ruleId
 ruleIndex
 
      Properties
      evaluatedOutputs
      evaluatedOutputs: EvaluatedDecisionOutput[]
      the evaluated decision outputs
      
-
      ruleId
      ruleId: string
      the id of the matched rule
      
-
      ruleIndex
      ruleIndex: number
      the index of the matched rule
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      ruleId
      ruleId: string
      the id of the matched rule
      
+
      ruleIndex
      ruleIndex: number
      the index of the matched rule
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.MigrateProcessInstanceRequest.html b/interfaces/zeebe_types.MigrateProcessInstanceRequest.html
index 0de467d5..e10b23cf 100644
--- a/interfaces/zeebe_types.MigrateProcessInstanceRequest.html
+++ b/interfaces/zeebe_types.MigrateProcessInstanceRequest.html
@@ -1,3 +1,3 @@
-MigrateProcessInstanceRequest | @camunda8/sdk
      Interface MigrateProcessInstanceRequest
      interface MigrateProcessInstanceRequest { 
          migrationPlan: MigrationPlan; 
          processInstanceKey: string; 
      }
      Properties
      migrationPlan
+MigrateProcessInstanceRequest | @camunda8/sdk
      Interface MigrateProcessInstanceRequest
      interface MigrateProcessInstanceRequest { 
          migrationPlan: MigrationPlan; 
          processInstanceKey: string; 
      }
      Properties
      migrationPlan
 processInstanceKey
-
      Properties
      migrationPlan
      migrationPlan: MigrationPlan
      processInstanceKey
      processInstanceKey: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      migrationPlan
      migrationPlan: MigrationPlan
      processInstanceKey
      processInstanceKey: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ModifyProcessInstanceRequest.html b/interfaces/zeebe_types.ModifyProcessInstanceRequest.html
index 3b9e4b26..3c33194d 100644
--- a/interfaces/zeebe_types.ModifyProcessInstanceRequest.html
+++ b/interfaces/zeebe_types.ModifyProcessInstanceRequest.html
@@ -1,8 +1,8 @@
-ModifyProcessInstanceRequest | @camunda8/sdk
      Interface ModifyProcessInstanceRequest
      interface ModifyProcessInstanceRequest { 
          activateInstructions?: ActivateInstruction[]; 
          processInstanceKey: string; 
          terminateInstructions?: TerminateInstruction[]; 
      }
      Properties
      activateInstructions?
+ModifyProcessInstanceRequest | @camunda8/sdk
      Interface ModifyProcessInstanceRequest
      interface ModifyProcessInstanceRequest { 
          activateInstructions?: ActivateInstruction[]; 
          processInstanceKey: string; 
          terminateInstructions?: TerminateInstruction[]; 
      }
      Properties
      activateInstructions?
 processInstanceKey
 terminateInstructions?
 
      Properties
      Optional activateInstructions
      activateInstructions?: ActivateInstruction[]
      instructions describing which elements should be activated in which scopes,
 and which variables should be created
      
-
      processInstanceKey
      processInstanceKey: string
      the key of the process instance that should be modified
      
-
      Optional terminateInstructions
      terminateInstructions?: TerminateInstruction[]
      instructions describing which elements should be terminated
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      processInstanceKey
      processInstanceKey: string
      the key of the process instance that should be modified
      
+
      Optional terminateInstructions
      terminateInstructions?: TerminateInstruction[]
      instructions describing which elements should be terminated
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.OAuthProviderConfig.html b/interfaces/zeebe_types.OAuthProviderConfig.html
index 1b4954fc..9df9e1e5 100644
--- a/interfaces/zeebe_types.OAuthProviderConfig.html
+++ b/interfaces/zeebe_types.OAuthProviderConfig.html
@@ -1,4 +1,4 @@
-OAuthProviderConfig | @camunda8/sdk
      Interface OAuthProviderConfig
      interface OAuthProviderConfig { 
          audience: string; 
          authServerUrl: string; 
          cacheDir?: string; 
          cacheOnDisk?: boolean; 
          clientId: string; 
          clientSecret: string; 
          customRootCert?: Buffer; 
      }
      Properties
      audience
+OAuthProviderConfig | @camunda8/sdk
      Interface OAuthProviderConfig
      interface OAuthProviderConfig { 
          audience: string; 
          authServerUrl: string; 
          cacheDir?: string; 
          cacheOnDisk?: boolean; 
          clientId: string; 
          clientSecret: string; 
          customRootCert?: Buffer; 
      }
      Properties
      audience
 authServerUrl
 cacheDir?
 cacheOnDisk?
@@ -6,8 +6,8 @@
 clientSecret
 customRootCert?
 
      Properties
      audience
      audience: string
      OAuth Audience
      
-
      authServerUrl
      authServerUrl: string
      OAuth Endpoint URL
      
-
      Optional cacheDir
      cacheDir?: string
      Override default token cache directory
      
-
      Optional cacheOnDisk
      cacheOnDisk?: boolean
      Cache token in memory and on filesystem?
      
-
      clientId
      clientId: string
      clientSecret
      clientSecret: string
      Optional customRootCert
      customRootCert?: Buffer
      Custom TLS certificate for OAuth
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      authServerUrl
      authServerUrl: string
      OAuth Endpoint URL
      
+
      Optional cacheDir
      cacheDir?: string
      Override default token cache directory
      
+
      Optional cacheOnDisk
      cacheOnDisk?: boolean
      Cache token in memory and on filesystem?
      
+
      clientId
      clientId: string
      clientSecret
      clientSecret: string
      Optional customRootCert
      customRootCert?: Buffer
      Custom TLS certificate for OAuth
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.OperationOptionsNoRetry.html b/interfaces/zeebe_types.OperationOptionsNoRetry.html
index dbf6fd42..f7f8bbef 100644
--- a/interfaces/zeebe_types.OperationOptionsNoRetry.html
+++ b/interfaces/zeebe_types.OperationOptionsNoRetry.html
@@ -1,3 +1,3 @@
-OperationOptionsNoRetry | @camunda8/sdk
      Interface OperationOptionsNoRetry
      interface OperationOptionsNoRetry { 
          retry: false; 
          version?: number; 
      }
      Properties
      retry
+OperationOptionsNoRetry | @camunda8/sdk
      Interface OperationOptionsNoRetry
      interface OperationOptionsNoRetry { 
          retry: false; 
          version?: number; 
      }
      Properties
      retry
 version?
-
      Properties
      retry
      retry: false
      Optional version
      version?: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      retry
      retry: false
      Optional version
      version?: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.OperationOptionsWithRetry.html b/interfaces/zeebe_types.OperationOptionsWithRetry.html
index 2967d3c8..16608cb7 100644
--- a/interfaces/zeebe_types.OperationOptionsWithRetry.html
+++ b/interfaces/zeebe_types.OperationOptionsWithRetry.html
@@ -1,4 +1,4 @@
-OperationOptionsWithRetry | @camunda8/sdk
      Interface OperationOptionsWithRetry
      interface OperationOptionsWithRetry { 
          maxRetries: number; 
          retry: true; 
          version?: number; 
      }
      Properties
      maxRetries
+OperationOptionsWithRetry | @camunda8/sdk
      Interface OperationOptionsWithRetry
      interface OperationOptionsWithRetry { 
          maxRetries: number; 
          retry: true; 
          version?: number; 
      }
      Properties
      maxRetries
 retry
 version?
-
      Properties
      maxRetries
      maxRetries: number
      retry
      retry: true
      Optional version
      version?: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      maxRetries
      maxRetries: number
      retry
      retry: true
      Optional version
      version?: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.Partition.html b/interfaces/zeebe_types.Partition.html
index 2e948353..32b539ef 100644
--- a/interfaces/zeebe_types.Partition.html
+++ b/interfaces/zeebe_types.Partition.html
@@ -1,6 +1,6 @@
-Partition | @camunda8/sdk
      Interface Partition
      interface Partition { 
          health: PartitionBrokerHealth; 
          partitionId: number; 
          role: PartitionBrokerRole; 
      }
      Properties
      health
+Partition | @camunda8/sdk
      Interface Partition
      interface Partition { 
          health: PartitionBrokerHealth; 
          partitionId: number; 
          role: PartitionBrokerRole; 
      }
      Properties
      health
 partitionId
 role
 
      Properties
      health
      health: PartitionBrokerHealth
      the health of this partition
      
-
      partitionId
      partitionId: number
      role
      role: PartitionBrokerRole
      the role of the broker for this partition
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      partitionId
      partitionId: number
      role
      role: PartitionBrokerRole
      the role of the broker for this partition
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ProcessDeployment.html b/interfaces/zeebe_types.ProcessDeployment.html
index c021a66b..bba009cf 100644
--- a/interfaces/zeebe_types.ProcessDeployment.html
+++ b/interfaces/zeebe_types.ProcessDeployment.html
@@ -1,2 +1,2 @@
-ProcessDeployment | @camunda8/sdk
      Interface ProcessDeployment
      interface ProcessDeployment { 
          process: ProcessMetadata; 
      }
      Properties
      process
-
      Properties
      process
      process: ProcessMetadata
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+ProcessDeployment | @camunda8/sdk
      Interface ProcessDeployment
      interface ProcessDeployment { 
          process: ProcessMetadata; 
      }
      Properties
      process
+
      Properties
      process
      process: ProcessMetadata
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ProcessInstanceCreationStartInstruction.html b/interfaces/zeebe_types.ProcessInstanceCreationStartInstruction.html
index 3a4ec6ea..ef04a4f5 100644
--- a/interfaces/zeebe_types.ProcessInstanceCreationStartInstruction.html
+++ b/interfaces/zeebe_types.ProcessInstanceCreationStartInstruction.html
@@ -1,4 +1,4 @@
-ProcessInstanceCreationStartInstruction | @camunda8/sdk
      Interface ProcessInstanceCreationStartInstruction
      interface ProcessInstanceCreationStartInstruction { 
          elementId: string; 
      }
      Properties
      elementId
+ProcessInstanceCreationStartInstruction | @camunda8/sdk
      Interface ProcessInstanceCreationStartInstruction
      interface ProcessInstanceCreationStartInstruction { 
          elementId: string; 
      }
      Properties
      elementId
 
      Properties
      elementId
      elementId: string
      future extensions might include
      
 
        
 
      • different types of start instructions
        • 
@@ -6,4 +6,4 @@
 for now, however, the start instruction is implicitly a
 "startBeforeElement" instruction
 
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ProcessMetadata.html b/interfaces/zeebe_types.ProcessMetadata.html
index bf567c63..5c78a599 100644
--- a/interfaces/zeebe_types.ProcessMetadata.html
+++ b/interfaces/zeebe_types.ProcessMetadata.html
@@ -1,13 +1,13 @@
-ProcessMetadata | @camunda8/sdk
      Interface ProcessMetadata
      interface ProcessMetadata { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          resourceName: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      bpmnProcessId
+ProcessMetadata | @camunda8/sdk
      Interface ProcessMetadata
      interface ProcessMetadata { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          resourceName: string; 
          tenantId: string; 
          version: number; 
      }
      Properties
      bpmnProcessId
 processDefinitionKey
 resourceName
 tenantId
 version
 
      Properties
      Readonly bpmnProcessId
      bpmnProcessId: string
      the bpmn process ID, as parsed during deployment; together with the version forms a
 unique identifier for a specific process definition
      
-
      Readonly processDefinitionKey
      processDefinitionKey: string
      the assigned key, which acts as a unique identifier for this process
      
-
      Readonly resourceName
      resourceName: string
      the resource name (see: ProcessRequestObject.name) from which this process was
+
      Readonly processDefinitionKey
      processDefinitionKey: string
      the assigned key, which acts as a unique identifier for this process
      
+
      Readonly resourceName
      resourceName: string
      the resource name (see: ProcessRequestObject.name) from which this process was
 parsed
      
-
      tenantId
      tenantId: string
      the tenant identifier of the deployed process
      
-
      Readonly version
      version: number
      the assigned process version
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      tenantId
      tenantId: string
      the tenant identifier of the deployed process
      
+
      Readonly version
      version: number
      the assigned process version
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ProcessRequestObject.html b/interfaces/zeebe_types.ProcessRequestObject.html
index 74fc89fa..f193a95a 100644
--- a/interfaces/zeebe_types.ProcessRequestObject.html
+++ b/interfaces/zeebe_types.ProcessRequestObject.html
@@ -1,3 +1,3 @@
-ProcessRequestObject | @camunda8/sdk
      Interface ProcessRequestObject
      interface ProcessRequestObject { 
          definition: Buffer; 
          name?: string; 
      }
      Properties
      definition
+ProcessRequestObject | @camunda8/sdk
      Interface ProcessRequestObject
      interface ProcessRequestObject { 
          definition: Buffer; 
          name?: string; 
      }
      Properties
      definition
 name?
-
      Properties
      definition
      definition: Buffer
      Optional name
      name?: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      definition
      definition: Buffer
      Optional name
      name?: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.PublishMessageRequest.html b/interfaces/zeebe_types.PublishMessageRequest.html
index 05a68c72..87a9b55f 100644
--- a/interfaces/zeebe_types.PublishMessageRequest.html
+++ b/interfaces/zeebe_types.PublishMessageRequest.html
@@ -1,12 +1,12 @@
-PublishMessageRequest | @camunda8/sdk
      Interface PublishMessageRequest<Variables>
      interface PublishMessageRequest<Variables> { 
          correlationKey: string; 
          messageId?: string; 
          name: string; 
          tenantId?: string; 
          timeToLive?: MaybeTimeDuration; 
          variables?: Variables; 
      }
       
      Type Parameters
       
      Properties
      correlationKey
+PublishMessageRequest | @camunda8/sdk
      Interface PublishMessageRequest<Variables>
      interface PublishMessageRequest<Variables> { 
          correlationKey: string; 
          messageId?: string; 
          name: string; 
          tenantId?: string; 
          timeToLive?: MaybeTimeDuration; 
          variables?: Variables; 
      }
       
      Type Parameters
       
      Properties
      correlationKey
 messageId?
 name
 tenantId?
 timeToLive?
 variables?
 
      Properties
      correlationKey
      correlationKey: string
      The value to match with the field specified as "Subscription Correlation Key" in BPMN
      
-
      Optional messageId
      messageId?: string
      Unique ID for this message
      
-
      name
      name: string
      Should match the "Message Name" in a BPMN Message Catch
      
-
      Optional tenantId
      tenantId?: string
      the tenantId of the message
      
-
      Optional timeToLive
      timeToLive?: MaybeTimeDuration
      The number of seconds for the message to buffer on the broker, awaiting correlation. Omit or set to zero for no buffering.
      
-
      Optional variables
      variables?: Variables
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Optional messageId
      messageId?: string
      Unique ID for this message
      
+
      name
      name: string
      Should match the "Message Name" in a BPMN Message Catch
      
+
      Optional tenantId
      tenantId?: string
      the tenantId of the message
      
+
      Optional timeToLive
      timeToLive?: MaybeTimeDuration
      The number of seconds for the message to buffer on the broker, awaiting correlation. Omit or set to zero for no buffering.
      
+
      Optional variables
      variables?: Variables
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.PublishMessageResponse.html b/interfaces/zeebe_types.PublishMessageResponse.html
index fa2d128f..a42c3623 100644
--- a/interfaces/zeebe_types.PublishMessageResponse.html
+++ b/interfaces/zeebe_types.PublishMessageResponse.html
@@ -1,5 +1,5 @@
-PublishMessageResponse | @camunda8/sdk
      Interface PublishMessageResponse
      interface PublishMessageResponse { 
          key: string; 
          tenantId: string; 
      }
      Properties
      key
+PublishMessageResponse | @camunda8/sdk
      Interface PublishMessageResponse
      interface PublishMessageResponse { 
          key: string; 
          tenantId: string; 
      }
      Properties
      key
 tenantId
 
      Properties
      key
      key: string
      the unique ID of the message that was published
      
-
      tenantId
      tenantId: string
      the tenantId of the message
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      tenantId
      tenantId: string
      the tenantId of the message
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.PublishStartMessageRequest.html b/interfaces/zeebe_types.PublishStartMessageRequest.html
index 6d0c4744..6967313d 100644
--- a/interfaces/zeebe_types.PublishStartMessageRequest.html
+++ b/interfaces/zeebe_types.PublishStartMessageRequest.html
@@ -1,12 +1,12 @@
-PublishStartMessageRequest | @camunda8/sdk
      Interface PublishStartMessageRequest<Variables>
      interface PublishStartMessageRequest<Variables> { 
          correlationKey?: string; 
          messageId?: string; 
          name: string; 
          tenantId?: string; 
          timeToLive: MaybeTimeDuration; 
          variables: Variables; 
      }
       
      Type Parameters
       
      Properties
      correlationKey?
+PublishStartMessageRequest | @camunda8/sdk
      Interface PublishStartMessageRequest<Variables>
      interface PublishStartMessageRequest<Variables> { 
          correlationKey?: string; 
          messageId?: string; 
          name: string; 
          tenantId?: string; 
          timeToLive: MaybeTimeDuration; 
          variables: Variables; 
      }
       
      Type Parameters
       
      Properties
      correlationKey?
 messageId?
 name
 tenantId?
 timeToLive
 variables
-
      Properties
      Optional correlationKey
      correlationKey?: string
      Optional messageId
      messageId?: string
      Unique ID for this message
      
-
      name
      name: string
      Should match the "Message Name" in a BPMN Message Catch
      
-
      Optional tenantId
      tenantId?: string
      the tenantId for the message
      
-
      timeToLive
      timeToLive: MaybeTimeDuration
      The number of seconds for the message to buffer on the broker, awaiting correlation.
+
      Properties
      Optional correlationKey
      correlationKey?: string
      Optional messageId
      messageId?: string
      Unique ID for this message
      
+
      name
      name: string
      Should match the "Message Name" in a BPMN Message Catch
      
+
      Optional tenantId
      tenantId?: string
      the tenantId for the message
      
+
      timeToLive
      timeToLive: MaybeTimeDuration
      The number of seconds for the message to buffer on the broker, awaiting correlation.
 Omit or set to zero for no buffering.
      
-
      variables
      variables: Variables
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      variables
      variables: Variables
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ResolveIncidentRequest.html b/interfaces/zeebe_types.ResolveIncidentRequest.html
index 6ea070c2..a726a401 100644
--- a/interfaces/zeebe_types.ResolveIncidentRequest.html
+++ b/interfaces/zeebe_types.ResolveIncidentRequest.html
@@ -1,2 +1,2 @@
-ResolveIncidentRequest | @camunda8/sdk
      Interface ResolveIncidentRequest
      interface ResolveIncidentRequest { 
          incidentKey: string; 
      }
      Properties
      incidentKey
-
      Properties
      Readonly incidentKey
      incidentKey: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+ResolveIncidentRequest | @camunda8/sdk
      Interface ResolveIncidentRequest
      interface ResolveIncidentRequest { 
          incidentKey: string; 
      }
      Properties
      incidentKey
+
      Properties
      Readonly incidentKey
      incidentKey: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.Resource.html b/interfaces/zeebe_types.Resource.html
index edf76674..fc2977dd 100644
--- a/interfaces/zeebe_types.Resource.html
+++ b/interfaces/zeebe_types.Resource.html
@@ -1,5 +1,5 @@
-Resource | @camunda8/sdk
      Interface Resource
      interface Resource { 
          content: Buffer; 
          name: string; 
      }
      Properties
      content
+Resource | @camunda8/sdk
      Interface Resource
      interface Resource { 
          content: Buffer; 
          name: string; 
      }
      Properties
      content
 name
 
      Properties
      content
      content: Buffer
      the file content as a UTF8-encoded string
      
-
      name
      name: string
      the resource name, e.g. myProcess.bpmn or myDecision.dmn
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      name
      name: string
      the resource name, e.g. myProcess.bpmn or myDecision.dmn
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.SetVariablesRequest.html b/interfaces/zeebe_types.SetVariablesRequest.html
index f8b5c248..79d52924 100644
--- a/interfaces/zeebe_types.SetVariablesRequest.html
+++ b/interfaces/zeebe_types.SetVariablesRequest.html
@@ -1,11 +1,11 @@
-SetVariablesRequest | @camunda8/sdk
      Interface SetVariablesRequest<Variables>
      interface SetVariablesRequest<Variables> { 
          elementInstanceKey: string; 
          local: boolean; 
          variables: Partial<Variables>; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      elementInstanceKey
+SetVariablesRequest | @camunda8/sdk
      Interface SetVariablesRequest<Variables>
      interface SetVariablesRequest<Variables> { 
          elementInstanceKey: string; 
          local: boolean; 
          variables: Partial<Variables>; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      elementInstanceKey
 local
 variables
-
      Properties
      Readonly elementInstanceKey
      elementInstanceKey: string
      local
      local: boolean
      if true, the variables will be merged strictly into the local scope (as indicated by
+
      Properties
      Readonly elementInstanceKey
      elementInstanceKey: string
      local
      local: boolean
      if true, the variables will be merged strictly into the local scope (as indicated by
  elementInstanceKey); this means the variables is not propagated to upper scopes.
  for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
 1 => { "foo" : 2 }, and 2 => { "bar" : 1 }. if we send an update request with
 elementInstanceKey = 2, variables { "foo" : 5 }, and local is true, then scope 1 will
 be unchanged, and scope 2 will now be { "bar" : 1, "foo" 5 }. if local was false, however,
 then scope 1 would be { "foo": 5 }, and scope 2 would be { "bar" : 1 }.
      
-
      variables
      variables: Partial<Variables>
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      variables
      variables: Partial<Variables>
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.SetVariablesRequestOnTheWire.html b/interfaces/zeebe_types.SetVariablesRequestOnTheWire.html
index b1c0b017..c7509d35 100644
--- a/interfaces/zeebe_types.SetVariablesRequestOnTheWire.html
+++ b/interfaces/zeebe_types.SetVariablesRequestOnTheWire.html
@@ -1,11 +1,11 @@
-SetVariablesRequestOnTheWire | @camunda8/sdk
      Interface SetVariablesRequestOnTheWire
      interface SetVariablesRequestOnTheWire { 
          elementInstanceKey: string; 
          local: boolean; 
          variables: string; 
      }
      Hierarchy (view full)
      Properties
      elementInstanceKey
+SetVariablesRequestOnTheWire | @camunda8/sdk
      Interface SetVariablesRequestOnTheWire
      interface SetVariablesRequestOnTheWire { 
          elementInstanceKey: string; 
          local: boolean; 
          variables: string; 
      }
      Hierarchy (view full)
      Properties
      elementInstanceKey
 local
 variables
-
      Properties
      Readonly elementInstanceKey
      elementInstanceKey: string
      local
      local: boolean
      if true, the variables will be merged strictly into the local scope (as indicated by
+
      Properties
      Readonly elementInstanceKey
      elementInstanceKey: string
      local
      local: boolean
      if true, the variables will be merged strictly into the local scope (as indicated by
  elementInstanceKey); this means the variables is not propagated to upper scopes.
  for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
 1 => { "foo" : 2 }, and 2 => { "bar" : 1 }. if we send an update request with
 elementInstanceKey = 2, variables { "foo" : 5 }, and local is true, then scope 1 will
 be unchanged, and scope 2 will now be { "bar" : 1, "foo" 5 }. if local was false, however,
 then scope 1 would be { "foo": 5 }, and scope 2 would be { "bar" : 1 }.
      
-
      variables
      variables: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      variables
      variables: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.StreamActivatedJobsRequest.html b/interfaces/zeebe_types.StreamActivatedJobsRequest.html
index 1ede1c40..b0b61ac8 100644
--- a/interfaces/zeebe_types.StreamActivatedJobsRequest.html
+++ b/interfaces/zeebe_types.StreamActivatedJobsRequest.html
@@ -1,13 +1,13 @@
-StreamActivatedJobsRequest | @camunda8/sdk
      Interface StreamActivatedJobsRequest
      interface StreamActivatedJobsRequest { 
          fetchVariable: string[]; 
          tenantIds: string[]; 
          timeout: number; 
          type: string; 
          worker: string; 
      }
      Properties
      fetchVariable
+StreamActivatedJobsRequest | @camunda8/sdk
      Interface StreamActivatedJobsRequest
      interface StreamActivatedJobsRequest { 
          fetchVariable: string[]; 
          tenantIds: string[]; 
          timeout: number; 
          type: string; 
          worker: string; 
      }
      Properties
      fetchVariable
 tenantIds
 timeout
 type
 worker
 
      Properties
      fetchVariable
      fetchVariable: string[]
      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
      
-
      tenantIds
      tenantIds: string[]
      a list of identifiers of tenants for which to stream jobs
      
-
      timeout
      timeout: number
      a job returned after this call will not be activated by another call until the
+
      tenantIds
      tenantIds: string[]
      a list of identifiers of tenants for which to stream jobs
      
+
      timeout
      timeout: number
      a job returned after this call will not be activated by another call until the
 timeout (in ms) has been reached
      
-
      type
      type: string
      the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
      
-
      worker
      worker: string
      the name of the worker activating the jobs, mostly used for logging purposes
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      type
      type: string
      the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
      
+
      worker
      worker: string
      the name of the worker activating the jobs, mostly used for logging purposes
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.TerminateInstruction.html b/interfaces/zeebe_types.TerminateInstruction.html
index 568f42cc..ead70d34 100644
--- a/interfaces/zeebe_types.TerminateInstruction.html
+++ b/interfaces/zeebe_types.TerminateInstruction.html
@@ -1,3 +1,3 @@
-TerminateInstruction | @camunda8/sdk
      Interface TerminateInstruction
      interface TerminateInstruction { 
          elementInstanceKey: string; 
      }
      Properties
      elementInstanceKey
+TerminateInstruction | @camunda8/sdk
      Interface TerminateInstruction
      interface TerminateInstruction { 
          elementInstanceKey: string; 
      }
      Properties
      elementInstanceKey
 
      Properties
      elementInstanceKey
      elementInstanceKey: string
      the id of the element that should be terminated
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ThrowErrorRequest.html b/interfaces/zeebe_types.ThrowErrorRequest.html
index c70c91ff..3d1e909e 100644
--- a/interfaces/zeebe_types.ThrowErrorRequest.html
+++ b/interfaces/zeebe_types.ThrowErrorRequest.html
@@ -1,13 +1,13 @@
-ThrowErrorRequest | @camunda8/sdk
      Interface ThrowErrorRequest
      interface ThrowErrorRequest { 
          errorCode: string; 
          errorMessage?: string; 
          jobKey: string; 
          variables?: JSONDoc; 
      }
      Properties
      errorCode
+ThrowErrorRequest | @camunda8/sdk
      Interface ThrowErrorRequest
      interface ThrowErrorRequest { 
          errorCode: string; 
          errorMessage?: string; 
          jobKey: string; 
          variables?: JSONDoc; 
      }
      Properties
      errorCode
 errorMessage?
 jobKey
 variables?
 
      Properties
      errorCode
      errorCode: string
      the error code that will be matched with an error catch event
      
-
      Optional errorMessage
      errorMessage?: string
      an optional error message that provides additional context
      
-
      jobKey
      jobKey: string
      the unique job identifier, as obtained when activating the job
      
-
      Optional variables
      variables?: JSONDoc
      JSON document that will instantiate the variables at the local scope of the error catch
+
      Optional errorMessage
      errorMessage?: string
      an optional error message that provides additional context
      
+
      jobKey
      jobKey: string
      the unique job identifier, as obtained when activating the job
      
+
      Optional variables
      variables?: JSONDoc
      JSON document that will instantiate the variables at the local scope of the error catch
 event that catches the thrown error; it must be a JSON object, as variables will be mapped in a
 key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
 "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
 valid argument, as the root of the JSON document is an array and not an object.
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.TopologyResponse.html b/interfaces/zeebe_types.TopologyResponse.html
index 96264183..a040bf21 100644
--- a/interfaces/zeebe_types.TopologyResponse.html
+++ b/interfaces/zeebe_types.TopologyResponse.html
@@ -1,6 +1,6 @@
-TopologyResponse | @camunda8/sdk
      Interface TopologyResponse
      interface TopologyResponse { 
          brokers: BrokerInfo[]; 
          clusterSize: number; 
          gatewayVersion: string; 
          partitionsCount: number; 
          replicationFactor: number; 
      }
      Properties
      brokers
+TopologyResponse | @camunda8/sdk
      Interface TopologyResponse
      interface TopologyResponse { 
          brokers: BrokerInfo[]; 
          clusterSize: number; 
          gatewayVersion: string; 
          partitionsCount: number; 
          replicationFactor: number; 
      }
      Properties
      brokers
 clusterSize
 gatewayVersion
 partitionsCount
 replicationFactor
-
      Properties
      Readonly brokers
      brokers: BrokerInfo[]
      Readonly clusterSize
      clusterSize: number
      Readonly gatewayVersion
      gatewayVersion: string
      Readonly partitionsCount
      partitionsCount: number
      Readonly replicationFactor
      replicationFactor: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Readonly brokers
      brokers: BrokerInfo[]
      Readonly clusterSize
      clusterSize: number
      Readonly gatewayVersion
      gatewayVersion: string
      Readonly partitionsCount
      partitionsCount: number
      Readonly replicationFactor
      replicationFactor: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.UpdateJobRetriesRequest.html b/interfaces/zeebe_types.UpdateJobRetriesRequest.html
index e2165f02..5cc884c8 100644
--- a/interfaces/zeebe_types.UpdateJobRetriesRequest.html
+++ b/interfaces/zeebe_types.UpdateJobRetriesRequest.html
@@ -1,3 +1,3 @@
-UpdateJobRetriesRequest | @camunda8/sdk
      Interface UpdateJobRetriesRequest
      interface UpdateJobRetriesRequest { 
          jobKey: string; 
          retries: number; 
      }
      Properties
      jobKey
+UpdateJobRetriesRequest | @camunda8/sdk
      Interface UpdateJobRetriesRequest
      interface UpdateJobRetriesRequest { 
          jobKey: string; 
          retries: number; 
      }
      Properties
      jobKey
 retries
-
      Properties
      Readonly jobKey
      jobKey: string
      retries
      retries: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Readonly jobKey
      jobKey: string
      retries
      retries: number
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.VariableInstruction.html b/interfaces/zeebe_types.VariableInstruction.html
index 5a0d082f..fc8d39b4 100644
--- a/interfaces/zeebe_types.VariableInstruction.html
+++ b/interfaces/zeebe_types.VariableInstruction.html
@@ -1,10 +1,10 @@
-VariableInstruction | @camunda8/sdk
      Interface VariableInstruction
      interface VariableInstruction { 
          scopeId: string; 
          variables: JSONDoc; 
      }
      Properties
      scopeId
+VariableInstruction | @camunda8/sdk
      Interface VariableInstruction
      interface VariableInstruction { 
          scopeId: string; 
          variables: JSONDoc; 
      }
      Properties
      scopeId
 variables
 
      Properties
      scopeId
      scopeId: string
      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
      
-
      variables
      variables: JSONDoc
      JSON document that will instantiate the variables for the root variable scope of the
+
      variables
      variables: JSONDoc
      JSON document that will instantiate the variables for the root variable scope of the
 process instance; it must be a JSON object, as variables will be mapped in a
 key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
 "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
 valid argument, as the root of the JSON document is an array and not an object.
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ZBClientOptions.html b/interfaces/zeebe_types.ZBClientOptions.html
index 22c4cebb..638b98ec 100644
--- a/interfaces/zeebe_types.ZBClientOptions.html
+++ b/interfaces/zeebe_types.ZBClientOptions.html
@@ -1,4 +1,4 @@
-ZBClientOptions | @camunda8/sdk
      Interface ZBClientOptions
      interface ZBClientOptions { 
          camundaCloud?: CamundaCloudConfig; 
          connectionTolerance?: MaybeTimeDuration; 
          customSSL?: CustomSSL; 
          eagerConnection?: boolean; 
          hostname?: string; 
          logNamespace?: string; 
          loglevel?: Loglevel; 
          longPoll: MaybeTimeDuration; 
          maxRetries?: number; 
          maxRetryTimeout?: MaybeTimeDuration; 
          oAuth?: OAuthProviderConfig; 
          onConnectionError?: (() => void); 
          onReady?: (() => void); 
          pollInterval: MaybeTimeDuration; 
          port?: string; 
          retry?: boolean; 
          stdout?: ZBCustomLogger; 
          tenantId?: string; 
          useTLS?: boolean; 
      }
      Properties
      camundaCloud?
+ZBClientOptions | @camunda8/sdk
      Interface ZBClientOptions
      interface ZBClientOptions { 
          camundaCloud?: CamundaCloudConfig; 
          connectionTolerance?: MaybeTimeDuration; 
          customSSL?: CustomSSL; 
          eagerConnection?: boolean; 
          hostname?: string; 
          logNamespace?: string; 
          loglevel?: Loglevel; 
          longPoll: MaybeTimeDuration; 
          maxRetries?: number; 
          maxRetryTimeout?: MaybeTimeDuration; 
          oAuth?: OAuthProviderConfig; 
          onConnectionError?: (() => void); 
          onReady?: (() => void); 
          pollInterval: MaybeTimeDuration; 
          port?: string; 
          retry?: boolean; 
          stdout?: ZBCustomLogger; 
          tenantId?: string; 
          useTLS?: boolean; 
      }
      Properties
      camundaCloud?
 connectionTolerance?
 customSSL?
 eagerConnection?
@@ -17,4 +17,4 @@
 stdout?
 tenantId?
 useTLS?
-
      Properties
      Optional camundaCloud
      camundaCloud?: CamundaCloudConfig
      Optional connectionTolerance
      connectionTolerance?: MaybeTimeDuration
      Optional customSSL
      customSSL?: CustomSSL
      Optional eagerConnection
      eagerConnection?: boolean
      Optional hostname
      hostname?: string
      Optional logNamespace
      logNamespace?: string
      Optional loglevel
      loglevel?: Loglevel
      longPoll
      longPoll: MaybeTimeDuration
      Optional maxRetries
      maxRetries?: number
      Optional maxRetryTimeout
      maxRetryTimeout?: MaybeTimeDuration
      Optional oAuth
      oAuth?: OAuthProviderConfig
      Optional onConnectionError
      onConnectionError?: (() => void)
      Type declaration
        • (): void
        • Returns void
      Optional onReady
      onReady?: (() => void)
      Type declaration
        • (): void
        • Returns void
      pollInterval
      pollInterval: MaybeTimeDuration
      Optional port
      port?: string
      Optional retry
      retry?: boolean
      Optional stdout
      stdout?: ZBCustomLogger
      Optional tenantId
      tenantId?: string
      Optional useTLS
      useTLS?: boolean
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Optional camundaCloud
      camundaCloud?: CamundaCloudConfig
      Optional connectionTolerance
      connectionTolerance?: MaybeTimeDuration
      Optional customSSL
      customSSL?: CustomSSL
      Optional eagerConnection
      eagerConnection?: boolean
      Optional hostname
      hostname?: string
      Optional logNamespace
      logNamespace?: string
      Optional loglevel
      loglevel?: Loglevel
      longPoll
      longPoll: MaybeTimeDuration
      Optional maxRetries
      maxRetries?: number
      Optional maxRetryTimeout
      maxRetryTimeout?: MaybeTimeDuration
      Optional oAuth
      oAuth?: OAuthProviderConfig
      Optional onConnectionError
      onConnectionError?: (() => void)
      Type declaration
        • (): void
        • Returns void
      Optional onReady
      onReady?: (() => void)
      Type declaration
        • (): void
        • Returns void
      pollInterval
      pollInterval: MaybeTimeDuration
      Optional port
      port?: string
      Optional retry
      retry?: boolean
      Optional stdout
      stdout?: ZBCustomLogger
      Optional tenantId
      tenantId?: string
      Optional useTLS
      useTLS?: boolean
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ZBCustomLogger.html b/interfaces/zeebe_types.ZBCustomLogger.html
index 0e614bdd..e2e367e9 100644
--- a/interfaces/zeebe_types.ZBCustomLogger.html
+++ b/interfaces/zeebe_types.ZBCustomLogger.html
@@ -1,7 +1,7 @@
-ZBCustomLogger | @camunda8/sdk
      Interface ZBCustomLogger
      interface ZBCustomLogger { 
          debug: ((message) => void); 
          error: ((message) => void); 
          info: ((message) => void); 
      }
      Properties
      debug
+ZBCustomLogger | @camunda8/sdk
      Interface ZBCustomLogger
      interface ZBCustomLogger { 
          debug: ((message) => void); 
          error: ((message) => void); 
          info: ((message) => void); 
      }
      Properties
      debug
 error
 info
 
      Properties
      debug
      debug: ((message) => void)
      Receives a JSON-stringified ZBLogMessage
      
-
      Type declaration
        • (message): void
        • Parameters
          • message: string
          Returns void
      error
      error: ((message) => void)
      Receives a JSON-stringified ZBLogMessage
      
-
      Type declaration
        • (message): void
        • Parameters
          • message: string
          Returns void
      info
      info: ((message) => void)
      Receives a JSON-stringified ZBLogMessage
      
-
      Type declaration
        • (message): void
        • Parameters
          • message: string
          Returns void
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Type declaration
        • (message): void
        • Parameters
          • message: string
          Returns void
      error
      error: ((message) => void)
      Receives a JSON-stringified ZBLogMessage
      
+
      Type declaration
        • (message): void
        • Parameters
          • message: string
          Returns void
      info
      info: ((message) => void)
      Receives a JSON-stringified ZBLogMessage
      
+
      Type declaration
        • (message): void
        • Parameters
          • message: string
          Returns void
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ZBGrpc.html b/interfaces/zeebe_types.ZBGrpc.html
index cb32ddce..6f15ad61 100644
--- a/interfaces/zeebe_types.ZBGrpc.html
+++ b/interfaces/zeebe_types.ZBGrpc.html
@@ -1,4 +1,4 @@
-ZBGrpc | @camunda8/sdk
      Interface ZBGrpc
      interface ZBGrpc { 
          activateJobsStream: ((req) => ClientReadableStream<unknown>); 
          channelClosed: boolean; 
          client: Client; 
          completeJobSync: ((req) => Promise<void>); 
          connected: boolean; 
          deleteResourceSync: ((deleteResourceRequest) => Promise<Record<string, never>>); 
          host: string; 
          longPoll?: MaybeTimeDuration; 
          broadcastSignalSync(signal): Promise<BroadcastSignalResponse>; 
          cancelProcessInstanceSync(processInstanceKey): Promise<void>; 
          close(timeout?): Promise<void>; 
          createProcessInstanceSync(createProcessInstanceRequest): Promise<CreateProcessInstanceResponse>; 
          createProcessInstanceWithResultSync(createProcessInstanceWithResultRequest): Promise<CreateProcessInstanceWithResultResponseOnWire>; 
          deployResourceSync<T>(resource): Promise<DeployResourceResponse<T>>; 
          evaluateDecisionSync(evaluateDecisionRequest): Promise<EvaluateDecisionResponse>; 
          failJobSync(failJobRequest): Promise<void>; 
          listMethods(): string[]; 
          migrateProcessInstanceSync(request): Promise<MigrateProcessInstanceResponse>; 
          modifyProcessInstanceSync(request): Promise<ModifyProcessInstanceResponse>; 
          publishMessageSync(publishMessageRequest): Promise<PublishMessageResponse>; 
          resolveIncidentSync(resolveIncidentRequest): Promise<void>; 
          runService(fnName, data, fnAnswer): void; 
          setVariablesSync(request): Promise<void>; 
          throwErrorSync(throwErrorRequest): Promise<void>; 
          topologySync(): Promise<TopologyResponse>; 
          updateJobRetriesSync(updateJobRetriesRequest): Promise<void>; 
      }
      Hierarchy (view full)
      Properties
      activateJobsStream
+ZBGrpc | @camunda8/sdk
      Interface ZBGrpc
      interface ZBGrpc { 
          activateJobsStream: ((req) => ClientReadableStream<unknown>); 
          channelClosed: boolean; 
          client: Client; 
          completeJobSync: ((req) => Promise<void>); 
          connected: boolean; 
          deleteResourceSync: ((deleteResourceRequest) => Promise<Record<string, never>>); 
          host: string; 
          longPoll?: MaybeTimeDuration; 
          broadcastSignalSync(signal): Promise<BroadcastSignalResponse>; 
          cancelProcessInstanceSync(processInstanceKey): Promise<void>; 
          close(timeout?): Promise<void>; 
          createProcessInstanceSync(createProcessInstanceRequest): Promise<CreateProcessInstanceResponse>; 
          createProcessInstanceWithResultSync(createProcessInstanceWithResultRequest): Promise<CreateProcessInstanceWithResultResponseOnWire>; 
          deployResourceSync<T>(resource): Promise<DeployResourceResponse<T>>; 
          evaluateDecisionSync(evaluateDecisionRequest): Promise<EvaluateDecisionResponse>; 
          failJobSync(failJobRequest): Promise<void>; 
          listMethods(): string[]; 
          migrateProcessInstanceSync(request): Promise<MigrateProcessInstanceResponse>; 
          modifyProcessInstanceSync(request): Promise<ModifyProcessInstanceResponse>; 
          publishMessageSync(publishMessageRequest): Promise<PublishMessageResponse>; 
          resolveIncidentSync(resolveIncidentRequest): Promise<void>; 
          runService(fnName, data, fnAnswer): void; 
          setVariablesSync(request): Promise<void>; 
          throwErrorSync(throwErrorRequest): Promise<void>; 
          topologySync(): Promise<TopologyResponse>; 
          updateJobRetriesSync(updateJobRetriesRequest): Promise<void>; 
      }
      Hierarchy (view full)
      Properties
      activateJobsStream
 channelClosed
 client
 completeJobSync
@@ -24,4 +24,4 @@
 throwErrorSync
 topologySync
 updateJobRetriesSync
-
      Properties
      activateJobsStream
      activateJobsStream: ((req) => ClientReadableStream<unknown>)
      Type declaration
        • (req): ClientReadableStream<unknown>
        • Parameters
          Returns ClientReadableStream<unknown>
      channelClosed
      channelClosed: boolean = false
      client
      client: Client
      completeJobSync
      completeJobSync: ((req) => Promise<void>)
      Type declaration
      connected
      connected: boolean = false
      deleteResourceSync
      deleteResourceSync: ((deleteResourceRequest) => Promise<Record<string, never>>)
      Type declaration
        • (deleteResourceRequest): Promise<Record<string, never>>
        • Parameters
          Returns Promise<Record<string, never>>
      host
      host: string
      Optional longPoll
      longPoll?: MaybeTimeDuration
      Methods
      broadcastSignalSync
      cancelProcessInstanceSync
      • cancelProcessInstanceSync(processInstanceKey): Promise<void>
      • Parameters
        • processInstanceKey: { 
              processInstanceKey: string | number; 
          }
          • processInstanceKey: string | number
        Returns Promise<void>
      close
      createProcessInstanceSync
      createProcessInstanceWithResultSync
      deployResourceSync
      evaluateDecisionSync
      failJobSync
      listMethods
      migrateProcessInstanceSync
      modifyProcessInstanceSync
      publishMessageSync
      resolveIncidentSync
      runService
      setVariablesSync
      throwErrorSync
      topologySync
      updateJobRetriesSync
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      activateJobsStream
      activateJobsStream: ((req) => ClientReadableStream<unknown>)
      Type declaration
        • (req): ClientReadableStream<unknown>
        • Parameters
          Returns ClientReadableStream<unknown>
      channelClosed
      channelClosed: boolean = false
      client
      client: Client
      completeJobSync
      completeJobSync: ((req) => Promise<void>)
      Type declaration
      connected
      connected: boolean = false
      deleteResourceSync
      deleteResourceSync: ((deleteResourceRequest) => Promise<Record<string, never>>)
      Type declaration
        • (deleteResourceRequest): Promise<Record<string, never>>
        • Parameters
          Returns Promise<Record<string, never>>
      host
      host: string
      Optional longPoll
      longPoll?: MaybeTimeDuration
      Methods
      broadcastSignalSync
      cancelProcessInstanceSync
      • cancelProcessInstanceSync(processInstanceKey): Promise<void>
      • Parameters
        • processInstanceKey: { 
              processInstanceKey: string | number; 
          }
          • processInstanceKey: string | number
        Returns Promise<void>
      close
      createProcessInstanceSync
      createProcessInstanceWithResultSync
      deployResourceSync
      evaluateDecisionSync
      failJobSync
      listMethods
      migrateProcessInstanceSync
      modifyProcessInstanceSync
      publishMessageSync
      resolveIncidentSync
      runService
      setVariablesSync
      throwErrorSync
      topologySync
      updateJobRetriesSync
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ZBLogMessage.html b/interfaces/zeebe_types.ZBLogMessage.html
index 7e69312b..3292d682 100644
--- a/interfaces/zeebe_types.ZBLogMessage.html
+++ b/interfaces/zeebe_types.ZBLogMessage.html
@@ -1,7 +1,7 @@
-ZBLogMessage | @camunda8/sdk
      Interface ZBLogMessage
      interface ZBLogMessage { 
          context: string; 
          id: string; 
          level: Loglevel; 
          message: string; 
          time: string; 
          timestamp: Date; 
      }
      Properties
      context
+ZBLogMessage | @camunda8/sdk
      Interface ZBLogMessage
      interface ZBLogMessage { 
          context: string; 
          id: string; 
          level: Loglevel; 
          message: string; 
          time: string; 
          timestamp: Date; 
      }
      Properties
      context
 id
 level
 message
 time
 timestamp
-
      Properties
      context
      context: string
      id
      id: string
      level
      level: Loglevel
      message
      message: string
      time
      time: string
      timestamp
      timestamp: Date
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      context
      context: string
      id
      id: string
      level
      level: Loglevel
      message
      message: string
      time
      time: string
      timestamp
      timestamp: Date
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ZBLoggerConfig.html b/interfaces/zeebe_types.ZBLoggerConfig.html
index 1e5d2a8b..c246b891 100644
--- a/interfaces/zeebe_types.ZBLoggerConfig.html
+++ b/interfaces/zeebe_types.ZBLoggerConfig.html
@@ -1,4 +1,4 @@
-ZBLoggerConfig | @camunda8/sdk
      Interface ZBLoggerConfig
      interface ZBLoggerConfig { 
          _tag: "ZBCLIENT" | "ZBWORKER"; 
          color?: Chalk; 
          colorise?: boolean; 
          id?: string; 
          loglevel?: Loglevel; 
          longPoll?: MaybeTimeDuration; 
          namespace: string | string[]; 
          pollInterval?: MaybeTimeDuration; 
          stdout?: ZBCustomLogger; 
          taskType?: string; 
      }
      Hierarchy (view full)
      Properties
      _tag
+ZBLoggerConfig | @camunda8/sdk
      Interface ZBLoggerConfig
      interface ZBLoggerConfig { 
          _tag: "ZBCLIENT" | "ZBWORKER"; 
          color?: Chalk; 
          colorise?: boolean; 
          id?: string; 
          loglevel?: Loglevel; 
          longPoll?: MaybeTimeDuration; 
          namespace: string | string[]; 
          pollInterval?: MaybeTimeDuration; 
          stdout?: ZBCustomLogger; 
          taskType?: string; 
      }
      Hierarchy (view full)
      Properties
      _tag
 color?
 colorise?
 id?
@@ -8,4 +8,4 @@
 pollInterval?
 stdout?
 taskType?
-
      Properties
      _tag
      _tag: "ZBCLIENT" | "ZBWORKER"
      Optional color
      color?: Chalk
      Optional colorise
      colorise?: boolean
      Optional id
      id?: string
      Optional loglevel
      loglevel?: Loglevel
      Optional longPoll
      longPoll?: MaybeTimeDuration
      namespace
      namespace: string | string[]
      Optional pollInterval
      pollInterval?: MaybeTimeDuration
      Optional stdout
      stdout?: ZBCustomLogger
      Optional taskType
      taskType?: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      _tag
      _tag: "ZBCLIENT" | "ZBWORKER"
      Optional color
      color?: Chalk
      Optional colorise
      colorise?: boolean
      Optional id
      id?: string
      Optional loglevel
      loglevel?: Loglevel
      Optional longPoll
      longPoll?: MaybeTimeDuration
      namespace
      namespace: string | string[]
      Optional pollInterval
      pollInterval?: MaybeTimeDuration
      Optional stdout
      stdout?: ZBCustomLogger
      Optional taskType
      taskType?: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ZBLoggerOptions.html b/interfaces/zeebe_types.ZBLoggerOptions.html
index 70889dc9..ae52a41b 100644
--- a/interfaces/zeebe_types.ZBLoggerOptions.html
+++ b/interfaces/zeebe_types.ZBLoggerOptions.html
@@ -1,8 +1,8 @@
-ZBLoggerOptions | @camunda8/sdk
      Interface ZBLoggerOptions
      interface ZBLoggerOptions { 
          color?: Chalk; 
          loglevel?: Loglevel; 
          longPoll?: MaybeTimeDuration; 
          namespace: string | string[]; 
          pollInterval?: MaybeTimeDuration; 
          stdout?: ZBCustomLogger; 
          taskType?: string; 
      }
      Hierarchy (view full)
      Properties
      color?
+ZBLoggerOptions | @camunda8/sdk
      Interface ZBLoggerOptions
      interface ZBLoggerOptions { 
          color?: Chalk; 
          loglevel?: Loglevel; 
          longPoll?: MaybeTimeDuration; 
          namespace: string | string[]; 
          pollInterval?: MaybeTimeDuration; 
          stdout?: ZBCustomLogger; 
          taskType?: string; 
      }
      Hierarchy (view full)
      Properties
      color?
 loglevel?
 longPoll?
 namespace
 pollInterval?
 stdout?
 taskType?
-
      Properties
      Optional color
      color?: Chalk
      Optional loglevel
      loglevel?: Loglevel
      Optional longPoll
      longPoll?: MaybeTimeDuration
      namespace
      namespace: string | string[]
      Optional pollInterval
      pollInterval?: MaybeTimeDuration
      Optional stdout
      stdout?: ZBCustomLogger
      Optional taskType
      taskType?: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Optional color
      color?: Chalk
      Optional loglevel
      loglevel?: Loglevel
      Optional longPoll
      longPoll?: MaybeTimeDuration
      namespace
      namespace: string | string[]
      Optional pollInterval
      pollInterval?: MaybeTimeDuration
      Optional stdout
      stdout?: ZBCustomLogger
      Optional taskType
      taskType?: string
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ZBWorkerConfig.html b/interfaces/zeebe_types.ZBWorkerConfig.html
index 358d15ca..dda11412 100644
--- a/interfaces/zeebe_types.ZBWorkerConfig.html
+++ b/interfaces/zeebe_types.ZBWorkerConfig.html
@@ -1,4 +1,4 @@
-ZBWorkerConfig | @camunda8/sdk
      Interface ZBWorkerConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      interface ZBWorkerConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> { 
          connectionTolerance?: MaybeTimeDuration; 
          customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>); 
          debug?: boolean; 
          failProcessOnException?: boolean; 
          fetchVariable?: (keyof WorkerInputVariables)[]; 
          id?: string; 
          inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>); 
          logNamespace?: string; 
          loglevel?: Loglevel; 
          longPoll?: MaybeTimeDuration; 
          maxJobsToActivate?: number; 
          onConnectionError?: (() => void); 
          onConnectionErrorHandler?: ConnectionErrorHandler; 
          onReady?: (() => void); 
          pollInterval?: MaybeTimeDuration; 
          stdout?: ZBCustomLogger; 
          taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>; 
          taskType: string; 
          timeout?: MaybeTimeDuration; 
      }
       
      Type Parameters
      • WorkerInputVariables
      • CustomHeaderShape
      • WorkerOutputVariables
       
      Hierarchy (view full)
      Properties
      connectionTolerance?
+ZBWorkerConfig | @camunda8/sdk
      Interface ZBWorkerConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      interface ZBWorkerConfig<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> { 
          connectionTolerance?: MaybeTimeDuration; 
          customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>); 
          debug?: boolean; 
          failProcessOnException?: boolean; 
          fetchVariable?: (keyof WorkerInputVariables)[]; 
          id?: string; 
          inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>); 
          logNamespace?: string; 
          loglevel?: Loglevel; 
          longPoll?: MaybeTimeDuration; 
          maxJobsToActivate?: number; 
          onConnectionError?: (() => void); 
          onConnectionErrorHandler?: ConnectionErrorHandler; 
          onReady?: (() => void); 
          pollInterval?: MaybeTimeDuration; 
          stdout?: ZBCustomLogger; 
          taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>; 
          taskType: string; 
          timeout?: MaybeTimeDuration; 
      }
       
      Type Parameters
      • WorkerInputVariables
      • CustomHeaderShape
      • WorkerOutputVariables
       
      Hierarchy (view full)
      Properties
      connectionTolerance?
 customHeadersDto?
 debug?
 failProcessOnException?
@@ -18,24 +18,24 @@
 taskType
 timeout?
 
      Properties
      Optional connectionTolerance
      connectionTolerance?: MaybeTimeDuration
      If your Grpc connection jitters, this is the window before the connectionError
      
-
      Optional customHeadersDto
      customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>)
      Provide an annotated Dto class to control the serialisation of JSON numbers. This allows you to serialise
+
      Optional customHeadersDto
      customHeadersDto?: (new (...args) => Readonly<CustomHeaderShape>)
      Provide an annotated Dto class to control the serialisation of JSON numbers. This allows you to serialise
 numbers as strings or BigInts to avoid precision loss. This also gives you design-time type safety.
      
-
      Type declaration
      Optional debug
      debug?: boolean
      Enable debug tracking
      
-
      Optional failProcessOnException
      failProcessOnException?: boolean
      If a handler throws an unhandled exception, if this is set true, the process will be failed. Defaults to false.
      
-
      Optional fetchVariable
      fetchVariable?: (keyof WorkerInputVariables)[]
      Constrain payload to these keys only.
      
-
      Optional id
      id?: string
      A custom id for the worker. If none is supplied, a UUID will be generated.
      
-
      Optional inputVariableDto
      inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>)
      Provide an annotated Dto class to control the serialisation of JSON numbers. This allows you to serialise
+
      Type declaration
      Optional debug
      debug?: boolean
      Enable debug tracking
      
+
      Optional failProcessOnException
      failProcessOnException?: boolean
      If a handler throws an unhandled exception, if this is set true, the process will be failed. Defaults to false.
      
+
      Optional fetchVariable
      fetchVariable?: (keyof WorkerInputVariables)[]
      Constrain payload to these keys only.
      
+
      Optional id
      id?: string
      A custom id for the worker. If none is supplied, a UUID will be generated.
      
+
      Optional inputVariableDto
      inputVariableDto?: (new (...args) => Readonly<WorkerInputVariables>)
      Provide an annotated Dto class to control the serialisation of JSON numbers. This allows you to serialise
 numbers as strings or BigInts to avoid precision loss. This also gives you design-time type safety.
      
-
      Type declaration
      Optional logNamespace
      logNamespace?: string
      Optional loglevel
      loglevel?: Loglevel
      A log level if you want it to differ from the ZBClient
      
-
      Optional longPoll
      longPoll?: MaybeTimeDuration
      A custom longpoll timeout. By default long polling is every 30 seconds.
      
-
      Optional maxJobsToActivate
      maxJobsToActivate?: number
      Max concurrent tasks for this worker. Default 32.
      
-
      Optional onConnectionError
      onConnectionError?: (() => void)
      This handler is called when the worker cannot connect to the broker, or loses its connection.
      
-
      Type declaration
        • (): void
        • Returns void
      Optional onConnectionErrorHandler
      onConnectionErrorHandler?: ConnectionErrorHandler
      This handler is called when the worker cannot connect to the broker, or loses its connection.
      
-
      Optional onReady
      onReady?: (() => void)
      This handler is called when the worker (re)establishes its connection to the broker
      
-
      Type declaration
        • (): void
        • Returns void
      Optional pollInterval
      pollInterval?: MaybeTimeDuration
      Poll Interval in ms. Default 100.
      
-
      Optional stdout
      stdout?: ZBCustomLogger
      An implementation of the ZBCustomLogger interface for logging
      
-
      taskHandler
      taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      A job handler - this must return a job action - e.g.: job.complete(), job.error() - in all code paths.
      
-
      taskType
      taskType: string
      The task type that this worker will request jobs for.
      
-
      Optional timeout
      timeout?: MaybeTimeDuration
      Max seconds to allow before time out of a job given to this worker. Default: 30s.
+
      Type declaration
      Optional logNamespace
      logNamespace?: string
      Optional loglevel
      loglevel?: Loglevel
      A log level if you want it to differ from the ZBClient
      
+
      Optional longPoll
      longPoll?: MaybeTimeDuration
      A custom longpoll timeout. By default long polling is every 30 seconds.
      
+
      Optional maxJobsToActivate
      maxJobsToActivate?: number
      Max concurrent tasks for this worker. Default 32.
      
+
      Optional onConnectionError
      onConnectionError?: (() => void)
      This handler is called when the worker cannot connect to the broker, or loses its connection.
      
+
      Type declaration
        • (): void
        • Returns void
      Optional onConnectionErrorHandler
      onConnectionErrorHandler?: ConnectionErrorHandler
      This handler is called when the worker cannot connect to the broker, or loses its connection.
      
+
      Optional onReady
      onReady?: (() => void)
      This handler is called when the worker (re)establishes its connection to the broker
      
+
      Type declaration
        • (): void
        • Returns void
      Optional pollInterval
      pollInterval?: MaybeTimeDuration
      Poll Interval in ms. Default 100.
      
+
      Optional stdout
      stdout?: ZBCustomLogger
      An implementation of the ZBCustomLogger interface for logging
      
+
      taskHandler
      taskHandler: ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      A job handler - this must return a job action - e.g.: job.complete(), job.error() - in all code paths.
      
+
      taskType
      taskType: string
      The task type that this worker will request jobs for.
      
+
      Optional timeout
      timeout?: MaybeTimeDuration
      Max seconds to allow before time out of a job given to this worker. Default: 30s.
 The broker checks deadline timeouts every 30 seconds, so an
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ZBWorkerOptions.html b/interfaces/zeebe_types.ZBWorkerOptions.html
index 16848380..13b5edcb 100644
--- a/interfaces/zeebe_types.ZBWorkerOptions.html
+++ b/interfaces/zeebe_types.ZBWorkerOptions.html
@@ -1,4 +1,4 @@
-ZBWorkerOptions | @camunda8/sdk
      Interface ZBWorkerOptions<InputVars>
      interface ZBWorkerOptions<InputVars> { 
          debug?: boolean; 
          failProcessOnException?: boolean; 
          fetchVariable?: (keyof InputVars)[]; 
          maxJobsToActivate?: number; 
          onConnectionErrorHandler?: ConnectionErrorHandler; 
          pollInterval?: MaybeTimeDuration; 
          timeout?: MaybeTimeDuration; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      debug?
+ZBWorkerOptions | @camunda8/sdk
      Interface ZBWorkerOptions<InputVars>
      interface ZBWorkerOptions<InputVars> { 
          debug?: boolean; 
          failProcessOnException?: boolean; 
          fetchVariable?: (keyof InputVars)[]; 
          maxJobsToActivate?: number; 
          onConnectionErrorHandler?: ConnectionErrorHandler; 
          pollInterval?: MaybeTimeDuration; 
          timeout?: MaybeTimeDuration; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      debug?
 failProcessOnException?
 fetchVariable?
 maxJobsToActivate?
@@ -6,11 +6,11 @@
 pollInterval?
 timeout?
 
      Properties
      Optional debug
      debug?: boolean
      Enable debug tracking
      
-
      Optional failProcessOnException
      failProcessOnException?: boolean
      If a handler throws an unhandled exception, if this is set true, the process will be failed. Defaults to false.
      
-
      Optional fetchVariable
      fetchVariable?: (keyof InputVars)[]
      Constrain payload to these keys only.
      
-
      Optional maxJobsToActivate
      maxJobsToActivate?: number
      Max concurrent tasks for this worker. Default 32.
      
-
      Optional onConnectionErrorHandler
      onConnectionErrorHandler?: ConnectionErrorHandler
      This handler is called when the worker cannot connect to the broker, or loses its connection.
      
-
      Optional pollInterval
      pollInterval?: MaybeTimeDuration
      Poll Interval in ms. Default 100.
      
-
      Optional timeout
      timeout?: MaybeTimeDuration
      Max seconds to allow before time out of a job given to this worker. Default: 30s.
+
      Optional failProcessOnException
      failProcessOnException?: boolean
      If a handler throws an unhandled exception, if this is set true, the process will be failed. Defaults to false.
      
+
      Optional fetchVariable
      fetchVariable?: (keyof InputVars)[]
      Constrain payload to these keys only.
      
+
      Optional maxJobsToActivate
      maxJobsToActivate?: number
      Max concurrent tasks for this worker. Default 32.
      
+
      Optional onConnectionErrorHandler
      onConnectionErrorHandler?: ConnectionErrorHandler
      This handler is called when the worker cannot connect to the broker, or loses its connection.
      
+
      Optional pollInterval
      pollInterval?: MaybeTimeDuration
      Poll Interval in ms. Default 100.
      
+
      Optional timeout
      timeout?: MaybeTimeDuration
      Max seconds to allow before time out of a job given to this worker. Default: 30s.
 The broker checks deadline timeouts every 30 seconds, so an
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types.ZeebeJob.html b/interfaces/zeebe_types.ZeebeJob.html
index ca4dd744..22f02fbb 100644
--- a/interfaces/zeebe_types.ZeebeJob.html
+++ b/interfaces/zeebe_types.ZeebeJob.html
@@ -1,4 +1,4 @@
-ZeebeJob | @camunda8/sdk
      Interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> { 
          bpmnProcessId: string; 
          cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">); 
          complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">); 
          customHeaders: Readonly<CustomHeaderShape>; 
          deadline: string; 
          elementId: string; 
          elementInstanceKey: string; 
          error: ErrorJobOutcome; 
          fail: { 
              (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
              (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
          }; 
          forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT"); 
          key: string; 
          processDefinitionVersion: number; 
          processInstanceKey: string; 
          retries: number; 
          type: string; 
          variables: Readonly<WorkerInputVariables>; 
          worker: string; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
+ZeebeJob | @camunda8/sdk
      Interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
      interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> { 
          bpmnProcessId: string; 
          cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">); 
          complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">); 
          customHeaders: Readonly<CustomHeaderShape>; 
          deadline: string; 
          elementId: string; 
          elementInstanceKey: string; 
          error: ErrorJobOutcome; 
          fail: { 
              (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
              (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
          }; 
          forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT"); 
          key: string; 
          processDefinitionVersion: number; 
          processInstanceKey: string; 
          retries: number; 
          type: string; 
          variables: Readonly<WorkerInputVariables>; 
          worker: string; 
      }
       
      Type Parameters
       
      Hierarchy (view full)
      Properties
      bpmnProcessId
 cancelWorkflow
 complete
 customHeaders
@@ -16,28 +16,28 @@
 variables
 worker
 
      Properties
      Readonly bpmnProcessId
      bpmnProcessId: string
      The bpmn process ID of the job process definition
      
-
      cancelWorkflow
      cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)
      Cancel the workflow.
      
-
      Type declaration
        • (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
        • Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
      complete
      complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)
      Complete the job with a success, optionally passing in a state update to merge
+
      cancelWorkflow
      cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)
      Cancel the workflow.
      
+
      Type declaration
        • (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
        • Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
      complete
      complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)
      Complete the job with a success, optionally passing in a state update to merge
 with the process variables on the broker.
      
-
      Type declaration
        • (updatedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
        • Parameters
          Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
      Readonly customHeaders
      customHeaders: Readonly<CustomHeaderShape>
      A set of custom headers defined during modelling
      
-
      Readonly deadline
      deadline: string
      Readonly elementId
      elementId: string
      The associated task element ID
      
-
      Readonly elementInstanceKey
      elementInstanceKey: string
      The unique key identifying the associated task, unique within the scope of the
+
      Type declaration
        • (updatedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
        • Parameters
          Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
      Readonly customHeaders
      customHeaders: Readonly<CustomHeaderShape>
      A set of custom headers defined during modelling
      
+
      Readonly deadline
      deadline: string
      Readonly elementId
      elementId: string
      The associated task element ID
      
+
      Readonly elementInstanceKey
      elementInstanceKey: string
      The unique key identifying the associated task, unique within the scope of the
 process instance
      
-
      error
      error: ErrorJobOutcome
      Report a business error (i.e. non-technical) that occurs while processing a job.
+
      error
      error: ErrorJobOutcome
      Report a business error (i.e. non-technical) that occurs while processing a job.
 The error is handled in the process by an error catch event.
 If there is no error catch event with the specified errorCode then an incident will be raised instead.
      
-
      fail
      fail: { 
          (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
          (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
      }
      Fail the job with an informative message as to the cause. Optionally, pass in a
+
      fail
      fail: { 
          (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
          (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>; 
      }
      Fail the job with an informative message as to the cause. Optionally, pass in a
 value remaining retries. If no value is passed for retries then the current retry
 count is decremented. Pass in 0for retries to raise an incident in Operate. Optionally,
 specify a retry backoff period in milliseconds. Default is 0ms (immediate retry) if not
 specified.
      
-
      Type declaration
      forward
      forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")
      Mark this job as forwarded to another system for completion. No action is taken by the broker.
+
      Type declaration
      forward
      forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")
      Mark this job as forwarded to another system for completion. No action is taken by the broker.
 This method releases worker capacity to handle another job.
      
-
      Type declaration
        • (): "JOB_ACTION_ACKNOWLEDGEMENT"
        • Returns "JOB_ACTION_ACKNOWLEDGEMENT"
      Readonly key
      key: string
      The key, a unique identifier for the job
      
-
      Readonly processDefinitionVersion
      processDefinitionVersion: number
      The version of the job process definition
      
-
      Readonly processInstanceKey
      processInstanceKey: string
      The job's process instance key
      
-
      Readonly retries
      retries: number
      Readonly type
      type: string
      The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
+
      Type declaration
        • (): "JOB_ACTION_ACKNOWLEDGEMENT"
        • Returns "JOB_ACTION_ACKNOWLEDGEMENT"
      Readonly key
      key: string
      The key, a unique identifier for the job
      
+
      Readonly processDefinitionVersion
      processDefinitionVersion: number
      The version of the job process definition
      
+
      Readonly processInstanceKey
      processInstanceKey: string
      The job's process instance key
      
+
      Readonly retries
      retries: number
      Readonly type
      type: string
      The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
 type="payment-service" />)
      
-
      Readonly variables
      variables: Readonly<WorkerInputVariables>
      All visible variables in the task scope, computed at activation time.
      
-
      Readonly worker
      worker: string
      The name of the worker that activated this job
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Readonly variables
      variables: Readonly<WorkerInputVariables>
      All visible variables in the task scope, computed at activation time.
      
+
      Readonly worker
      worker: string
      The name of the worker that activated this job
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types._internal_.CreateProcessInstanceWithResultResponseBase.html b/interfaces/zeebe_types._internal_.CreateProcessInstanceWithResultResponseBase.html
index dd1eebbd..b5b2296b 100644
--- a/interfaces/zeebe_types._internal_.CreateProcessInstanceWithResultResponseBase.html
+++ b/interfaces/zeebe_types._internal_.CreateProcessInstanceWithResultResponseBase.html
@@ -1,13 +1,13 @@
-CreateProcessInstanceWithResultResponseBase | @camunda8/sdk
      Interface CreateProcessInstanceWithResultResponseBase
      interface CreateProcessInstanceWithResultResponseBase { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          tenantId: string; 
          version: number; 
      }
      Hierarchy (view full)
      Properties
      bpmnProcessId
+CreateProcessInstanceWithResultResponseBase | @camunda8/sdk
      Interface CreateProcessInstanceWithResultResponseBase
      interface CreateProcessInstanceWithResultResponseBase { 
          bpmnProcessId: string; 
          processDefinitionKey: string; 
          processInstanceKey: string; 
          tenantId: string; 
          version: number; 
      }
      Hierarchy (view full)
      Properties
      bpmnProcessId
 processDefinitionKey
 processInstanceKey
 tenantId
 version
 
      Properties
      Readonly bpmnProcessId
      bpmnProcessId: string
      the BPMN process ID of the process definition which was used to create the process
 instance
      
-
      Readonly processDefinitionKey
      processDefinitionKey: string
      the key of the process definition which was used to create the process instance
      
-
      Readonly processInstanceKey
      processInstanceKey: string
      the unique identifier of the created process instance; to be used wherever a request
+
      Readonly processDefinitionKey
      processDefinitionKey: string
      the key of the process definition which was used to create the process instance
      
+
      Readonly processInstanceKey
      processInstanceKey: string
      the unique identifier of the created process instance; to be used wherever a request
 needs a process instance key (e.g. CancelProcessInstanceRequest)
      
-
      Readonly tenantId
      tenantId: string
      the tenant identifier of the process definition
      
-
      Readonly version
      version: number
      the version of the process definition which was used to create the process instance
      
-
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Readonly tenantId
      tenantId: string
      the tenant identifier of the process definition
      
+
      Readonly version
      version: number
      the version of the process definition which was used to create the process instance
      
+
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types._internal_.CustomSSL.html b/interfaces/zeebe_types._internal_.CustomSSL.html
index f711daea..410788d3 100644
--- a/interfaces/zeebe_types._internal_.CustomSSL.html
+++ b/interfaces/zeebe_types._internal_.CustomSSL.html
@@ -1,5 +1,5 @@
-CustomSSL | @camunda8/sdk
      Interface CustomSSL
      interface CustomSSL { 
          certChain?: Buffer; 
          privateKey?: Buffer; 
          rootCerts?: Buffer; 
          verifyOptions?: VerifyOptions; 
      }
      Properties
      certChain?
+CustomSSL | @camunda8/sdk
      Interface CustomSSL
      interface CustomSSL { 
          certChain?: Buffer; 
          privateKey?: Buffer; 
          rootCerts?: Buffer; 
          verifyOptions?: VerifyOptions; 
      }
      Properties
      certChain?
 privateKey?
 rootCerts?
 verifyOptions?
-
      Properties
      Optional certChain
      certChain?: Buffer
      Optional privateKey
      privateKey?: Buffer
      Optional rootCerts
      rootCerts?: Buffer
      Optional verifyOptions
      verifyOptions?: VerifyOptions
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
+
      Properties
      Optional certChain
      certChain?: Buffer
      Optional privateKey
      privateKey?: Buffer
      Optional rootCerts
      rootCerts?: Buffer
      Optional verifyOptions
      verifyOptions?: VerifyOptions
      Settings
      Member Visibility
      Theme
      On This Page
      Generated using TypeDoc
      
\ No newline at end of file
diff --git a/interfaces/zeebe_types._internal_.GrpcClientCtor.html b/interfaces/zeebe_types._internal_.GrpcClientCtor.html
index c4825050..72672957 100644
--- a/interfaces/zeebe_types._internal_.GrpcClientCtor.html
+++ b/interfaces/zeebe_types._internal_.GrpcClientCtor.html
@@ -1,4 +1,4 @@
-GrpcClientCtor | @camunda8/sdk
      Interface GrpcClientCtor
      interface GrpcClientCtor { 
          config: { 
              CAMUNDA_CONSOLE_BASE_URL: undefined | string; 
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string; 
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string; 
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string; 
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string; 
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string; 
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string; 
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string; 
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string; 
              CAMUNDA_MODELER_BASE_URL: string; 
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string; 
              CAMUNDA_OAUTH_DISABLED: boolean; 
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number; 
              CAMUNDA_OAUTH_URL: undefined | string; 
              CAMUNDA_OPERATE_BASE_URL: undefined | string; 
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string; 
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string; 
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string; 
              CAMUNDA_SECURE_CONNECTION: boolean; 
              CAMUNDA_TASKLIST_BASE_URL: undefined | string; 
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string; 
              CAMUNDA_TENANT_ID: undefined | string; 
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string; 
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean; 
              CAMUNDA_TOKEN_SCOPE: undefined | string; 
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string; 
              ZEEBE_ADDRESS: string; 
              ZEEBE_CLIENT_ID: undefined | string; 
              ZEEBE_CLIENT_SECRET: undefined | string; 
              zeebeGrpcSettings: { 
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number; 
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number; 
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number; 
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number; 
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number; 
                  GRPC_KEEPALIVE_TIMEOUT_MS: number; 
                  GRPC_KEEPALIVE_TIME_MS: number; 
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number; 
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number; 
                  ZEEBE_CLIENT_LOG_LEVEL: string; 
                  ZEEBE_CLIENT_LOG_TYPE: string; 
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number; 
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean; 
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number; 
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number; 
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number; 
                  ZEEBE_GRPC_CLIENT_RETRY: boolean; 
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number; 
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number; 
              }; 
          }; 
          connectionTolerance: MaybeTimeDuration; 
          customSSL?: CustomSSL; 
          host: string; 
          loglevel: Loglevel; 
          namespace: string; 
          oAuth?: IOAuthProvider; 
          options: IParseOptions & IConversionOptions & {} & GrpcClientExtendedOptions; 
          packageName: string; 
          protoPath: string; 
          service: string; 
          stdout: ZBCustomLogger; 
          tasktype?: string; 
          useTLS: boolean; 
      }
      Properties
      config
+GrpcClientCtor | @camunda8/sdk
      Interface GrpcClientCtor
      interface GrpcClientCtor { 
          config: { 
              CAMUNDA_CONSOLE_BASE_URL: undefined | string; 
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string; 
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string; 
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string; 
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string; 
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string; 
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string; 
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string; 
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string; 
              CAMUNDA_MODELER_BASE_URL: string; 
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined | string; 
              CAMUNDA_OAUTH_DISABLED: boolean; 
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number; 
              CAMUNDA_OAUTH_URL: undefined | string; 
              CAMUNDA_OPERATE_BASE_URL: undefined | string; 
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string; 
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string; 
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string; 
              CAMUNDA_SECURE_CONNECTION: boolean; 
              CAMUNDA_TASKLIST_BASE_URL: undefined | string; 
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string; 
              CAMUNDA_TENANT_ID: undefined | string; 
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string; 
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean; 
              CAMUNDA_TOKEN_SCOPE: undefined | string; 
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: string; 
              ZEEBE_ADDRESS: string; 
              ZEEBE_CLIENT_ID: undefined | string; 
              ZEEBE_CLIENT_SECRET: undefined | string; 
              zeebeGrpcSettings: { 
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number; 
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number; 
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number; 
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | number; 
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number; 
                  GRPC_KEEPALIVE_TIMEOUT_MS: number; 
                  GRPC_KEEPALIVE_TIME_MS: number; 
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | number; 
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | number; 
                  ZEEBE_CLIENT_LOG_LEVEL: string; 
                  ZEEBE_CLIENT_LOG_TYPE: string; 
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number; 
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean; 
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number; 
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number; 
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number; 
                  ZEEBE_GRPC_CLIENT_RETRY: boolean; 
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number; 
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number; 
              }; 
          }; 
          connectionTolerance: MaybeTimeDuration; 
          customSSL?: CustomSSL; 
          host: string; 
          loglevel: Loglevel; 
          namespace: string; 
          oAuth?: IOAuthProvider; 
          options: IParseOptions & IConversionOptions & {} & GrpcClientExtendedOptions; 
          packageName: string; 
          protoPath: string; 
          service: string; 
          stdout: ZBCustomLogger; 
          tasktype?: string; 
          useTLS: boolean; 
      }
      Properties
      config
 connectionTolerance
 customSSL?
 host
@@ -79,4 +79,4 @@
 
    • ZEEBE_GRPC_CLIENT_RETRY: boolean
      Automate retrying operations that fail due to network conditions or broker backpressure. Defaults to true
      
 
    • ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number
      How long in seconds the long poll Job Activation request is held open by a worker. Defaults to 60
      
 
    • ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number
      After a long poll Job Activation request, this is the cool-off period in milliseconds before the worker requests more work. Defaults to 300
      
-
      • connectionTolerance
      connectionTolerance: MaybeTimeDuration
      Optional customSSL
      customSSL?: CustomSSL
      host
      host: string
      loglevel
      loglevel: Loglevel
      namespace
      namespace: string
      Optional oAuth
      oAuth?: IOAuthProvider
      options
      options: IParseOptions & IConversionOptions & {} & GrpcClientExtendedOptions
      Type declaration
        packageName
        packageName: string
        protoPath
        protoPath: string
        service
        service: string
        stdout
        stdout: ZBCustomLogger
        Optional tasktype
        tasktype?: string
        useTLS
        useTLS: boolean
        Settings
        Member Visibility
        Theme
        On This Page
        Generated using TypeDoc
        
\ No newline at end of file
+
        connectionTolerance
        connectionTolerance: MaybeTimeDuration
        Optional customSSL
        customSSL?: CustomSSL
        host
        host: string
        loglevel
        loglevel: Loglevel
        namespace
        namespace: string
        Optional oAuth
        oAuth?: IOAuthProvider
        options
        options: IParseOptions & IConversionOptions & {} & GrpcClientExtendedOptions
        Type declaration
          packageName
          packageName: string
          protoPath
          protoPath: string
          service
          service: string
          stdout
          stdout: ZBCustomLogger
          Optional tasktype
          tasktype?: string
          useTLS
          useTLS: boolean
          Settings
          Member Visibility
          Theme
          On This Page
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/interfaces/zeebe_types._internal_.GrpcClientExtendedOptions.html b/interfaces/zeebe_types._internal_.GrpcClientExtendedOptions.html
index 49388e73..79246a52 100644
--- a/interfaces/zeebe_types._internal_.GrpcClientExtendedOptions.html
+++ b/interfaces/zeebe_types._internal_.GrpcClientExtendedOptions.html
@@ -1,3 +1,3 @@
-GrpcClientExtendedOptions | @camunda8/sdk
          Interface GrpcClientExtendedOptions
          interface GrpcClientExtendedOptions { 
              longPoll?: MaybeTimeDuration; 
              pollInterval?: MaybeTimeDuration; 
          }
          Properties
          longPoll?
+GrpcClientExtendedOptions | @camunda8/sdk
          Interface GrpcClientExtendedOptions
          interface GrpcClientExtendedOptions { 
              longPoll?: MaybeTimeDuration; 
              pollInterval?: MaybeTimeDuration; 
          }
          Properties
          longPoll?
 pollInterval?
-
          Properties
          Optional longPoll
          longPoll?: MaybeTimeDuration
          Optional pollInterval
          pollInterval?: MaybeTimeDuration
          Settings
          Member Visibility
          Theme
          On This Page
          Generated using TypeDoc
          
\ No newline at end of file
+
          Properties
          Optional longPoll
          longPoll?: MaybeTimeDuration
          Optional pollInterval
          pollInterval?: MaybeTimeDuration
          Settings
          Member Visibility
          Theme
          On This Page
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/interfaces/zeebe_types._internal_.MappingInstruction.html b/interfaces/zeebe_types._internal_.MappingInstruction.html
index fe84b41b..0382f6ca 100644
--- a/interfaces/zeebe_types._internal_.MappingInstruction.html
+++ b/interfaces/zeebe_types._internal_.MappingInstruction.html
@@ -1,3 +1,3 @@
-MappingInstruction | @camunda8/sdk
          Interface MappingInstruction
          interface MappingInstruction { 
              sourceElementId: string; 
              targetElementId: string; 
          }
          Properties
          sourceElementId
+MappingInstruction | @camunda8/sdk
          Interface MappingInstruction
          interface MappingInstruction { 
              sourceElementId: string; 
              targetElementId: string; 
          }
          Properties
          sourceElementId
 targetElementId
-
          Properties
          sourceElementId
          sourceElementId: string
          targetElementId
          targetElementId: string
          Settings
          Member Visibility
          Theme
          On This Page
          Generated using TypeDoc
          
\ No newline at end of file
+
          Properties
          sourceElementId
          sourceElementId: string
          targetElementId
          targetElementId: string
          Settings
          Member Visibility
          Theme
          On This Page
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/interfaces/zeebe_types._internal_.MigrationPlan.html b/interfaces/zeebe_types._internal_.MigrationPlan.html
index 4f9fae70..a48b8d02 100644
--- a/interfaces/zeebe_types._internal_.MigrationPlan.html
+++ b/interfaces/zeebe_types._internal_.MigrationPlan.html
@@ -1,3 +1,3 @@
-MigrationPlan | @camunda8/sdk
          Interface MigrationPlan
          interface MigrationPlan { 
              mappingInstructions: MappingInstruction[]; 
              targetProcessDefinitionKey: string; 
          }
          Properties
          mappingInstructions
+MigrationPlan | @camunda8/sdk
          Interface MigrationPlan
          interface MigrationPlan { 
              mappingInstructions: MappingInstruction[]; 
              targetProcessDefinitionKey: string; 
          }
          Properties
          mappingInstructions
 targetProcessDefinitionKey
-
          Properties
          mappingInstructions
          mappingInstructions: MappingInstruction[]
          targetProcessDefinitionKey
          targetProcessDefinitionKey: string
          Settings
          Member Visibility
          Theme
          On This Page
          Generated using TypeDoc
          
\ No newline at end of file
+
          Properties
          mappingInstructions
          mappingInstructions: MappingInstruction[]
          targetProcessDefinitionKey
          targetProcessDefinitionKey: string
          Settings
          Member Visibility
          Theme
          On This Page
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/interfaces/zeebe_types._internal_.SetVariablesRequestBase.html b/interfaces/zeebe_types._internal_.SetVariablesRequestBase.html
index 3e19abed..3735ba27 100644
--- a/interfaces/zeebe_types._internal_.SetVariablesRequestBase.html
+++ b/interfaces/zeebe_types._internal_.SetVariablesRequestBase.html
@@ -1,10 +1,10 @@
-SetVariablesRequestBase | @camunda8/sdk
          Interface SetVariablesRequestBase
          interface SetVariablesRequestBase { 
              elementInstanceKey: string; 
              local: boolean; 
          }
          Hierarchy (view full)
          Properties
          elementInstanceKey
+SetVariablesRequestBase | @camunda8/sdk
          Interface SetVariablesRequestBase
          interface SetVariablesRequestBase { 
              elementInstanceKey: string; 
              local: boolean; 
          }
          Hierarchy (view full)
          Properties
          elementInstanceKey
 local
-
          Properties
          Readonly elementInstanceKey
          elementInstanceKey: string
          local
          local: boolean
          if true, the variables will be merged strictly into the local scope (as indicated by
+
          Properties
          Readonly elementInstanceKey
          elementInstanceKey: string
          local
          local: boolean
          if true, the variables will be merged strictly into the local scope (as indicated by
  elementInstanceKey); this means the variables is not propagated to upper scopes.
  for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
 1 => { "foo" : 2 }, and 2 => { "bar" : 1 }. if we send an update request with
 elementInstanceKey = 2, variables { "foo" : 5 }, and local is true, then scope 1 will
 be unchanged, and scope 2 will now be { "bar" : 1, "foo" 5 }. if local was false, however,
 then scope 1 would be { "foo": 5 }, and scope 2 would be { "bar" : 1 }.
          
-
          Settings
          Member Visibility
          Theme
          On This Page
          Generated using TypeDoc
          
\ No newline at end of file
+
          Settings
          Member Visibility
          Theme
          On This Page
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/modules/index.Admin.AdminDto.html b/modules/index.Admin.AdminDto.html
index 6b52d077..bc513545 100644
--- a/modules/index.Admin.AdminDto.html
+++ b/modules/index.Admin.AdminDto.html
@@ -1,4 +1,4 @@
-AdminDto | @camunda8/sdk
          Namespace AdminDto
          Index
          Interfaces
          Cluster
+AdminDto | @camunda8/sdk
          Namespace AdminDto
          Index
          Interfaces
          Cluster
 ClusterClient
 ClusterClientConnectionDetails
 CreateClusterBody
diff --git a/modules/index.Admin.html b/modules/index.Admin.html
index 2ad49c9a..20e10be5 100644
--- a/modules/index.Admin.html
+++ b/modules/index.Admin.html
@@ -1,3 +1,3 @@
-Admin | @camunda8/sdk
          Namespace Admin
          Index
          Namespaces
          AdminDto
+Admin | @camunda8/sdk
          Namespace Admin
          Index
          Namespaces
          AdminDto
 
          Classes
          AdminApiClient
 
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/modules/index.Auth.html b/modules/index.Auth.html
index af9ab558..752fa4d9 100644
--- a/modules/index.Auth.html
+++ b/modules/index.Auth.html
@@ -1,4 +1,4 @@
-Auth | @camunda8/sdk
          Namespace Auth
          Index
          Classes
          NullAuthProvider
+Auth | @camunda8/sdk
          Namespace Auth
          Index
          Classes
          NullAuthProvider
 OAuthProvider
 
          Interfaces
          IOAuthProvider
 Token
diff --git a/modules/index.Modeler.ModelerDto.html b/modules/index.Modeler.ModelerDto.html
index e1520a78..9d37c7c7 100644
--- a/modules/index.Modeler.ModelerDto.html
+++ b/modules/index.Modeler.ModelerDto.html
@@ -1,4 +1,4 @@
-ModelerDto | @camunda8/sdk
          Namespace ModelerDto
          Index
          Interfaces
          CreateCollaboratorDto
+ModelerDto | @camunda8/sdk
          Namespace ModelerDto
          Index
          Interfaces
          CreateCollaboratorDto
 CreateFileDto
 CreateFolderDto
 CreateMilestoneDto
diff --git a/modules/index.Modeler.html b/modules/index.Modeler.html
index 434d8982..11c3a04f 100644
--- a/modules/index.Modeler.html
+++ b/modules/index.Modeler.html
@@ -1,3 +1,3 @@
-Modeler | @camunda8/sdk
          Namespace Modeler
          Index
          Namespaces
          ModelerDto
+Modeler | @camunda8/sdk
          Namespace Modeler
          Index
          Namespaces
          ModelerDto
 
          Classes
          ModelerApiClient
 
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/modules/index.Operate.OperateDto.html b/modules/index.Operate.OperateDto.html
index 464c2506..897c8165 100644
--- a/modules/index.Operate.OperateDto.html
+++ b/modules/index.Operate.OperateDto.html
@@ -1,4 +1,4 @@
-OperateDto | @camunda8/sdk
          Namespace OperateDto
          Index
          Classes
          ChangeStatus
+OperateDto | @camunda8/sdk
          Namespace OperateDto
          Index
          Classes
          ChangeStatus
 DecisionDefinition
 DecisionInstance
 DecisionInstanceInput
diff --git a/modules/index.Operate.html b/modules/index.Operate.html
index e5d01d7f..8e1c1bc0 100644
--- a/modules/index.Operate.html
+++ b/modules/index.Operate.html
@@ -1,3 +1,3 @@
-Operate | @camunda8/sdk
          Namespace Operate
          Index
          Namespaces
          OperateDto
+Operate | @camunda8/sdk
          Namespace Operate
          Index
          Namespaces
          OperateDto
 
          Classes
          OperateApiClient
 
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/modules/index.Optimize.OptimizeDto.html b/modules/index.Optimize.OptimizeDto.html
index 016ae0bb..d4316c59 100644
--- a/modules/index.Optimize.OptimizeDto.html
+++ b/modules/index.Optimize.OptimizeDto.html
@@ -1,4 +1,4 @@
-OptimizeDto | @camunda8/sdk
          Namespace OptimizeDto
          Index
          Interfaces
          CloudEventV1
+OptimizeDto | @camunda8/sdk
          Namespace OptimizeDto
          Index
          Interfaces
          CloudEventV1
 CloudEventV1Attributes
 CloudEventV1OptionalAttributes
 DashboardDefinition
diff --git a/modules/index.Optimize.html b/modules/index.Optimize.html
index a09cd031..bf6457e0 100644
--- a/modules/index.Optimize.html
+++ b/modules/index.Optimize.html
@@ -1,3 +1,3 @@
-Optimize | @camunda8/sdk
          Namespace Optimize
          Index
          Namespaces
          OptimizeDto
+Optimize | @camunda8/sdk
          Namespace Optimize
          Index
          Namespaces
          OptimizeDto
 
          Classes
          OptimizeApiClient
 
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/modules/index.Tasklist.TasklistDto.html b/modules/index.Tasklist.TasklistDto.html
index bdddab7b..0a755697 100644
--- a/modules/index.Tasklist.TasklistDto.html
+++ b/modules/index.Tasklist.TasklistDto.html
@@ -1,4 +1,4 @@
-TasklistDto | @camunda8/sdk
          Namespace TasklistDto
          Index
          Classes
          Form
+TasklistDto | @camunda8/sdk
          Namespace TasklistDto
          Index
          Classes
          Form
 TaskResponse
 TaskSearchResponse
 
          Interfaces
          DateFilter
diff --git a/modules/index.Tasklist.html b/modules/index.Tasklist.html
index a7cc9de8..6276b0db 100644
--- a/modules/index.Tasklist.html
+++ b/modules/index.Tasklist.html
@@ -1,3 +1,3 @@
-Tasklist | @camunda8/sdk
          Namespace Tasklist
          Index
          Namespaces
          TasklistDto
+Tasklist | @camunda8/sdk
          Namespace Tasklist
          Index
          Namespaces
          TasklistDto
 
          Classes
          TasklistApiClient
 
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/modules/index.Zeebe.Types.html b/modules/index.Zeebe.Types.html
index ad891a85..e95fdebb 100644
--- a/modules/index.Zeebe.Types.html
+++ b/modules/index.Zeebe.Types.html
@@ -1,4 +1,4 @@
-Types | @camunda8/sdk
          Namespace Types
          Index
          Enumerations
          PartitionBrokerHealth
+Types | @camunda8/sdk
          Namespace Types
          Index
          Enumerations
          PartitionBrokerHealth
 PartitionBrokerRole
 
          Variables
          JOB_ACTION_ACKNOWLEDGEMENT
 
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/modules/index.Zeebe.html b/modules/index.Zeebe.html
index 5b73c6a3..882b4112 100644
--- a/modules/index.Zeebe.html
+++ b/modules/index.Zeebe.html
@@ -1,4 +1,4 @@
-Zeebe | @camunda8/sdk
          Namespace Zeebe
          Index
          Namespaces
          Types
+Zeebe | @camunda8/sdk
          Namespace Zeebe
          Index
          Namespaces
          Types
 
          Classes
          BpmnParser
 ZBWorker
 ZeebeGrpcClient
diff --git a/modules/index.html b/modules/index.html
index d278fae7..2c5d9784 100644
--- a/modules/index.html
+++ b/modules/index.html
@@ -1,4 +1,4 @@
-index | @camunda8/sdk
          Module index
          Index
          Modules
          <internal>
+index | @camunda8/sdk
          Module index
          Index
          Modules
          <internal>
 
          Namespaces
          Admin
 Auth
 Modeler
diff --git a/modules/zeebe_types.html b/modules/zeebe_types.html
index 74de807c..2f2e064c 100644
--- a/modules/zeebe_types.html
+++ b/modules/zeebe_types.html
@@ -1,4 +1,4 @@
-zeebe/types | @camunda8/sdk
          Module zeebe/types
          References
          PartitionBrokerHealth
+zeebe/types | @camunda8/sdk
          Module zeebe/types
          References
          PartitionBrokerHealth
 PartitionBrokerRole
 
          Modules
          <internal>
 
          Interfaces
          ActivateInstruction
diff --git a/types/index.Admin.AdminDto.ClusterStatusstring.html b/types/index.Admin.AdminDto.ClusterStatusstring.html
index 881e2a8e..e4350187 100644
--- a/types/index.Admin.AdminDto.ClusterStatusstring.html
+++ b/types/index.Admin.AdminDto.ClusterStatusstring.html
@@ -1 +1 @@
-ClusterStatusstring | @camunda8/sdk
          Type alias ClusterStatusstring
          ClusterStatusstring: "Healthy" | "Unhealthy" | "Creating" | "Updating"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+ClusterStatusstring | @camunda8/sdk
          Type alias ClusterStatusstring
          ClusterStatusstring: "Healthy" | "Unhealthy" | "Creating" | "Updating"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index.Admin.AdminDto.OrganizationRole.html b/types/index.Admin.AdminDto.OrganizationRole.html
index 8d334b87..0fdbd5c6 100644
--- a/types/index.Admin.AdminDto.OrganizationRole.html
+++ b/types/index.Admin.AdminDto.OrganizationRole.html
@@ -1 +1 @@
-OrganizationRole | @camunda8/sdk
          Type alias OrganizationRole
          OrganizationRole: "member" | "admin" | "owner" | "supportagent" | "operationsengineer" | "taskuser" | "analyst" | "developer" | "visitor"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+OrganizationRole | @camunda8/sdk
          Type alias OrganizationRole
          OrganizationRole: "member" | "admin" | "owner" | "supportagent" | "operationsengineer" | "taskuser" | "analyst" | "developer" | "visitor"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index.Optimize.OptimizeDto.DashboardCollection.html b/types/index.Optimize.OptimizeDto.DashboardCollection.html
index dd25e0bd..549458f7 100644
--- a/types/index.Optimize.OptimizeDto.DashboardCollection.html
+++ b/types/index.Optimize.OptimizeDto.DashboardCollection.html
@@ -1 +1 @@
-DashboardCollection | @camunda8/sdk
          Type alias DashboardCollection
          DashboardCollection: { 
              id: string; 
          }[]
          Type declaration
          • id: string
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+DashboardCollection | @camunda8/sdk
          Type alias DashboardCollection
          DashboardCollection: { 
              id: string; 
          }[]
          Type declaration
          • id: string
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index.Optimize.OptimizeDto.EntityImportResponse.html b/types/index.Optimize.OptimizeDto.EntityImportResponse.html
index 9cc3c9cf..b26a8f86 100644
--- a/types/index.Optimize.OptimizeDto.EntityImportResponse.html
+++ b/types/index.Optimize.OptimizeDto.EntityImportResponse.html
@@ -1 +1 @@
-EntityImportResponse | @camunda8/sdk
          Type alias EntityImportResponse
          EntityImportResponse: { 
              entityType: "dashboard" | "report"; 
              id: string; 
          }[]
          Type declaration
          • entityType: "dashboard" | "report"
          • id: string
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+EntityImportResponse | @camunda8/sdk
          Type alias EntityImportResponse
          EntityImportResponse: { 
              entityType: "dashboard" | "report"; 
              id: string; 
          }[]
          Type declaration
          • entityType: "dashboard" | "report"
          • id: string
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index.Optimize.OptimizeDto.ReportCollection.html b/types/index.Optimize.OptimizeDto.ReportCollection.html
index 05db9232..af42c4a7 100644
--- a/types/index.Optimize.OptimizeDto.ReportCollection.html
+++ b/types/index.Optimize.OptimizeDto.ReportCollection.html
@@ -1 +1 @@
-ReportCollection | @camunda8/sdk
          Type alias ReportCollection
          ReportCollection: { 
              id: string; 
          }[]
          Type declaration
          • id: string
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+ReportCollection | @camunda8/sdk
          Type alias ReportCollection
          ReportCollection: { 
              id: string; 
          }[]
          Type declaration
          • id: string
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index.Optimize.OptimizeDto.SingleProcessReport.html b/types/index.Optimize.OptimizeDto.SingleProcessReport.html
index bfa2dc68..df468bb2 100644
--- a/types/index.Optimize.OptimizeDto.SingleProcessReport.html
+++ b/types/index.Optimize.OptimizeDto.SingleProcessReport.html
@@ -1 +1 @@
-SingleProcessReport | @camunda8/sdk
          Type alias SingleProcessReport
          SingleProcessReport: unknown
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+SingleProcessReport | @camunda8/sdk
          Type alias SingleProcessReport
          SingleProcessReport: unknown
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index.Optimize.OptimizeDto.VariableType.html b/types/index.Optimize.OptimizeDto.VariableType.html
index b128be33..3146265f 100644
--- a/types/index.Optimize.OptimizeDto.VariableType.html
+++ b/types/index.Optimize.OptimizeDto.VariableType.html
@@ -1 +1 @@
-VariableType | @camunda8/sdk
          Type alias VariableType
          VariableType: "string" | "short" | "long" | "double" | "integer" | "boolean" | "date"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+VariableType | @camunda8/sdk
          Type alias VariableType
          VariableType: "string" | "short" | "long" | "double" | "integer" | "boolean" | "date"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index.RESTError.html b/types/index.RESTError.html
index 64fb21f4..7719ba82 100644
--- a/types/index.RESTError.html
+++ b/types/index.RESTError.html
@@ -1 +1 @@
-RESTError | @camunda8/sdk
          Type alias RESTError
          RESTError: HTTPError | Got.RequestError | Got.ReadError | Got.ParseError | Got.TimeoutError | Got.CancelError | Got.CacheError | Got.MaxRedirectsError | Got.UnsupportedProtocolError
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+RESTError | @camunda8/sdk
          Type alias RESTError
          RESTError: HTTPError | Got.RequestError | Got.ReadError | Got.ParseError | Got.TimeoutError | Got.CancelError | Got.CacheError | Got.MaxRedirectsError | Got.UnsupportedProtocolError
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index.Tasklist.TasklistDto.TaskState.html b/types/index.Tasklist.TasklistDto.TaskState.html
index 698ceb69..53d923a7 100644
--- a/types/index.Tasklist.TasklistDto.TaskState.html
+++ b/types/index.Tasklist.TasklistDto.TaskState.html
@@ -1 +1 @@
-TaskState | @camunda8/sdk
          Type alias TaskState
          TaskState: "COMPLETED" | "CREATED" | "CANCELED" | "FAILED"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+TaskState | @camunda8/sdk
          Type alias TaskState
          TaskState: "COMPLETED" | "CREATED" | "CANCELED" | "FAILED"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.DeepPartial.html b/types/index._internal_.DeepPartial.html
index b427936f..5a30188d 100644
--- a/types/index._internal_.DeepPartial.html
+++ b/types/index._internal_.DeepPartial.html
@@ -1 +1 @@
-DeepPartial | @camunda8/sdk
          Type alias DeepPartial<T>
          DeepPartial<T>: {
              [K in keyof T]?: T[K] extends object
                  ? DeepPartial<T[K]>
                  : T[K]
          }
          Type Parameters
          • T
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+DeepPartial | @camunda8/sdk
          Type alias DeepPartial<T>
          DeepPartial<T>: {
              [K in keyof T]?: T[K] extends object
                  ? DeepPartial<T[K]>
                  : T[K]
          }
          Type Parameters
          • T
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.EnhanceWithTenantIdIfMissing.html b/types/index._internal_.EnhanceWithTenantIdIfMissing.html
index 61e61a5d..810686ea 100644
--- a/types/index._internal_.EnhanceWithTenantIdIfMissing.html
+++ b/types/index._internal_.EnhanceWithTenantIdIfMissing.html
@@ -1 +1 @@
-EnhanceWithTenantIdIfMissing | @camunda8/sdk
          Type alias EnhanceWithTenantIdIfMissing<T>
          EnhanceWithTenantIdIfMissing<T>: T extends { 
                  filter: { 
                      tenantId: string | undefined; 
                  }; 
              }
              ? T
              : T extends { 
                      filter: infer  F; 
                  }
                  ? { 
                      filter: F & { 
                          tenantId: string | undefined; 
                      }; 
                  } & Omit<T, "filter">
                  : { 
                      filter: { 
                          tenantId: string | undefined; 
                      }; 
                  } & T
          Type Parameters
          • T
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+EnhanceWithTenantIdIfMissing | @camunda8/sdk
          Type alias EnhanceWithTenantIdIfMissing<T>
          EnhanceWithTenantIdIfMissing<T>: T extends { 
                  filter: { 
                      tenantId: string | undefined; 
                  }; 
              }
              ? T
              : T extends { 
                      filter: infer  F; 
                  }
                  ? { 
                      filter: F & { 
                          tenantId: string | undefined; 
                      }; 
                  } & Omit<T, "filter">
                  : { 
                      filter: { 
                          tenantId: string | undefined; 
                      }; 
                  } & T
          Type Parameters
          • T
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.EventKey.html b/types/index._internal_.EventKey.html
index 2d35a3fe..95b00273 100644
--- a/types/index._internal_.EventKey.html
+++ b/types/index._internal_.EventKey.html
@@ -1 +1 @@
-EventKey | @camunda8/sdk
          Type alias EventKey<T>
          EventKey<T>: string & keyof T
          Type Parameters
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+EventKey | @camunda8/sdk
          Type alias EventKey<T>
          EventKey<T>: string & keyof T
          Type Parameters
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.EventMap.html b/types/index._internal_.EventMap.html
index f165d80a..fa3c8685 100644
--- a/types/index._internal_.EventMap.html
+++ b/types/index._internal_.EventMap.html
@@ -1 +1 @@
-EventMap | @camunda8/sdk
          Type alias EventMap
          EventMap: Record<string, unknown>
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+EventMap | @camunda8/sdk
          Type alias EventMap
          EventMap: Record<string, unknown>
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.EventReceiver.html b/types/index._internal_.EventReceiver.html
index bec542e3..089af507 100644
--- a/types/index._internal_.EventReceiver.html
+++ b/types/index._internal_.EventReceiver.html
@@ -1 +1 @@
-EventReceiver | @camunda8/sdk
          Type alias EventReceiver
          EventReceiver: (() => void)
          Type declaration
            • (): void
            • Returns void
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+EventReceiver | @camunda8/sdk
          Type alias EventReceiver
          EventReceiver: (() => void)
          Type declaration
            • (): void
            • Returns void
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.GrpcConnectionProfile.html b/types/index._internal_.GrpcConnectionProfile.html
index 1ebec4ee..43d7e59d 100644
--- a/types/index._internal_.GrpcConnectionProfile.html
+++ b/types/index._internal_.GrpcConnectionProfile.html
@@ -1 +1 @@
-GrpcConnectionProfile | @camunda8/sdk
          Type alias GrpcConnectionProfile
          GrpcConnectionProfile: "CAMUNDA_CLOUD" | "VANILLA"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+GrpcConnectionProfile | @camunda8/sdk
          Type alias GrpcConnectionProfile
          GrpcConnectionProfile: "CAMUNDA_CLOUD" | "VANILLA"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.JSON.html b/types/index._internal_.JSON.html
index 3a68edce..fc41228e 100644
--- a/types/index._internal_.JSON.html
+++ b/types/index._internal_.JSON.html
@@ -1 +1 @@
-JSON | @camunda8/sdk
          Type alias JSON
          JSON: string | number | boolean | JSON[] | JSONDoc[]
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+JSON | @camunda8/sdk
          Type alias JSON
          JSON: string | number | boolean | JSON[] | JSONDoc[]
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.JSONDoc-1.html b/types/index._internal_.JSONDoc-1.html
index 516a8df9..7505378b 100644
--- a/types/index._internal_.JSONDoc-1.html
+++ b/types/index._internal_.JSONDoc-1.html
@@ -1 +1 @@
-JSONDoc | @camunda8/sdk
          Type alias JSONDoc
          JSONDoc: { 
              [key: string]: string | boolean | number | JSONDoc; 
          }
          Type declaration
          • [key: string]: string | boolean | number | JSONDoc
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+JSONDoc | @camunda8/sdk
          Type alias JSONDoc
          JSONDoc: { 
              [key: string]: string | boolean | number | JSONDoc; 
          }
          Type declaration
          • [key: string]: string | boolean | number | JSONDoc
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.LogFn.html b/types/index._internal_.LogFn.html
index c4bfa72f..4b45b7e3 100644
--- a/types/index._internal_.LogFn.html
+++ b/types/index._internal_.LogFn.html
@@ -1 +1 @@
-LogFn | @camunda8/sdk
          Type alias LogFn
          LogFn: ((logMessage) => void)
          Type declaration
            • (logMessage): void
            • Parameters
              • logMessage: string
              Returns void
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+LogFn | @camunda8/sdk
          Type alias LogFn
          LogFn: ((logMessage) => void)
          Type declaration
            • (logMessage): void
            • Parameters
              • logMessage: string
              Returns void
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.State.html b/types/index._internal_.State.html
index 08d62cbe..1831d7d6 100644
--- a/types/index._internal_.State.html
+++ b/types/index._internal_.State.html
@@ -1 +1 @@
-State | @camunda8/sdk
          Type alias State
          State: "ERROR" | "CONNECTED" | "UNKNOWN"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+State | @camunda8/sdk
          Type alias State
          State: "ERROR" | "CONNECTED" | "UNKNOWN"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/index._internal_.TokenGrantAudienceType.html b/types/index._internal_.TokenGrantAudienceType.html
index 4bddce52..1caffe77 100644
--- a/types/index._internal_.TokenGrantAudienceType.html
+++ b/types/index._internal_.TokenGrantAudienceType.html
@@ -1 +1 @@
-TokenGrantAudienceType | @camunda8/sdk
          Type alias TokenGrantAudienceType
          TokenGrantAudienceType: "OPERATE" | "ZEEBE" | "OPTIMIZE" | "TASKLIST" | "CONSOLE" | "MODELER"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+TokenGrantAudienceType | @camunda8/sdk
          Type alias TokenGrantAudienceType
          TokenGrantAudienceType: "OPERATE" | "ZEEBE" | "OPTIMIZE" | "TASKLIST" | "CONSOLE" | "MODELER"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.ConnectionErrorHandler.html b/types/zeebe_types.ConnectionErrorHandler.html
index a4456b1b..c339a237 100644
--- a/types/zeebe_types.ConnectionErrorHandler.html
+++ b/types/zeebe_types.ConnectionErrorHandler.html
@@ -1 +1 @@
-ConnectionErrorHandler | @camunda8/sdk
          Type alias ConnectionErrorHandler
          ConnectionErrorHandler: ((error?) => void)
          Type declaration
            • (error?): void
            • Parameters
              • Optional error: unknown
              Returns void
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+ConnectionErrorHandler | @camunda8/sdk
          Type alias ConnectionErrorHandler
          ConnectionErrorHandler: ((error?) => void)
          Type declaration
            • (error?): void
            • Parameters
              • Optional error: unknown
              Returns void
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.Deployment.html b/types/zeebe_types.Deployment.html
index 27a1ddac..3cf8a970 100644
--- a/types/zeebe_types.Deployment.html
+++ b/types/zeebe_types.Deployment.html
@@ -1 +1 @@
-Deployment | @camunda8/sdk
          Type alias Deployment
          Deployment: ProcessDeployment | DecisionDeployment | DecisionRequirementsDeployment | FormDeployment
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+Deployment | @camunda8/sdk
          Type alias Deployment
          Deployment: ProcessDeployment | DecisionDeployment | DecisionRequirementsDeployment | FormDeployment
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.ErrorJobOutcome.html b/types/zeebe_types.ErrorJobOutcome.html
index 991e4b88..d89545aa 100644
--- a/types/zeebe_types.ErrorJobOutcome.html
+++ b/types/zeebe_types.ErrorJobOutcome.html
@@ -1 +1 @@
-ErrorJobOutcome | @camunda8/sdk
          Type alias ErrorJobOutcome
          ErrorJobOutcome: ((errorCode, errorMessage?) => Promise<JOB_ACTION_ACKNOWLEDGEMENT>)
          Type declaration
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+ErrorJobOutcome | @camunda8/sdk
          Type alias ErrorJobOutcome
          ErrorJobOutcome: ((errorCode, errorMessage?) => Promise<JOB_ACTION_ACKNOWLEDGEMENT>)
          Type declaration
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.EvaluateDecisionRequest.html b/types/zeebe_types.EvaluateDecisionRequest.html
index ffda4239..87d6f644 100644
--- a/types/zeebe_types.EvaluateDecisionRequest.html
+++ b/types/zeebe_types.EvaluateDecisionRequest.html
@@ -15,4 +15,4 @@
 named "a" and "b" respectively, with their associated values.
 [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the
 JSON document is an array and not an object.
          
-
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT.html b/types/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT.html
index 127e07a8..3c5b58c5 100644
--- a/types/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT.html
+++ b/types/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT.html
@@ -1 +1 @@
-JOB_ACTION_ACKNOWLEDGEMENT | @camunda8/sdk
          Type alias JOB_ACTION_ACKNOWLEDGEMENT
          JOB_ACTION_ACKNOWLEDGEMENT: typeof JOB_ACTION_ACKNOWLEDGEMENT
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+JOB_ACTION_ACKNOWLEDGEMENT | @camunda8/sdk
          Type alias JOB_ACTION_ACKNOWLEDGEMENT
          JOB_ACTION_ACKNOWLEDGEMENT: typeof JOB_ACTION_ACKNOWLEDGEMENT
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.JSON.html b/types/zeebe_types.JSON.html
index 5d28caf0..8ce47516 100644
--- a/types/zeebe_types.JSON.html
+++ b/types/zeebe_types.JSON.html
@@ -1 +1 @@
-JSON | @camunda8/sdk
          Type alias JSON
          JSON: string | number | boolean | JSON[] | JSONDoc[] | JSONDoc
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+JSON | @camunda8/sdk
          Type alias JSON
          JSON: string | number | boolean | JSON[] | JSONDoc[] | JSONDoc
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.Loglevel.html b/types/zeebe_types.Loglevel.html
index 7f73f3af..d79a9065 100644
--- a/types/zeebe_types.Loglevel.html
+++ b/types/zeebe_types.Loglevel.html
@@ -1 +1 @@
-Loglevel | @camunda8/sdk
          Type alias Loglevel
          Loglevel: "INFO" | "DEBUG" | "NONE" | "ERROR"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+Loglevel | @camunda8/sdk
          Type alias Loglevel
          Loglevel: "INFO" | "DEBUG" | "NONE" | "ERROR"
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.MigrateProcessInstanceResponse.html b/types/zeebe_types.MigrateProcessInstanceResponse.html
index c9052927..e2253391 100644
--- a/types/zeebe_types.MigrateProcessInstanceResponse.html
+++ b/types/zeebe_types.MigrateProcessInstanceResponse.html
@@ -1 +1 @@
-MigrateProcessInstanceResponse | @camunda8/sdk
          Type alias MigrateProcessInstanceResponse
          MigrateProcessInstanceResponse: Record<string, never>
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+MigrateProcessInstanceResponse | @camunda8/sdk
          Type alias MigrateProcessInstanceResponse
          MigrateProcessInstanceResponse: Record<string, never>
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.ModifyProcessInstanceResponse.html b/types/zeebe_types.ModifyProcessInstanceResponse.html
index 244fb3b4..40ddaee7 100644
--- a/types/zeebe_types.ModifyProcessInstanceResponse.html
+++ b/types/zeebe_types.ModifyProcessInstanceResponse.html
@@ -1 +1 @@
-ModifyProcessInstanceResponse | @camunda8/sdk
          Type alias ModifyProcessInstanceResponse
          ModifyProcessInstanceResponse: Record<string, never>
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+ModifyProcessInstanceResponse | @camunda8/sdk
          Type alias ModifyProcessInstanceResponse
          ModifyProcessInstanceResponse: Record<string, never>
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.MustReturnJobActionAcknowledgement.html b/types/zeebe_types.MustReturnJobActionAcknowledgement.html
index c6aad053..ca5b8b58 100644
--- a/types/zeebe_types.MustReturnJobActionAcknowledgement.html
+++ b/types/zeebe_types.MustReturnJobActionAcknowledgement.html
@@ -1 +1 @@
-MustReturnJobActionAcknowledgement | @camunda8/sdk
          Type alias MustReturnJobActionAcknowledgement
          MustReturnJobActionAcknowledgement: JOB_ACTION_ACKNOWLEDGEMENT | Promise<JOB_ACTION_ACKNOWLEDGEMENT>
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+MustReturnJobActionAcknowledgement | @camunda8/sdk
          Type alias MustReturnJobActionAcknowledgement
          MustReturnJobActionAcknowledgement: JOB_ACTION_ACKNOWLEDGEMENT | Promise<JOB_ACTION_ACKNOWLEDGEMENT>
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.OperationOptions.html b/types/zeebe_types.OperationOptions.html
index cc26238f..f2ad9f48 100644
--- a/types/zeebe_types.OperationOptions.html
+++ b/types/zeebe_types.OperationOptions.html
@@ -1 +1 @@
-OperationOptions | @camunda8/sdk
          Type alias OperationOptions
          OperationOptions: OperationOptionsWithRetry | OperationOptionsNoRetry
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+OperationOptions | @camunda8/sdk
          Type alias OperationOptions
          OperationOptions: OperationOptionsWithRetry | OperationOptionsNoRetry
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/types/zeebe_types.ZBWorkerTaskHandler.html b/types/zeebe_types.ZBWorkerTaskHandler.html
index fa5b929e..49de2d7b 100644
--- a/types/zeebe_types.ZBWorkerTaskHandler.html
+++ b/types/zeebe_types.ZBWorkerTaskHandler.html
@@ -1 +1 @@
-ZBWorkerTaskHandler | @camunda8/sdk
          Type alias ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
          ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>: ((job, worker) => MustReturnJobActionAcknowledgement)
          Type Parameters
          Type declaration
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+ZBWorkerTaskHandler | @camunda8/sdk
          Type alias ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>
          ZBWorkerTaskHandler<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>: ((job, worker) => MustReturnJobActionAcknowledgement)
          Type Parameters
          Type declaration
          Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/variables/index.Dto.html b/variables/index.Dto.html
index 89b00558..c75f5e10 100644
--- a/variables/index.Dto.html
+++ b/variables/index.Dto.html
@@ -7,4 +7,4 @@
 
        • Int64String: ((target, propertyKey) => void)
            • (target, propertyKey): void
            • Decorate Dto string fields as @Int64String to specify that the JSON number property should be parsed as a string.
              
 
              Parameters
              • target: any
              • propertyKey: string | symbol
              Returns void
              Example
              class MyDto extends LosslessDto {
                @Int64String
                int64NumberField!: string
                @BigIntValue
                bigintField!: bigint
                @ChildDto(MyChildDto)
                childDtoField!: MyChildDto
                normalField!: string
                normalNumberField!: number
                maybePresentField?: string
              }
 
              
-
        • LosslessDto: typeof LosslessDto
          • Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
+
        • LosslessDto: typeof LosslessDto
          • Settings
          Member Visibility
          Theme
          Generated using TypeDoc
          
\ No newline at end of file
diff --git a/variables/index.Zeebe.Logging.html b/variables/index.Zeebe.Logging.html
index b1739281..f647ff0e 100644
--- a/variables/index.Zeebe.Logging.html
+++ b/variables/index.Zeebe.Logging.html
@@ -20,4 +20,4 @@

          See util.format() for more information.

          Parameters

          • Optional message: any
          • Rest ...optionalParams: any[]

          Returns void

          Since

          v0.1.100

          -
        • ZBLogger: typeof ZBLogger
        • ZBSimpleLogger: Logger

          • Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file +
        • ZBLogger: typeof ZBLogger
        • ZBSimpleLogger: Logger

          • Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/variables/index.Zeebe.Types.JOB_ACTION_ACKNOWLEDGEMENT.html b/variables/index.Zeebe.Types.JOB_ACTION_ACKNOWLEDGEMENT.html index 7a0c5f43..ab9b7a44 100644 --- a/variables/index.Zeebe.Types.JOB_ACTION_ACKNOWLEDGEMENT.html +++ b/variables/index.Zeebe.Types.JOB_ACTION_ACKNOWLEDGEMENT.html @@ -1 +1 @@ -JOB_ACTION_ACKNOWLEDGEMENT | @camunda8/sdk

          Variable JOB_ACTION_ACKNOWLEDGEMENT

          JOB_ACTION_ACKNOWLEDGEMENT: "JOB_ACTION_ACKNOWLEDGEMENT" = ...

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file +JOB_ACTION_ACKNOWLEDGEMENT | @camunda8/sdk

          Variable JOB_ACTION_ACKNOWLEDGEMENT

          JOB_ACTION_ACKNOWLEDGEMENT: "JOB_ACTION_ACKNOWLEDGEMENT" = ...

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/variables/index._internal_.ConnectionStatusEvent.html b/variables/index._internal_.ConnectionStatusEvent.html index 8b18d52c..c262e2fd 100644 --- a/variables/index._internal_.ConnectionStatusEvent.html +++ b/variables/index._internal_.ConnectionStatusEvent.html @@ -1 +1 @@ -ConnectionStatusEvent | @camunda8/sdk

          Variable ConnectionStatusEventConst

          ConnectionStatusEvent: {
              close: "close";
              connectionError: "connectionError";
              ready: "ready";
              unknown: "unknown";
          } = ...

          Type declaration

          • close: "close"
          • connectionError: "connectionError"
          • ready: "ready"
          • unknown: "unknown"

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file +ConnectionStatusEvent | @camunda8/sdk

          Variable ConnectionStatusEventConst

          ConnectionStatusEvent: {
              close: "close";
              connectionError: "connectionError";
              ready: "ready";
              unknown: "unknown";
          } = ...

          Type declaration

          • close: "close"
          • connectionError: "connectionError"
          • ready: "ready"
          • unknown: "unknown"

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/variables/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT-1.html b/variables/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT-1.html index 1ab568d2..c20493db 100644 --- a/variables/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT-1.html +++ b/variables/zeebe_types.JOB_ACTION_ACKNOWLEDGEMENT-1.html @@ -1 +1 @@ -JOB_ACTION_ACKNOWLEDGEMENT | @camunda8/sdk

          Variable JOB_ACTION_ACKNOWLEDGEMENTConst

          JOB_ACTION_ACKNOWLEDGEMENT: "JOB_ACTION_ACKNOWLEDGEMENT" = ...

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file +JOB_ACTION_ACKNOWLEDGEMENT | @camunda8/sdk

          Variable JOB_ACTION_ACKNOWLEDGEMENTConst

          JOB_ACTION_ACKNOWLEDGEMENT: "JOB_ACTION_ACKNOWLEDGEMENT" = ...

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file