@epilot/sdk 2.7.1 → 2.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (225) hide show
  1. package/definitions/app.json +101 -8
  2. package/definitions/configuration-hub-runtime.json +1 -1
  3. package/definitions/configuration-hub.json +623 -0
  4. package/definitions/customer-portal.json +72 -58
  5. package/definitions/design-runtime.json +1 -1
  6. package/definitions/design.json +52 -12
  7. package/definitions/file-runtime.json +1 -1
  8. package/definitions/file.json +88 -4
  9. package/definitions/journey-runtime.json +1 -1
  10. package/definitions/journey.json +21 -1
  11. package/definitions/notes-runtime.json +1 -1
  12. package/definitions/notes.json +123 -1
  13. package/definitions/pricing.json +149 -404
  14. package/dist/apis/access-token.cjs +6 -6
  15. package/dist/apis/access-token.js +1 -1
  16. package/dist/apis/address-suggestions.cjs +6 -6
  17. package/dist/apis/address-suggestions.js +1 -1
  18. package/dist/apis/address.cjs +6 -6
  19. package/dist/apis/address.js +1 -1
  20. package/dist/apis/ai-agents.cjs +6 -6
  21. package/dist/apis/ai-agents.js +1 -1
  22. package/dist/apis/app.cjs +6 -6
  23. package/dist/apis/app.d.cts +2 -2
  24. package/dist/apis/app.d.ts +2 -2
  25. package/dist/apis/app.js +1 -1
  26. package/dist/apis/audit-logs.cjs +6 -6
  27. package/dist/apis/audit-logs.js +1 -1
  28. package/dist/apis/automation.cjs +6 -6
  29. package/dist/apis/automation.js +1 -1
  30. package/dist/apis/billing.cjs +6 -6
  31. package/dist/apis/billing.js +1 -1
  32. package/dist/apis/blueprint-manifest.cjs +6 -6
  33. package/dist/apis/blueprint-manifest.js +1 -1
  34. package/dist/apis/calendar.cjs +6 -6
  35. package/dist/apis/calendar.js +1 -1
  36. package/dist/apis/configuration-hub.cjs +8 -8
  37. package/dist/apis/configuration-hub.d.cts +2 -2
  38. package/dist/apis/configuration-hub.d.ts +2 -2
  39. package/dist/apis/configuration-hub.js +2 -2
  40. package/dist/apis/consent.cjs +6 -6
  41. package/dist/apis/consent.js +1 -1
  42. package/dist/apis/customer-portal.cjs +6 -6
  43. package/dist/apis/customer-portal.d.cts +2 -2
  44. package/dist/apis/customer-portal.d.ts +2 -2
  45. package/dist/apis/customer-portal.js +1 -1
  46. package/dist/apis/dashboard.cjs +6 -6
  47. package/dist/apis/dashboard.js +1 -1
  48. package/dist/apis/data-governance.cjs +6 -6
  49. package/dist/apis/data-governance.js +1 -1
  50. package/dist/apis/deduplication.cjs +6 -6
  51. package/dist/apis/deduplication.js +1 -1
  52. package/dist/apis/design.cjs +8 -8
  53. package/dist/apis/design.d.cts +2 -2
  54. package/dist/apis/design.d.ts +2 -2
  55. package/dist/apis/design.js +2 -2
  56. package/dist/apis/document.cjs +6 -6
  57. package/dist/apis/document.js +1 -1
  58. package/dist/apis/email-settings.cjs +6 -6
  59. package/dist/apis/email-settings.js +1 -1
  60. package/dist/apis/email-template.cjs +6 -6
  61. package/dist/apis/email-template.js +1 -1
  62. package/dist/apis/entity-mapping.cjs +6 -6
  63. package/dist/apis/entity-mapping.js +1 -1
  64. package/dist/apis/entity.cjs +6 -6
  65. package/dist/apis/entity.js +1 -1
  66. package/dist/apis/environments.cjs +6 -6
  67. package/dist/apis/environments.js +1 -1
  68. package/dist/apis/event-catalog.cjs +6 -6
  69. package/dist/apis/event-catalog.js +1 -1
  70. package/dist/apis/file.cjs +8 -8
  71. package/dist/apis/file.d.cts +2 -2
  72. package/dist/apis/file.d.ts +2 -2
  73. package/dist/apis/file.js +2 -2
  74. package/dist/apis/iban.cjs +6 -6
  75. package/dist/apis/iban.js +1 -1
  76. package/dist/apis/integration-toolkit.cjs +6 -6
  77. package/dist/apis/integration-toolkit.js +1 -1
  78. package/dist/apis/journey.cjs +8 -8
  79. package/dist/apis/journey.d.cts +2 -2
  80. package/dist/apis/journey.d.ts +2 -2
  81. package/dist/apis/journey.js +2 -2
  82. package/dist/apis/kanban.cjs +6 -6
  83. package/dist/apis/kanban.js +1 -1
  84. package/dist/apis/message.cjs +6 -6
  85. package/dist/apis/message.js +1 -1
  86. package/dist/apis/metering.cjs +6 -6
  87. package/dist/apis/metering.js +1 -1
  88. package/dist/apis/notes.cjs +8 -8
  89. package/dist/apis/notes.d.cts +2 -2
  90. package/dist/apis/notes.d.ts +2 -2
  91. package/dist/apis/notes.js +2 -2
  92. package/dist/apis/notification.cjs +6 -6
  93. package/dist/apis/notification.js +1 -1
  94. package/dist/apis/organization.cjs +6 -6
  95. package/dist/apis/organization.js +1 -1
  96. package/dist/apis/partner-directory.cjs +6 -6
  97. package/dist/apis/partner-directory.js +1 -1
  98. package/dist/apis/permissions.cjs +6 -6
  99. package/dist/apis/permissions.js +1 -1
  100. package/dist/apis/pricing-tier.cjs +6 -6
  101. package/dist/apis/pricing-tier.js +1 -1
  102. package/dist/apis/pricing.cjs +6 -6
  103. package/dist/apis/pricing.d.cts +2 -2
  104. package/dist/apis/pricing.d.ts +2 -2
  105. package/dist/apis/pricing.js +1 -1
  106. package/dist/apis/purpose.cjs +6 -6
  107. package/dist/apis/purpose.js +1 -1
  108. package/dist/apis/query.cjs +6 -6
  109. package/dist/apis/query.js +1 -1
  110. package/dist/apis/sandbox.cjs +6 -6
  111. package/dist/apis/sandbox.js +1 -1
  112. package/dist/apis/sharing.cjs +6 -6
  113. package/dist/apis/sharing.js +1 -1
  114. package/dist/apis/submission.cjs +6 -6
  115. package/dist/apis/submission.js +1 -1
  116. package/dist/apis/target.cjs +6 -6
  117. package/dist/apis/target.js +1 -1
  118. package/dist/apis/targeting.cjs +6 -6
  119. package/dist/apis/targeting.js +1 -1
  120. package/dist/apis/template-variables.cjs +6 -6
  121. package/dist/apis/template-variables.js +1 -1
  122. package/dist/apis/user.cjs +6 -6
  123. package/dist/apis/user.js +1 -1
  124. package/dist/apis/validation-rules.cjs +6 -6
  125. package/dist/apis/validation-rules.js +1 -1
  126. package/dist/apis/webhooks.cjs +6 -6
  127. package/dist/apis/webhooks.js +1 -1
  128. package/dist/apis/workflow-definition.cjs +6 -6
  129. package/dist/apis/workflow-definition.js +1 -1
  130. package/dist/apis/workflow.cjs +6 -6
  131. package/dist/apis/workflow.js +1 -1
  132. package/dist/{app-SSF545U7.cjs → app-74LECFMK.cjs} +1 -1
  133. package/dist/{app-34OBBTA4.js → app-GNUHCGPO.js} +1 -1
  134. package/dist/{app.d--5n0FQQ4.d.cts → app.d-BOR23dso.d.cts} +104 -4
  135. package/dist/{app.d--5n0FQQ4.d.ts → app.d-BOR23dso.d.ts} +104 -4
  136. package/dist/bin/cli.js +1 -1
  137. package/dist/{chunk-SCMAZ73K.js → chunk-2FJMQLXE.js} +28 -19
  138. package/dist/chunk-4M5V6BIT.cjs +14 -0
  139. package/dist/chunk-JOUTFBLN.js +14 -0
  140. package/dist/chunk-LAWKCWVU.cjs +14 -0
  141. package/dist/{chunk-ZSONBZIF.cjs → chunk-MOLFG5L4.cjs} +1 -1
  142. package/dist/chunk-P4NA7NWG.js +14 -0
  143. package/dist/{chunk-R7XDTILZ.cjs → chunk-QNMDISUR.cjs} +28 -19
  144. package/dist/chunk-RDVFQOCQ.js +14 -0
  145. package/dist/chunk-WHXYES2D.cjs +14 -0
  146. package/dist/{chunk-RW5JOHG7.js → chunk-WIQXF7DD.js} +1 -1
  147. package/dist/{chunk-ONOGGR6Q.js → chunk-WW6DVKJR.js} +1 -1
  148. package/dist/{chunk-M2SSGV7K.cjs → chunk-ZOQUGWQL.cjs} +1 -1
  149. package/dist/configuration-hub-E7S4JB2T.js +7 -0
  150. package/dist/configuration-hub-Q5JBYB52.cjs +7 -0
  151. package/dist/{configuration-hub-runtime-L6IOERSP.js → configuration-hub-runtime-CXME7TCX.js} +1 -1
  152. package/dist/{configuration-hub-runtime-I5Y67CXD.cjs → configuration-hub-runtime-QVLJKEZD.cjs} +2 -2
  153. package/dist/configuration-hub.d-CbSJDa7k.d.cts +1096 -0
  154. package/dist/configuration-hub.d-CbSJDa7k.d.ts +1096 -0
  155. package/dist/customer-portal-IBM3K2EZ.cjs +7 -0
  156. package/dist/customer-portal-XPYKMIIA.js +7 -0
  157. package/dist/{customer-portal.d-C7ZCbjiY.d.cts → customer-portal.d-CTTCBAZI.d.cts} +217 -61
  158. package/dist/{customer-portal.d-C7ZCbjiY.d.ts → customer-portal.d-CTTCBAZI.d.ts} +217 -61
  159. package/dist/design-DUFBH5ZB.js +7 -0
  160. package/dist/design-W3D3UPGB.cjs +7 -0
  161. package/dist/design-runtime-3RHYNHUV.cjs +5 -0
  162. package/dist/{design-runtime-QMJM4FAF.js → design-runtime-DLMA4EHQ.js} +1 -1
  163. package/dist/{design.d-BRre8iLg.d.cts → design.d-DzSDu8cy.d.cts} +41 -3
  164. package/dist/{design.d-BRre8iLg.d.ts → design.d-DzSDu8cy.d.ts} +41 -3
  165. package/dist/file-BGJVE7QG.cjs +7 -0
  166. package/dist/file-DRLPMLFW.js +7 -0
  167. package/dist/file-runtime-7AWKNQU6.cjs +5 -0
  168. package/dist/{file-runtime-BIRMXYRH.js → file-runtime-DKGFS44O.js} +1 -1
  169. package/dist/{file.d-DTlrbI40.d.cts → file.d-Rq_mbdOo.d.cts} +145 -5
  170. package/dist/{file.d-DTlrbI40.d.ts → file.d-Rq_mbdOo.d.ts} +145 -5
  171. package/dist/index.cjs +18 -18
  172. package/dist/index.d.cts +8 -8
  173. package/dist/index.d.ts +8 -8
  174. package/dist/index.js +6 -6
  175. package/dist/journey-4DIIPRU4.js +7 -0
  176. package/dist/journey-ATC3Y5AW.cjs +7 -0
  177. package/dist/{journey-runtime-SPBL3F32.cjs → journey-runtime-G2O5C3N2.cjs} +2 -2
  178. package/dist/{journey-runtime-YXIAOTMD.js → journey-runtime-RI2LJO5S.js} +1 -1
  179. package/dist/{journey.d-ClXO0xK8.d.cts → journey.d-BenIUWaO.d.cts} +9 -3
  180. package/dist/{journey.d-ClXO0xK8.d.ts → journey.d-BenIUWaO.d.ts} +9 -3
  181. package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
  182. package/dist/notes-6JESMRLW.js +7 -0
  183. package/dist/notes-SLEUSNP4.cjs +7 -0
  184. package/dist/{notes-runtime-CVNAVKPP.js → notes-runtime-I4SWR3PZ.js} +1 -1
  185. package/dist/notes-runtime-YWTRRNH5.cjs +5 -0
  186. package/dist/{notes.d-BcV_m5fe.d.cts → notes.d-rbcyHfiB.d.cts} +101 -3
  187. package/dist/{notes.d-BcV_m5fe.d.ts → notes.d-rbcyHfiB.d.ts} +101 -3
  188. package/dist/pricing-F7HQ6BWC.cjs +7 -0
  189. package/dist/pricing-YCD4EUGI.js +7 -0
  190. package/dist/{pricing.d-BHpMU4KU.d.cts → pricing.d-exMaGWm1.d.cts} +140 -280
  191. package/dist/{pricing.d-BHpMU4KU.d.ts → pricing.d-exMaGWm1.d.ts} +140 -280
  192. package/docs/app.md +34 -10
  193. package/docs/configuration-hub.md +660 -0
  194. package/docs/customer-portal.md +221 -159
  195. package/docs/design.md +81 -4
  196. package/docs/file.md +81 -0
  197. package/docs/journey.md +2 -0
  198. package/docs/notes.md +47 -1
  199. package/docs/pricing.md +269 -218
  200. package/package.json +1 -1
  201. package/dist/chunk-3APTSPY4.js +0 -14
  202. package/dist/chunk-EIIIKDOJ.cjs +0 -14
  203. package/dist/chunk-KIWRGUKM.js +0 -14
  204. package/dist/chunk-MB6NKETA.cjs +0 -14
  205. package/dist/chunk-OPXGJKZR.cjs +0 -14
  206. package/dist/chunk-VSZEOCIE.js +0 -14
  207. package/dist/configuration-hub-A3S6ND6R.cjs +0 -7
  208. package/dist/configuration-hub-PMAW44U5.js +0 -7
  209. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  210. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  211. package/dist/customer-portal-7HYSBH7H.cjs +0 -7
  212. package/dist/customer-portal-X4LJX6AU.js +0 -7
  213. package/dist/design-DROLIWS3.js +0 -7
  214. package/dist/design-XZKOZLTR.cjs +0 -7
  215. package/dist/design-runtime-OXEXKZVG.cjs +0 -5
  216. package/dist/file-P2FUUER2.js +0 -7
  217. package/dist/file-XTY74SIX.cjs +0 -7
  218. package/dist/file-runtime-24S3QPA7.cjs +0 -5
  219. package/dist/journey-KDR5EU3W.js +0 -7
  220. package/dist/journey-REBN4TGQ.cjs +0 -7
  221. package/dist/notes-K2IIFCX3.cjs +0 -7
  222. package/dist/notes-Q7JGS7O3.js +0 -7
  223. package/dist/notes-runtime-E3YYF74V.cjs +0 -5
  224. package/dist/pricing-FODHQFCB.cjs +0 -7
  225. package/dist/pricing-XRIDVZFC.js +0 -7
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/journey.json
4
- 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 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})\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';
5
- export {
6
- journey_default as default
7
- };
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/journey.json
4
- 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 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})\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';
5
-
6
-
7
- exports.default = journey_default;
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/notes.json
4
- var notes_default = '# Notes API\n\n- **Base URL:** `https://notes.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/notes](https://docs.epilot.io/api/notes)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.notes.createNote(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/notes\'\n\nconst notesClient = getClient()\nauthorize(notesClient, () => \'<token>\')\nconst { data } = await notesClient.createNote(...)\n```\n\n## Operations\n\n**Notes**\n- [`createNote`](#createnote)\n- [`getNote`](#getnote)\n- [`patchNote`](#patchnote)\n- [`updateNote`](#updatenote)\n- [`deleteNote`](#deletenote)\n- [`searchNotesByContext`](#searchnotesbycontext)\n- [`getNoteContexts`](#getnotecontexts)\n\n**Pinning**\n- [`pinNote`](#pinnote)\n\n**Reactions**\n- [`addNoteReaction`](#addnotereaction)\n- [`removeNoteReaction`](#removenotereaction)\n- [`toggleNoteReactions`](#togglenotereactions)\n\n**Schemas**\n- [`NotePostRequestBody`](#notepostrequestbody)\n- [`ContextType`](#contexttype)\n- [`NoteEntity`](#noteentity)\n- [`Entity`](#entity)\n- [`CreatedByType`](#createdbytype)\n- [`NoteGetRequestResponse`](#notegetrequestresponse)\n- [`NotePatchRequestBody`](#notepatchrequestbody)\n- [`NonHydratedNoteEntity`](#nonhydratednoteentity)\n- [`NoteEntityParent`](#noteentityparent)\n- [`NotePutRequestBody`](#noteputrequestbody)\n- [`NoteSearchByContextRequestBody`](#notesearchbycontextrequestbody)\n- [`NotesSearchRequestResponse`](#notessearchrequestresponse)\n- [`NoteContexts`](#notecontexts)\n- [`WorkflowExecution`](#workflowexecution)\n- [`ReactionRequest`](#reactionrequest)\n- [`ToggleReactionsRequest`](#togglereactionsrequest)\n\n### `createNote`\n\nCreates a new Note entry\n\n`POST /v1/note`\n\n```ts\nconst { data } = await client.createNote(\n null,\n {\n _tags: [\'string\'],\n type: \'string\',\n entity_id: \'string\',\n parent_id: \'string\',\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n additional_contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n content: \'string\',\n attachments: [\'string\'],\n read_by: [\'string\']\n },\n)\n```\n\n---\n\n### `getNote`\n\nRetrieves a single Note entry based on it\'s Entity ID\n\n`GET /v1/note/{id}`\n\n```ts\nconst { data } = await client.getNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n})\n```\n\n---\n\n### `patchNote`\n\nUpdates an existing Note entry\n\n`PATCH /v1/note/{id}`\n\n```ts\nconst { data } = await client.patchNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `updateNote`\n\nUpdates an existing Note entry\n\n`PUT /v1/note/{id}`\n\n```ts\nconst { data } = await client.updateNote(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n _id: \'string\',\n _org: \'string\',\n _schema: \'string\',\n _created_at: \'1970-01-01T00:00:00.000Z\',\n _updated_at: \'1970-01-01T00:00:00.000Z\',\n _created_by: \'string\',\n _tags: [\'string\'],\n _acl: {},\n _owners: [\n {\n org_id: \'string\',\n user_id: \'string\'\n }\n ],\n type: \'string\',\n context_entities: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n parent: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n attachments: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n content: \'string\',\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n pinned_at: \'1970-01-01T00:00:00.000Z\',\n edited_at: \'1970-01-01T00:00:00.000Z\',\n created_by: [\n {\n type: \'user\',\n user_id: \'string\',\n display_name: \'string\',\n org_id: \'string\',\n email: \'string\',\n phone: \'string\'\n }\n ],\n read_by: [\'string\'],\n reactions: {}\n },\n)\n```\n\n---\n\n### `deleteNote`\n\nDeletes a single Note entry based on it\'s Entity ID\n\n`DELETE /v1/note/{id}`\n\n```ts\nconst { data } = await client.deleteNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `searchNotesByContext`\n\nSearch for a paginated list of Notes based on one or more contexts\n\n`POST /v1/notes:search`\n\n```ts\nconst { data } = await client.searchNotesByContext(\n null,\n {\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n include_related_schemas: [\'string\'],\n from: 0,\n size: 10\n },\n)\n```\n\n---\n\n### `pinNote`\n\nPins a single Note entry based on it\'s Entity ID\n\n`POST /v1/note/{id}/pin`\n\n```ts\nconst { data } = await client.pinNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getNoteContexts`\n\nGets all the Entity and non-Entity records the Note is contextually attached to\n\n`GET /v1/note/{id}/context`\n\n```ts\nconst { data } = await client.getNoteContexts({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "type": "workflow_execution",\n "context": {\n "_id": "string",\n "_org": "string",\n "_schema": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_created_by": "string",\n "_tags": ["string"],\n "_acl": {},\n "_owners": [\n {\n "org_id": "string",\n "user_id": "string"\n }\n ],\n "type": "string"\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `addNoteReaction`\n\nAdds an emoji reaction to a note\n\n`POST /v1/note/{id}/reaction`\n\n```ts\nconst { data } = await client.addNoteReaction(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n emoji: \'thumbs-up\'\n },\n)\n```\n\n---\n\n### `removeNoteReaction`\n\nRemoves an emoji reaction from a note\n\n`DELETE /v1/note/{id}/reaction/{emoji_shortcode}`\n\n```ts\nconst { data } = await client.removeNoteReaction({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n emoji_shortcode: \'example\',\n})\n```\n\n---\n\n### `toggleNoteReactions`\n\nToggles multiple emoji reactions on a note. If a user has already reacted with an emoji, it removes the reaction. If a user hasn\'t reacted with an emoji, it adds the reaction.\n\n`POST /v1/note/{id}/reactions/toggle`\n\n```ts\nconst { data } = await client.toggleNoteReactions(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n emojis: [\'thumbs-up\', \'heart\']\n },\n)\n```\n\n---\n\n## Schemas\n\n### `NotePostRequestBody`\n\n```ts\ntype NotePostRequestBody = {\n _tags?: string[]\n type?: string\n entity_id?: string\n parent_id?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n additional_contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n content?: string\n attachments?: string[]\n read_by?: string[]\n}\n```\n\n### `ContextType`\n\n```ts\ntype ContextType = "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n```\n\n### `NoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place.\n\n```ts\ntype NoteEntity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `CreatedByType`\n\n```ts\ntype CreatedByType = "user" | "group"\n```\n\n### `NoteGetRequestResponse`\n\n```ts\ntype NoteGetRequestResponse = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `NotePatchRequestBody`\n\n```ts\ntype NotePatchRequestBody = {\n _tags?: string[]\n type?: string\n attachments?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n comments?: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n content?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n pinned_at?: string // date-time\n edited_at?: string // date-time\n created_by?: Array<{\n type: "user" | "group"\n user_id?: string\n display_name?: string\n org_id?: string\n email?: string\n phone?: string\n }>\n read_by?: string[]\n reactions?: Record<string, string[]>\n}\n```\n\n### `NonHydratedNoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are not hydrated in place.\n\n```ts\ntype NonHydratedNoteEntity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `NoteEntityParent`\n\nThe Note\'s parent Note\n\n```ts\ntype NoteEntityParent = {\n $relation?: Array<{\n entity_id: string\n }>\n}\n```\n\n### `NotePutRequestBody`\n\n```ts\ntype NotePutRequestBody = {\n _id?: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n context_entities?: {\n $relation: Array<{\n entity_id: { ... }\n }>\n }\n parent?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n attachments?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n content?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n pinned_at?: string // date-time\n edited_at?: string // date-time\n created_by?: Array<{\n type: "user" | "group"\n user_id?: string\n display_name?: string\n org_id?: string\n email?: string\n phone?: string\n }>\n read_by?: string[]\n reactions?: Record<string, string[]>\n}\n```\n\n### `NoteSearchByContextRequestBody`\n\n```ts\ntype NoteSearchByContextRequestBody = {\n contexts: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n include_related_schemas?: string[]\n from?: number\n size?: number\n}\n```\n\n### `NotesSearchRequestResponse`\n\n```ts\ntype NotesSearchRequestResponse = {\n hits?: number\n results: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n}\n```\n\n### `NoteContexts`\n\nList of resolved Entity and non-Entity contexts attached to a given Note.\n\n```ts\ntype NoteContexts = {\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n context: {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n } | {\n id: string\n definitionId: string\n orgId: string\n name: string\n }\n}\n```\n\n### `WorkflowExecution`\n\nBase metadata for a Workflow Execution. This is a lightweight representation of a Workflow Execution, and does not contain all it\'s data\n\n```ts\ntype WorkflowExecution = {\n id: string\n definitionId: string\n orgId: string\n name: string\n}\n```\n\n### `ReactionRequest`\n\n```ts\ntype ReactionRequest = {\n emoji: string\n}\n```\n\n### `ToggleReactionsRequest`\n\n```ts\ntype ToggleReactionsRequest = {\n emojis: string[]\n}\n```\n';
5
-
6
-
7
- exports.default = notes_default;
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/notes.json
4
- var notes_default = '# Notes API\n\n- **Base URL:** `https://notes.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/notes](https://docs.epilot.io/api/notes)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.notes.createNote(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/notes\'\n\nconst notesClient = getClient()\nauthorize(notesClient, () => \'<token>\')\nconst { data } = await notesClient.createNote(...)\n```\n\n## Operations\n\n**Notes**\n- [`createNote`](#createnote)\n- [`getNote`](#getnote)\n- [`patchNote`](#patchnote)\n- [`updateNote`](#updatenote)\n- [`deleteNote`](#deletenote)\n- [`searchNotesByContext`](#searchnotesbycontext)\n- [`getNoteContexts`](#getnotecontexts)\n\n**Pinning**\n- [`pinNote`](#pinnote)\n\n**Reactions**\n- [`addNoteReaction`](#addnotereaction)\n- [`removeNoteReaction`](#removenotereaction)\n- [`toggleNoteReactions`](#togglenotereactions)\n\n**Schemas**\n- [`NotePostRequestBody`](#notepostrequestbody)\n- [`ContextType`](#contexttype)\n- [`NoteEntity`](#noteentity)\n- [`Entity`](#entity)\n- [`CreatedByType`](#createdbytype)\n- [`NoteGetRequestResponse`](#notegetrequestresponse)\n- [`NotePatchRequestBody`](#notepatchrequestbody)\n- [`NonHydratedNoteEntity`](#nonhydratednoteentity)\n- [`NoteEntityParent`](#noteentityparent)\n- [`NotePutRequestBody`](#noteputrequestbody)\n- [`NoteSearchByContextRequestBody`](#notesearchbycontextrequestbody)\n- [`NotesSearchRequestResponse`](#notessearchrequestresponse)\n- [`NoteContexts`](#notecontexts)\n- [`WorkflowExecution`](#workflowexecution)\n- [`ReactionRequest`](#reactionrequest)\n- [`ToggleReactionsRequest`](#togglereactionsrequest)\n\n### `createNote`\n\nCreates a new Note entry\n\n`POST /v1/note`\n\n```ts\nconst { data } = await client.createNote(\n null,\n {\n _tags: [\'string\'],\n type: \'string\',\n entity_id: \'string\',\n parent_id: \'string\',\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n additional_contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n content: \'string\',\n attachments: [\'string\'],\n read_by: [\'string\']\n },\n)\n```\n\n---\n\n### `getNote`\n\nRetrieves a single Note entry based on it\'s Entity ID\n\n`GET /v1/note/{id}`\n\n```ts\nconst { data } = await client.getNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n})\n```\n\n---\n\n### `patchNote`\n\nUpdates an existing Note entry\n\n`PATCH /v1/note/{id}`\n\n```ts\nconst { data } = await client.patchNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `updateNote`\n\nUpdates an existing Note entry\n\n`PUT /v1/note/{id}`\n\n```ts\nconst { data } = await client.updateNote(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n _id: \'string\',\n _org: \'string\',\n _schema: \'string\',\n _created_at: \'1970-01-01T00:00:00.000Z\',\n _updated_at: \'1970-01-01T00:00:00.000Z\',\n _created_by: \'string\',\n _tags: [\'string\'],\n _acl: {},\n _owners: [\n {\n org_id: \'string\',\n user_id: \'string\'\n }\n ],\n type: \'string\',\n context_entities: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n parent: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n attachments: {\n $relation: [\n {\n entity_id: \'string\'\n }\n ]\n },\n content: \'string\',\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n pinned_at: \'1970-01-01T00:00:00.000Z\',\n edited_at: \'1970-01-01T00:00:00.000Z\',\n created_by: [\n {\n type: \'user\',\n user_id: \'string\',\n display_name: \'string\',\n org_id: \'string\',\n email: \'string\',\n phone: \'string\'\n }\n ],\n read_by: [\'string\'],\n reactions: {}\n },\n)\n```\n\n---\n\n### `deleteNote`\n\nDeletes a single Note entry based on it\'s Entity ID\n\n`DELETE /v1/note/{id}`\n\n```ts\nconst { data } = await client.deleteNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `searchNotesByContext`\n\nSearch for a paginated list of Notes based on one or more contexts\n\n`POST /v1/notes:search`\n\n```ts\nconst { data } = await client.searchNotesByContext(\n null,\n {\n contexts: [\n {\n type: \'workflow_execution\',\n id: \'string\'\n }\n ],\n include_related_schemas: [\'string\'],\n from: 0,\n size: 10\n },\n)\n```\n\n---\n\n### `pinNote`\n\nPins a single Note entry based on it\'s Entity ID\n\n`POST /v1/note/{id}/pin`\n\n```ts\nconst { data } = await client.pinNote({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getNoteContexts`\n\nGets all the Entity and non-Entity records the Note is contextually attached to\n\n`GET /v1/note/{id}/context`\n\n```ts\nconst { data } = await client.getNoteContexts({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "type": "workflow_execution",\n "context": {\n "_id": "string",\n "_org": "string",\n "_schema": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_created_by": "string",\n "_tags": ["string"],\n "_acl": {},\n "_owners": [\n {\n "org_id": "string",\n "user_id": "string"\n }\n ],\n "type": "string"\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `addNoteReaction`\n\nAdds an emoji reaction to a note\n\n`POST /v1/note/{id}/reaction`\n\n```ts\nconst { data } = await client.addNoteReaction(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n emoji: \'thumbs-up\'\n },\n)\n```\n\n---\n\n### `removeNoteReaction`\n\nRemoves an emoji reaction from a note\n\n`DELETE /v1/note/{id}/reaction/{emoji_shortcode}`\n\n```ts\nconst { data } = await client.removeNoteReaction({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n emoji_shortcode: \'example\',\n})\n```\n\n---\n\n### `toggleNoteReactions`\n\nToggles multiple emoji reactions on a note. If a user has already reacted with an emoji, it removes the reaction. If a user hasn\'t reacted with an emoji, it adds the reaction.\n\n`POST /v1/note/{id}/reactions/toggle`\n\n```ts\nconst { data } = await client.toggleNoteReactions(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n emojis: [\'thumbs-up\', \'heart\']\n },\n)\n```\n\n---\n\n## Schemas\n\n### `NotePostRequestBody`\n\n```ts\ntype NotePostRequestBody = {\n _tags?: string[]\n type?: string\n entity_id?: string\n parent_id?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n additional_contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n content?: string\n attachments?: string[]\n read_by?: string[]\n}\n```\n\n### `ContextType`\n\n```ts\ntype ContextType = "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n```\n\n### `NoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are hydrated in place.\n\n```ts\ntype NoteEntity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `Entity`\n\nBase Entity schema\n\n```ts\ntype Entity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `CreatedByType`\n\n```ts\ntype CreatedByType = "user" | "group"\n```\n\n### `NoteGetRequestResponse`\n\n```ts\ntype NoteGetRequestResponse = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `NotePatchRequestBody`\n\n```ts\ntype NotePatchRequestBody = {\n _tags?: string[]\n type?: string\n attachments?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n comments?: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n content?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n pinned_at?: string // date-time\n edited_at?: string // date-time\n created_by?: Array<{\n type: "user" | "group"\n user_id?: string\n display_name?: string\n org_id?: string\n email?: string\n phone?: string\n }>\n read_by?: string[]\n reactions?: Record<string, string[]>\n}\n```\n\n### `NonHydratedNoteEntity`\n\nA note Entity object cotaining Entity metadata and content. Relational attributes are not hydrated in place.\n\n```ts\ntype NonHydratedNoteEntity = {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n}\n```\n\n### `NoteEntityParent`\n\nThe Note\'s parent Note\n\n```ts\ntype NoteEntityParent = {\n $relation?: Array<{\n entity_id: string\n }>\n}\n```\n\n### `NotePutRequestBody`\n\n```ts\ntype NotePutRequestBody = {\n _id?: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: string\n user_id: string\n }>\n type?: string\n context_entities?: {\n $relation: Array<{\n entity_id: { ... }\n }>\n }\n parent?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n attachments?: {\n $relation?: Array<{\n entity_id: { ... }\n }>\n }\n content?: string\n contexts?: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n pinned_at?: string // date-time\n edited_at?: string // date-time\n created_by?: Array<{\n type: "user" | "group"\n user_id?: string\n display_name?: string\n org_id?: string\n email?: string\n phone?: string\n }>\n read_by?: string[]\n reactions?: Record<string, string[]>\n}\n```\n\n### `NoteSearchByContextRequestBody`\n\n```ts\ntype NoteSearchByContextRequestBody = {\n contexts: Array<{\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n id: string\n }>\n include_related_schemas?: string[]\n from?: number\n size?: number\n}\n```\n\n### `NotesSearchRequestResponse`\n\n```ts\ntype NotesSearchRequestResponse = {\n hits?: number\n results: Array<{\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n }>\n}\n```\n\n### `NoteContexts`\n\nList of resolved Entity and non-Entity contexts attached to a given Note.\n\n```ts\ntype NoteContexts = {\n type: "workflow_execution" | "workflow_task" | "workflow_configuration" | "journey_configuration" | "entity"\n context: {\n _id: string\n _org?: string\n _schema?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _created_by?: string | number\n _tags?: string[]\n _acl?: Record<string, string[]>\n _owners?: Array<{\n org_id: { ... }\n user_id: { ... }\n }>\n type?: string\n } | {\n id: string\n definitionId: string\n orgId: string\n name: string\n }\n}\n```\n\n### `WorkflowExecution`\n\nBase metadata for a Workflow Execution. This is a lightweight representation of a Workflow Execution, and does not contain all it\'s data\n\n```ts\ntype WorkflowExecution = {\n id: string\n definitionId: string\n orgId: string\n name: string\n}\n```\n\n### `ReactionRequest`\n\n```ts\ntype ReactionRequest = {\n emoji: string\n}\n```\n\n### `ToggleReactionsRequest`\n\n```ts\ntype ToggleReactionsRequest = {\n emojis: string[]\n}\n```\n';
5
- export {
6
- notes_default as default
7
- };
@@ -1,5 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
-
3
- var _chunkM2SSGV7Kcjs = require('./chunk-M2SSGV7K.cjs');
4
- require('./chunk-NJK5F5TF.cjs');
5
- exports. default = _chunkM2SSGV7Kcjs.require_notes_runtime.call(void 0, );