From 3e1a032a59126efc16560341555f0c1dba3a4318 Mon Sep 17 00:00:00 2001 From: Viljami + Claude Date: Fri, 15 May 2026 12:04:52 +0000 Subject: [PATCH 1/2] chore(journey-client): add version query param to getJourney and getJourneyV2 Sync journey-client with journey-api v1.4.2 spec. The version parameter fetches historical DynamoDB snapshots (0 = live row, positive integers = historical versions). Slack: https://epilot.slack.com/archives/C0ADDKKTLVD/p1778846228348419 https://claude.ai/code/session_01NdLLRTB2abkToYRMzJ4EkE Co-authored-by: Claude --- .../journey-client/src/openapi-runtime.json | 10 +++++++++ clients/journey-client/src/openapi.d.ts | 12 +++++++--- clients/journey-client/src/openapi.json | 22 ++++++++++++++++++- packages/epilot-sdk-v2/docs/journey.md | 2 ++ .../src/definitions/journey-runtime.json | 2 +- packages/epilot-sdk-v2/src/docs/journey.json | 2 +- packages/epilot-sdk-v2/src/types/journey.d.ts | 12 +++++++--- 7 files changed, 53 insertions(+), 9 deletions(-) diff --git a/clients/journey-client/src/openapi-runtime.json b/clients/journey-client/src/openapi-runtime.json index 9765cd9d..8ca9e5c3 100644 --- a/clients/journey-client/src/openapi-runtime.json +++ b/clients/journey-client/src/openapi-runtime.json @@ -32,6 +32,11 @@ "in": "path", "required": true }, + { + "name": "version", + "in": "query", + "required": false + }, { "name": "source", "in": "query", @@ -202,6 +207,11 @@ "name": "id", "in": "path", "required": true + }, + { + "name": "version", + "in": "query", + "required": false } ], "responses": {} diff --git a/clients/journey-client/src/openapi.d.ts b/clients/journey-client/src/openapi.d.ts index 2eb8539d..7a5ace80 100644 --- a/clients/journey-client/src/openapi.d.ts +++ b/clients/journey-client/src/openapi.d.ts @@ -1298,6 +1298,7 @@ declare namespace Paths { export type Id = string; // uuid export type OrgId = string; export type Source = string; + export type Version = number; } export interface PathParameters { id: /** @@ -1307,6 +1308,7 @@ declare namespace Paths { Parameters.Id /* uuid */; } export interface QueryParameters { + version?: Parameters.Version; source?: Parameters.Source; orgId?: Parameters.OrgId; } @@ -1352,6 +1354,7 @@ declare namespace Paths { * 509cdffe-424f-457a-95c2-9708c304ce77 */ export type Id = string; // uuid + export type Version = number; } export interface PathParameters { id: /** @@ -1360,6 +1363,9 @@ declare namespace Paths { */ Parameters.Id /* uuid */; } + export interface QueryParameters { + version?: Parameters.Version; + } namespace Responses { export type $200 = Components.Schemas.JourneyCreationRequestV2; } @@ -1672,13 +1678,13 @@ export interface OperationMethods { ): OperationResponse /** * getJourneyV2 - getJourneyV2 - * + * * Get journey by id */ 'getJourneyV2'( - parameters?: Parameters | null, + parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig + config?: AxiosRequestConfig ): OperationResponse /** * removeJourneyV2 - removeJourneyV2 diff --git a/clients/journey-client/src/openapi.json b/clients/journey-client/src/openapi.json index 64b6b0aa..07bcf99a 100644 --- a/clients/journey-client/src/openapi.json +++ b/clients/journey-client/src/openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Journey API", "description": "API to configure journeys", - "version": "1.4.1" + "version": "1.4.2" }, "security": [ { @@ -114,6 +114,16 @@ "example": "509cdffe-424f-457a-95c2-9708c304ce77" } }, + { + "name": "version", + "in": "query", + "description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.", + "required": false, + "schema": { + "type": "integer", + "default": 0 + } + }, { "name": "source", "in": "query", @@ -708,6 +718,16 @@ "format": "uuid", "example": "509cdffe-424f-457a-95c2-9708c304ce77" } + }, + { + "name": "version", + "in": "query", + "description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.", + "required": false, + "schema": { + "type": "integer", + "default": 0 + } } ], "responses": { diff --git a/packages/epilot-sdk-v2/docs/journey.md b/packages/epilot-sdk-v2/docs/journey.md index e5d97b2e..0c48d20d 100644 --- a/packages/epilot-sdk-v2/docs/journey.md +++ b/packages/epilot-sdk-v2/docs/journey.md @@ -100,6 +100,7 @@ Get journey by id. Private journeys requires valid private token to be passed ```ts const { data } = await client.getJourney({ id: '123e4567-e89b-12d3-a456-426614174000', + version: 1, source: 'example', orgId: 'example', }) @@ -1432,6 +1433,7 @@ Get journey by id ```ts const { data } = await client.getJourneyV2({ id: '123e4567-e89b-12d3-a456-426614174000', + version: 1, }) ``` diff --git a/packages/epilot-sdk-v2/src/definitions/journey-runtime.json b/packages/epilot-sdk-v2/src/definitions/journey-runtime.json index 35d0075c..104e6e21 100644 --- a/packages/epilot-sdk-v2/src/definitions/journey-runtime.json +++ b/packages/epilot-sdk-v2/src/definitions/journey-runtime.json @@ -1 +1 @@ -{"s":"https://journey-config.sls.epilot.io","o":[["getJourneysByOrgId","get","/v1/journey/organization/{id}",[["id","p",true],["hydrate","q"]]],["getJourney","get","/v1/journey/configuration/{id}",[["id","p",true],["source","q"],["orgId","q"]]],["removeJourney","delete","/v1/journey/configuration/{id}",[["id","p",true]]],["getJourneyProducts","get","/v1/journey/products/{id}",[["id","p",true],["source","q"],["postal_code","q"],["city","q"],["street","q"],["street_number","q"]]],["createJourney","post","/v1/journey/configuration",[["skipAutomation","q"]],1],["updateJourney","put","/v1/journey/configuration",null,1],["patchUpdateJourney","patch","/v1/journey/configuration",null,1],["searchJourneys","post","/v1/journey/configuration/search",null,1],["generateDocument","post","/v1/journey/document:generate",null,1],["createJourneyV2","post","/v2/journey/configuration",[["skipAutomation","q"]],1],["updateJourneyV2","put","/v2/journey/configuration",null,1],["patchUpdateJourneyV2","patch","/v2/journey/configuration",null,1],["getJourneyV2","get","/v2/journey/configuration/{id}",[["id","p",true]]],["removeJourneyV2","delete","/v2/journey/configuration/{id}",[["id","p",true]]],["getSettingsForJourney","get","/v1/journey/{id}/settings",[["id","p",true]]],["getButtonOptions","get","/v1/journey/button-options",[["fileId","q",true]]]],"v":"3.0.0"} \ No newline at end of file +{"s":"https://journey-config.sls.epilot.io","o":[["getJourneysByOrgId","get","/v1/journey/organization/{id}",[["id","p",true],["hydrate","q"]]],["getJourney","get","/v1/journey/configuration/{id}",[["id","p",true],["version","q"],["source","q"],["orgId","q"]]],["removeJourney","delete","/v1/journey/configuration/{id}",[["id","p",true]]],["getJourneyProducts","get","/v1/journey/products/{id}",[["id","p",true],["source","q"],["postal_code","q"],["city","q"],["street","q"],["street_number","q"]]],["createJourney","post","/v1/journey/configuration",[["skipAutomation","q"]],1],["updateJourney","put","/v1/journey/configuration",null,1],["patchUpdateJourney","patch","/v1/journey/configuration",null,1],["searchJourneys","post","/v1/journey/configuration/search",null,1],["generateDocument","post","/v1/journey/document:generate",null,1],["createJourneyV2","post","/v2/journey/configuration",[["skipAutomation","q"]],1],["updateJourneyV2","put","/v2/journey/configuration",null,1],["patchUpdateJourneyV2","patch","/v2/journey/configuration",null,1],["getJourneyV2","get","/v2/journey/configuration/{id}",[["id","p",true],["version","q"]]],["removeJourneyV2","delete","/v2/journey/configuration/{id}",[["id","p",true]]],["getSettingsForJourney","get","/v1/journey/{id}/settings",[["id","p",true]]],["getButtonOptions","get","/v1/journey/button-options",[["fileId","q",true]]]],"v":"3.0.0"} \ No newline at end of file diff --git a/packages/epilot-sdk-v2/src/docs/journey.json b/packages/epilot-sdk-v2/src/docs/journey.json index 936ae65c..ec9d7231 100644 --- a/packages/epilot-sdk-v2/src/docs/journey.json +++ b/packages/epilot-sdk-v2/src/docs/journey.json @@ -1 +1 @@ -"# 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(() => '')\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, () => '')\nconst { data } = await journeyClient.getJourneysByOrgId(...)\n```\n\n## Operations\n\n**Journeys**\n- [`getJourneysByOrgId`](#getjourneysbyorgid)\n- [`getJourney`](#getjourney)\n- [`removeJourney`](#removejourney)\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- [`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- [`JourneyFeatureFlags`](#journeyfeatureflags)\n- [`JourneyAuditInfo`](#journeyauditinfo)\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
\nResponse\n\n```json\n{}\n```\n\n
\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 source: 'example',\n orgId: 'example',\n})\n```\n\n
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\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 \"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 \"isPublished\": true,\n \"status\": \"string\",\n \"isActive\": true,\n \"savingProgress\": {\n \"savingMode\": \"auto\",\n \"supportedVersion\": 0\n },\n \"thirdPartyCookies\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\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
\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### `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
\nResponse\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
\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 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 }\n ],\n journey_type: 'Sales template (Premium)',\n protected: true,\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 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 isPublished: true,\n status: 'string',\n isActive: true,\n savingProgress: {\n savingMode: 'auto',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: 'rule123',\n block2: {\n field1: 'rule456',\n field2: 'rule789'\n }\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n createdBy: 'string',\n updatedBy: 'string',\n __lastModifiedAt: 'string'\n },\n)\n```\n\n
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\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 \"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 \"isPublished\": true,\n \"status\": \"string\",\n \"isActive\": true,\n \"savingProgress\": {\n \"savingMode\": \"auto\",\n \"supportedVersion\": 0\n },\n \"thirdPartyCookies\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\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
\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 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 }\n ],\n journey_type: 'Sales template (Premium)',\n protected: true,\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 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 isPublished: true,\n status: 'string',\n isActive: true,\n savingProgress: {\n savingMode: 'auto',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: 'rule123',\n block2: {\n field1: 'rule456',\n field2: 'rule789'\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
\nResponse\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 \"settings\": {\n \"embedOptions\": {},\n \"safeModeAutomation\": true,\n \"canary\": true,\n \"designId\": \"string\",\n \"templateId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"isPublished\": true,\n \"status\": \"string\",\n \"isActive\": true,\n \"savingProgress\": {},\n \"thirdPartyCookies\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {}\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
\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
\nResponse\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
\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 language: 'de'\n },\n)\n```\n\n
\nResponse\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
\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 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 }\n ],\n journey_type: 'Sales template (Premium)',\n protected: true,\n settings: {\n embedOptions: {\n mode: 'full-screen',\n lang: 'de',\n width: 'string',\n topBar: true,\n scrollToTop: true,\n button: {\n text: 'string',\n align: 'left'\n }\n },\n safeModeAutomation: true,\n designId: 'string',\n entityId: 'string',\n mappingsAutomationId: 'string',\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 enableDarkMode: true\n },\n validationRules: {\n block1: 'rule123',\n block2: {\n field1: 'rule456',\n field2: 'rule789'\n }\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\n \"settings\": {\n \"embedOptions\": {\n \"mode\": \"full-screen\",\n \"lang\": \"de\",\n \"width\": \"string\",\n \"topBar\": true,\n \"scrollToTop\": true,\n \"button\": {\n \"text\": \"string\",\n \"align\": \"left\"\n }\n },\n \"safeModeAutomation\": true,\n \"designId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"enableDarkMode\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\n }\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\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 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 }\n ],\n journey_type: 'Sales template (Premium)',\n protected: true,\n settings: {\n embedOptions: {\n mode: 'full-screen',\n lang: 'de',\n width: 'string',\n topBar: true,\n scrollToTop: true,\n button: {\n text: 'string',\n align: 'left'\n }\n },\n safeModeAutomation: true,\n designId: 'string',\n entityId: 'string',\n mappingsAutomationId: 'string',\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 enableDarkMode: true\n },\n validationRules: {\n block1: 'rule123',\n block2: {\n field1: 'rule456',\n field2: 'rule789'\n }\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\n \"settings\": {\n \"embedOptions\": {\n \"mode\": \"full-screen\",\n \"lang\": \"de\",\n \"width\": \"string\",\n \"topBar\": true,\n \"scrollToTop\": true,\n \"button\": {\n \"text\": \"string\",\n \"align\": \"left\"\n }\n },\n \"safeModeAutomation\": true,\n \"designId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"enableDarkMode\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\n }\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\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
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\n \"settings\": {\n \"embedOptions\": {\n \"mode\": \"full-screen\",\n \"lang\": \"de\",\n \"width\": \"string\",\n \"topBar\": true,\n \"scrollToTop\": true,\n \"button\": {\n \"text\": \"string\",\n \"align\": \"left\"\n }\n },\n \"safeModeAutomation\": true,\n \"designId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"enableDarkMode\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\n }\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\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})\n```\n\n
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\n \"settings\": {\n \"embedOptions\": {\n \"mode\": \"full-screen\",\n \"lang\": \"de\",\n \"width\": \"string\",\n \"topBar\": true,\n \"scrollToTop\": true,\n \"button\": {\n \"text\": \"string\",\n \"align\": \"left\"\n }\n },\n \"safeModeAutomation\": true,\n \"designId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"enableDarkMode\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\n }\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\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
\nResponse\n\n```json\n{\n \"organizationId\": \"739224\",\n \"canary\": true,\n \"thirdPartyCookies\": true\n}\n```\n\n
\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
\nResponse\n\n```json\n[\n {\n \"value\": \"Button Hidden Value\",\n \"label\": \"Button Label\"\n }\n]\n```\n\n
\n\n---\n\n## Schemas\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 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\n contextSchema?: Array<{\n id?: { ... }\n type: { ... }\n paramKey: { ... }\n isRequired?: { ... }\n shouldLoadEntity?: { ... }\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: { ... }\n safeModeAutomation?: { ... }\n canary?: { ... }\n designId: { ... }\n templateId?: { ... }\n entityId?: { ... }\n mappingsAutomationId?: { ... }\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 isPublished?: { ... }\n status?: { ... }\n isActive?: { ... }\n savingProgress?: { ... }\n thirdPartyCookies?: { ... }\n }\n validationRules?: Record>\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\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 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\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>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\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 targetedCustomer?: string\n description?: string\n organizationSettings?: Record\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 isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record>\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 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\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>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\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 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 enableDarkMode?: boolean\n }\n validationRules?: Record>\n _manifest?: string // uuid[]\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 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\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>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\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 targetedCustomer?: string\n description?: string\n organizationSettings?: Record\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 isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record>\n // ...\n}\n```\n\n### `JourneyFeatureFlags`\n\n```ts\ntype JourneyFeatureFlags = {\n featureFlags?: Record\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### `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 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 rule IDs (for block-level rules) or rule references (for field-level rules).\n\n\n```ts\ntype ValidationRuleRef = Record>\n```\n\n### `RuleRef`\n\nField-level rule references within a block.\nMaps field names to rule IDs.\n\n\n```ts\ntype RuleRef = Record\n```\n" +"# 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(() => '')\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, () => '')\nconst { data } = await journeyClient.getJourneysByOrgId(...)\n```\n\n## Operations\n\n**Journeys**\n- [`getJourneysByOrgId`](#getjourneysbyorgid)\n- [`getJourney`](#getjourney)\n- [`removeJourney`](#removejourney)\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- [`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- [`JourneyFeatureFlags`](#journeyfeatureflags)\n- [`JourneyAuditInfo`](#journeyauditinfo)\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
\nResponse\n\n```json\n{}\n```\n\n
\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 source: 'example',\n orgId: 'example',\n})\n```\n\n
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\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 \"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 \"isPublished\": true,\n \"status\": \"string\",\n \"isActive\": true,\n \"savingProgress\": {\n \"savingMode\": \"auto\",\n \"supportedVersion\": 0\n },\n \"thirdPartyCookies\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\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
\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### `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
\nResponse\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
\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 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 }\n ],\n journey_type: 'Sales template (Premium)',\n protected: true,\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 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 isPublished: true,\n status: 'string',\n isActive: true,\n savingProgress: {\n savingMode: 'auto',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: 'rule123',\n block2: {\n field1: 'rule456',\n field2: 'rule789'\n }\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n createdBy: 'string',\n updatedBy: 'string',\n __lastModifiedAt: 'string'\n },\n)\n```\n\n
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\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 \"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 \"isPublished\": true,\n \"status\": \"string\",\n \"isActive\": true,\n \"savingProgress\": {\n \"savingMode\": \"auto\",\n \"supportedVersion\": 0\n },\n \"thirdPartyCookies\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\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
\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 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 }\n ],\n journey_type: 'Sales template (Premium)',\n protected: true,\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 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 isPublished: true,\n status: 'string',\n isActive: true,\n savingProgress: {\n savingMode: 'auto',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: 'rule123',\n block2: {\n field1: 'rule456',\n field2: 'rule789'\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
\nResponse\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 \"settings\": {\n \"embedOptions\": {},\n \"safeModeAutomation\": true,\n \"canary\": true,\n \"designId\": \"string\",\n \"templateId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"isPublished\": true,\n \"status\": \"string\",\n \"isActive\": true,\n \"savingProgress\": {},\n \"thirdPartyCookies\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {}\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
\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
\nResponse\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
\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 language: 'de'\n },\n)\n```\n\n
\nResponse\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
\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 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 }\n ],\n journey_type: 'Sales template (Premium)',\n protected: true,\n settings: {\n embedOptions: {\n mode: 'full-screen',\n lang: 'de',\n width: 'string',\n topBar: true,\n scrollToTop: true,\n button: {\n text: 'string',\n align: 'left'\n }\n },\n safeModeAutomation: true,\n designId: 'string',\n entityId: 'string',\n mappingsAutomationId: 'string',\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 enableDarkMode: true\n },\n validationRules: {\n block1: 'rule123',\n block2: {\n field1: 'rule456',\n field2: 'rule789'\n }\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\n \"settings\": {\n \"embedOptions\": {\n \"mode\": \"full-screen\",\n \"lang\": \"de\",\n \"width\": \"string\",\n \"topBar\": true,\n \"scrollToTop\": true,\n \"button\": {\n \"text\": \"string\",\n \"align\": \"left\"\n }\n },\n \"safeModeAutomation\": true,\n \"designId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"enableDarkMode\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\n }\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\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 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 }\n ],\n journey_type: 'Sales template (Premium)',\n protected: true,\n settings: {\n embedOptions: {\n mode: 'full-screen',\n lang: 'de',\n width: 'string',\n topBar: true,\n scrollToTop: true,\n button: {\n text: 'string',\n align: 'left'\n }\n },\n safeModeAutomation: true,\n designId: 'string',\n entityId: 'string',\n mappingsAutomationId: 'string',\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 enableDarkMode: true\n },\n validationRules: {\n block1: 'rule123',\n block2: {\n field1: 'rule456',\n field2: 'rule789'\n }\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\n \"settings\": {\n \"embedOptions\": {\n \"mode\": \"full-screen\",\n \"lang\": \"de\",\n \"width\": \"string\",\n \"topBar\": true,\n \"scrollToTop\": true,\n \"button\": {\n \"text\": \"string\",\n \"align\": \"left\"\n }\n },\n \"safeModeAutomation\": true,\n \"designId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"enableDarkMode\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\n }\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\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
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\n \"settings\": {\n \"embedOptions\": {\n \"mode\": \"full-screen\",\n \"lang\": \"de\",\n \"width\": \"string\",\n \"topBar\": true,\n \"scrollToTop\": true,\n \"button\": {\n \"text\": \"string\",\n \"align\": \"left\"\n }\n },\n \"safeModeAutomation\": true,\n \"designId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"enableDarkMode\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\n }\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\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
\nResponse\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 \"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 }\n ],\n \"journey_type\": \"Sales template (Premium)\",\n \"protected\": true,\n \"settings\": {\n \"embedOptions\": {\n \"mode\": \"full-screen\",\n \"lang\": \"de\",\n \"width\": \"string\",\n \"topBar\": true,\n \"scrollToTop\": true,\n \"button\": {\n \"text\": \"string\",\n \"align\": \"left\"\n }\n },\n \"safeModeAutomation\": true,\n \"designId\": \"string\",\n \"entityId\": \"string\",\n \"mappingsAutomationId\": \"string\",\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 \"enableDarkMode\": true\n },\n \"validationRules\": {\n \"block1\": \"rule123\",\n \"block2\": {\n \"field1\": \"rule456\",\n \"field2\": \"rule789\"\n }\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\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
\nResponse\n\n```json\n{\n \"organizationId\": \"739224\",\n \"canary\": true,\n \"thirdPartyCookies\": true\n}\n```\n\n
\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
\nResponse\n\n```json\n[\n {\n \"value\": \"Button Hidden Value\",\n \"label\": \"Button Label\"\n }\n]\n```\n\n
\n\n---\n\n## Schemas\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 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\n contextSchema?: Array<{\n id?: { ... }\n type: { ... }\n paramKey: { ... }\n isRequired?: { ... }\n shouldLoadEntity?: { ... }\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: { ... }\n safeModeAutomation?: { ... }\n canary?: { ... }\n designId: { ... }\n templateId?: { ... }\n entityId?: { ... }\n mappingsAutomationId?: { ... }\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 isPublished?: { ... }\n status?: { ... }\n isActive?: { ... }\n savingProgress?: { ... }\n thirdPartyCookies?: { ... }\n }\n validationRules?: Record>\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\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 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\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>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\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 targetedCustomer?: string\n description?: string\n organizationSettings?: Record\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 isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record>\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 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\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>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\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 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 enableDarkMode?: boolean\n }\n validationRules?: Record>\n _manifest?: string // uuid[]\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 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\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>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\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 targetedCustomer?: string\n description?: string\n organizationSettings?: Record\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 isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record>\n // ...\n}\n```\n\n### `JourneyFeatureFlags`\n\n```ts\ntype JourneyFeatureFlags = {\n featureFlags?: Record\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### `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 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 rule IDs (for block-level rules) or rule references (for field-level rules).\n\n\n```ts\ntype ValidationRuleRef = Record>\n```\n\n### `RuleRef`\n\nField-level rule references within a block.\nMaps field names to rule IDs.\n\n\n```ts\ntype RuleRef = Record\n```\n" diff --git a/packages/epilot-sdk-v2/src/types/journey.d.ts b/packages/epilot-sdk-v2/src/types/journey.d.ts index 374093ce..d771cac5 100644 --- a/packages/epilot-sdk-v2/src/types/journey.d.ts +++ b/packages/epilot-sdk-v2/src/types/journey.d.ts @@ -1299,6 +1299,7 @@ export declare namespace Paths { export type Id = string; // uuid export type OrgId = string; export type Source = string; + export type Version = number; } export interface PathParameters { id: /** @@ -1308,6 +1309,7 @@ export declare namespace Paths { Parameters.Id /* uuid */; } export interface QueryParameters { + version?: Parameters.Version; source?: Parameters.Source; orgId?: Parameters.OrgId; } @@ -1353,6 +1355,7 @@ export declare namespace Paths { * 509cdffe-424f-457a-95c2-9708c304ce77 */ export type Id = string; // uuid + export type Version = number; } export interface PathParameters { id: /** @@ -1361,6 +1364,9 @@ export declare namespace Paths { */ Parameters.Id /* uuid */; } + export interface QueryParameters { + version?: Parameters.Version; + } namespace Responses { export type $200 = Components.Schemas.JourneyCreationRequestV2; } @@ -1673,13 +1679,13 @@ export interface OperationMethods { ): OperationResponse /** * getJourneyV2 - getJourneyV2 - * + * * Get journey by id */ 'getJourneyV2'( - parameters?: Parameters | null, + parameters?: Parameters | null, data?: any, - config?: AxiosRequestConfig + config?: AxiosRequestConfig ): OperationResponse /** * removeJourneyV2 - removeJourneyV2 From ca211b76245fdbf21cdac9d4af37d07f6259f0e2 Mon Sep 17 00:00:00 2001 From: Viljami + Claude Date: Fri, 15 May 2026 12:05:35 +0000 Subject: [PATCH 2/2] chore: update package-lock.json https://claude.ai/code/session_01NdLLRTB2abkToYRMzJ4EkE Co-authored-by: Claude --- package-lock.json | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/package-lock.json b/package-lock.json index 05ec5790..d6ed5895 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1251,11 +1251,7 @@ }, "clients/customer-portal-client": { "name": "@epilot/customer-portal-client", -<<<<<<< HEAD - "version": "0.38.1", -======= - "version": "0.38.7", ->>>>>>> 4dfbac174137bfe20b85f7fd20b7ba11ec8b683f + "version": "0.39.0", "license": "UNLICENSED", "dependencies": { "buffer": "^6.0.3", @@ -2109,7 +2105,7 @@ }, "clients/entity-client": { "name": "@epilot/entity-client", - "version": "7.2.1", + "version": "7.2.1-rc1", "license": "MIT", "dependencies": { "@dazn/lambda-powertools-correlation-ids": "^1.28.1", @@ -2446,7 +2442,7 @@ }, "clients/event-catalog-client": { "name": "@epilot/event-catalog-client", - "version": "0.4.2", + "version": "0.5.0", "license": "MIT", "dependencies": { "@dazn/lambda-powertools-correlation-ids": "^1.28.1", @@ -2553,7 +2549,7 @@ }, "clients/file-client": { "name": "@epilot/file-client", - "version": "1.23.0", + "version": "1.24.0", "license": "MIT", "dependencies": { "buffer": "^6.0.3", @@ -2766,7 +2762,7 @@ }, "clients/integration-toolkit-client": { "name": "@epilot/integration-toolkit-client", - "version": "1.0.3", + "version": "1.1.0", "license": "MIT", "dependencies": { "@dazn/lambda-powertools-correlation-ids": "^1.28.1", @@ -3137,7 +3133,7 @@ }, "clients/metering-client": { "name": "@epilot/metering-client", - "version": "0.9.1", + "version": "0.9.2", "license": "UNLICENSED", "dependencies": { "buffer": "^6.0.3", @@ -4934,7 +4930,7 @@ }, "clients/webhooks-client": { "name": "@epilot/webhooks-client", - "version": "2.19.0", + "version": "2.20.1", "license": "MIT", "dependencies": { "@dazn/lambda-powertools-correlation-ids": "^1.28.1", @@ -24775,7 +24771,7 @@ }, "packages/epilot-sdk-v2": { "name": "@epilot/sdk", - "version": "2.4.4", + "version": "2.7.0", "license": "MIT", "bin": { "epilot-sdk": "dist/bin/cli.js"