@epilot/sdk 2.8.9 → 2.9.0

package/dist/journey-4DIIPRU4.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/journey.json
+var journey_default = '# Journey API\n\n- **Base URL:** `https://journey-config.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/journey](https://docs.epilot.io/api/journey)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.journey.getJourneysByOrgId(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/journey\'\n\nconst journeyClient = getClient()\nauthorize(journeyClient, () => \'<token>\')\nconst { data } = await journeyClient.getJourneysByOrgId(...)\n```\n\n## Operations\n\n**Journeys**\n- [`getJourneysByOrgId`](#getjourneysbyorgid)\n- [`getJourney`](#getjourney)\n- [`removeJourney`](#removejourney)\n- [`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<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getJourney`\n\nGet journey by id. Private journeys requires valid private token to be passed\n\n`GET /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourney({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  version: 1,\n  source: \'example\',\n  orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "organizationId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `removeJourney`\n\nRemove journey by id\n\n`DELETE /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourney({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getJourneyProducts`\n\nGet products available in the journey by id. requires public journey token to be passed.\n\n`GET /v1/journey/products/{id}`\n\n```ts\nconst { data } = await client.getJourneyProducts({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  source: \'example\',\n  postal_code: \'example\',\n  city: \'example\',\n  street: \'example\',\n  street_number: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "type": "string",\n    "_schema": "string",\n    "_title": "string",\n    "name": "string",\n    "_id": "string",\n    "_org": "string",\n    "code": "string",\n    "description": "string",\n    "feature": [\n      {}\n    ],\n    "product_images": [\n      {}\n    ],\n    "legal_footnote": "string",\n    "product_downloads": [\n      {}\n    ],\n    "price": {}\n  }\n]\n```\n\n</details>\n\n---\n\n### `createJourney`\n\nCreate a Journey\n\n`POST /v1/journey/configuration`\n\n```ts\nconst { data } = await client.createJourney(\n  {\n    skipAutomation: \'example\',\n  },\n  {\n    journeyId: \'string\',\n    organizationId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        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<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "organizationId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `updateJourney`\n\nUpdate a Journey\n\n`PUT /v1/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourney(\n  null,\n  {\n    journeyId: \'string\',\n    organizationId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        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<details>\n<summary>Response</summary>\n\n```json\n{\n  "createdJourney": {\n    "journeyId": "string",\n    "organizationId": "string",\n    "brandId": "string",\n    "name": "string",\n    "steps": [\n      {}\n    ],\n    "design": {\n      "logoUrl": "string",\n      "theme": {},\n      "designTokens": {}\n    },\n    "rules": [\n      {}\n    ],\n    "logics": [\n      {}\n    ],\n    "logicsV4": {},\n    "contextSchema": [\n      {}\n    ],\n    "journey_type": "Sales template (Premium)",\n    "protected": true,\n    "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</details>\n\n---\n\n### `searchJourneys`\n\nSearch Journeys\n\n`POST /v1/journey/configuration/search`\n\n```ts\nconst { data } = await client.searchJourneys(\n  null,\n  {\n    q: \'_tags:*Flex*\',\n    from: 0,\n    size: 25,\n    sort: \'_created_at:desc\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 1,\n  "results": [\n    {\n      "_id": "e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8",\n      "_schema": "journey",\n      "_title": "Journey Entity Title",\n      "_org": "739224",\n      "_created_at": "2020-01-01T00:00:00.000Z",\n      "_updated_at": "2020-01-01T00:00:00.000Z",\n      "_tags": ["Flex"],\n      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n      "journey_name": "Journey Name",\n      "journey_id": "de7df470-253e-11ed-9174-116b8a718c0a",\n      "journey_type": "Sales template",\n      "design": "Design EPILOT",\n      "created_by": [\n        {\n          "id": "12345"\n        }\n      ],\n      "journey_version": "Flex"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `generateDocument`\n\nBuilds document generated from a template with journey values."\n\n`POST /v1/journey/document:generate`\n\n```ts\nconst { data } = await client.generateDocument(\n  null,\n  {\n    file_id: \'1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\',\n    context_data: {\n      additionalProperties: \'string\'\n    },\n    language: \'de\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "job_status": "STARTED",\n  "message": "string",\n  "pdf_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.pdf"\n      }\n    }\n  },\n  "docx_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.docx"\n      }\n    }\n  },\n  "variable_payload": {\n    "additionalProperties": "string"\n  },\n  "template_settings": {\n    "custom_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "suggested_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "display_margin_guidelines": true,\n    "enable_data_table_margin_autofix": false,\n    "template_with_datatable": false,\n    "enabled_template_settings_persistence": false,\n    "misconfigured_margins": false,\n    "file_entity_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"\n  }\n}\n```\n\n</details>\n\n---\n\n### `createJourneyV2`\n\nCreate a Journey\n\n`POST /v2/journey/configuration`\n\n```ts\nconst { data } = await client.createJourneyV2(\n  {\n    skipAutomation: \'example\',\n  },\n  {\n    journeyId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        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<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `updateJourneyV2`\n\nUpdate a Journey\n\n`PUT /v2/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourneyV2(\n  null,\n  {\n    journeyId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        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<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `patchUpdateJourneyV2`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v2/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourneyV2(\n  null,\n  {\n    journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n    __lastModifiedAt: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `getJourneyV2`\n\nGet journey by id\n\n`GET /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourneyV2({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  version: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `removeJourneyV2`\n\nRemove journey by id\n\n`DELETE /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourneyV2({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getSettingsForJourney`\n\nGet settings related to the journey using journey ID.\n\n`GET /v1/journey/{id}/settings`\n\n```ts\nconst { data } = await client.getSettingsForJourney({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "organizationId": "739224",\n  "canary": true,\n  "thirdPartyCookies": true\n}\n```\n\n</details>\n\n---\n\n### `getButtonOptions`\n\nGet button options from a csv file.\n\n`GET /v1/journey/button-options`\n\n```ts\nconst { data } = await client.getButtonOptions({\n  fileId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "value": "Button Hidden Value",\n    "label": "Button Label"\n  }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `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<string, {\n      id?: { ... }\n      protected?: { ... }\n      action?: { ... }\n      triggeredOn?: { ... }\n      conditions?: { ... }\n      settings?: { ... }\n    }>\n    contextSchema?: Array<{\n      id?: { ... }\n      type: { ... }\n      paramKey: { ... }\n      isRequired?: { ... }\n      shouldLoadEntity?: { ... }\n    }>\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<string, string | Record<string, string>>\n    _manifest?: string // uuid[]\n    createdBy?: string\n    updatedBy?: string\n    __lastModifiedAt?: string\n    createdAt: string\n    lastModifiedAt: string\n    deletedAt?: string\n    version: number\n    revisions: number\n    featureFlags?: Record<string, unknown>\n  }\n}\n```\n\n### `JourneyProductsResponse`\n\n```ts\ntype JourneyProductsResponse = Array<{\n  type?: string\n  _schema?: string\n  _title?: string\n  name?: string\n  _id?: string\n  _org?: string\n  code?: string\n  description?: string\n  feature?: unknown[]\n  product_images?: unknown[]\n  legal_footnote?: string\n  product_downloads?: unknown[]\n  price?: object\n}>\n```\n\n### `PatchUpdateJourneyRequest`\n\nPatch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\n\n\n```ts\ntype PatchUpdateJourneyRequest = {\n  journeyId: string // uuid\n  __lastModifiedAt?: string\n}\n```\n\n### `JourneyCreationRequest`\n\n```ts\ntype JourneyCreationRequest = {\n  journeyId?: string\n  organizationId: string\n  brandId?: string\n  name: string\n  steps: Array<{\n    showStepName?: boolean\n    title?: string\n    subTitle?: string\n    showStepSubtitle?: boolean\n    showStepper?: boolean\n    showStepperLabels?: boolean\n    hideNextButton?: boolean\n    name: string\n    stepId?: string\n    schema: unknown\n    uischema: unknown\n    maxWidth?: "small" | "medium" | "large" | "extra large"\n  }>\n  design?: {\n    logoUrl?: string\n    theme?: Record<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n  }>\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<string, boolean>\n    publicToken?: string\n    runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n    filePurposes?: string[]\n    entityTags?: string[]\n    addressSuggestionsFileUrl?: string\n    addressSuggestionsFileId?: string\n    addressSuggestionsCountryCode?: string\n    addressSuggestionsEnableAutoComplete?: boolean\n    addressSuggestionsSource?: string[]\n    addressSuggestionsEnableFreeText?: boolean\n    useNewDesign?: boolean\n    useAustrianLabels?: boolean\n    enableDarkMode?: boolean\n    accessMode?: "PUBLIC" | "PRIVATE"\n    isPublished?: boolean\n    status?: string\n    isActive?: boolean\n    savingProgress?: {\n      savingMode?: { ... }\n      supportedVersion?: { ... }\n    }\n    thirdPartyCookies?: boolean\n  }\n  validationRules?: Record<string, string | Record<string, string>>\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<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n  }>\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<string, string | Record<string, string>>\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<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n  }>\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<string, boolean>\n    publicToken?: string\n    runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n    filePurposes?: string[]\n    entityTags?: string[]\n    addressSuggestionsFileUrl?: string\n    addressSuggestionsFileId?: string\n    addressSuggestionsCountryCode?: string\n    addressSuggestionsEnableAutoComplete?: boolean\n    addressSuggestionsSource?: string[]\n    addressSuggestionsEnableFreeText?: boolean\n    useNewDesign?: boolean\n    useAustrianLabels?: boolean\n    enableDarkMode?: boolean\n    accessMode?: "PUBLIC" | "PRIVATE"\n    isPublished?: boolean\n    status?: string\n    isActive?: boolean\n    savingProgress?: {\n      savingMode?: { ... }\n      supportedVersion?: { ... }\n    }\n    thirdPartyCookies?: boolean\n  }\n  validationRules?: Record<string, string | Record<string, string>>\n  // ...\n}\n```\n\n### `JourneyFeatureFlags`\n\n```ts\ntype JourneyFeatureFlags = {\n  featureFlags?: Record<string, unknown>\n}\n```\n\n### `JourneyAuditInfo`\n\n```ts\ntype JourneyAuditInfo = {\n  createdAt: string\n  lastModifiedAt: string\n  deletedAt?: string\n  version: number\n  revisions: number\n}\n```\n\n### `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<string, string | Record<string, string>>\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<string, string>\n```\n';
+export {
+  journey_default as default
+};

package/dist/journey-ATC3Y5AW.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/journey.json
+var journey_default = '# Journey API\n\n- **Base URL:** `https://journey-config.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/journey](https://docs.epilot.io/api/journey)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.journey.getJourneysByOrgId(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/journey\'\n\nconst journeyClient = getClient()\nauthorize(journeyClient, () => \'<token>\')\nconst { data } = await journeyClient.getJourneysByOrgId(...)\n```\n\n## Operations\n\n**Journeys**\n- [`getJourneysByOrgId`](#getjourneysbyorgid)\n- [`getJourney`](#getjourney)\n- [`removeJourney`](#removejourney)\n- [`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<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getJourney`\n\nGet journey by id. Private journeys requires valid private token to be passed\n\n`GET /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourney({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  version: 1,\n  source: \'example\',\n  orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "organizationId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `removeJourney`\n\nRemove journey by id\n\n`DELETE /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourney({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getJourneyProducts`\n\nGet products available in the journey by id. requires public journey token to be passed.\n\n`GET /v1/journey/products/{id}`\n\n```ts\nconst { data } = await client.getJourneyProducts({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  source: \'example\',\n  postal_code: \'example\',\n  city: \'example\',\n  street: \'example\',\n  street_number: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "type": "string",\n    "_schema": "string",\n    "_title": "string",\n    "name": "string",\n    "_id": "string",\n    "_org": "string",\n    "code": "string",\n    "description": "string",\n    "feature": [\n      {}\n    ],\n    "product_images": [\n      {}\n    ],\n    "legal_footnote": "string",\n    "product_downloads": [\n      {}\n    ],\n    "price": {}\n  }\n]\n```\n\n</details>\n\n---\n\n### `createJourney`\n\nCreate a Journey\n\n`POST /v1/journey/configuration`\n\n```ts\nconst { data } = await client.createJourney(\n  {\n    skipAutomation: \'example\',\n  },\n  {\n    journeyId: \'string\',\n    organizationId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        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<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "organizationId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `updateJourney`\n\nUpdate a Journey\n\n`PUT /v1/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourney(\n  null,\n  {\n    journeyId: \'string\',\n    organizationId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        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<details>\n<summary>Response</summary>\n\n```json\n{\n  "createdJourney": {\n    "journeyId": "string",\n    "organizationId": "string",\n    "brandId": "string",\n    "name": "string",\n    "steps": [\n      {}\n    ],\n    "design": {\n      "logoUrl": "string",\n      "theme": {},\n      "designTokens": {}\n    },\n    "rules": [\n      {}\n    ],\n    "logics": [\n      {}\n    ],\n    "logicsV4": {},\n    "contextSchema": [\n      {}\n    ],\n    "journey_type": "Sales template (Premium)",\n    "protected": true,\n    "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</details>\n\n---\n\n### `searchJourneys`\n\nSearch Journeys\n\n`POST /v1/journey/configuration/search`\n\n```ts\nconst { data } = await client.searchJourneys(\n  null,\n  {\n    q: \'_tags:*Flex*\',\n    from: 0,\n    size: 25,\n    sort: \'_created_at:desc\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 1,\n  "results": [\n    {\n      "_id": "e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8",\n      "_schema": "journey",\n      "_title": "Journey Entity Title",\n      "_org": "739224",\n      "_created_at": "2020-01-01T00:00:00.000Z",\n      "_updated_at": "2020-01-01T00:00:00.000Z",\n      "_tags": ["Flex"],\n      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n      "journey_name": "Journey Name",\n      "journey_id": "de7df470-253e-11ed-9174-116b8a718c0a",\n      "journey_type": "Sales template",\n      "design": "Design EPILOT",\n      "created_by": [\n        {\n          "id": "12345"\n        }\n      ],\n      "journey_version": "Flex"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `generateDocument`\n\nBuilds document generated from a template with journey values."\n\n`POST /v1/journey/document:generate`\n\n```ts\nconst { data } = await client.generateDocument(\n  null,\n  {\n    file_id: \'1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\',\n    context_data: {\n      additionalProperties: \'string\'\n    },\n    language: \'de\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "job_status": "STARTED",\n  "message": "string",\n  "pdf_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.pdf"\n      }\n    }\n  },\n  "docx_output": {\n    "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx",\n    "output_document": {\n      "s3ref": {\n        "bucket": "document-api-preview-prod",\n        "key": "preview/my-template.docx"\n      }\n    }\n  },\n  "variable_payload": {\n    "additionalProperties": "string"\n  },\n  "template_settings": {\n    "custom_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "suggested_margins": {\n      "top": 2.54,\n      "bottom": 2.54\n    },\n    "display_margin_guidelines": true,\n    "enable_data_table_margin_autofix": false,\n    "template_with_datatable": false,\n    "enabled_template_settings_persistence": false,\n    "misconfigured_margins": false,\n    "file_entity_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"\n  }\n}\n```\n\n</details>\n\n---\n\n### `createJourneyV2`\n\nCreate a Journey\n\n`POST /v2/journey/configuration`\n\n```ts\nconst { data } = await client.createJourneyV2(\n  {\n    skipAutomation: \'example\',\n  },\n  {\n    journeyId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        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<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `updateJourneyV2`\n\nUpdate a Journey\n\n`PUT /v2/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourneyV2(\n  null,\n  {\n    journeyId: \'string\',\n    brandId: \'string\',\n    name: \'string\',\n    steps: [\n      {\n        showStepName: true,\n        title: \'string\',\n        subTitle: \'string\',\n        showStepSubtitle: true,\n        showStepper: true,\n        showStepperLabels: true,\n        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<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `patchUpdateJourneyV2`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v2/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourneyV2(\n  null,\n  {\n    journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n    __lastModifiedAt: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `getJourneyV2`\n\nGet journey by id\n\n`GET /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourneyV2({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  version: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "journeyId": "string",\n  "brandId": "string",\n  "name": "string",\n  "steps": [\n    {\n      "showStepName": true,\n      "title": "string",\n      "subTitle": "string",\n      "showStepSubtitle": true,\n      "showStepper": true,\n      "showStepperLabels": true,\n      "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</details>\n\n---\n\n### `removeJourneyV2`\n\nRemove journey by id\n\n`DELETE /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourneyV2({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getSettingsForJourney`\n\nGet settings related to the journey using journey ID.\n\n`GET /v1/journey/{id}/settings`\n\n```ts\nconst { data } = await client.getSettingsForJourney({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "organizationId": "739224",\n  "canary": true,\n  "thirdPartyCookies": true\n}\n```\n\n</details>\n\n---\n\n### `getButtonOptions`\n\nGet button options from a csv file.\n\n`GET /v1/journey/button-options`\n\n```ts\nconst { data } = await client.getButtonOptions({\n  fileId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "value": "Button Hidden Value",\n    "label": "Button Label"\n  }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `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<string, {\n      id?: { ... }\n      protected?: { ... }\n      action?: { ... }\n      triggeredOn?: { ... }\n      conditions?: { ... }\n      settings?: { ... }\n    }>\n    contextSchema?: Array<{\n      id?: { ... }\n      type: { ... }\n      paramKey: { ... }\n      isRequired?: { ... }\n      shouldLoadEntity?: { ... }\n    }>\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<string, string | Record<string, string>>\n    _manifest?: string // uuid[]\n    createdBy?: string\n    updatedBy?: string\n    __lastModifiedAt?: string\n    createdAt: string\n    lastModifiedAt: string\n    deletedAt?: string\n    version: number\n    revisions: number\n    featureFlags?: Record<string, unknown>\n  }\n}\n```\n\n### `JourneyProductsResponse`\n\n```ts\ntype JourneyProductsResponse = Array<{\n  type?: string\n  _schema?: string\n  _title?: string\n  name?: string\n  _id?: string\n  _org?: string\n  code?: string\n  description?: string\n  feature?: unknown[]\n  product_images?: unknown[]\n  legal_footnote?: string\n  product_downloads?: unknown[]\n  price?: object\n}>\n```\n\n### `PatchUpdateJourneyRequest`\n\nPatch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\n\n\n```ts\ntype PatchUpdateJourneyRequest = {\n  journeyId: string // uuid\n  __lastModifiedAt?: string\n}\n```\n\n### `JourneyCreationRequest`\n\n```ts\ntype JourneyCreationRequest = {\n  journeyId?: string\n  organizationId: string\n  brandId?: string\n  name: string\n  steps: Array<{\n    showStepName?: boolean\n    title?: string\n    subTitle?: string\n    showStepSubtitle?: boolean\n    showStepper?: boolean\n    showStepperLabels?: boolean\n    hideNextButton?: boolean\n    name: string\n    stepId?: string\n    schema: unknown\n    uischema: unknown\n    maxWidth?: "small" | "medium" | "large" | "extra large"\n  }>\n  design?: {\n    logoUrl?: string\n    theme?: Record<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n  }>\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<string, boolean>\n    publicToken?: string\n    runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n    filePurposes?: string[]\n    entityTags?: string[]\n    addressSuggestionsFileUrl?: string\n    addressSuggestionsFileId?: string\n    addressSuggestionsCountryCode?: string\n    addressSuggestionsEnableAutoComplete?: boolean\n    addressSuggestionsSource?: string[]\n    addressSuggestionsEnableFreeText?: boolean\n    useNewDesign?: boolean\n    useAustrianLabels?: boolean\n    enableDarkMode?: boolean\n    accessMode?: "PUBLIC" | "PRIVATE"\n    isPublished?: boolean\n    status?: string\n    isActive?: boolean\n    savingProgress?: {\n      savingMode?: { ... }\n      supportedVersion?: { ... }\n    }\n    thirdPartyCookies?: boolean\n  }\n  validationRules?: Record<string, string | Record<string, string>>\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<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n  }>\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<string, string | Record<string, string>>\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<string, unknown>\n    designTokens?: object\n  }\n  rules?: Array<{\n    type: "inject" | "injectWithKey"\n    sourceType: "journey" | "step" | "block"\n    source: string\n    target: string\n  }>\n  logics?: Array<{\n    autoGeneratedId?: string\n    conditions: string[]\n    actions: string[]\n  }>\n  logicsV4?: Record<string, {\n    id?: string // uuid\n    protected?: boolean\n    action?: string\n    triggeredOn?: string\n    conditions?: Array<Array<{\n      operator?: { ... }\n      functionName?: { ... }\n      fact?: { ... }\n      value?: { ... }\n      args?: { ... }\n    }>>\n    settings?: object\n  }>\n  contextSchema?: Array<{\n    id?: string // uuid\n    type: string\n    paramKey: string\n    isRequired?: boolean\n    shouldLoadEntity?: boolean\n  }>\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<string, boolean>\n    publicToken?: string\n    runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n    filePurposes?: string[]\n    entityTags?: string[]\n    addressSuggestionsFileUrl?: string\n    addressSuggestionsFileId?: string\n    addressSuggestionsCountryCode?: string\n    addressSuggestionsEnableAutoComplete?: boolean\n    addressSuggestionsSource?: string[]\n    addressSuggestionsEnableFreeText?: boolean\n    useNewDesign?: boolean\n    useAustrianLabels?: boolean\n    enableDarkMode?: boolean\n    accessMode?: "PUBLIC" | "PRIVATE"\n    isPublished?: boolean\n    status?: string\n    isActive?: boolean\n    savingProgress?: {\n      savingMode?: { ... }\n      supportedVersion?: { ... }\n    }\n    thirdPartyCookies?: boolean\n  }\n  validationRules?: Record<string, string | Record<string, string>>\n  // ...\n}\n```\n\n### `JourneyFeatureFlags`\n\n```ts\ntype JourneyFeatureFlags = {\n  featureFlags?: Record<string, unknown>\n}\n```\n\n### `JourneyAuditInfo`\n\n```ts\ntype JourneyAuditInfo = {\n  createdAt: string\n  lastModifiedAt: string\n  deletedAt?: string\n  version: number\n  revisions: number\n}\n```\n\n### `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<string, string | Record<string, string>>\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<string, string>\n```\n';
+
+
+exports.default = journey_default;

package/dist/{journey.d-B1sOeMHw.d.cts → journey.d-BenIUWaO.d.cts}

@@ -270,10 +270,6 @@ declare namespace Components {
              * If true, journey is displayed in read-only mode
              */
             protected?: boolean;
-            /**
-             * Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*​/blocks/**).
-             */
-            protectedEditable?: string[];
             settings?: {
                 embedOptions?: {
                     mode?: "full-screen" | "inline";
@@ -526,10 +522,6 @@ declare namespace Components {
              * If true, journey is displayed in read-only mode
              */
             protected?: boolean;
-            /**
-             * Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*​/blocks/**).
-             */
-            protectedEditable?: string[];
             settings?: {
                 embedOptions?: {
                     mode?: "full-screen" | "inline";
@@ -765,10 +757,6 @@ declare namespace Components {
              * If true, journey is displayed in read-only mode
              */
             protected?: boolean;
-            /**
-             * Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*​/blocks/**).
-             */
-            protectedEditable?: string[];
             settings?: {
                 embedOptions?: {
                     mode?: "full-screen" | "inline";
@@ -826,7 +814,6 @@ declare namespace Components {
                  * If true, the journey shows an icon to toggle dark mode
                  */
                 enableDarkMode?: boolean;
-                isActive?: boolean;
             };
             validationRules?: /**
              * References to validation rules organized by blocks and fields.
@@ -1688,13 +1675,13 @@ interface OperationMethods {
   ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
   /**
    * getJourneyV2 - getJourneyV2
-   * 
+   *
    * Get journey by id
    */
   'getJourneyV2'(
     parameters?: Parameters<Paths.GetJourneyV2.QueryParameters & Paths.GetJourneyV2.PathParameters> | null,
     data?: any,
-    config?: AxiosRequestConfig  
+    config?: AxiosRequestConfig
   ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
   /**
    * removeJourneyV2 - removeJourneyV2
@@ -1881,7 +1868,7 @@ interface PathsDictionary {
      * Get journey by id
      */
     'get'(
-      parameters?: Parameters<Paths.GetJourneyV2.QueryParameters & Paths.GetJourneyV2.PathParameters> | null,
+      parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetJourneyV2.Responses.$200>

package/dist/{journey.d-B1sOeMHw.d.ts → journey.d-BenIUWaO.d.ts}

@@ -270,10 +270,6 @@ declare namespace Components {
              * If true, journey is displayed in read-only mode
              */
             protected?: boolean;
-            /**
-             * Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*​/blocks/**).
-             */
-            protectedEditable?: string[];
             settings?: {
                 embedOptions?: {
                     mode?: "full-screen" | "inline";
@@ -526,10 +522,6 @@ declare namespace Components {
              * If true, journey is displayed in read-only mode
              */
             protected?: boolean;
-            /**
-             * Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*​/blocks/**).
-             */
-            protectedEditable?: string[];
             settings?: {
                 embedOptions?: {
                     mode?: "full-screen" | "inline";
@@ -765,10 +757,6 @@ declare namespace Components {
              * If true, journey is displayed in read-only mode
              */
             protected?: boolean;
-            /**
-             * Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*​/blocks/**).
-             */
-            protectedEditable?: string[];
             settings?: {
                 embedOptions?: {
                     mode?: "full-screen" | "inline";
@@ -826,7 +814,6 @@ declare namespace Components {
                  * If true, the journey shows an icon to toggle dark mode
                  */
                 enableDarkMode?: boolean;
-                isActive?: boolean;
             };
             validationRules?: /**
              * References to validation rules organized by blocks and fields.
@@ -1688,13 +1675,13 @@ interface OperationMethods {
   ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
   /**
    * getJourneyV2 - getJourneyV2
-   * 
+   *
    * Get journey by id
    */
   'getJourneyV2'(
     parameters?: Parameters<Paths.GetJourneyV2.QueryParameters & Paths.GetJourneyV2.PathParameters> | null,
     data?: any,
-    config?: AxiosRequestConfig  
+    config?: AxiosRequestConfig
   ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
   /**
    * removeJourneyV2 - removeJourneyV2
@@ -1881,7 +1868,7 @@ interface PathsDictionary {
      * Get journey by id
      */
     'get'(
-      parameters?: Parameters<Paths.GetJourneyV2.QueryParameters & Paths.GetJourneyV2.PathParameters> | null,
+      parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetJourneyV2.Responses.$200>

package/dist/{targeting-WC62BBZN.cjs → targeting-DAFJBPIZ.cjs}

@@ -1,7 +1,7 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
 
 // src/docs/targeting.json
-var targeting_default = '# Targeting API\n\n- **Base URL:** `https://targeting.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/targeting](https://docs.epilot.io/api/targeting)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.targeting.changeCampaignStatus(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/targeting\'\n\nconst targetingClient = getClient()\nauthorize(targetingClient, () => \'<token>\')\nconst { data } = await targetingClient.changeCampaignStatus(...)\n```\n\n## Operations\n\n**Campaign**\n- [`changeCampaignStatus`](#changecampaignstatus)\n- [`getCampaignJobStatus`](#getcampaignjobstatus)\n- [`getCampaignPortals`](#getcampaignportals)\n- [`setupCampaign`](#setupcampaign)\n- [`matchCampaigns`](#matchcampaigns)\n\n**Campaign Delivery**\n- [`retriggerCampaignAutomations`](#retriggercampaignautomations)\n\n**Target**\n- [`matchTargets`](#matchtargets)\n- [`getTargetQueries`](#gettargetqueries)\n\n**Campaign Recipient**\n- [`createRecipient`](#createrecipient)\n- [`updateRecipient`](#updaterecipient)\n- [`updateRecipientPortalStatus`](#updaterecipientportalstatus)\n- [`getRecipients`](#getrecipients)\n\n**Schemas**\n- [`BaseError`](#baseerror)\n- [`ServerError`](#servererror)\n- [`ClientError`](#clienterror)\n- [`BaseUUID`](#baseuuid)\n- [`BaseNanoID`](#basenanoid)\n- [`BaseTags`](#basetags)\n- [`BaseRelation`](#baserelation)\n- [`BaseSystemId`](#basesystemid)\n- [`BaseEntityOwner`](#baseentityowner)\n- [`BaseEntityAcl`](#baseentityacl)\n- [`BaseSystemFields`](#basesystemfields)\n- [`BaseSystemFieldsRequired`](#basesystemfieldsrequired)\n- [`CampaignStatus`](#campaignstatus)\n- [`ExecutionSummaryItem`](#executionsummaryitem)\n- [`JobStatus`](#jobstatus)\n- [`Campaign`](#campaign)\n- [`Target`](#target)\n- [`MatchCampaignParams`](#matchcampaignparams)\n- [`MatchTargetParams`](#matchtargetparams)\n- [`GetTargetQueriesParams`](#gettargetqueriesparams)\n- [`TargetQueryResult`](#targetqueryresult)\n- [`AutomationStatus`](#automationstatus)\n- [`PortalStatus`](#portalstatus)\n- [`Recipient`](#recipient)\n- [`BaseRecipientPayload`](#baserecipientpayload)\n- [`AutomationRecipientPayload`](#automationrecipientpayload)\n- [`PortalRecipientPayload`](#portalrecipientpayload)\n- [`CreateRecipientPayload`](#createrecipientpayload)\n- [`UpdateRecipientPayload`](#updaterecipientpayload)\n- [`RetriggerAutomationsRequest`](#retriggerautomationsrequest)\n- [`RetriggerAutomationsResult`](#retriggerautomationsresult)\n- [`UpdatePortalStatusRequest`](#updateportalstatusrequest)\n- [`SetupCampaignRequest`](#setupcampaignrequest)\n- [`SetupTariffChangeCampaignRequest`](#setuptariffchangecampaignrequest)\n- [`SetupTariffChangeCampaignResponse`](#setuptariffchangecampaignresponse)\n\n### `changeCampaignStatus`\n\nChange the status of a campaign\n\n`POST /v1/campaign/{campaign_id}/status`\n\n```ts\nconst { data } = await client.changeCampaignStatus({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "campaign": {\n    "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n    "_org": "string",\n    "_owners": [\n      {\n        "org_id": "123",\n        "user_id": "123"\n      }\n    ],\n    "_schema": "string",\n    "_title": "string",\n    "_tags": ["string"],\n    "_created_at": "1970-01-01T00:00:00.000Z",\n    "_updated_at": "1970-01-01T00:00:00.000Z",\n    "_acl": {\n      "view": ["org:456"],\n      "edit": ["org:456"],\n      "delete": ["org:456"]\n    },\n    "name": "string",\n    "goal": "string",\n    "status": "draft",\n    "start_date": "1970-01-01",\n    "end_date": "1970-01-01",\n    "flow_id": "string",\n    "job_id": "string",\n    "target": {\n      "$relation": [\n        {\n          "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n          "_tags": ["string"]\n        }\n      ]\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `getCampaignJobStatus`\n\nGet the status of a campaign\'s automation job\n\n`GET /v1/campaign/{campaign_id}/job`\n\n```ts\nconst { data } = await client.getCampaignJobStatus({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "queued",\n  "execution_summary": [\n    {\n      "execution_id": "string",\n      "execution_status": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getCampaignPortals`\n\nGet portals usage info for a campaign\n\n`GET /v1/campaign/{campaign_id}/portals`\n\n```ts\nconst { data } = await client.getCampaignPortals({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "portal": {\n      "origin": "string",\n      "domain": "string",\n      "name": "string"\n    },\n    "widgets": [\n      {\n        "id": "string",\n        "headline": {\n          "en": "string",\n          "de": "string"\n        }\n      }\n    ]\n  }\n]\n```\n\n</details>\n\n---\n\n### `retriggerCampaignAutomations`\n\nRetrigger automations for campaign recipients\n\n`POST /v1/campaign/{campaign_id}/automations:retrigger`\n\n```ts\nconst { data } = await client.retriggerCampaignAutomations(\n  {\n    campaign_id: \'example\',\n  },\n  {\n    recipient_ids: [\'3fa85f64-5717-4562-b3fc-2c963f66afa6\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "message": "string",\n  "results": [\n    {\n      "recipient_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "result": "success",\n      "execution_id": "string",\n      "error": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `setupCampaign`\n\nSet up a campaign with related entities and configurations\n\n`POST /v1/campaign:setup`\n\n```ts\nconst { data } = await client.setupCampaign(\n  null,\n  {\n    type: \'tariff_change\',\n    product_recommendation: {\n      name: \'string\',\n      source_product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n      source_price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n      offers: [\n        {\n          target_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n          items: [\n            {\n              product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n              price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n              highlight_config: {}\n            }\n          ]\n        }\n      ]\n    },\n    campaign: {\n      name: \'string\',\n      goal: \'string\',\n      target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n    },\n    journey: {\n      journey_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n    },\n    channels: {\n      portal_widget: {\n        portal_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        block_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n      },\n      email: {\n        automation_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        template_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n      }\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "type": "tariff_change",\n  "product_recommendation_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "journey_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "portal_widget_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84"\n}\n```\n\n</details>\n\n---\n\n### `matchCampaigns`\n\nMatch campaigns\n\n`POST /v1/campaign:match`\n\n```ts\nconst { data } = await client.matchCampaigns(\n  null,\n  {\n    entity_refs: [\n      {\n        entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        entity_schema: \'string\'\n      }\n    ],\n    campaign_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "campaign": {\n        "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n        "_org": "string",\n        "_owners": [\n          {\n            "org_id": "123",\n            "user_id": "123"\n          }\n        ],\n        "_schema": "string",\n        "_title": "string",\n        "_tags": ["string"],\n        "_created_at": "1970-01-01T00:00:00.000Z",\n        "_updated_at": "1970-01-01T00:00:00.000Z",\n        "_acl": {\n          "view": ["org:456"],\n          "edit": ["org:456"],\n          "delete": ["org:456"]\n        },\n        "name": "string",\n        "goal": "string",\n        "status": "draft",\n        "start_date": "1970-01-01",\n        "end_date": "1970-01-01",\n        "flow_id": "string",\n        "job_id": "string",\n        "target": {\n          "$relation": [\n            {\n              "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n              "_tags": ["string"]\n            }\n          ]\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `matchTargets`\n\nMatch targets\n\n`POST /v1/target:match`\n\n```ts\nconst { data } = await client.matchTargets(\n  null,\n  {\n    entity_refs: [\n      {\n        entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        entity_schema: \'string\'\n      }\n    ],\n    target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "target": {\n        "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n        "_org": "string",\n        "_owners": [\n          {\n            "org_id": "123",\n            "user_id": "123"\n          }\n        ],\n        "_schema": "string",\n        "_title": "string",\n        "_tags": ["string"],\n        "_created_at": "1970-01-01T00:00:00.000Z",\n        "_updated_at": "1970-01-01T00:00:00.000Z",\n        "_acl": {\n          "view": ["org:456"],\n          "edit": ["org:456"],\n          "delete": ["org:456"]\n        },\n        "name": "string",\n        "description": "string",\n        "entity_schema": "string",\n        "entity_filters": {}\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getTargetQueries`\n\nGet target queries\n\n`POST /v1/target/queries`\n\n```ts\nconst { data } = await client.getTargetQueries(\n  null,\n  {\n    target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "target_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "query": "string",\n      "error": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createRecipient`\n\nCreate a recipient associated with a campaign\n\n`POST /v1/campaign/{campaign_id}/recipient`\n\n```ts\nconst { data } = await client.createRecipient(\n  {\n    campaign_id: \'example\',\n  },\n  {\n    entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n    entity_schema: \'string\',\n    automation_status: \'pending\',\n    automation_execution_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipient`\n\nUpdate a recipient\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}`\n\n```ts\nconst { data } = await client.updateRecipient(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    automation_status: \'pending\',\n    automation_execution_id: \'string\',\n    portal_status: \'sent\',\n    portal_state: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipientPortalStatus`\n\nUpdate portal status for a campaign recipient\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status`\n\n```ts\nconst { data } = await client.updateRecipientPortalStatus(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    status: \'sent\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getRecipients`\n\nGet campaign recipients\n\n`GET /v1/campaign/{campaign_id}/recipients`\n\n```ts\nconst { data } = await client.getRecipients({\n  campaign_id: \'example\',\n  limit: 1,\n  next: \'example\',\n  q: \'example\',\n  automation_status: \'example\',\n  portal_status: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "entity_schema": "string",\n      "title": "string",\n      "automation_status": "pending",\n      "automation_execution_id": "string",\n      "portal_status": "sent",\n      "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n      "portal_state": {},\n      "updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "next": "string",\n  "total": 0\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseError`\n\n```ts\ntype BaseError = {\n  status: number\n  message: string\n}\n```\n\n### `ServerError`\n\n```ts\ntype ServerError = {\n  status: number\n  message: string\n}\n```\n\n### `ClientError`\n\nDescribes the structure of a client error response, which can be one of several types:\n1. `MessageError`: Contains a \'message\' field for general descriptive errors.\n2. `CodeError`: Contains a \'code\' field for specific, machine-readable error codes.\n3. `StatusedError`: Contains \'error\' and \'status\' f\n\n```ts\ntype ClientError = {\n  message: string\n} | {\n  code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS"\n} | {\n  error: string\n  status: number\n}\n```\n\n### `BaseUUID`\n\n```ts\ntype BaseUUID = string // uuid\n```\n\n### `BaseNanoID`\n\n```ts\ntype BaseNanoID = string\n```\n\n### `BaseTags`\n\n```ts\ntype BaseTags = string[]\n```\n\n### `BaseRelation`\n\n```ts\ntype BaseRelation = {\n  $relation?: Array<{\n    entity_id?: string // uuid\n    _tags?: string[]\n  }>\n}\n```\n\n### `BaseSystemId`\n\n```ts\ntype BaseSystemId = {\n  _id: string // uuid\n}\n```\n\n### `BaseEntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype BaseEntityOwner = {\n  org_id: string\n  user_id?: string\n}\n```\n\n### `BaseEntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype BaseEntityAcl = {\n  view?: string[]\n  edit?: string[]\n  delete?: string[]\n}\n```\n\n### `BaseSystemFields`\n\n```ts\ntype BaseSystemFields = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n}\n```\n\n### `BaseSystemFieldsRequired`\n\n```ts\ntype BaseSystemFieldsRequired = object\n```\n\n### `CampaignStatus`\n\n```ts\ntype CampaignStatus = "draft" | "activating" | "active" | "inactive"\n```\n\n### `ExecutionSummaryItem`\n\n```ts\ntype ExecutionSummaryItem = {\n  execution_id?: string\n  execution_status?: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = {\n  status?: "queued" | "processing" | "finished" | "failed" | "cancelled" | "send_report"\n  execution_summary?: Array<{\n    execution_id?: string\n    execution_status?: string\n  }>\n}\n```\n\n### `Campaign`\n\n```ts\ntype Campaign = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  goal?: string\n  status?: "draft" | "activating" | "active" | "inactive"\n  start_date?: string // date\n  end_date?: string // date\n  flow_id?: string\n  job_id?: string\n  target?: {\n    $relation?: Array<{\n      entity_id?: { ... }\n      _tags?: { ... }\n    }>\n  }\n}\n```\n\n### `Target`\n\n```ts\ntype Target = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  description?: string\n  entity_schema?: string\n  entity_filters?: Record<string, unknown>\n}\n```\n\n### `MatchCampaignParams`\n\n```ts\ntype MatchCampaignParams = {\n  entity_refs: Array<{\n    entity_id: string // uuid\n    entity_schema: string\n  }>\n  campaign_ids: string // uuid[]\n}\n```\n\n### `MatchTargetParams`\n\n```ts\ntype MatchTargetParams = {\n  entity_refs: Array<{\n    entity_id: string // uuid\n    entity_schema: string\n  }>\n  target_ids: string // uuid[]\n}\n```\n\n### `GetTargetQueriesParams`\n\n```ts\ntype GetTargetQueriesParams = {\n  target_ids: string // uuid[]\n}\n```\n\n### `TargetQueryResult`\n\n```ts\ntype TargetQueryResult = {\n  target_id: string // uuid\n  query: string\n  error?: string\n}\n```\n\n### `AutomationStatus`\n\n```ts\ntype AutomationStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled"\n```\n\n### `PortalStatus`\n\n```ts\ntype PortalStatus = "sent" | "seen" | "dismissed" | "clicked"\n```\n\n### `Recipient`\n\n```ts\ntype Recipient = {\n  entity_id?: string // uuid\n  entity_schema?: string\n  title?: string\n  automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id?: string\n  portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n  portal_status_updated_at?: string // date-time\n  portal_state?: Record<string, unknown>\n  updated_at?: string // date-time\n}\n```\n\n### `BaseRecipientPayload`\n\n```ts\ntype BaseRecipientPayload = {\n  entity_id: string // uuid\n  entity_schema: string\n}\n```\n\n### `AutomationRecipientPayload`\n\n```ts\ntype AutomationRecipientPayload = {\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n}\n```\n\n### `PortalRecipientPayload`\n\n```ts\ntype PortalRecipientPayload = {\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `CreateRecipientPayload`\n\n```ts\ntype CreateRecipientPayload = {\n  entity_id: string // uuid\n  entity_schema: string\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n} | {\n  entity_id: string // uuid\n  entity_schema: string\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n} | {\n  entity_id: string // uuid\n  entity_schema: string\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `UpdateRecipientPayload`\n\n```ts\ntype UpdateRecipientPayload = {\n  automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id?: string\n  portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `RetriggerAutomationsRequest`\n\n```ts\ntype RetriggerAutomationsRequest = {\n  recipient_ids: string // uuid[]\n}\n```\n\n### `RetriggerAutomationsResult`\n\n```ts\ntype RetriggerAutomationsResult = {\n  recipient_id: string // uuid\n  result: "success" | "failure" | "not_found" | "invalid_status"\n  execution_id?: string\n  error?: string\n}\n```\n\n### `UpdatePortalStatusRequest`\n\n```ts\ntype UpdatePortalStatusRequest = {\n  status: "sent" | "seen" | "dismissed" | "clicked"\n}\n```\n\n### `SetupCampaignRequest`\n\nDiscriminated by `type`. Each campaign variant has its own request shape;\nnew variants are added by introducing a new schema and extending the `oneOf` list.\n\n\n```ts\ntype SetupCampaignRequest = {\n  type: "tariff_change"\n  product_recommendation: {\n    name?: string\n    source_product_id?: string // uuid\n    source_price_id?: string // uuid\n    offers?: Array<{\n      target_id?: { ... }\n      items: { ... }\n    }>\n  }\n  campaign: {\n    name: string\n    goal?: string\n    target_ids: string // uuid[]\n  }\n  journey?: {\n    journey_id: string // uuid\n  }\n  channels?: {\n    portal_widget?: {\n      portal_id: { ... }\n      block_id: { ... }\n    }\n    email?: {\n      automation_id?: { ... }\n      template_id?: { ... }\n    }\n  }\n}\n```\n\n### `SetupTariffChangeCampaignRequest`\n\n```ts\ntype SetupTariffChangeCampaignRequest = {\n  type: "tariff_change"\n  product_recommendation: {\n    name?: string\n    source_product_id?: string // uuid\n    source_price_id?: string // uuid\n    offers?: Array<{\n      target_id?: { ... }\n      items: { ... }\n    }>\n  }\n  campaign: {\n    name: string\n    goal?: string\n    target_ids: string // uuid[]\n  }\n  journey?: {\n    journey_id: string // uuid\n  }\n  channels?: {\n    portal_widget?: {\n      portal_id: { ... }\n      block_id: { ... }\n    }\n    email?: {\n      automation_id?: { ... }\n      template_id?: { ... }\n    }\n  }\n}\n```\n\n### `SetupTariffChangeCampaignResponse`\n\n```ts\ntype SetupTariffChangeCampaignResponse = {\n  type: "tariff_change"\n  product_recommendation_id: string // uuid\n  campaign_id: string // uuid\n  journey_id?: string // uuid\n  portal_widget_id?: string // uuid\n}\n```\n';
+var targeting_default = '# Targeting API\n\n- **Base URL:** `https://targeting.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/targeting](https://docs.epilot.io/api/targeting)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.targeting.changeCampaignStatus(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/targeting\'\n\nconst targetingClient = getClient()\nauthorize(targetingClient, () => \'<token>\')\nconst { data } = await targetingClient.changeCampaignStatus(...)\n```\n\n## Operations\n\n**Campaign**\n- [`changeCampaignStatus`](#changecampaignstatus)\n- [`getCampaignJobStatus`](#getcampaignjobstatus)\n- [`getCampaignPortals`](#getcampaignportals)\n- [`setupCampaign`](#setupcampaign)\n- [`matchCampaigns`](#matchcampaigns)\n\n**Campaign Delivery**\n- [`retriggerCampaignAutomations`](#retriggercampaignautomations)\n\n**Target**\n- [`matchTargets`](#matchtargets)\n- [`getTargetQueries`](#gettargetqueries)\n\n**Campaign Recipient**\n- [`createRecipient`](#createrecipient)\n- [`updateRecipient`](#updaterecipient)\n- [`updateRecipientPortalStatus`](#updaterecipientportalstatus)\n- [`getRecipients`](#getrecipients)\n\n**Schemas**\n- [`BaseError`](#baseerror)\n- [`ServerError`](#servererror)\n- [`ClientError`](#clienterror)\n- [`BaseUUID`](#baseuuid)\n- [`BaseNanoID`](#basenanoid)\n- [`BaseTags`](#basetags)\n- [`BaseRelation`](#baserelation)\n- [`BaseSystemId`](#basesystemid)\n- [`BaseEntityOwner`](#baseentityowner)\n- [`BaseEntityAcl`](#baseentityacl)\n- [`BaseSystemFields`](#basesystemfields)\n- [`BaseSystemFieldsRequired`](#basesystemfieldsrequired)\n- [`CampaignStatus`](#campaignstatus)\n- [`ExecutionSummaryItem`](#executionsummaryitem)\n- [`JobStatus`](#jobstatus)\n- [`Campaign`](#campaign)\n- [`Target`](#target)\n- [`MatchCampaignParams`](#matchcampaignparams)\n- [`MatchTargetParams`](#matchtargetparams)\n- [`GetTargetQueriesParams`](#gettargetqueriesparams)\n- [`TargetQueryResult`](#targetqueryresult)\n- [`AutomationStatus`](#automationstatus)\n- [`PortalStatus`](#portalstatus)\n- [`Recipient`](#recipient)\n- [`BaseRecipientPayload`](#baserecipientpayload)\n- [`AutomationRecipientPayload`](#automationrecipientpayload)\n- [`PortalRecipientPayload`](#portalrecipientpayload)\n- [`CreateRecipientPayload`](#createrecipientpayload)\n- [`UpdateRecipientPayload`](#updaterecipientpayload)\n- [`RetriggerAutomationsRequest`](#retriggerautomationsrequest)\n- [`RetriggerAutomationsResult`](#retriggerautomationsresult)\n- [`UpdatePortalStatusRequest`](#updateportalstatusrequest)\n- [`SetupCampaignRequest`](#setupcampaignrequest)\n- [`SetupTariffChangeCampaignRequest`](#setuptariffchangecampaignrequest)\n- [`SetupTariffChangeCampaignResponse`](#setuptariffchangecampaignresponse)\n\n### `changeCampaignStatus`\n\nChange the status of a campaign\n\n`POST /v1/campaign/{campaign_id}/status`\n\n```ts\nconst { data } = await client.changeCampaignStatus({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "campaign": {\n    "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n    "_org": "string",\n    "_owners": [\n      {\n        "org_id": "123",\n        "user_id": "123"\n      }\n    ],\n    "_schema": "string",\n    "_title": "string",\n    "_tags": ["string"],\n    "_created_at": "1970-01-01T00:00:00.000Z",\n    "_updated_at": "1970-01-01T00:00:00.000Z",\n    "_acl": {\n      "view": ["org:456"],\n      "edit": ["org:456"],\n      "delete": ["org:456"]\n    },\n    "name": "string",\n    "goal": "string",\n    "status": "draft",\n    "start_date": "1970-01-01",\n    "end_date": "1970-01-01",\n    "flow_id": "string",\n    "job_id": "string",\n    "target": {\n      "$relation": [\n        {\n          "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n          "_tags": ["string"]\n        }\n      ]\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `getCampaignJobStatus`\n\nGet the status of a campaign\'s automation job\n\n`GET /v1/campaign/{campaign_id}/job`\n\n```ts\nconst { data } = await client.getCampaignJobStatus({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "queued",\n  "execution_summary": [\n    {\n      "execution_id": "string",\n      "execution_status": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getCampaignPortals`\n\nGet portals usage info for a campaign\n\n`GET /v1/campaign/{campaign_id}/portals`\n\n```ts\nconst { data } = await client.getCampaignPortals({\n  campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "portal": {\n      "origin": "string",\n      "domain": "string",\n      "name": "string"\n    },\n    "widgets": [\n      {\n        "id": "string",\n        "headline": {\n          "en": "string",\n          "de": "string"\n        }\n      }\n    ]\n  }\n]\n```\n\n</details>\n\n---\n\n### `retriggerCampaignAutomations`\n\nRetrigger automations for campaign recipients\n\n`POST /v1/campaign/{campaign_id}/automations:retrigger`\n\n```ts\nconst { data } = await client.retriggerCampaignAutomations(\n  {\n    campaign_id: \'example\',\n  },\n  {\n    recipient_ids: [\'3fa85f64-5717-4562-b3fc-2c963f66afa6\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "message": "string",\n  "results": [\n    {\n      "recipient_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n      "result": "success",\n      "execution_id": "string",\n      "error": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `setupCampaign`\n\nSet up a campaign with related entities and configurations\n\n`POST /v1/campaign:setup`\n\n```ts\nconst { data } = await client.setupCampaign(\n  null,\n  {\n    type: \'tariff_change\',\n    product_recommendation: {\n      name: \'string\',\n      source_product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n      source_price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n      offers: [\n        {\n          target_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n          items: [\n            {\n              product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n              price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n              highlight_config: {}\n            }\n          ]\n        }\n      ]\n    },\n    campaign: {\n      name: \'string\',\n      goal: \'string\',\n      target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n    },\n    journey: {\n      journey_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n    },\n    channels: {\n      portal_widget: {\n        portal_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        block_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n      },\n      email: {\n        automation_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n      }\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "type": "tariff_change",\n  "product_recommendation_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "journey_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "portal_widget_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84"\n}\n```\n\n</details>\n\n---\n\n### `matchCampaigns`\n\nMatch campaigns\n\n`POST /v1/campaign:match`\n\n```ts\nconst { data } = await client.matchCampaigns(\n  null,\n  {\n    entity_refs: [\n      {\n        entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        entity_schema: \'string\'\n      }\n    ],\n    campaign_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "campaign": {\n        "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n        "_org": "string",\n        "_owners": [\n          {\n            "org_id": "123",\n            "user_id": "123"\n          }\n        ],\n        "_schema": "string",\n        "_title": "string",\n        "_tags": ["string"],\n        "_created_at": "1970-01-01T00:00:00.000Z",\n        "_updated_at": "1970-01-01T00:00:00.000Z",\n        "_acl": {\n          "view": ["org:456"],\n          "edit": ["org:456"],\n          "delete": ["org:456"]\n        },\n        "name": "string",\n        "goal": "string",\n        "status": "draft",\n        "start_date": "1970-01-01",\n        "end_date": "1970-01-01",\n        "flow_id": "string",\n        "job_id": "string",\n        "target": {\n          "$relation": [\n            {\n              "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n              "_tags": ["string"]\n            }\n          ]\n        }\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `matchTargets`\n\nMatch targets\n\n`POST /v1/target:match`\n\n```ts\nconst { data } = await client.matchTargets(\n  null,\n  {\n    entity_refs: [\n      {\n        entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n        entity_schema: \'string\'\n      }\n    ],\n    target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "target": {\n        "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n        "_org": "string",\n        "_owners": [\n          {\n            "org_id": "123",\n            "user_id": "123"\n          }\n        ],\n        "_schema": "string",\n        "_title": "string",\n        "_tags": ["string"],\n        "_created_at": "1970-01-01T00:00:00.000Z",\n        "_updated_at": "1970-01-01T00:00:00.000Z",\n        "_acl": {\n          "view": ["org:456"],\n          "edit": ["org:456"],\n          "delete": ["org:456"]\n        },\n        "name": "string",\n        "description": "string",\n        "entity_schema": "string",\n        "entity_filters": {}\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getTargetQueries`\n\nGet target queries\n\n`POST /v1/target/queries`\n\n```ts\nconst { data } = await client.getTargetQueries(\n  null,\n  {\n    target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "target_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "query": "string",\n      "error": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createRecipient`\n\nCreate a recipient associated with a campaign\n\n`POST /v1/campaign/{campaign_id}/recipient`\n\n```ts\nconst { data } = await client.createRecipient(\n  {\n    campaign_id: \'example\',\n  },\n  {\n    entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n    entity_schema: \'string\',\n    automation_status: \'pending\',\n    automation_execution_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipient`\n\nUpdate a recipient\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}`\n\n```ts\nconst { data } = await client.updateRecipient(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    automation_status: \'pending\',\n    automation_execution_id: \'string\',\n    portal_status: \'sent\',\n    portal_state: {}\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipientPortalStatus`\n\nUpdate portal status for a campaign recipient\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status`\n\n```ts\nconst { data } = await client.updateRecipientPortalStatus(\n  {\n    campaign_id: \'example\',\n    recipient_id: \'example\',\n  },\n  {\n    status: \'sent\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n  "entity_schema": "string",\n  "title": "string",\n  "automation_status": "pending",\n  "automation_execution_id": "string",\n  "portal_status": "sent",\n  "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n  "portal_state": {},\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getRecipients`\n\nGet campaign recipients\n\n`GET /v1/campaign/{campaign_id}/recipients`\n\n```ts\nconst { data } = await client.getRecipients({\n  campaign_id: \'example\',\n  limit: 1,\n  next: \'example\',\n  q: \'example\',\n  automation_status: \'example\',\n  portal_status: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n      "entity_schema": "string",\n      "title": "string",\n      "automation_status": "pending",\n      "automation_execution_id": "string",\n      "portal_status": "sent",\n      "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n      "portal_state": {},\n      "updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ],\n  "next": "string",\n  "total": 0\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseError`\n\n```ts\ntype BaseError = {\n  status: number\n  message: string\n}\n```\n\n### `ServerError`\n\n```ts\ntype ServerError = {\n  status: number\n  message: string\n}\n```\n\n### `ClientError`\n\nDescribes the structure of a client error response, which can be one of several types:\n1. `MessageError`: Contains a \'message\' field for general descriptive errors.\n2. `CodeError`: Contains a \'code\' field for specific, machine-readable error codes.\n3. `StatusedError`: Contains \'error\' and \'status\' f\n\n```ts\ntype ClientError = {\n  message: string\n} | {\n  code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS"\n} | {\n  error: string\n  status: number\n}\n```\n\n### `BaseUUID`\n\n```ts\ntype BaseUUID = string // uuid\n```\n\n### `BaseNanoID`\n\n```ts\ntype BaseNanoID = string\n```\n\n### `BaseTags`\n\n```ts\ntype BaseTags = string[]\n```\n\n### `BaseRelation`\n\n```ts\ntype BaseRelation = {\n  $relation?: Array<{\n    entity_id?: string // uuid\n    _tags?: string[]\n  }>\n}\n```\n\n### `BaseSystemId`\n\n```ts\ntype BaseSystemId = {\n  _id: string // uuid\n}\n```\n\n### `BaseEntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype BaseEntityOwner = {\n  org_id: string\n  user_id?: string\n}\n```\n\n### `BaseEntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype BaseEntityAcl = {\n  view?: string[]\n  edit?: string[]\n  delete?: string[]\n}\n```\n\n### `BaseSystemFields`\n\n```ts\ntype BaseSystemFields = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n}\n```\n\n### `BaseSystemFieldsRequired`\n\n```ts\ntype BaseSystemFieldsRequired = object\n```\n\n### `CampaignStatus`\n\n```ts\ntype CampaignStatus = "draft" | "activating" | "active" | "inactive"\n```\n\n### `ExecutionSummaryItem`\n\n```ts\ntype ExecutionSummaryItem = {\n  execution_id?: string\n  execution_status?: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = {\n  status?: "queued" | "processing" | "finished" | "failed" | "cancelled" | "send_report"\n  execution_summary?: Array<{\n    execution_id?: string\n    execution_status?: string\n  }>\n}\n```\n\n### `Campaign`\n\n```ts\ntype Campaign = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  goal?: string\n  status?: "draft" | "activating" | "active" | "inactive"\n  start_date?: string // date\n  end_date?: string // date\n  flow_id?: string\n  job_id?: string\n  target?: {\n    $relation?: Array<{\n      entity_id?: { ... }\n      _tags?: { ... }\n    }>\n  }\n}\n```\n\n### `Target`\n\n```ts\ntype Target = {\n  _id?: string // uuid\n  _org?: string\n  _owners?: Array<{\n    org_id: string\n    user_id?: string\n  }>\n  _schema?: string\n  _title?: string\n  _tags?: string[]\n  _created_at?: string // date-time\n  _updated_at?: string // date-time\n  _acl?: {\n    view?: string[]\n    edit?: string[]\n    delete?: string[]\n  }\n  name?: string\n  description?: string\n  entity_schema?: string\n  entity_filters?: Record<string, unknown>\n}\n```\n\n### `MatchCampaignParams`\n\n```ts\ntype MatchCampaignParams = {\n  entity_refs: Array<{\n    entity_id: string // uuid\n    entity_schema: string\n  }>\n  campaign_ids: string // uuid[]\n}\n```\n\n### `MatchTargetParams`\n\n```ts\ntype MatchTargetParams = {\n  entity_refs: Array<{\n    entity_id: string // uuid\n    entity_schema: string\n  }>\n  target_ids: string // uuid[]\n}\n```\n\n### `GetTargetQueriesParams`\n\n```ts\ntype GetTargetQueriesParams = {\n  target_ids: string // uuid[]\n}\n```\n\n### `TargetQueryResult`\n\n```ts\ntype TargetQueryResult = {\n  target_id: string // uuid\n  query: string\n  error?: string\n}\n```\n\n### `AutomationStatus`\n\n```ts\ntype AutomationStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled"\n```\n\n### `PortalStatus`\n\n```ts\ntype PortalStatus = "sent" | "seen" | "dismissed" | "clicked"\n```\n\n### `Recipient`\n\n```ts\ntype Recipient = {\n  entity_id?: string // uuid\n  entity_schema?: string\n  title?: string\n  automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id?: string\n  portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n  portal_status_updated_at?: string // date-time\n  portal_state?: Record<string, unknown>\n  updated_at?: string // date-time\n}\n```\n\n### `BaseRecipientPayload`\n\n```ts\ntype BaseRecipientPayload = {\n  entity_id: string // uuid\n  entity_schema: string\n}\n```\n\n### `AutomationRecipientPayload`\n\n```ts\ntype AutomationRecipientPayload = {\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n}\n```\n\n### `PortalRecipientPayload`\n\n```ts\ntype PortalRecipientPayload = {\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `CreateRecipientPayload`\n\n```ts\ntype CreateRecipientPayload = {\n  entity_id: string // uuid\n  entity_schema: string\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n} | {\n  entity_id: string // uuid\n  entity_schema: string\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n} | {\n  entity_id: string // uuid\n  entity_schema: string\n  automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id: string\n  portal_status: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `UpdateRecipientPayload`\n\n```ts\ntype UpdateRecipientPayload = {\n  automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n  automation_execution_id?: string\n  portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n  portal_state?: Record<string, unknown>\n}\n```\n\n### `RetriggerAutomationsRequest`\n\n```ts\ntype RetriggerAutomationsRequest = {\n  recipient_ids: string // uuid[]\n}\n```\n\n### `RetriggerAutomationsResult`\n\n```ts\ntype RetriggerAutomationsResult = {\n  recipient_id: string // uuid\n  result: "success" | "failure" | "not_found" | "invalid_status"\n  execution_id?: string\n  error?: string\n}\n```\n\n### `UpdatePortalStatusRequest`\n\n```ts\ntype UpdatePortalStatusRequest = {\n  status: "sent" | "seen" | "dismissed" | "clicked"\n}\n```\n\n### `SetupCampaignRequest`\n\nDiscriminated by `type`. Each campaign variant has its own request shape;\nnew variants are added by introducing a new schema and extending the `oneOf` list.\n\n\n```ts\ntype SetupCampaignRequest = {\n  type: "tariff_change"\n  product_recommendation: {\n    name?: string\n    source_product_id?: string // uuid\n    source_price_id?: string // uuid\n    offers?: Array<{\n      target_id?: { ... }\n      items: { ... }\n    }>\n  }\n  campaign: {\n    name: string\n    goal?: string\n    target_ids: string // uuid[]\n  }\n  journey?: {\n    journey_id: string // uuid\n  }\n  channels?: {\n    portal_widget?: {\n      portal_id: { ... }\n      block_id: { ... }\n    }\n    email?: {\n      automation_id: { ... }\n    }\n  }\n}\n```\n\n### `SetupTariffChangeCampaignRequest`\n\n```ts\ntype SetupTariffChangeCampaignRequest = {\n  type: "tariff_change"\n  product_recommendation: {\n    name?: string\n    source_product_id?: string // uuid\n    source_price_id?: string // uuid\n    offers?: Array<{\n      target_id?: { ... }\n      items: { ... }\n    }>\n  }\n  campaign: {\n    name: string\n    goal?: string\n    target_ids: string // uuid[]\n  }\n  journey?: {\n    journey_id: string // uuid\n  }\n  channels?: {\n    portal_widget?: {\n      portal_id: { ... }\n      block_id: { ... }\n    }\n    email?: {\n      automation_id: { ... }\n    }\n  }\n}\n```\n\n### `SetupTariffChangeCampaignResponse`\n\n```ts\ntype SetupTariffChangeCampaignResponse = {\n  type: "tariff_change"\n  product_recommendation_id: string // uuid\n  campaign_id: string // uuid\n  journey_id?: string // uuid\n  portal_widget_id?: string // uuid\n}\n```\n';
 
 
 exports.default = targeting_default;