@epilot/sdk 2.20.25 → 2.20.26

package/dist/journey-ZN46FFPM.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/journey.json
+var journey_default = '# Journey API\n\n- **Base URL:** `https://journey-config.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/journey](https://docs.epilot.io/api/journey)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.journey.getJourneysByOrgId(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/journey\'\n\nconst journeyClient = getClient()\nauthorize(journeyClient, () => \'<token>\')\nconst { data } = await journeyClient.getJourneysByOrgId(...)\n```\n\n## Operations\n\n**Journeys**\n- [`getJourneysByOrgId`](#getjourneysbyorgid)\n- [`getJourney`](#getjourney)\n- [`removeJourney`](#removejourney)\n- [`createJourneyRevision`](#createjourneyrevision)\n- [`listJourneyRevisions`](#listjourneyrevisions)\n- [`getJourneyRevision`](#getjourneyrevision)\n- [`publishJourneyRevision`](#publishjourneyrevision)\n- [`getJourneyPublishState`](#getjourneypublishstate)\n- [`getJourneyEnvironment`](#getjourneyenvironment)\n- [`getJourneyEnvironmentVariables`](#getjourneyenvironmentvariables)\n- [`getJourneyProducts`](#getjourneyproducts)\n- [`createJourney`](#createjourney)\n- [`updateJourney`](#updatejourney)\n- [`patchUpdateJourney`](#patchupdatejourney)\n- [`searchJourneys`](#searchjourneys)\n- [`generateDocument`](#generatedocument)\n- [`getSettingsForJourney`](#getsettingsforjourney)\n- [`getButtonOptions`](#getbuttonoptions)\n\n**Journeys V2**\n- [`createJourneyV2`](#createjourneyv2)\n- [`updateJourneyV2`](#updatejourneyv2)\n- [`patchUpdateJourneyV2`](#patchupdatejourneyv2)\n- [`getJourneyV2`](#getjourneyv2)\n- [`removeJourneyV2`](#removejourneyv2)\n\n**Schemas**\n- [`EnvironmentMapEntry`](#environmentmapentry)\n- [`EnvironmentMap`](#environmentmap)\n- [`EnvironmentLink`](#environmentlink)\n- [`EnvironmentLinkList`](#environmentlinklist)\n- [`JourneyEnvironmentResponse`](#journeyenvironmentresponse)\n- [`JourneyEnvironmentVariablesResponse`](#journeyenvironmentvariablesresponse)\n- [`GetJourneysResponse`](#getjourneysresponse)\n- [`JourneyResponse`](#journeyresponse)\n- [`JourneyProductsResponse`](#journeyproductsresponse)\n- [`PatchUpdateJourneyRequest`](#patchupdatejourneyrequest)\n- [`JourneyCreationRequest`](#journeycreationrequest)\n- [`JourneyCreationRequestV2`](#journeycreationrequestv2)\n- [`SearchJourneysQueryRequest`](#searchjourneysqueryrequest)\n- [`SearchJourneysResponse`](#searchjourneysresponse)\n- [`Journey`](#journey)\n- [`JourneyServedRevision`](#journeyservedrevision)\n- [`JourneyActivationGuarantee`](#journeyactivationguarantee)\n- [`JourneyFeatureFlags`](#journeyfeatureflags)\n- [`JourneyAuditInfo`](#journeyauditinfo)\n- [`JourneyRevisionRequest`](#journeyrevisionrequest)\n- [`PublishRevisionRequest`](#publishrevisionrequest)\n- [`JourneyRevisionSummary`](#journeyrevisionsummary)\n- [`JourneyRevisionList`](#journeyrevisionlist)\n- [`JourneyRevision`](#journeyrevision)\n- [`JourneyRevisionConflict`](#journeyrevisionconflict)\n- [`JourneyPublishState`](#journeypublishstate)\n- [`PublishResult`](#publishresult)\n- [`JourneyValidationResponse`](#journeyvalidationresponse)\n- [`JourneyValidationError`](#journeyvalidationerror)\n- [`S3Reference`](#s3reference)\n- [`TemplateSettings`](#templatesettings)\n- [`GenerateDocumentResponse`](#generatedocumentresponse)\n- [`GenerateDocumentRequest`](#generatedocumentrequest)\n- [`GetSettingsForJourney`](#getsettingsforjourney)\n- [`ButtonOption`](#buttonoption)\n- [`ValidationRuleRef`](#validationruleref)\n- [`RuleRef`](#ruleref)\n\n### `getJourneysByOrgId`\n\nGet all journeys by organization id\n\n`GET /v1/journey/organization/{id}`\n\n```ts\nconst { data } = await client.getJourneysByOrgId({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  hydrate: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getJourney`\n\nGet journey by id. Private journeys requires valid private token to be passed\n\n`GET /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourney({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  version: 1,\n  revision_id: \'example\',\n  source: \'example\',\n  orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "organizationId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "stepperType": "numbers",\n      "hideNextButton": true,\n      "name": "string",\n      "stepId": "string",\n      "schema": {},\n      "uischema": {},\n      "maxWidth": "small"\n    }\n  ],\n  "design": {\n    "logoUrl": "string",\n    "theme": {},\n    "designTokens": {}\n  },\n  "rules": [\n    {\n      "type": "inject",\n      "sourceType": "journey",\n      "source": "string",\n      "target": "string"\n    }\n  ],\n  "logics": [\n    {\n      "autoGeneratedId": "string",\n      "conditions": ["string"],\n      "actions": ["string"]\n    }\n  ],\n  "logicsV4": {},\n  "contextSchema": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "type": "string",\n      "paramKey": "string",\n      "isRequired": true,\n      "shouldLoadEntity": true,\n      "description": "string"\n    }\n  ],\n  "journey_type": "Sales template (Premium)",\n  "protected": true,\n  "protectedEditable": ["string"],\n  "settings": {\n    "embedOptions": {\n      "mode": "full-screen",\n      "lang": "de",\n      "width": "string",\n      "topBar": true,\n      "scrollToTop": true,\n      "button": {}\n    },\n    "safeModeAutomation": true,\n    "canary": true,\n    "designId": "string",\n    "templateId": "string",\n    "entityId": "string",\n    "mappingsAutomationId": "string",\n    "newMappings": true,\n    "targetedCustomer": "string",\n    "description": "string",\n    "organizationSettings": {},\n    "publicToken": "string",\n    "runtimeEntities": ["ORDER"],\n    "filePurposes": ["string"],\n    "entityTags": ["string"],\n    "addressSuggestionsFileUrl": "string",\n    "addressSuggestionsFileId": "string",\n    "addressSuggestionsCountryCode": "string",\n    "addressSuggestionsEnableAutoComplete": true,\n    "addressSuggestionsSource": ["string"],\n    "addressSuggestionsEnableFreeText": true,\n    "useNewDesign": true,\n    "useAustrianLabels": true,\n    "enableDarkMode": true,\n    "accessMode": "PUBLIC",\n    "authGate": {\n      "stepId": "string"\n    },\n    "isPublished": true,\n    "status": "string",\n    "isActive": true,\n    "savingProgress": {\n      "mode": "auto",\n      "supportedRevision": 0\n    },\n    "thirdPartyCookies": true\n  },\n  "validationRules": {\n    "block1": "rule123",\n    "block2": ["rule456", "rule789"],\n    "block3": {\n      "field1": "rule101",\n      "field2": ["rule102", "rule103"]\n    }\n  },\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "createdBy": "string",\n  "updatedBy": "string",\n  "__lastModifiedAt": "string",\n  "createdAt": "string",\n  "lastModifiedAt": "string",\n  "deletedAt": "string",\n  "version": 0,\n  "revisions": 0,\n  "featureFlags": {},\n  "revision_id": "42"\n}\n```\n\n</details>\n\n---\n\n### `removeJourney`\n\nRemove journey by id\n\n`DELETE /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourney({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `createJourneyRevision`\n\nCreates a revision: an immutable copy of the complete journey configuration, identified by `revision_id`. Nothing customers receive changes; the revision only becomes the published version when it is \n\n`POST /v1/journey/configuration/{id}/revisions`\n\n```ts\nconst { data } = await client.createJourneyRevision(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    journeyId: \'string\',\n    organizationId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        stepperType: \'numbers\',\n        hideNextButton: true,\n        name: \'string\',\n        stepId: \'string\',\n        schema: {},\n        uischema: {},\n        maxWidth: \'small\'\n      }\n    ],\n    design: {\n      logoUrl: \'string\',\n      theme: {},\n      designTokens: {}\n    },\n    rules: [\n      {\n        type: \'inject\',\n        sourceType: \'journey\',\n        source: \'string\',\n        target: \'string\'\n      }\n    ],\n    logics: [\n      {\n        autoGeneratedId: \'string\',\n        conditions: [\'string\'],\n        actions: [\'string\']\n      }\n    ],\n    logicsV4: {},\n    contextSchema: [\n      {\n        id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        type: \'string\',\n        paramKey: \'string\',\n        isRequired: true,\n        shouldLoadEntity: true,\n        description: \'string\'\n      }\n    ],\n    journey_type: \'Sales template (Premium)\',\n    protected: true,\n    protectedEditable: [\'string\'],\n    settings: {\n      embedOptions: {\n        mode: \'full-screen\',\n        lang: \'de\',\n        width: \'string\',\n        topBar: true,\n        scrollToTop: true,\n        button: { /* ... */ }\n      },\n      safeModeAutomation: true,\n      canary: true,\n      designId: \'string\',\n      templateId: \'string\',\n      entityId: \'string\',\n      mappingsAutomationId: \'string\',\n      newMappings: true,\n      targetedCustomer: \'string\',\n      description: \'string\',\n      organizationSettings: {},\n      publicToken: \'string\',\n      runtimeEntities: [\'ORDER\'],\n      filePurposes: [\'string\'],\n      entityTags: [\'string\'],\n      addressSuggestionsFileUrl: \'string\',\n      addressSuggestionsFileId: \'string\',\n      addressSuggestionsCountryCode: \'string\',\n      addressSuggestionsEnableAutoComplete: true,\n      addressSuggestionsSource: [\'string\'],\n      addressSuggestionsEnableFreeText: true,\n      useNewDesign: true,\n      useAustrianLabels: true,\n      enableDarkMode: true,\n      accessMode: \'PUBLIC\',\n      authGate: {\n        stepId: \'string\'\n      },\n      isPublished: true,\n      status: \'string\',\n      isActive: true,\n      savingProgress: {\n        mode: \'auto\',\n        supportedRevision: 0\n      },\n      thirdPartyCookies: true\n    },\n    validationRules: {\n      block1: \'rule123\',\n      block2: [\'rule456\', \'rule789\'],\n      block3: {\n        field1: \'rule101\',\n        field2: [\'rule102\', \'rule103\']\n      }\n    },\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n    createdBy: \'string\',\n    updatedBy: \'string\',\n    __lastModifiedAt: \'string\',\n    parent_revision_id: \'41\',\n    based_on_revision_id: \'37\',\n    mapping_config_version: 12,\n    revision_name: \'Changes to Steps and Logic\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "revision_id": "42",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "name": "Summer campaign",\n  "description": "string",\n  "published_at": "1970-01-01T00:00:00.000Z",\n  "is_published": true,\n  "mapping_config_version": 12\n}\n```\n\n</details>\n\n---\n\n### `listJourneyRevisions`\n\nLists the journey\'s revision history, newest first. Metadata only, no configuration payload. `is_published` says whether a revision is the published version right now, which is a different question fr\n\n`GET /v1/journey/configuration/{id}/revisions`\n\n```ts\nconst { data } = await client.listJourneyRevisions({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  limit: 1,\n  cursor: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "revision_id": "42",\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "created_by": "string",\n      "name": "Summer campaign",\n      "description": "string",\n      "published_at": "1970-01-01T00:00:00.000Z",\n      "is_published": true,\n      "mapping_config_version": 12\n    }\n  ],\n  "next_cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJourneyRevision`\n\nReturns one revision with its full configuration, in the shape the builder holds a journey in, so it can be loaded straight into the editor as unsaved changes. Reading a revision changes nothing; a cl\n\n`GET /v1/journey/configuration/{id}/revisions/{revision_id}`\n\n```ts\nconst { data } = await client.getJourneyRevision({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  revision_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "revision_id": "42",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "created_by": "string",\n  "name": "Summer campaign",\n  "description": "string",\n  "published_at": "1970-01-01T00:00:00.000Z",\n  "is_published": true,\n  "mapping_config_version": 12,\n  "configuration": {\n    "journeyId": "string",\n    "organizationId": "string",\n    "brandId": "string",\n    "name": "string",\n    "steps": [\n      {}\n    ],\n    "design": {\n      "logoUrl": "string",\n      "theme": {},\n      "designTokens": {}\n    },\n    "rules": [\n      {}\n    ],\n    "logics": [\n      {}\n    ],\n    "logicsV4": {},\n    "contextSchema": [\n      {}\n    ],\n    "journey_type": "Sales template (Premium)",\n    "protected": true,\n    "protectedEditable": ["string"],\n    "settings": {\n      "embedOptions": {},\n      "safeModeAutomation": true,\n      "canary": true,\n      "designId": "string",\n      "templateId": "string",\n      "entityId": "string",\n      "mappingsAutomationId": "string",\n      "newMappings": true,\n      "targetedCustomer": "string",\n      "description": "string",\n      "organizationSettings": {},\n      "publicToken": "string",\n      "runtimeEntities": ["ORDER"],\n      "filePurposes": ["string"],\n      "entityTags": ["string"],\n      "addressSuggestionsFileUrl": "string",\n      "addressSuggestionsFileId": "string",\n      "addressSuggestionsCountryCode": "string",\n      "addressSuggestionsEnableAutoComplete": true,\n      "addressSuggestionsSource": ["string"],\n      "addressSuggestionsEnableFreeText": true,\n      "useNewDesign": true,\n      "useAustrianLabels": true,\n      "enableDarkMode": true,\n      "accessMode": "PUBLIC",\n      "authGate": {},\n      "isPublished": true,\n      "status": "string",\n      "isActive": true,\n      "savingProgress": {},\n      "thirdPartyCookies": true\n    },\n    "validationRules": {\n      "block1": "rule123",\n      "block2": ["rule456", "rule789"],\n      "block3": {}\n    },\n    "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n    "createdBy": "string",\n    "updatedBy": "string",\n    "__lastModifiedAt": "string",\n    "createdAt": "string",\n    "lastModifiedAt": "string",\n    "deletedAt": "string",\n    "version": 0,\n    "revisions": 0,\n    "featureFlags": {}\n  }\n}\n```\n\n</details>\n\n---\n\n### `publishJourneyRevision`\n\nMakes one revision the published version, the one customers receive, in a single transaction: the revision\'s configuration is copied onto the journey record, its datasource set onto the published data\n\n`POST /v1/journey/configuration/{id}/publish`\n\n```ts\nconst { data } = await client.publishJourneyRevision(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    revision_id: \'42\',\n    name: \'Summer campaign\',\n    description: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "revision_id": "42",\n  "name": "Summer campaign",\n  "published_at": "1970-01-01T00:00:00.000Z",\n  "published_by": "string",\n  "post_publish_warnings": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyPublishState`\n\nAnswers which revision is the published version without paging through the history. A journey that has not adopted versioning yet returns `200` with `published_revision_id: null`, not `404`.\n\n`GET /v1/journey/configuration/{id}/publish-state`\n\n```ts\nconst { data } = await client.getJourneyPublishState({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "published_revision_id": "42",\n  "published_at": "1970-01-01T00:00:00.000Z",\n  "published_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJourneyEnvironment`\n\nResolve the environment variables referenced by this journey. Only browser-safe value types are returned.\n\n`GET /v1/journey/configuration/{id}/environment`\n\n```ts\nconst { data } = await client.getJourneyEnvironment({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "items": [\n    {\n      "datasourceId": "string",\n      "type": "Text",\n      "value": "string"\n    }\n  ],\n  "errors": [\n    {\n      "datasourceId": "string",\n      "code": "not_found"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyEnvironmentVariables`\n\nList the organization\'s environment variables that a journey block may use as an options source. Only Map variables that currently hold a valid value are returned. Intended for the journey builder\'s a\n\n`GET /v1/journey/environment-variables`\n\n```ts\nconst { data } = await client.getJourneyEnvironmentVariables()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "items": [\n    {\n      "key": "string",\n      "type": "Map",\n      "value": {\n        "fallbackLanguage": "de",\n        "options": [\n          {\n            "key": "string",\n            "value": "string"\n          }\n        ]\n      },\n      "description": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyProducts`\n\nGet products available in the journey by id. requires public journey token to be passed.\n\n`GET /v1/journey/products/{id}`\n\n```ts\nconst { data } = await client.getJourneyProducts({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  source: \'example\',\n  postal_code: \'example\',\n  city: \'example\',\n  street: \'example\',\n  street_number: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "type": "string",\n    "_schema": "string",\n    "_title": "string",\n    "name": "string",\n    "_id": "string",\n    "_org": "string",\n    "code": "string",\n    "description": "string",\n    "feature": [\n      {}\n    ],\n    "product_images": [\n      {}\n    ],\n    "legal_footnote": "string",\n    "product_downloads": [\n      {}\n    ],\n    "price": {}\n  }\n]\n```\n\n</details>\n\n---\n\n### `createJourney`\n\nCreate a Journey\n\n`POST /v1/journey/configuration`\n\n```ts\nconst { data } = await client.createJourney(\n  {\n    skipAutomation: \'example\',\n  },\n  {\n    journeyId: \'string\',\n    organizationId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        stepperType: \'numbers\',\n        hideNextButton: true,\n        name: \'string\',\n        stepId: \'string\',\n        schema: {},\n        uischema: {},\n        maxWidth: \'small\'\n      }\n    ],\n    design: {\n      logoUrl: \'string\',\n      theme: {},\n      designTokens: {}\n    },\n    rules: [\n      {\n        type: \'inject\',\n        sourceType: \'journey\',\n        source: \'string\',\n        target: \'string\'\n      }\n    ],\n    logics: [\n      {\n        autoGeneratedId: \'string\',\n        conditions: [\'string\'],\n        actions: [\'string\']\n      }\n    ],\n    logicsV4: {},\n    contextSchema: [\n      {\n        id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        type: \'string\',\n        paramKey: \'string\',\n        isRequired: true,\n        shouldLoadEntity: true,\n        description: \'string\'\n      }\n    ],\n    journey_type: \'Sales template (Premium)\',\n    protected: true,\n    protectedEditable: [\'string\'],\n    settings: {\n      embedOptions: {\n        mode: \'full-screen\',\n        lang: \'de\',\n        width: \'string\',\n        topBar: true,\n        scrollToTop: true,\n        button: { /* ... */ }\n      },\n      safeModeAutomation: true,\n      canary: true,\n      designId: \'string\',\n      templateId: \'string\',\n      entityId: \'string\',\n      mappingsAutomationId: \'string\',\n      newMappings: true,\n      targetedCustomer: \'string\',\n      description: \'string\',\n      organizationSettings: {},\n      publicToken: \'string\',\n      runtimeEntities: [\'ORDER\'],\n      filePurposes: [\'string\'],\n      entityTags: [\'string\'],\n      addressSuggestionsFileUrl: \'string\',\n      addressSuggestionsFileId: \'string\',\n      addressSuggestionsCountryCode: \'string\',\n      addressSuggestionsEnableAutoComplete: true,\n      addressSuggestionsSource: [\'string\'],\n      addressSuggestionsEnableFreeText: true,\n      useNewDesign: true,\n      useAustrianLabels: true,\n      enableDarkMode: true,\n      accessMode: \'PUBLIC\',\n      authGate: {\n        stepId: \'string\'\n      },\n      isPublished: true,\n      status: \'string\',\n      isActive: true,\n      savingProgress: {\n        mode: \'auto\',\n        supportedRevision: 0\n      },\n      thirdPartyCookies: true\n    },\n    validationRules: {\n      block1: \'rule123\',\n      block2: [\'rule456\', \'rule789\'],\n      block3: {\n        field1: \'rule101\',\n        field2: [\'rule102\', \'rule103\']\n      }\n    },\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n    createdBy: \'string\',\n    updatedBy: \'string\',\n    __lastModifiedAt: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "organizationId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "stepperType": "numbers",\n      "hideNextButton": true,\n      "name": "string",\n      "stepId": "string",\n      "schema": {},\n      "uischema": {},\n      "maxWidth": "small"\n    }\n  ],\n  "design": {\n    "logoUrl": "string",\n    "theme": {},\n    "designTokens": {}\n  },\n  "rules": [\n    {\n      "type": "inject",\n      "sourceType": "journey",\n      "source": "string",\n      "target": "string"\n    }\n  ],\n  "logics": [\n    {\n      "autoGeneratedId": "string",\n      "conditions": ["string"],\n      "actions": ["string"]\n    }\n  ],\n  "logicsV4": {},\n  "contextSchema": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "type": "string",\n      "paramKey": "string",\n      "isRequired": true,\n      "shouldLoadEntity": true,\n      "description": "string"\n    }\n  ],\n  "journey_type": "Sales template (Premium)",\n  "protected": true,\n  "protectedEditable": ["string"],\n  "settings": {\n    "embedOptions": {\n      "mode": "full-screen",\n      "lang": "de",\n      "width": "string",\n      "topBar": true,\n      "scrollToTop": true,\n      "button": {}\n    },\n    "safeModeAutomation": true,\n    "canary": true,\n    "designId": "string",\n    "templateId": "string",\n    "entityId": "string",\n    "mappingsAutomationId": "string",\n    "newMappings": true,\n    "targetedCustomer": "string",\n    "description": "string",\n    "organizationSettings": {},\n    "publicToken": "string",\n    "runtimeEntities": ["ORDER"],\n    "filePurposes": ["string"],\n    "entityTags": ["string"],\n    "addressSuggestionsFileUrl": "string",\n    "addressSuggestionsFileId": "string",\n    "addressSuggestionsCountryCode": "string",\n    "addressSuggestionsEnableAutoComplete": true,\n    "addressSuggestionsSource": ["string"],\n    "addressSuggestionsEnableFreeText": true,\n    "useNewDesign": true,\n    "useAustrianLabels": true,\n    "enableDarkMode": true,\n    "accessMode": "PUBLIC",\n    "authGate": {\n      "stepId": "string"\n    },\n    "isPublished": true,\n    "status": "string",\n    "isActive": true,\n    "savingProgress": {\n      "mode": "auto",\n      "supportedRevision": 0\n    },\n    "thirdPartyCookies": true\n  },\n  "validationRules": {\n    "block1": "rule123",\n    "block2": ["rule456", "rule789"],\n    "block3": {\n      "field1": "rule101",\n      "field2": ["rule102", "rule103"]\n    }\n  },\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n  "createdBy": "string",\n  "updatedBy": "string",\n  "__lastModifiedAt": "string",\n  "createdAt": "string",\n  "lastModifiedAt": "string",\n  "deletedAt": "string",\n  "version": 0,\n  "revisions": 0,\n  "featureFlags": {}\n}\n```\n\n</details>\n\n---\n\n### `updateJourney`\n\nUpdate a Journey\n\n`PUT /v1/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourney(\n  null,\n  {\n    journeyId: \'string\',\n    organizationId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        stepperType: \'numbers\',\n        hideNextButton: true,\n        name: \'string\',\n        stepId: \'string\',\n        schema: {},\n        uischema: {},\n        maxWidth: \'small\'\n      }\n    ],\n    design: {\n      logoUrl: \'string\',\n      theme: {},\n      designTokens: {}\n    },\n    rules: [\n      {\n        type: \'inject\',\n        sourceType: \'journey\',\n        source: \'string\',\n        target: \'string\'\n      }\n    ],\n    logics: [\n      {\n        autoGeneratedId: \'string\',\n        conditions: [\'string\'],\n        actions: [\'string\']\n      }\n    ],\n    logicsV4: {},\n    contextSchema: [\n      {\n        id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        type: \'string\',\n        paramKey: \'string\',\n        isRequired: true,\n        shouldLoadEntity: true,\n        description: \'string\'\n      }\n    ],\n    journey_type: \'Sales template (Premium)\',\n    protected: true,\n    protectedEditable: [\'string\'],\n    settings: {\n      embedOptions: {\n        mode: \'full-screen\',\n        lang: \'de\',\n        width: \'string\',\n        topBar: true,\n        scrollToTop: true,\n        button: { /* ... */ }\n      },\n      safeModeAutomation: true,\n      canary: true,\n      designId: \'string\',\n      templateId: \'string\',\n      entityId: \'string\',\n      mappingsAutomationId: \'string\',\n      newMappings: true,\n      targetedCustomer: \'string\',\n      description: \'string\',\n      organizationSettings: {},\n      publicToken: \'string\',\n      runtimeEntities: [\'ORDER\'],\n      filePurposes: [\'string\'],\n      entityTags: [\'string\'],\n      addressSuggestionsFileUrl: \'string\',\n      addressSuggestionsFileId: \'string\',\n      addressSuggestionsCountryCode: \'string\',\n      addressSuggestionsEnableAutoComplete: true,\n      addressSuggestionsSource: [\'string\'],\n      addressSuggestionsEnableFreeText: true,\n      useNewDesign: true,\n      useAustrianLabels: true,\n      enableDarkMode: true,\n      accessMode: \'PUBLIC\',\n      authGate: {\n        stepId: \'string\'\n      },\n      isPublished: true,\n      status: \'string\',\n      isActive: true,\n      savingProgress: {\n        mode: \'auto\',\n        supportedRevision: 0\n      },\n      thirdPartyCookies: true\n    },\n    validationRules: {\n      block1: \'rule123\',\n      block2: [\'rule456\', \'rule789\'],\n      block3: {\n        field1: \'rule101\',\n        field2: [\'rule102\', \'rule103\']\n      }\n    },\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n    createdBy: \'string\',\n    updatedBy: \'string\',\n    __lastModifiedAt: \'string\'\n  },\n)\n```\n\n---\n\n### `patchUpdateJourney`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v1/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourney(\n  null,\n  {\n    journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n    __lastModifiedAt: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "createdJourney": {\n    "journeyId": "string",\n    "organizationId": "string",\n    "brandId": "string",\n    "name": "string",\n    "steps": [\n      {}\n    ],\n    "design": {\n      "logoUrl": "string",\n      "theme": {},\n      "designTokens": {}\n    },\n    "rules": [\n      {}\n    ],\n    "logics": [\n      {}\n    ],\n    "logicsV4": {},\n    "contextSchema": [\n      {}\n    ],\n    "journey_type": "Sales template (Premium)",\n    "protected": true,\n    "protectedEditable": ["string"],\n    "settings": {\n      "embedOptions": {},\n      "safeModeAutomation": true,\n      "canary": true,\n      "designId": "string",\n      "templateId": "string",\n      "entityId": "string",\n      "mappingsAutomationId": "string",\n      "newMappings": true,\n      "targetedCustomer": "string",\n      "description": "string",\n      "organizationSettings": {},\n      "publicToken": "string",\n      "runtimeEntities": ["ORDER"],\n      "filePurposes": ["string"],\n      "entityTags": ["string"],\n      "addressSuggestionsFileUrl": "string",\n      "addressSuggestionsFileId": "string",\n      "addressSuggestionsCountryCode": "string",\n      "addressSuggestionsEnableAutoComplete": true,\n      "addressSuggestionsSource": ["string"],\n      "addressSuggestionsEnableFreeText": true,\n      "useNewDesign": true,\n      "useAustrianLabels": true,\n      "enableDarkMode": true,\n      "accessMode": "PUBLIC",\n      "authGate": {},\n      "isPublished": true,\n      "status": "string",\n      "isActive": true,\n      "savingProgress": {},\n      "thirdPartyCookies": true\n    },\n    "validationRules": {\n      "block1": "rule123",\n      "block2": ["rule456", "rule789"],\n      "block3": {}\n    },\n    "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n    "createdBy": "string",\n    "updatedBy": "string",\n    "__lastModifiedAt": "string",\n    "createdAt": "string",\n    "lastModifiedAt": "string",\n    "deletedAt": "string",\n    "version": 0,\n    "revisions": 0,\n    "featureFlags": {}\n  }\n}\n```\n\n</details>\n\n---\n\n### `searchJourneys`\n\nSearch Journeys\n\n`POST /v1/journey/configuration/search`\n\n```ts\nconst { data } = await client.searchJourneys(\n  null,\n  {\n    q: \'_tags:*Flex*\',\n    from: 0,\n    size: 25,\n    sort: \'_created_at:desc\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 1,\n  "results": [\n    {\n      "_id": "e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8",\n      "_schema": "journey",\n      "_title": "Journey Entity Title",\n      "_org": "739224",\n      "_created_at": "2020-01-01T00:00:00.000Z",\n      "_updated_at": "2020-01-01T00:00:00.000Z",\n      "_tags": ["Flex"],\n      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n      "journey_name": "Journey Name",\n      "journey_id": "de7df470-253e-11ed-9174-116b8a718c0a",\n      "journey_type": "Sales template",\n      "design": "Design EPILOT",\n      "created_by": [\n        {\n          "id": "12345"\n        }\n      ],\n      "journey_version": "Flex"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `generateDocument`\n\nBuilds document generated from a template with journey values."\n\n`POST /v1/journey/document:generate`\n\n```ts\nconst { data } = await client.generateDocument(\n  null,\n  {\n    file_id: \'1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\',\n    context_data: {\n      additionalProperties: \'string\'\n    },\n    context_entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n    language: \'de\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "job_status": "STARTED",\n  "message": "string",\n  "pdf_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.pdf"\n      }\n    }\n  },\n  "docx_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.docx"\n      }\n    }\n  },\n  "variable_payload": {\n    "additionalProperties": "string"\n  },\n  "template_settings": {\n    "custom_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "suggested_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "display_margin_guidelines": true,\n    "enable_data_table_margin_autofix": false,\n    "template_with_datatable": false,\n    "enabled_template_settings_persistence": false,\n    "misconfigured_margins": false,\n    "file_entity_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"\n  }\n}\n```\n\n</details>\n\n---\n\n### `createJourneyV2`\n\nCreate a Journey\n\n`POST /v2/journey/configuration`\n\n```ts\nconst { data } = await client.createJourneyV2(\n  {\n    skipAutomation: \'example\',\n  },\n  {\n    journeyId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        stepperType: \'numbers\',\n        hideNextButton: true,\n        name: \'string\',\n        stepId: \'string\',\n        schema: {},\n        uischema: {},\n        maxWidth: \'small\'\n      }\n    ],\n    design: {\n      logoUrl: \'string\',\n      theme: {},\n      designTokens: {}\n    },\n    rules: [\n      {\n        type: \'inject\',\n        sourceType: \'journey\',\n        source: \'string\',\n        target: \'string\'\n      }\n    ],\n    logics: [\n      {\n        autoGeneratedId: \'string\',\n        conditions: [\'string\'],\n        actions: [\'string\']\n      }\n    ],\n    logicsV4: {},\n    contextSchema: [\n      {\n        id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        type: \'string\',\n        paramKey: \'string\',\n        isRequired: true,\n        shouldLoadEntity: true,\n        description: \'string\'\n      }\n    ],\n    journey_type: \'Sales template (Premium)\',\n    protected: true,\n    protectedEditable: [\'string\'],\n    settings: {\n      embedOptions: {\n        mode: \'full-screen\',\n        lang: \'de\',\n        width: \'string\',\n        topBar: true,\n        scrollToTop: true,\n        button: { /* ... */ }\n      },\n      safeModeAutomation: true,\n      designId: \'string\',\n      entityId: \'string\',\n      mappingsAutomationId: \'string\',\n      newMappings: true,\n      templateId: \'string\',\n      targetedCustomer: \'string\',\n      description: \'string\',\n      publicToken: \'string\',\n      runtimeEntities: [\'ORDER\'],\n      filePurposes: [\'string\'],\n      entityTags: [\'string\'],\n      addressSuggestionsFileUrl: \'string\',\n      addressSuggestionsFileId: \'string\',\n      addressSuggestionsCountryCode: \'string\',\n      addressSuggestionsEnableAutoComplete: true,\n      addressSuggestionsSource: [\'string\'],\n      addressSuggestionsEnableFreeText: true,\n      useNewDesign: true,\n      thirdPartyCookies: true,\n      accessMode: \'PUBLIC\',\n      authGate: {\n        stepId: \'string\'\n      },\n      enableDarkMode: true,\n      useAustrianLabels: true,\n      isActive: true,\n      savingProgress: {\n        mode: \'auto\',\n        supportedRevision: 0\n      }\n    },\n    validationRules: {\n      block1: \'rule123\',\n      block2: [\'rule456\', \'rule789\'],\n      block3: {\n        field1: \'rule101\',\n        field2: [\'rule102\', \'rule103\']\n      }\n    },\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "stepperType": "numbers",\n      "hideNextButton": true,\n      "name": "string",\n      "stepId": "string",\n      "schema": {},\n      "uischema": {},\n      "maxWidth": "small"\n    }\n  ],\n  "design": {\n    "logoUrl": "string",\n    "theme": {},\n    "designTokens": {}\n  },\n  "rules": [\n    {\n      "type": "inject",\n      "sourceType": "journey",\n      "source": "string",\n      "target": "string"\n    }\n  ],\n  "logics": [\n    {\n      "autoGeneratedId": "string",\n      "conditions": ["string"],\n      "actions": ["string"]\n    }\n  ],\n  "logicsV4": {},\n  "contextSchema": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "type": "string",\n      "paramKey": "string",\n      "isRequired": true,\n      "shouldLoadEntity": true,\n      "description": "string"\n    }\n  ],\n  "journey_type": "Sales template (Premium)",\n  "protected": true,\n  "protectedEditable": ["string"],\n  "settings": {\n    "embedOptions": {\n      "mode": "full-screen",\n      "lang": "de",\n      "width": "string",\n      "topBar": true,\n      "scrollToTop": true,\n      "button": {}\n    },\n    "safeModeAutomation": true,\n    "designId": "string",\n    "entityId": "string",\n    "mappingsAutomationId": "string",\n    "newMappings": true,\n    "templateId": "string",\n    "targetedCustomer": "string",\n    "description": "string",\n    "publicToken": "string",\n    "runtimeEntities": ["ORDER"],\n    "filePurposes": ["string"],\n    "entityTags": ["string"],\n    "addressSuggestionsFileUrl": "string",\n    "addressSuggestionsFileId": "string",\n    "addressSuggestionsCountryCode": "string",\n    "addressSuggestionsEnableAutoComplete": true,\n    "addressSuggestionsSource": ["string"],\n    "addressSuggestionsEnableFreeText": true,\n    "useNewDesign": true,\n    "thirdPartyCookies": true,\n    "accessMode": "PUBLIC",\n    "authGate": {\n      "stepId": "string"\n    },\n    "enableDarkMode": true,\n    "useAustrianLabels": true,\n    "isActive": true,\n    "savingProgress": {\n      "mode": "auto",\n      "supportedRevision": 0\n    }\n  },\n  "validationRules": {\n    "block1": "rule123",\n    "block2": ["rule456", "rule789"],\n    "block3": {\n      "field1": "rule101",\n      "field2": ["rule102", "rule103"]\n    }\n  },\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `updateJourneyV2`\n\nUpdate a Journey\n\n`PUT /v2/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourneyV2(\n  null,\n  {\n    journeyId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        stepperType: \'numbers\',\n        hideNextButton: true,\n        name: \'string\',\n        stepId: \'string\',\n        schema: {},\n        uischema: {},\n        maxWidth: \'small\'\n      }\n    ],\n    design: {\n      logoUrl: \'string\',\n      theme: {},\n      designTokens: {}\n    },\n    rules: [\n      {\n        type: \'inject\',\n        sourceType: \'journey\',\n        source: \'string\',\n        target: \'string\'\n      }\n    ],\n    logics: [\n      {\n        autoGeneratedId: \'string\',\n        conditions: [\'string\'],\n        actions: [\'string\']\n      }\n    ],\n    logicsV4: {},\n    contextSchema: [\n      {\n        id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n        type: \'string\',\n        paramKey: \'string\',\n        isRequired: true,\n        shouldLoadEntity: true,\n        description: \'string\'\n      }\n    ],\n    journey_type: \'Sales template (Premium)\',\n    protected: true,\n    protectedEditable: [\'string\'],\n    settings: {\n      embedOptions: {\n        mode: \'full-screen\',\n        lang: \'de\',\n        width: \'string\',\n        topBar: true,\n        scrollToTop: true,\n        button: { /* ... */ }\n      },\n      safeModeAutomation: true,\n      designId: \'string\',\n      entityId: \'string\',\n      mappingsAutomationId: \'string\',\n      newMappings: true,\n      templateId: \'string\',\n      targetedCustomer: \'string\',\n      description: \'string\',\n      publicToken: \'string\',\n      runtimeEntities: [\'ORDER\'],\n      filePurposes: [\'string\'],\n      entityTags: [\'string\'],\n      addressSuggestionsFileUrl: \'string\',\n      addressSuggestionsFileId: \'string\',\n      addressSuggestionsCountryCode: \'string\',\n      addressSuggestionsEnableAutoComplete: true,\n      addressSuggestionsSource: [\'string\'],\n      addressSuggestionsEnableFreeText: true,\n      useNewDesign: true,\n      thirdPartyCookies: true,\n      accessMode: \'PUBLIC\',\n      authGate: {\n        stepId: \'string\'\n      },\n      enableDarkMode: true,\n      useAustrianLabels: true,\n      isActive: true,\n      savingProgress: {\n        mode: \'auto\',\n        supportedRevision: 0\n      }\n    },\n    validationRules: {\n      block1: \'rule123\',\n      block2: [\'rule456\', \'rule789\'],\n      block3: {\n        field1: \'rule101\',\n        field2: [\'rule102\', \'rule103\']\n      }\n    },\n    _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "stepperType": "numbers",\n      "hideNextButton": true,\n      "name": "string",\n      "stepId": "string",\n      "schema": {},\n      "uischema": {},\n      "maxWidth": "small"\n    }\n  ],\n  "design": {\n    "logoUrl": "string",\n    "theme": {},\n    "designTokens": {}\n  },\n  "rules": [\n    {\n      "type": "inject",\n      "sourceType": "journey",\n      "source": "string",\n      "target": "string"\n    }\n  ],\n  "logics": [\n    {\n      "autoGeneratedId": "string",\n      "conditions": ["string"],\n      "actions": ["string"]\n    }\n  ],\n  "logicsV4": {},\n  "contextSchema": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "type": "string",\n      "paramKey": "string",\n      "isRequired": true,\n      "shouldLoadEntity": true,\n      "description": "string"\n    }\n  ],\n  "journey_type": "Sales template (Premium)",\n  "protected": true,\n  "protectedEditable": ["string"],\n  "settings": {\n    "embedOptions": {\n      "mode": "full-screen",\n      "lang": "de",\n      "width": "string",\n      "topBar": true,\n      "scrollToTop": true,\n      "button": {}\n    },\n    "safeModeAutomation": true,\n    "designId": "string",\n    "entityId": "string",\n    "mappingsAutomationId": "string",\n    "newMappings": true,\n    "templateId": "string",\n    "targetedCustomer": "string",\n    "description": "string",\n    "publicToken": "string",\n    "runtimeEntities": ["ORDER"],\n    "filePurposes": ["string"],\n    "entityTags": ["string"],\n    "addressSuggestionsFileUrl": "string",\n    "addressSuggestionsFileId": "string",\n    "addressSuggestionsCountryCode": "string",\n    "addressSuggestionsEnableAutoComplete": true,\n    "addressSuggestionsSource": ["string"],\n    "addressSuggestionsEnableFreeText": true,\n    "useNewDesign": true,\n    "thirdPartyCookies": true,\n    "accessMode": "PUBLIC",\n    "authGate": {\n      "stepId": "string"\n    },\n    "enableDarkMode": true,\n    "useAustrianLabels": true,\n    "isActive": true,\n    "savingProgress": {\n      "mode": "auto",\n      "supportedRevision": 0\n    }\n  },\n  "validationRules": {\n    "block1": "rule123",\n    "block2": ["rule456", "rule789"],\n    "block3": {\n      "field1": "rule101",\n      "field2": ["rule102", "rule103"]\n    }\n  },\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `patchUpdateJourneyV2`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v2/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourneyV2(\n  null,\n  {\n    journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n    __lastModifiedAt: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "stepperType": "numbers",\n      "hideNextButton": true,\n      "name": "string",\n      "stepId": "string",\n      "schema": {},\n      "uischema": {},\n      "maxWidth": "small"\n    }\n  ],\n  "design": {\n    "logoUrl": "string",\n    "theme": {},\n    "designTokens": {}\n  },\n  "rules": [\n    {\n      "type": "inject",\n      "sourceType": "journey",\n      "source": "string",\n      "target": "string"\n    }\n  ],\n  "logics": [\n    {\n      "autoGeneratedId": "string",\n      "conditions": ["string"],\n      "actions": ["string"]\n    }\n  ],\n  "logicsV4": {},\n  "contextSchema": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "type": "string",\n      "paramKey": "string",\n      "isRequired": true,\n      "shouldLoadEntity": true,\n      "description": "string"\n    }\n  ],\n  "journey_type": "Sales template (Premium)",\n  "protected": true,\n  "protectedEditable": ["string"],\n  "settings": {\n    "embedOptions": {\n      "mode": "full-screen",\n      "lang": "de",\n      "width": "string",\n      "topBar": true,\n      "scrollToTop": true,\n      "button": {}\n    },\n    "safeModeAutomation": true,\n    "designId": "string",\n    "entityId": "string",\n    "mappingsAutomationId": "string",\n    "newMappings": true,\n    "templateId": "string",\n    "targetedCustomer": "string",\n    "description": "string",\n    "publicToken": "string",\n    "runtimeEntities": ["ORDER"],\n    "filePurposes": ["string"],\n    "entityTags": ["string"],\n    "addressSuggestionsFileUrl": "string",\n    "addressSuggestionsFileId": "string",\n    "addressSuggestionsCountryCode": "string",\n    "addressSuggestionsEnableAutoComplete": true,\n    "addressSuggestionsSource": ["string"],\n    "addressSuggestionsEnableFreeText": true,\n    "useNewDesign": true,\n    "thirdPartyCookies": true,\n    "accessMode": "PUBLIC",\n    "authGate": {\n      "stepId": "string"\n    },\n    "enableDarkMode": true,\n    "useAustrianLabels": true,\n    "isActive": true,\n    "savingProgress": {\n      "mode": "auto",\n      "supportedRevision": 0\n    }\n  },\n  "validationRules": {\n    "block1": "rule123",\n    "block2": ["rule456", "rule789"],\n    "block3": {\n      "field1": "rule101",\n      "field2": ["rule102", "rule103"]\n    }\n  },\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyV2`\n\nGet journey by id\n\n`GET /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourneyV2({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  version: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "stepperType": "numbers",\n      "hideNextButton": true,\n      "name": "string",\n      "stepId": "string",\n      "schema": {},\n      "uischema": {},\n      "maxWidth": "small"\n    }\n  ],\n  "design": {\n    "logoUrl": "string",\n    "theme": {},\n    "designTokens": {}\n  },\n  "rules": [\n    {\n      "type": "inject",\n      "sourceType": "journey",\n      "source": "string",\n      "target": "string"\n    }\n  ],\n  "logics": [\n    {\n      "autoGeneratedId": "string",\n      "conditions": ["string"],\n      "actions": ["string"]\n    }\n  ],\n  "logicsV4": {},\n  "contextSchema": [\n    {\n      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "type": "string",\n      "paramKey": "string",\n      "isRequired": true,\n      "shouldLoadEntity": true,\n      "description": "string"\n    }\n  ],\n  "journey_type": "Sales template (Premium)",\n  "protected": true,\n  "protectedEditable": ["string"],\n  "settings": {\n    "embedOptions": {\n      "mode": "full-screen",\n      "lang": "de",\n      "width": "string",\n      "topBar": true,\n      "scrollToTop": true,\n      "button": {}\n    },\n    "safeModeAutomation": true,\n    "designId": "string",\n    "entityId": "string",\n    "mappingsAutomationId": "string",\n    "newMappings": true,\n    "templateId": "string",\n    "targetedCustomer": "string",\n    "description": "string",\n    "publicToken": "string",\n    "runtimeEntities": ["ORDER"],\n    "filePurposes": ["string"],\n    "entityTags": ["string"],\n    "addressSuggestionsFileUrl": "string",\n    "addressSuggestionsFileId": "string",\n    "addressSuggestionsCountryCode": "string",\n    "addressSuggestionsEnableAutoComplete": true,\n    "addressSuggestionsSource": ["string"],\n    "addressSuggestionsEnableFreeText": true,\n    "useNewDesign": true,\n    "thirdPartyCookies": true,\n    "accessMode": "PUBLIC",\n    "authGate": {\n      "stepId": "string"\n    },\n    "enableDarkMode": true,\n    "useAustrianLabels": true,\n    "isActive": true,\n    "savingProgress": {\n      "mode": "auto",\n      "supportedRevision": 0\n    }\n  },\n  "validationRules": {\n    "block1": "rule123",\n    "block2": ["rule456", "rule789"],\n    "block3": {\n      "field1": "rule101",\n      "field2": ["rule102", "rule103"]\n    }\n  },\n  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `removeJourneyV2`\n\nRemove journey by id\n\n`DELETE /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourneyV2({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getSettingsForJourney`\n\nGet settings related to the journey using journey ID.\n\n`GET /v1/journey/{id}/settings`\n\n```ts\nconst { data } = await client.getSettingsForJourney({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "organizationId": "739224",\n  "canary": true,\n  "thirdPartyCookies": true\n}\n```\n\n</details>\n\n---\n\n### `getButtonOptions`\n\nGet button options from a csv file.\n\n`GET /v1/journey/button-options`\n\n```ts\nconst { data } = await client.getButtonOptions({\n  fileId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "value": "Button Hidden Value",\n    "label": "Button Label"\n  }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `EnvironmentMapEntry`\n\n```ts\ntype EnvironmentMapEntry = {\n  key: string\n  value: string | Record<string, string>\n}\n```\n\n### `EnvironmentMap`\n\n```ts\ntype EnvironmentMap = {\n  fallbackLanguage?: string\n  options: Array<{\n    key: string\n    value: string | Record<string, string>\n  }>\n}\n```\n\n### `EnvironmentLink`\n\nOne link a customer clicks. `label` and `description` are each either a\nplain string or one string per language, deciding that independently.\nMirrors environments-api\'s `LinkFields`.\n\n\n```ts\ntype EnvironmentLink = {\n  url: string\n  label: string | Record<string, string>\n  description?: string | Record<string, string>\n}\n```\n\n### `EnvironmentLinkList`\n\nA list of links, served under this service\'s own `List`<Link>`` type\ntoken. environments-api types the variable `List` and declares the\nelement type inside the value; journey-api composes the two so a\nconsumer needs only one discriminant.\n\n\n```ts\ntype EnvironmentLinkList = {\n  itemType: "Link"\n  fallbackLanguage?: string\n  items: Array<{\n    url: string\n    label: string | Record<string, string>\n    description?: string | Record<string, string>\n  }>\n}\n```\n\n### `JourneyEnvironmentResponse`\n\n```ts\ntype JourneyEnvironmentResponse = {\n  items: Array<{\n    datasourceId: string\n    type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>"\n    value: string | number | boolean | {\n      fallbackLanguage?: { ... }\n      options: { ... }\n    } | {\n      itemType: { ... }\n      fallbackLanguage?: { ... }\n      items: { ... }\n    }\n  }>\n  errors: Array<{\n    datasourceId: string\n    code: "not_found" | "unsupported_type" | "not_set" | "invalid_value" | "incompatible_consumer"\n  }>\n}\n```\n\n### `JourneyEnvironmentVariablesResponse`\n\n```ts\ntype JourneyEnvironmentVariablesResponse = {\n  items: Array<{\n    key: string\n    type: "Map" | "List<Link>"\n    value: {\n      fallbackLanguage?: { ... }\n      options: { ... }\n    } | {\n      itemType: { ... }\n      fallbackLanguage?: { ... }\n      items: { ... }\n    }\n    description?: string\n  }>\n}\n```\n\n### `GetJourneysResponse`\n\n```ts\ntype GetJourneysResponse = object\n```\n\n### `JourneyResponse`\n\n```ts\ntype JourneyResponse = {\n  createdJourney?: {\n    journeyId?: string\n    organizationId: string\n    brandId?: string\n    name: string\n    steps: Array<{\n      showStepName?: { ... }\n      title?: { ... }\n      subTitle?: { ... }\n      showStepSubtitle?: { ... }\n      showStepper?: { ... }\n      showStepperLabels?: { ... }\n      stepperType?: { ... }\n      hideNextButton?: { ... }\n      name: { ... }\n      stepId?: { ... }\n      schema: { ... }\n      uischema: { ... }\n      maxWidth?: { ... }\n    }>\n    design?: {\n      logoUrl?: { ... }\n      theme?: { ... }\n      designTokens?: { ... }\n    }\n    rules?: Array<{\n      type: { ... }\n      sourceType: { ... }\n      source: { ... }\n      target: { ... }\n    }>\n    logics?: Array<{\n      autoGeneratedId?: { ... }\n      conditions: { ... }\n      actions: { ... }\n    }>\n    logicsV4?: Record<string, {\n      id?: { ... }\n      protected?: { ... }\n      action?: { ... }\n      triggeredOn?: { ... }\n      conditions?: { ... }\n      settings?: { ... }\n    }>\n    contextSchema?: Array<{\n      id?: { ... }\n      type: { ... }\n      paramKey: { ... }\n      isRequired?: { ... }\n      shouldLoadEntity?: { ... }\n      description?: { ... }\n    }>\n    journey_type?: string\n    protected?: boolean\n    protectedEditable?: string[]\n    settings?: {\n      embedOptions?: { ... }\n      safeModeAutomation?: { ... }\n      canary?: { ... }\n      designId: { ... }\n      templateId?: { ... }\n      entityId?: { ... }\n      mappingsAutomationId?: { ... }\n      newMappings?: { ... }\n      targetedCustomer?: { ... }\n      description?: { ... }\n      organizationSettings?: { ... }\n      publicToken?: { ... }\n      runtimeEntities?: { ... }\n      filePurposes?: { ... }\n      entityTags?: { ... }\n      addressSuggestionsFileUrl?: { ... }\n      addressSuggestionsFileId?: { ... }\n      addressSuggestionsCountryCode?: { ... }\n      addressSuggestionsEnableAutoComplete?: { ... }\n      addressSuggestionsSource?: { ... }\n      addressSuggestionsEnableFreeText?: { ... }\n      useNewDesign?: { ... }\n      useAustrianLabels?: { ... }\n      enableDarkMode?: { ... }\n      accessMode?: { ... }\n      authGate?: { ... }\n      isPublished?: { ... }\n      status?: { ... }\n      isActive?: { ... }\n      savingProgress?: { ... }\n      thirdPartyCookies?: { ... }\n    }\n    validationRules?: Record<string, string | string[] | Record<string, string | string[]>>\n    _manifest?: string // uuid[]\n    createdBy?: string\n    updatedBy?: string\n    __lastModifiedAt?: string\n    createdAt: string\n    lastModifiedAt: string\n    deletedAt?: string\n    version: number\n    revisions: number\n    featureFlags?: Record<string, unknown>\n  // ...\n}\n```\n\n### `JourneyProductsResponse`\n\n```ts\ntype JourneyProductsResponse = Array<{\n  type?: string\n  _schema?: string\n  _title?: string\n  name?: string\n  _id?: string\n  _org?: string\n  code?: string\n  description?: string\n  feature?: unknown[]\n  product_images?: unknown[]\n  legal_footnote?: string\n  product_downloads?: unknown[]\n  price?: object\n}>\n```\n\n### `PatchUpdateJourneyRequest`\n\nPatch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\n\n\n```ts\ntype PatchUpdateJourneyRequest = {\n  journeyId: string // uuid\n  __lastModifiedAt?: string\n}\n```\n\n### `JourneyCreationRequest`\n\n```ts\ntype JourneyCreationRequest = {\n  journeyId?: string\n  organizationId: string\n  brandId?: string\n  name: string\n  steps: Array<{\n    showStepName?: boolean\n    title?: string\n    subTitle?: string\n    showStepSubtitle?: boolean\n    showStepper?: boolean\n    showStepperLabels?: boolean\n    stepperType?: "numbers" | "progress bar"\n    hideNextButton?: boolean\n    name: string\n    stepId?: string\n    schema: unknown\n    uischema: unknown\n    maxWidth?: "small" | "medium" | "large" | "extra large"\n  }>\n  design?: {\n    logoUrl?: string\n    theme?: Record<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n    description?: string\n  }>\n  journey_type?: string\n  protected?: boolean\n  protectedEditable?: string[]\n  settings?: {\n    embedOptions?: {\n      mode?: { ... }\n      lang?: { ... }\n      width?: { ... }\n      topBar?: { ... }\n      scrollToTop?: { ... }\n      button?: { ... }\n    }\n    safeModeAutomation?: boolean\n    canary?: boolean\n    designId: string\n    templateId?: string\n    entityId?: string\n    mappingsAutomationId?: string\n    newMappings?: boolean\n    targetedCustomer?: string\n    description?: string\n    organizationSettings?: Record<string, boolean>\n    publicToken?: string\n    runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n    filePurposes?: string[]\n    entityTags?: string[]\n    addressSuggestionsFileUrl?: string\n    addressSuggestionsFileId?: string\n    addressSuggestionsCountryCode?: string\n    addressSuggestionsEnableAutoComplete?: boolean\n    addressSuggestionsSource?: string[]\n    addressSuggestionsEnableFreeText?: boolean\n    useNewDesign?: boolean\n    useAustrianLabels?: boolean\n    enableDarkMode?: boolean\n    accessMode?: "PUBLIC" | "PRIVATE"\n    authGate?: {\n      stepId: { ... }\n    }\n    isPublished?: boolean\n    status?: string\n    isActive?: boolean\n  // ...\n}\n```\n\n### `JourneyCreationRequestV2`\n\n```ts\ntype JourneyCreationRequestV2 = {\n  journeyId?: string\n  brandId?: string\n  name: string\n  steps: Array<{\n    showStepName?: boolean\n    title?: string\n    subTitle?: string\n    showStepSubtitle?: boolean\n    showStepper?: boolean\n    showStepperLabels?: boolean\n    stepperType?: "numbers" | "progress bar"\n    hideNextButton?: boolean\n    name: string\n    stepId?: string\n    schema: unknown\n    uischema: unknown\n    maxWidth?: "small" | "medium" | "large" | "extra large"\n  }>\n  design?: {\n    logoUrl?: string\n    theme?: Record<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n    description?: string\n  }>\n  journey_type?: string\n  protected?: boolean\n  protectedEditable?: string[]\n  settings?: {\n    embedOptions?: {\n      mode?: { ... }\n      lang?: { ... }\n      width?: { ... }\n      topBar?: { ... }\n      scrollToTop?: { ... }\n      button?: { ... }\n    }\n    safeModeAutomation?: boolean\n    designId?: string\n    entityId?: string\n    mappingsAutomationId?: string\n    newMappings?: boolean\n    templateId?: string\n    targetedCustomer?: string\n    description?: string\n    publicToken?: string\n    runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n    filePurposes?: string[]\n    entityTags?: string[]\n    addressSuggestionsFileUrl?: string\n    addressSuggestionsFileId?: string\n    addressSuggestionsCountryCode?: string\n    addressSuggestionsEnableAutoComplete?: boolean\n    addressSuggestionsSource?: string[]\n    addressSuggestionsEnableFreeText?: boolean\n    useNewDesign?: boolean\n    thirdPartyCookies?: boolean\n    accessMode?: "PUBLIC" | "PRIVATE"\n    authGate?: {\n      stepId: { ... }\n    }\n    enableDarkMode?: boolean\n    useAustrianLabels?: boolean\n    isActive?: boolean\n    savingProgress?: {\n      mode?: { ... }\n      supportedRevision?: { ... }\n    }\n  // ...\n}\n```\n\n### `SearchJourneysQueryRequest`\n\n```ts\ntype SearchJourneysQueryRequest = {\n  q?: string\n  from?: number\n  size?: number\n  sort?: string\n}\n```\n\n### `SearchJourneysResponse`\n\n```ts\ntype SearchJourneysResponse = {\n  hits?: number\n  results?: Array<{\n    _id?: string // uuid\n    _schema?: string\n    _title?: string\n    _org?: string\n    _created_at?: string // date-time\n    _updated_at?: string // date-time\n    _tags?: string[]\n    _manifest?: string // uuid[]\n    journey_name?: string\n    journey_id?: string // uuid\n    journey_type?: string\n    design?: string\n    created_by?: Array<{\n      id?: { ... }\n    }>\n    journey_version?: "Flex"\n  }>\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n  journeyId?: string\n  organizationId: string\n  brandId?: string\n  name: string\n  steps: Array<{\n    showStepName?: boolean\n    title?: string\n    subTitle?: string\n    showStepSubtitle?: boolean\n    showStepper?: boolean\n    showStepperLabels?: boolean\n    stepperType?: "numbers" | "progress bar"\n    hideNextButton?: boolean\n    name: string\n    stepId?: string\n    schema: unknown\n    uischema: unknown\n    maxWidth?: "small" | "medium" | "large" | "extra large"\n  }>\n  design?: {\n    logoUrl?: string\n    theme?: Record<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n    description?: string\n  }>\n  journey_type?: string\n  protected?: boolean\n  protectedEditable?: string[]\n  settings?: {\n    embedOptions?: {\n      mode?: { ... }\n      lang?: { ... }\n      width?: { ... }\n      topBar?: { ... }\n      scrollToTop?: { ... }\n      button?: { ... }\n    }\n    safeModeAutomation?: boolean\n    canary?: boolean\n    designId: string\n    templateId?: string\n    entityId?: string\n    mappingsAutomationId?: string\n    newMappings?: boolean\n    targetedCustomer?: string\n    description?: string\n    organizationSettings?: Record<string, boolean>\n    publicToken?: string\n    runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n    filePurposes?: string[]\n    entityTags?: string[]\n    addressSuggestionsFileUrl?: string\n    addressSuggestionsFileId?: string\n    addressSuggestionsCountryCode?: string\n    addressSuggestionsEnableAutoComplete?: boolean\n    addressSuggestionsSource?: string[]\n    addressSuggestionsEnableFreeText?: boolean\n    useNewDesign?: boolean\n    useAustrianLabels?: boolean\n    enableDarkMode?: boolean\n    accessMode?: "PUBLIC" | "PRIVATE"\n    authGate?: {\n      stepId: { ... }\n    }\n    isPublished?: boolean\n    status?: string\n    isActive?: boolean\n  // ...\n}\n```\n\n### `JourneyServedRevision`\n\nWhich revision the runtime read served: the requested one, or the published version when no revision was requested. Absent while the journey has not adopted versioning and on legacy `version` reads.\n\n\n```ts\ntype JourneyServedRevision = {\n  revision_id?: string\n}\n```\n\n### `JourneyActivationGuarantee`\n\nJourneys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.\n\n\n```ts\ntype JourneyActivationGuarantee = {\n  settings: {\n    isActive: boolean\n  }\n}\n```\n\n### `JourneyFeatureFlags`\n\n```ts\ntype JourneyFeatureFlags = {\n  featureFlags?: Record<string, unknown>\n}\n```\n\n### `JourneyAuditInfo`\n\n```ts\ntype JourneyAuditInfo = {\n  createdAt: string\n  lastModifiedAt: string\n  deletedAt?: string\n  version: number\n  revisions: number\n}\n```\n\n### `JourneyRevisionRequest`\n\nThe complete journey configuration a revision is created from, same shape as the `PUT` body. Server-managed attributes of the journey record (`revisions`, `version`, publish metadata) are ignored.\n\n\n```ts\ntype JourneyRevisionRequest = {\n  journeyId?: string\n  organizationId: string\n  brandId?: string\n  name: string\n  steps: Array<{\n    showStepName?: boolean\n    title?: string\n    subTitle?: string\n    showStepSubtitle?: boolean\n    showStepper?: boolean\n    showStepperLabels?: boolean\n    stepperType?: "numbers" | "progress bar"\n    hideNextButton?: boolean\n    name: string\n    stepId?: string\n    schema: unknown\n    uischema: unknown\n    maxWidth?: "small" | "medium" | "large" | "extra large"\n  }>\n  design?: {\n    logoUrl?: string\n    theme?: Record<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n    description?: string\n  }>\n  journey_type?: string\n  protected?: boolean\n  protectedEditable?: string[]\n  settings?: {\n    embedOptions?: {\n      mode?: { ... }\n      lang?: { ... }\n      width?: { ... }\n      topBar?: { ... }\n      scrollToTop?: { ... }\n      button?: { ... }\n    }\n    safeModeAutomation?: boolean\n    canary?: boolean\n    designId: string\n    templateId?: string\n    entityId?: string\n    mappingsAutomationId?: string\n    newMappings?: boolean\n    targetedCustomer?: string\n    description?: string\n    organizationSettings?: Record<string, boolean>\n    publicToken?: string\n    runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n    filePurposes?: string[]\n    entityTags?: string[]\n    addressSuggestionsFileUrl?: string\n    addressSuggestionsFileId?: string\n    addressSuggestionsCountryCode?: string\n    addressSuggestionsEnableAutoComplete?: boolean\n    addressSuggestionsSource?: string[]\n    addressSuggestionsEnableFreeText?: boolean\n    useNewDesign?: boolean\n    useAustrianLabels?: boolean\n    enableDarkMode?: boolean\n    accessMode?: "PUBLIC" | "PRIVATE"\n    authGate?: {\n      stepId: { ... }\n    }\n    isPublished?: boolean\n    status?: string\n    isActive?: boolean\n  // ...\n}\n```\n\n### `PublishRevisionRequest`\n\n```ts\ntype PublishRevisionRequest = {\n  revision_id: string\n  name?: string\n  description?: string\n}\n```\n\n### `JourneyRevisionSummary`\n\n```ts\ntype JourneyRevisionSummary = {\n  revision_id: string\n  created_at: string // date-time\n  created_by?: string\n  name?: string\n  description?: string\n  published_at?: string // date-time\n  is_published: boolean\n  mapping_config_version?: number\n}\n```\n\n### `JourneyRevisionList`\n\n```ts\ntype JourneyRevisionList = {\n  results: Array<{\n    revision_id: string\n    created_at: string // date-time\n    created_by?: string\n    name?: string\n    description?: string\n    published_at?: string // date-time\n    is_published: boolean\n    mapping_config_version?: number\n  }>\n  next_cursor?: string\n}\n```\n\n### `JourneyRevision`\n\n```ts\ntype JourneyRevision = {\n  revision_id: string\n  created_at: string // date-time\n  created_by?: string\n  name?: string\n  description?: string\n  published_at?: string // date-time\n  is_published: boolean\n  mapping_config_version?: number\n  configuration: {\n    journeyId?: string\n    organizationId: string\n    brandId?: string\n    name: string\n    steps: Array<{\n      showStepName?: { ... }\n      title?: { ... }\n      subTitle?: { ... }\n      showStepSubtitle?: { ... }\n      showStepper?: { ... }\n      showStepperLabels?: { ... }\n      stepperType?: { ... }\n      hideNextButton?: { ... }\n      name: { ... }\n      stepId?: { ... }\n      schema: { ... }\n      uischema: { ... }\n      maxWidth?: { ... }\n    }>\n    design?: {\n      logoUrl?: { ... }\n      theme?: { ... }\n      designTokens?: { ... }\n    }\n    rules?: Array<{\n      type: { ... }\n      sourceType: { ... }\n      source: { ... }\n      target: { ... }\n    }>\n    logics?: Array<{\n      autoGeneratedId?: { ... }\n      conditions: { ... }\n      actions: { ... }\n    }>\n    logicsV4?: Record<string, {\n      id?: { ... }\n      protected?: { ... }\n      action?: { ... }\n      triggeredOn?: { ... }\n      conditions?: { ... }\n      settings?: { ... }\n    }>\n    contextSchema?: Array<{\n      id?: { ... }\n      type: { ... }\n      paramKey: { ... }\n      isRequired?: { ... }\n      shouldLoadEntity?: { ... }\n      description?: { ... }\n    }>\n    journey_type?: string\n    protected?: boolean\n    protectedEditable?: string[]\n    settings?: {\n      embedOptions?: { ... }\n      safeModeAutomation?: { ... }\n      canary?: { ... }\n      designId: { ... }\n      templateId?: { ... }\n      entityId?: { ... }\n      mappingsAutomationId?: { ... }\n      newMappings?: { ... }\n      targetedCustomer?: { ... }\n      description?: { ... }\n      organizationSettings?: { ... }\n      publicToken?: { ... }\n      runtimeEntities?: { ... }\n      filePurposes?: { ... }\n      entityTags?: { ... }\n      addressSuggestionsFileUrl?: { ... }\n      addressSuggestionsFileId?: { ... }\n      addressSuggestionsCountryCode?: { ... }\n      addressSuggestionsEnableAutoComplete?: { ... }\n      addressSuggestionsSource?: { ... }\n      addressSuggestionsEnableFreeText?: { ... }\n      useNewDesign?: { ... }\n      useAustrianLabels?: { ... }\n      enableDarkMode?: { ... }\n      accessMode?: { ... }\n      authGate?: { ... }\n      isPublished?: { ... }\n      status?: { ... }\n      isActive?: { ... }\n      savingProgress?: { ... }\n      thirdPartyCookies?: { ... }\n    }\n    validationRules?: Record<string, string | string[] | Record<string, string | string[]>>\n    _manifest?: string // uuid[]\n    createdBy?: string\n  // ...\n}\n```\n\n### `JourneyRevisionConflict`\n\n```ts\ntype JourneyRevisionConflict = {\n  message: string\n  latest_revision: {\n    revision_id: string\n    created_at: string // date-time\n    created_by?: string\n    name?: string\n    description?: string\n    published_at?: string // date-time\n    is_published: boolean\n    mapping_config_version?: number\n  }\n}\n```\n\n### `JourneyPublishState`\n\n```ts\ntype JourneyPublishState = {\n  journey_id: string // uuid\n  published_revision_id: string\n  published_at?: string // date-time\n  published_by?: string\n}\n```\n\n### `PublishResult`\n\n```ts\ntype PublishResult = {\n  revision_id: string\n  name: string\n  published_at: string // date-time\n  published_by?: string\n  post_publish_warnings: string[]\n}\n```\n\n### `JourneyValidationResponse`\n\n```ts\ntype JourneyValidationResponse = {\n  valid: boolean\n  errors: Array<{\n    type?: string\n    severity?: "critical" | "high" | "medium" | "low"\n    message?: string\n    affectedStepIds?: string[]\n    count?: number\n    autoFix?: {\n      feasible?: { ... }\n      confidence?: { ... }\n      reason?: { ... }\n      details?: { ... }\n    }\n  }>\n  warnings?: Array<{\n    type?: string\n    message?: string\n  }>\n}\n```\n\n### `JourneyValidationError`\n\n```ts\ntype JourneyValidationError = {\n  error: string\n  message: string\n  details: Array<{\n    pattern?: string\n    severity?: "critical" | "high" | "medium" | "low"\n    message?: string\n    count?: number\n  }>\n}\n```\n\n### `S3Reference`\n\n```ts\ntype S3Reference = {\n  bucket: string\n  key: string\n}\n```\n\n### `TemplateSettings`\n\nTemplate Settings for document generation\n\n```ts\ntype TemplateSettings = {\n  custom_margins?: {\n    top?: number\n    bottom?: number\n  }\n  suggested_margins?: {\n    top?: number\n    bottom?: number\n  }\n  display_margin_guidelines?: boolean\n  enable_data_table_margin_autofix?: boolean\n  template_with_datatable?: boolean\n  enabled_template_settings_persistence?: boolean\n  misconfigured_margins?: boolean\n  file_entity_id?: string // uuid\n}\n```\n\n### `GenerateDocumentResponse`\n\n```ts\ntype GenerateDocumentResponse = {\n  job_id?: string // uuid\n  job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED"\n  message?: string\n  pdf_output?: {\n    preview_url?: string\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  docx_output?: {\n    preview_url?: string\n    output_document?: {\n      filename?: { ... }\n      s3ref?: { ... }\n    }\n  }\n  variable_payload?: {\n    additionalProperties?: string\n  }\n  template_settings?: {\n    custom_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    suggested_margins?: {\n      top?: { ... }\n      bottom?: { ... }\n    }\n    display_margin_guidelines?: boolean\n    enable_data_table_margin_autofix?: boolean\n    template_with_datatable?: boolean\n    enabled_template_settings_persistence?: boolean\n    misconfigured_margins?: boolean\n    file_entity_id?: string // uuid\n  }\n}\n```\n\n### `GenerateDocumentRequest`\n\n```ts\ntype GenerateDocumentRequest = {\n  file_id: string\n  context_data: {\n    additionalProperties?: string\n  }\n  context_entity_id?: string // uuid\n  language?: string\n}\n```\n\n### `GetSettingsForJourney`\n\n```ts\ntype GetSettingsForJourney = {\n  organizationId?: string\n  canary?: boolean\n  thirdPartyCookies?: boolean\n}\n```\n\n### `ButtonOption`\n\nA single button option data\n\n```ts\ntype ButtonOption = {\n  value?: string\n  label?: string\n}\n```\n\n### `ValidationRuleRef`\n\nReferences to validation rules organized by blocks and fields.\nMaps block IDs to either one or more ordered rule IDs (for block-level rules)\nor rule references (for field-level rules).\n\n\n```ts\ntype ValidationRuleRef = Record<string, string | string[] | Record<string, string | string[]>>\n```\n\n### `RuleRef`\n\nField-level rule references within a block.\nMaps field names to one or more ordered rule IDs.\n\n\n```ts\ntype RuleRef = Record<string, string | string[]>\n```\n';
+
+
+exports.default = journey_default;

package/dist/{journey.d-DvwLALwc.d.cts → journey.d-Dj93v-Lw.d.cts}

@@ -22,6 +22,39 @@ declare namespace Components {
              */
             label?: string;
         }
+        /**
+         * One link a customer clicks. `label` and `description` are each either a
+         * plain string or one string per language, deciding that independently.
+         * Mirrors environments-api's `LinkFields`.
+         *
+         */
+        export interface EnvironmentLink {
+            url: string;
+            label: string | {
+                [name: string]: string;
+            };
+            description?: string | {
+                [name: string]: string;
+            };
+        }
+        /**
+         * A list of links, served under this service's own `List<Link>` type
+         * token. environments-api types the variable `List` and declares the
+         * element type inside the value; journey-api composes the two so a
+         * consumer needs only one discriminant.
+         *
+         */
+        export interface EnvironmentLinkList {
+            itemType: "Link";
+            fallbackLanguage?: string;
+            items: /**
+             * One link a customer clicks. `label` and `description` are each either a
+             * plain string or one string per language, deciding that independently.
+             * Mirrors environments-api's `LinkFields`.
+             *
+             */
+            EnvironmentLink[];
+        }
         export interface EnvironmentMap {
             fallbackLanguage?: string;
             options: EnvironmentMapEntry[];
@@ -990,8 +1023,15 @@ declare namespace Components {
         export interface JourneyEnvironmentResponse {
             items: {
                 datasourceId: string;
-                type: "Text" | "Number" | "Boolean" | "Map";
-                value: string | number | boolean | EnvironmentMap;
+                type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>";
+                value: string | number | boolean | EnvironmentMap | /**
+                 * A list of links, served under this service's own `List<Link>` type
+                 * token. environments-api types the variable `List` and declares the
+                 * element type inside the value; journey-api composes the two so a
+                 * consumer needs only one discriminant.
+                 *
+                 */
+                EnvironmentLinkList;
             }[];
             errors: {
                 datasourceId: string;
@@ -1001,8 +1041,15 @@ declare namespace Components {
         export interface JourneyEnvironmentVariablesResponse {
             items: {
                 key: string;
-                type: "Map";
-                value: EnvironmentMap;
+                type: "Map" | "List<Link>";
+                value: EnvironmentMap | /**
+                 * A list of links, served under this service's own `List<Link>` type
+                 * token. environments-api types the variable `List` and declares the
+                 * element type inside the value; journey-api composes the two so a
+                 * consumer needs only one discriminant.
+                 *
+                 */
+                EnvironmentLinkList;
                 description?: string;
             }[];
         }
@@ -3777,6 +3824,8 @@ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 
 type ButtonOption = Components.Schemas.ButtonOption;
+type EnvironmentLink = Components.Schemas.EnvironmentLink;
+type EnvironmentLinkList = Components.Schemas.EnvironmentLinkList;
 type EnvironmentMap = Components.Schemas.EnvironmentMap;
 type EnvironmentMapEntry = Components.Schemas.EnvironmentMapEntry;
 type GenerateDocumentRequest = Components.Schemas.GenerateDocumentRequest;
@@ -3812,4 +3861,4 @@ type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
 type TemplateSettings = Components.Schemas.TemplateSettings;
 type ValidationRuleRef = Components.Schemas.ValidationRuleRef;
 
-export { type PublishRevisionRequest as A, type ButtonOption as B, type Client as C, type SearchJourneysQueryRequest as D, type EnvironmentMap as E, type SearchJourneysResponse as F, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentMapEntry as c, type GenerateDocumentResponse as d, type GetJourneysResponse as e, GetSettingsForJourney as f, type JourneyActivationGuarantee as g, type JourneyAuditInfo as h, type JourneyCreationRequest as i, type JourneyCreationRequestV2 as j, type JourneyEnvironmentResponse as k, type JourneyEnvironmentVariablesResponse as l, type JourneyFeatureFlags as m, type JourneyProductsResponse as n, type JourneyPublishState as o, type JourneyResponse as p, type JourneyRevision as q, type JourneyRevisionConflict as r, type JourneyRevisionList as s, type JourneyRevisionRequest as t, type JourneyRevisionSummary as u, type JourneyServedRevision as v, type JourneyValidationError as w, type JourneyValidationResponse as x, type PatchUpdateJourneyRequest as y, type PublishResult as z };
+export { type PatchUpdateJourneyRequest as A, type ButtonOption as B, type Client as C, type PublishResult as D, type EnvironmentLink as E, type PublishRevisionRequest as F, type GenerateDocumentRequest as G, type SearchJourneysQueryRequest as H, type SearchJourneysResponse as I, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentLinkList as c, type EnvironmentMap as d, type EnvironmentMapEntry as e, type GenerateDocumentResponse as f, type GetJourneysResponse as g, GetSettingsForJourney as h, type JourneyActivationGuarantee as i, type JourneyAuditInfo as j, type JourneyCreationRequest as k, type JourneyCreationRequestV2 as l, type JourneyEnvironmentResponse as m, type JourneyEnvironmentVariablesResponse as n, type JourneyFeatureFlags as o, type JourneyProductsResponse as p, type JourneyPublishState as q, type JourneyResponse as r, type JourneyRevision as s, type JourneyRevisionConflict as t, type JourneyRevisionList as u, type JourneyRevisionRequest as v, type JourneyRevisionSummary as w, type JourneyServedRevision as x, type JourneyValidationError as y, type JourneyValidationResponse as z };

package/dist/{journey.d-DvwLALwc.d.ts → journey.d-Dj93v-Lw.d.ts}

@@ -22,6 +22,39 @@ declare namespace Components {
              */
             label?: string;
         }
+        /**
+         * One link a customer clicks. `label` and `description` are each either a
+         * plain string or one string per language, deciding that independently.
+         * Mirrors environments-api's `LinkFields`.
+         *
+         */
+        export interface EnvironmentLink {
+            url: string;
+            label: string | {
+                [name: string]: string;
+            };
+            description?: string | {
+                [name: string]: string;
+            };
+        }
+        /**
+         * A list of links, served under this service's own `List<Link>` type
+         * token. environments-api types the variable `List` and declares the
+         * element type inside the value; journey-api composes the two so a
+         * consumer needs only one discriminant.
+         *
+         */
+        export interface EnvironmentLinkList {
+            itemType: "Link";
+            fallbackLanguage?: string;
+            items: /**
+             * One link a customer clicks. `label` and `description` are each either a
+             * plain string or one string per language, deciding that independently.
+             * Mirrors environments-api's `LinkFields`.
+             *
+             */
+            EnvironmentLink[];
+        }
         export interface EnvironmentMap {
             fallbackLanguage?: string;
             options: EnvironmentMapEntry[];
@@ -990,8 +1023,15 @@ declare namespace Components {
         export interface JourneyEnvironmentResponse {
             items: {
                 datasourceId: string;
-                type: "Text" | "Number" | "Boolean" | "Map";
-                value: string | number | boolean | EnvironmentMap;
+                type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>";
+                value: string | number | boolean | EnvironmentMap | /**
+                 * A list of links, served under this service's own `List<Link>` type
+                 * token. environments-api types the variable `List` and declares the
+                 * element type inside the value; journey-api composes the two so a
+                 * consumer needs only one discriminant.
+                 *
+                 */
+                EnvironmentLinkList;
             }[];
             errors: {
                 datasourceId: string;
@@ -1001,8 +1041,15 @@ declare namespace Components {
         export interface JourneyEnvironmentVariablesResponse {
             items: {
                 key: string;
-                type: "Map";
-                value: EnvironmentMap;
+                type: "Map" | "List<Link>";
+                value: EnvironmentMap | /**
+                 * A list of links, served under this service's own `List<Link>` type
+                 * token. environments-api types the variable `List` and declares the
+                 * element type inside the value; journey-api composes the two so a
+                 * consumer needs only one discriminant.
+                 *
+                 */
+                EnvironmentLinkList;
                 description?: string;
             }[];
         }
@@ -3777,6 +3824,8 @@ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 
 type ButtonOption = Components.Schemas.ButtonOption;
+type EnvironmentLink = Components.Schemas.EnvironmentLink;
+type EnvironmentLinkList = Components.Schemas.EnvironmentLinkList;
 type EnvironmentMap = Components.Schemas.EnvironmentMap;
 type EnvironmentMapEntry = Components.Schemas.EnvironmentMapEntry;
 type GenerateDocumentRequest = Components.Schemas.GenerateDocumentRequest;
@@ -3812,4 +3861,4 @@ type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
 type TemplateSettings = Components.Schemas.TemplateSettings;
 type ValidationRuleRef = Components.Schemas.ValidationRuleRef;
 
-export { type PublishRevisionRequest as A, type ButtonOption as B, type Client as C, type SearchJourneysQueryRequest as D, type EnvironmentMap as E, type SearchJourneysResponse as F, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentMapEntry as c, type GenerateDocumentResponse as d, type GetJourneysResponse as e, GetSettingsForJourney as f, type JourneyActivationGuarantee as g, type JourneyAuditInfo as h, type JourneyCreationRequest as i, type JourneyCreationRequestV2 as j, type JourneyEnvironmentResponse as k, type JourneyEnvironmentVariablesResponse as l, type JourneyFeatureFlags as m, type JourneyProductsResponse as n, type JourneyPublishState as o, type JourneyResponse as p, type JourneyRevision as q, type JourneyRevisionConflict as r, type JourneyRevisionList as s, type JourneyRevisionRequest as t, type JourneyRevisionSummary as u, type JourneyServedRevision as v, type JourneyValidationError as w, type JourneyValidationResponse as x, type PatchUpdateJourneyRequest as y, type PublishResult as z };
+export { type PatchUpdateJourneyRequest as A, type ButtonOption as B, type Client as C, type PublishResult as D, type EnvironmentLink as E, type PublishRevisionRequest as F, type GenerateDocumentRequest as G, type SearchJourneysQueryRequest as H, type SearchJourneysResponse as I, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentLinkList as c, type EnvironmentMap as d, type EnvironmentMapEntry as e, type GenerateDocumentResponse as f, type GetJourneysResponse as g, GetSettingsForJourney as h, type JourneyActivationGuarantee as i, type JourneyAuditInfo as j, type JourneyCreationRequest as k, type JourneyCreationRequestV2 as l, type JourneyEnvironmentResponse as m, type JourneyEnvironmentVariablesResponse as n, type JourneyFeatureFlags as o, type JourneyProductsResponse as p, type JourneyPublishState as q, type JourneyResponse as r, type JourneyRevision as s, type JourneyRevisionConflict as t, type JourneyRevisionList as u, type JourneyRevisionRequest as v, type JourneyRevisionSummary as w, type JourneyServedRevision as x, type JourneyValidationError as y, type JourneyValidationResponse as z };

package/docs/journey.md

@@ -54,6 +54,8 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
 **Schemas**
 - [`EnvironmentMapEntry`](#environmentmapentry)
 - [`EnvironmentMap`](#environmentmap)
+- [`EnvironmentLink`](#environmentlink)
+- [`EnvironmentLinkList`](#environmentlinklist)
 - [`JourneyEnvironmentResponse`](#journeyenvironmentresponse)
 - [`JourneyEnvironmentVariablesResponse`](#journeyenvironmentvariablesresponse)
 - [`GetJourneysResponse`](#getjourneysresponse)
@@ -2198,16 +2200,55 @@ type EnvironmentMap = {
 }
 ```
 
+### `EnvironmentLink`
+
+One link a customer clicks. `label` and `description` are each either a
+plain string or one string per language, deciding that independently.
+Mirrors environments-api's `LinkFields`.
+
+
+```ts
+type EnvironmentLink = {
+  url: string
+  label: string | Record<string, string>
+  description?: string | Record<string, string>
+}
+```
+
+### `EnvironmentLinkList`
+
+A list of links, served under this service's own `List`<Link>`` type
+token. environments-api types the variable `List` and declares the
+element type inside the value; journey-api composes the two so a
+consumer needs only one discriminant.
+
+
+```ts
+type EnvironmentLinkList = {
+  itemType: "Link"
+  fallbackLanguage?: string
+  items: Array<{
+    url: string
+    label: string | Record<string, string>
+    description?: string | Record<string, string>
+  }>
+}
+```
+
 ### `JourneyEnvironmentResponse`
 
 ```ts
 type JourneyEnvironmentResponse = {
   items: Array<{
     datasourceId: string
-    type: "Text" | "Number" | "Boolean" | "Map"
+    type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>"
     value: string | number | boolean | {
       fallbackLanguage?: { ... }
       options: { ... }
+    } | {
+      itemType: { ... }
+      fallbackLanguage?: { ... }
+      items: { ... }
     }
   }>
   errors: Array<{
@@ -2223,10 +2264,14 @@ type JourneyEnvironmentResponse = {
 type JourneyEnvironmentVariablesResponse = {
   items: Array<{
     key: string
-    type: "Map"
+    type: "Map" | "List<Link>"
     value: {
       fallbackLanguage?: { ... }
       options: { ... }
+    } | {
+      itemType: { ... }
+      fallbackLanguage?: { ... }
+      items: { ... }
     }
     description?: string
   }>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.25",
+  "version": "2.20.26",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",