@epilot/sdk 2.9.0 → 2.9.1

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 (215) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +1 -0
  3. package/definitions/access-token-runtime.json +1 -1
  4. package/definitions/access-token.json +155 -1
  5. package/definitions/automation.json +120 -0
  6. package/definitions/blueprint-manifest-runtime.json +1 -1
  7. package/definitions/blueprint-manifest.json +571 -1
  8. package/definitions/journey.json +19 -2
  9. package/definitions/snapshot-runtime.json +1 -0
  10. package/definitions/snapshot.json +935 -0
  11. package/definitions/targeting.json +5 -4
  12. package/definitions/user-runtime.json +1 -1
  13. package/definitions/user.json +441 -0
  14. package/dist/README-NBWAQWQS.js +7 -0
  15. package/dist/README-XCIDDEAE.cjs +7 -0
  16. package/dist/{_index-DB2VV4PQ.cjs → _index-D5TTZP5F.cjs} +4 -1
  17. package/dist/{_index-5FB6F5YY.js → _index-UY46ZN47.js} +3 -0
  18. package/dist/access-token-GD6REL4U.js +7 -0
  19. package/dist/access-token-NQ5BLMOW.cjs +7 -0
  20. package/dist/{access-token-runtime-KCKGT4O7.js → access-token-runtime-2PSLN2U3.js} +1 -1
  21. package/dist/{access-token-runtime-NZWZJPWV.cjs → access-token-runtime-B6Z7JLUS.cjs} +2 -2
  22. package/dist/{access-token.d-CnmUTOlq.d.cts → access-token.d-CegaQmrK.d.cts} +165 -5
  23. package/dist/{access-token.d-CnmUTOlq.d.ts → access-token.d-CegaQmrK.d.ts} +165 -5
  24. package/dist/{ai-agents.d-OkXfr2bz.d.cts → ai-agents.d-CC5IjXrs.d.cts} +0 -2
  25. package/dist/{ai-agents.d-OkXfr2bz.d.ts → ai-agents.d-CC5IjXrs.d.ts} +0 -2
  26. package/dist/apis/access-token.cjs +8 -8
  27. package/dist/apis/access-token.d.cts +2 -2
  28. package/dist/apis/access-token.d.ts +2 -2
  29. package/dist/apis/access-token.js +2 -2
  30. package/dist/apis/address-suggestions.cjs +6 -6
  31. package/dist/apis/address-suggestions.js +1 -1
  32. package/dist/apis/address.cjs +6 -6
  33. package/dist/apis/address.js +1 -1
  34. package/dist/apis/ai-agents.cjs +6 -6
  35. package/dist/apis/ai-agents.d.cts +2 -2
  36. package/dist/apis/ai-agents.d.ts +2 -2
  37. package/dist/apis/ai-agents.js +1 -1
  38. package/dist/apis/app.cjs +6 -6
  39. package/dist/apis/app.js +1 -1
  40. package/dist/apis/audit-logs.cjs +6 -6
  41. package/dist/apis/audit-logs.js +1 -1
  42. package/dist/apis/automation.cjs +6 -6
  43. package/dist/apis/automation.d.cts +2 -2
  44. package/dist/apis/automation.d.ts +2 -2
  45. package/dist/apis/automation.js +1 -1
  46. package/dist/apis/billing.cjs +6 -6
  47. package/dist/apis/billing.js +1 -1
  48. package/dist/apis/blueprint-manifest.cjs +8 -8
  49. package/dist/apis/blueprint-manifest.d.cts +2 -2
  50. package/dist/apis/blueprint-manifest.d.ts +2 -2
  51. package/dist/apis/blueprint-manifest.js +2 -2
  52. package/dist/apis/calendar.cjs +6 -6
  53. package/dist/apis/calendar.js +1 -1
  54. package/dist/apis/configuration-hub.cjs +6 -6
  55. package/dist/apis/configuration-hub.js +1 -1
  56. package/dist/apis/consent.cjs +6 -6
  57. package/dist/apis/consent.js +1 -1
  58. package/dist/apis/customer-portal.cjs +6 -6
  59. package/dist/apis/customer-portal.js +1 -1
  60. package/dist/apis/dashboard.cjs +6 -6
  61. package/dist/apis/dashboard.js +1 -1
  62. package/dist/apis/data-governance.cjs +6 -6
  63. package/dist/apis/data-governance.js +1 -1
  64. package/dist/apis/deduplication.cjs +6 -6
  65. package/dist/apis/deduplication.js +1 -1
  66. package/dist/apis/design.cjs +6 -6
  67. package/dist/apis/design.js +1 -1
  68. package/dist/apis/document.cjs +6 -6
  69. package/dist/apis/document.js +1 -1
  70. package/dist/apis/email-settings.cjs +6 -6
  71. package/dist/apis/email-settings.js +1 -1
  72. package/dist/apis/email-template.cjs +6 -6
  73. package/dist/apis/email-template.js +1 -1
  74. package/dist/apis/entity-mapping.cjs +6 -6
  75. package/dist/apis/entity-mapping.js +1 -1
  76. package/dist/apis/entity.cjs +6 -6
  77. package/dist/apis/entity.js +1 -1
  78. package/dist/apis/environments.cjs +6 -6
  79. package/dist/apis/environments.js +1 -1
  80. package/dist/apis/event-catalog.cjs +6 -6
  81. package/dist/apis/event-catalog.js +1 -1
  82. package/dist/apis/file.cjs +6 -6
  83. package/dist/apis/file.js +1 -1
  84. package/dist/apis/iban.cjs +6 -6
  85. package/dist/apis/iban.js +1 -1
  86. package/dist/apis/integration-toolkit.cjs +6 -6
  87. package/dist/apis/integration-toolkit.js +1 -1
  88. package/dist/apis/journey.cjs +6 -6
  89. package/dist/apis/journey.d.cts +2 -2
  90. package/dist/apis/journey.d.ts +2 -2
  91. package/dist/apis/journey.js +1 -1
  92. package/dist/apis/kanban.cjs +6 -6
  93. package/dist/apis/kanban.js +1 -1
  94. package/dist/apis/message.cjs +6 -6
  95. package/dist/apis/message.js +1 -1
  96. package/dist/apis/metering.cjs +6 -6
  97. package/dist/apis/metering.js +1 -1
  98. package/dist/apis/notes.cjs +6 -6
  99. package/dist/apis/notes.js +1 -1
  100. package/dist/apis/notification.cjs +6 -6
  101. package/dist/apis/notification.js +1 -1
  102. package/dist/apis/organization.cjs +6 -6
  103. package/dist/apis/organization.js +1 -1
  104. package/dist/apis/partner-directory.cjs +6 -6
  105. package/dist/apis/partner-directory.js +1 -1
  106. package/dist/apis/permissions.cjs +6 -6
  107. package/dist/apis/permissions.js +1 -1
  108. package/dist/apis/pricing-tier.cjs +6 -6
  109. package/dist/apis/pricing-tier.js +1 -1
  110. package/dist/apis/pricing.cjs +6 -6
  111. package/dist/apis/pricing.js +1 -1
  112. package/dist/apis/purpose.cjs +6 -6
  113. package/dist/apis/purpose.js +1 -1
  114. package/dist/apis/query.cjs +6 -6
  115. package/dist/apis/query.js +1 -1
  116. package/dist/apis/sandbox.cjs +6 -6
  117. package/dist/apis/sandbox.js +1 -1
  118. package/dist/apis/sharing.cjs +6 -6
  119. package/dist/apis/sharing.js +1 -1
  120. package/dist/apis/snapshot.cjs +38 -0
  121. package/dist/apis/snapshot.d.cts +18 -0
  122. package/dist/apis/snapshot.d.ts +18 -0
  123. package/dist/apis/snapshot.js +38 -0
  124. package/dist/apis/submission.cjs +6 -6
  125. package/dist/apis/submission.js +1 -1
  126. package/dist/apis/target.cjs +6 -6
  127. package/dist/apis/target.js +1 -1
  128. package/dist/apis/targeting.cjs +6 -6
  129. package/dist/apis/targeting.d.cts +2 -2
  130. package/dist/apis/targeting.d.ts +2 -2
  131. package/dist/apis/targeting.js +1 -1
  132. package/dist/apis/template-variables.cjs +6 -6
  133. package/dist/apis/template-variables.js +1 -1
  134. package/dist/apis/user.cjs +8 -8
  135. package/dist/apis/user.d.cts +2 -2
  136. package/dist/apis/user.d.ts +2 -2
  137. package/dist/apis/user.js +2 -2
  138. package/dist/apis/validation-rules.cjs +6 -6
  139. package/dist/apis/validation-rules.js +1 -1
  140. package/dist/apis/webhooks.cjs +6 -6
  141. package/dist/apis/webhooks.js +1 -1
  142. package/dist/apis/workflow-definition.cjs +6 -6
  143. package/dist/apis/workflow-definition.js +1 -1
  144. package/dist/apis/workflow.cjs +6 -6
  145. package/dist/apis/workflow.js +1 -1
  146. package/dist/automation-S6NFS5KU.cjs +7 -0
  147. package/dist/automation-W75XZG7B.js +7 -0
  148. package/dist/{automation.d-Du6-uiz5.d.cts → automation.d-DS_YXDE8.d.cts} +300 -1
  149. package/dist/{automation.d-Du6-uiz5.d.ts → automation.d-DS_YXDE8.d.ts} +300 -1
  150. package/dist/blueprint-manifest-WHYSBU66.cjs +7 -0
  151. package/dist/blueprint-manifest-WZVBTKUL.js +7 -0
  152. package/dist/{blueprint-manifest-runtime-FRLU3ZSF.js → blueprint-manifest-runtime-2344IUIE.js} +1 -1
  153. package/dist/{blueprint-manifest-runtime-EIDOROIQ.cjs → blueprint-manifest-runtime-WU5MWPVT.cjs} +2 -2
  154. package/dist/{blueprint-manifest.d-B8yDxagC.d.cts → blueprint-manifest.d-2-TORV8o.d.cts} +926 -4
  155. package/dist/{blueprint-manifest.d-B8yDxagC.d.ts → blueprint-manifest.d-2-TORV8o.d.ts} +926 -4
  156. package/dist/chunk-54QNWEPZ.js +14 -0
  157. package/dist/{chunk-CULH5PIN.cjs → chunk-6V3NYADA.cjs} +13 -11
  158. package/dist/chunk-NFIYEMMM.js +14 -0
  159. package/dist/{chunk-XSE4CFSM.js → chunk-OHHHS4HH.js} +1 -1
  160. package/dist/chunk-OWXEZ56F.cjs +14 -0
  161. package/dist/{chunk-RZ4ABDOF.js → chunk-QGP5WMHK.js} +13 -11
  162. package/dist/{chunk-OXJOO2YF.cjs → chunk-S5HBBTKM.cjs} +1 -1
  163. package/dist/{chunk-NGHCQ2FA.cjs → chunk-T57MT6J5.cjs} +1 -1
  164. package/dist/{chunk-4YBWMDFP.js → chunk-UWGWRGGB.js} +1 -1
  165. package/dist/chunk-YXJ4PBFQ.cjs +14 -0
  166. package/dist/index.cjs +24 -16
  167. package/dist/index.d.cts +23 -21
  168. package/dist/index.d.ts +23 -21
  169. package/dist/index.js +14 -6
  170. package/dist/journey-LHVSSVTG.cjs +7 -0
  171. package/dist/journey-NXL264XW.js +7 -0
  172. package/dist/{journey.d-BenIUWaO.d.ts → journey.d-B1sOeMHw.d.cts} +16 -3
  173. package/dist/{journey.d-BenIUWaO.d.cts → journey.d-B1sOeMHw.d.ts} +16 -3
  174. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  175. package/dist/snapshot-2HFERXRQ.js +7 -0
  176. package/dist/snapshot-UHCQAT4R.cjs +7 -0
  177. package/dist/snapshot-runtime-6DV42FVY.cjs +5 -0
  178. package/dist/snapshot-runtime-IW57MINC.js +5 -0
  179. package/dist/snapshot.d-CqefmvuB.d.cts +724 -0
  180. package/dist/snapshot.d-CqefmvuB.d.ts +724 -0
  181. package/dist/{targeting-DAFJBPIZ.cjs → targeting-WC62BBZN.cjs} +1 -1
  182. package/dist/{targeting-TGPCRRI6.js → targeting-X4Y2ODBT.js} +1 -1
  183. package/dist/{targeting.d-DxHQbn7-.d.cts → targeting.d-0rNF7ErD.d.cts} +11 -4
  184. package/dist/{targeting.d-DxHQbn7-.d.ts → targeting.d-0rNF7ErD.d.ts} +11 -4
  185. package/dist/user-3SLAEEVD.cjs +7 -0
  186. package/dist/user-PRUYBXQV.js +7 -0
  187. package/dist/{user-runtime-U4HYUWJU.js → user-runtime-6ICV2Y73.js} +1 -1
  188. package/dist/user-runtime-Y3227ETX.cjs +5 -0
  189. package/dist/{user.d-D18fe97W.d.cts → user.d-L-C7_K84.d.cts} +421 -1
  190. package/dist/{user.d-D18fe97W.d.ts → user.d-L-C7_K84.d.ts} +421 -1
  191. package/docs/access-token.md +111 -3
  192. package/docs/automation.md +180 -37
  193. package/docs/blueprint-manifest.md +421 -95
  194. package/docs/journey.md +28 -8
  195. package/docs/snapshot.md +607 -0
  196. package/docs/targeting.md +6 -3
  197. package/docs/user.md +321 -8
  198. package/package.json +20 -12
  199. package/definitions/focus-pocus-runtime.json +0 -1
  200. package/definitions/focus-pocus.json +0 -757
  201. package/dist/README-46VYEGGW.js +0 -7
  202. package/dist/README-IVBISSWB.cjs +0 -7
  203. package/dist/access-token-6BJDZSFE.cjs +0 -7
  204. package/dist/access-token-GSQZLDXR.js +0 -7
  205. package/dist/automation-BMO7ZFTN.cjs +0 -7
  206. package/dist/automation-MEZTSUR3.js +0 -7
  207. package/dist/blueprint-manifest-6DEYW5MW.js +0 -7
  208. package/dist/blueprint-manifest-GCV7H74X.cjs +0 -7
  209. package/dist/chunk-3XKBB5AE.js +0 -14
  210. package/dist/chunk-Z5TVWG3I.cjs +0 -14
  211. package/dist/journey-4DIIPRU4.js +0 -7
  212. package/dist/journey-ATC3Y5AW.cjs +0 -7
  213. package/dist/user-7ZN2XO7G.cjs +0 -7
  214. package/dist/user-ZK7BK6VY.js +0 -7
  215. package/dist/user-runtime-7O2HLFVQ.cjs +0 -5
package/dist/journey-4DIIPRU4.js DELETED
@@ -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 version: 1,\n source: \'example\',\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {\n "savingMode": "auto",\n "supportedVersion": 0\n },\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n}\n```\n\n</details>\n\n---\n\n### `removeJourney`\n\nRemove journey by id\n\n`DELETE /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getJourneyProducts`\n\nGet products available in the journey by id. requires public journey token to be passed.\n\n`GET /v1/journey/products/{id}`\n\n```ts\nconst { data } = await client.getJourneyProducts({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n source: \'example\',\n postal_code: \'example\',\n city: \'example\',\n street: \'example\',\n street_number: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "type": "string",\n "_schema": "string",\n "_title": "string",\n "name": "string",\n "_id": "string",\n "_org": "string",\n "code": "string",\n "description": "string",\n "feature": [\n {}\n ],\n "product_images": [\n {}\n ],\n "legal_footnote": "string",\n "product_downloads": [\n {}\n ],\n "price": {}\n }\n]\n```\n\n</details>\n\n---\n\n### `createJourney`\n\nCreate a Journey\n\n`POST /v1/journey/configuration`\n\n```ts\nconst { data } = await client.createJourney(\n {\n skipAutomation: \'example\',\n },\n {\n journeyId: \'string\',\n organizationId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n canary: true,\n designId: \'string\',\n templateId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n organizationSettings: {},\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n useAustrianLabels: true,\n enableDarkMode: true,\n accessMode: \'PUBLIC\',\n isPublished: true,\n status: \'string\',\n isActive: true,\n savingProgress: {\n savingMode: \'auto\',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n createdBy: \'string\',\n updatedBy: \'string\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {\n "savingMode": "auto",\n "supportedVersion": 0\n },\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n}\n```\n\n</details>\n\n---\n\n### `updateJourney`\n\nUpdate a Journey\n\n`PUT /v1/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourney(\n null,\n {\n journeyId: \'string\',\n organizationId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n canary: true,\n designId: \'string\',\n templateId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n organizationSettings: {},\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n useAustrianLabels: true,\n enableDarkMode: true,\n accessMode: \'PUBLIC\',\n isPublished: true,\n status: \'string\',\n isActive: true,\n savingProgress: {\n savingMode: \'auto\',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n createdBy: \'string\',\n updatedBy: \'string\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n---\n\n### `patchUpdateJourney`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v1/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourney(\n null,\n {\n journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "createdJourney": {\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {}\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {}\n ],\n "logics": [\n {}\n ],\n "logicsV4": {},\n "contextSchema": [\n {}\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {},\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {},\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {}\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n }\n}\n```\n\n</details>\n\n---\n\n### `searchJourneys`\n\nSearch Journeys\n\n`POST /v1/journey/configuration/search`\n\n```ts\nconst { data } = await client.searchJourneys(\n null,\n {\n q: \'_tags:*Flex*\',\n from: 0,\n size: 25,\n sort: \'_created_at:desc\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "results": [\n {\n "_id": "e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8",\n "_schema": "journey",\n "_title": "Journey Entity Title",\n "_org": "739224",\n "_created_at": "2020-01-01T00:00:00.000Z",\n "_updated_at": "2020-01-01T00:00:00.000Z",\n "_tags": ["Flex"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "journey_name": "Journey Name",\n "journey_id": "de7df470-253e-11ed-9174-116b8a718c0a",\n "journey_type": "Sales template",\n "design": "Design EPILOT",\n "created_by": [\n {\n "id": "12345"\n }\n ],\n "journey_version": "Flex"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `generateDocument`\n\nBuilds document generated from a template with journey values."\n\n`POST /v1/journey/document:generate`\n\n```ts\nconst { data } = await client.generateDocument(\n null,\n {\n file_id: \'1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\',\n context_data: {\n additionalProperties: \'string\'\n },\n language: \'de\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "job_status": "STARTED",\n "message": "string",\n "pdf_output": {\n "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf",\n "output_document": {\n "s3ref": {\n "bucket": "document-api-preview-prod",\n "key": "preview/my-template.pdf"\n }\n }\n },\n "docx_output": {\n "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx",\n "output_document": {\n "s3ref": {\n "bucket": "document-api-preview-prod",\n "key": "preview/my-template.docx"\n }\n }\n },\n "variable_payload": {\n "additionalProperties": "string"\n },\n "template_settings": {\n "custom_margins": {\n "top": 2.54,\n "bottom": 2.54\n },\n "suggested_margins": {\n "top": 2.54,\n "bottom": 2.54\n },\n "display_margin_guidelines": true,\n "enable_data_table_margin_autofix": false,\n "template_with_datatable": false,\n "enabled_template_settings_persistence": false,\n "misconfigured_margins": false,\n "file_entity_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"\n }\n}\n```\n\n</details>\n\n---\n\n### `createJourneyV2`\n\nCreate a Journey\n\n`POST /v2/journey/configuration`\n\n```ts\nconst { data } = await client.createJourneyV2(\n {\n skipAutomation: \'example\',\n },\n {\n journeyId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: {\n text: \'string\',\n align: \'left\'\n }\n },\n safeModeAutomation: true,\n designId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n templateId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n thirdPartyCookies: true,\n accessMode: \'PUBLIC\',\n enableDarkMode: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `updateJourneyV2`\n\nUpdate a Journey\n\n`PUT /v2/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourneyV2(\n null,\n {\n journeyId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: {\n text: \'string\',\n align: \'left\'\n }\n },\n safeModeAutomation: true,\n designId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n templateId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n thirdPartyCookies: true,\n accessMode: \'PUBLIC\',\n enableDarkMode: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `patchUpdateJourneyV2`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v2/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourneyV2(\n null,\n {\n journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyV2`\n\nGet journey by id\n\n`GET /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourneyV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n version: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `removeJourneyV2`\n\nRemove journey by id\n\n`DELETE /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourneyV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getSettingsForJourney`\n\nGet settings related to the journey using journey ID.\n\n`GET /v1/journey/{id}/settings`\n\n```ts\nconst { data } = await client.getSettingsForJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "organizationId": "739224",\n "canary": true,\n "thirdPartyCookies": true\n}\n```\n\n</details>\n\n---\n\n### `getButtonOptions`\n\nGet button options from a csv file.\n\n`GET /v1/journey/button-options`\n\n```ts\nconst { data } = await client.getButtonOptions({\n fileId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "value": "Button Hidden Value",\n "label": "Button Label"\n }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `GetJourneysResponse`\n\n```ts\ntype GetJourneysResponse = object\n```\n\n### `JourneyResponse`\n\n```ts\ntype JourneyResponse = {\n createdJourney?: {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: { ... }\n title?: { ... }\n subTitle?: { ... }\n showStepSubtitle?: { ... }\n showStepper?: { ... }\n showStepperLabels?: { ... }\n hideNextButton?: { ... }\n name: { ... }\n stepId?: { ... }\n schema: { ... }\n uischema: { ... }\n maxWidth?: { ... }\n }>\n design?: {\n logoUrl?: { ... }\n theme?: { ... }\n designTokens?: { ... }\n }\n rules?: Array<{\n type: { ... }\n sourceType: { ... }\n source: { ... }\n target: { ... }\n }>\n logics?: Array<{\n autoGeneratedId?: { ... }\n conditions: { ... }\n actions: { ... }\n }>\n logicsV4?: Record<string, {\n id?: { ... }\n protected?: { ... }\n action?: { ... }\n triggeredOn?: { ... }\n conditions?: { ... }\n settings?: { ... }\n }>\n contextSchema?: Array<{\n id?: { ... }\n type: { ... }\n paramKey: { ... }\n isRequired?: { ... }\n shouldLoadEntity?: { ... }\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: { ... }\n safeModeAutomation?: { ... }\n canary?: { ... }\n designId: { ... }\n templateId?: { ... }\n entityId?: { ... }\n mappingsAutomationId?: { ... }\n targetedCustomer?: { ... }\n description?: { ... }\n organizationSettings?: { ... }\n publicToken?: { ... }\n runtimeEntities?: { ... }\n filePurposes?: { ... }\n entityTags?: { ... }\n addressSuggestionsFileUrl?: { ... }\n addressSuggestionsFileId?: { ... }\n addressSuggestionsCountryCode?: { ... }\n addressSuggestionsEnableAutoComplete?: { ... }\n addressSuggestionsSource?: { ... }\n addressSuggestionsEnableFreeText?: { ... }\n useNewDesign?: { ... }\n useAustrianLabels?: { ... }\n enableDarkMode?: { ... }\n accessMode?: { ... }\n isPublished?: { ... }\n status?: { ... }\n isActive?: { ... }\n savingProgress?: { ... }\n thirdPartyCookies?: { ... }\n }\n validationRules?: Record<string, string | Record<string, string>>\n _manifest?: string // uuid[]\n createdBy?: string\n updatedBy?: string\n __lastModifiedAt?: string\n createdAt: string\n lastModifiedAt: string\n deletedAt?: string\n version: number\n revisions: number\n featureFlags?: Record<string, unknown>\n }\n}\n```\n\n### `JourneyProductsResponse`\n\n```ts\ntype JourneyProductsResponse = Array<{\n type?: string\n _schema?: string\n _title?: string\n name?: string\n _id?: string\n _org?: string\n code?: string\n description?: string\n feature?: unknown[]\n product_images?: unknown[]\n legal_footnote?: string\n product_downloads?: unknown[]\n price?: object\n}>\n```\n\n### `PatchUpdateJourneyRequest`\n\nPatch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\n\n\n```ts\ntype PatchUpdateJourneyRequest = {\n journeyId: string // uuid\n __lastModifiedAt?: string\n}\n```\n\n### `JourneyCreationRequest`\n\n```ts\ntype JourneyCreationRequest = {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n canary?: boolean\n designId: string\n templateId?: string\n entityId?: string\n mappingsAutomationId?: string\n targetedCustomer?: string\n description?: string\n organizationSettings?: Record<string, boolean>\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n useAustrianLabels?: boolean\n enableDarkMode?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record<string, string | Record<string, string>>\n // ...\n}\n```\n\n### `JourneyCreationRequestV2`\n\n```ts\ntype JourneyCreationRequestV2 = {\n journeyId?: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n designId?: string\n entityId?: string\n mappingsAutomationId?: string\n templateId?: string\n targetedCustomer?: string\n description?: string\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n thirdPartyCookies?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n enableDarkMode?: boolean\n }\n validationRules?: Record<string, string | Record<string, string>>\n _manifest?: string // uuid[]\n}\n```\n\n### `SearchJourneysQueryRequest`\n\n```ts\ntype SearchJourneysQueryRequest = {\n q?: string\n from?: number\n size?: number\n sort?: string\n}\n```\n\n### `SearchJourneysResponse`\n\n```ts\ntype SearchJourneysResponse = {\n hits?: number\n results?: Array<{\n _id?: string // uuid\n _schema?: string\n _title?: string\n _org?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _tags?: string[]\n _manifest?: string // uuid[]\n journey_name?: string\n journey_id?: string // uuid\n journey_type?: string\n design?: string\n created_by?: Array<{\n id?: { ... }\n }>\n journey_version?: "Flex"\n }>\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n canary?: boolean\n designId: string\n templateId?: string\n entityId?: string\n mappingsAutomationId?: string\n targetedCustomer?: string\n description?: string\n organizationSettings?: Record<string, boolean>\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n useAustrianLabels?: boolean\n enableDarkMode?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record<string, string | Record<string, string>>\n // ...\n}\n```\n\n### `JourneyFeatureFlags`\n\n```ts\ntype JourneyFeatureFlags = {\n featureFlags?: Record<string, unknown>\n}\n```\n\n### `JourneyAuditInfo`\n\n```ts\ntype JourneyAuditInfo = {\n createdAt: string\n lastModifiedAt: string\n deletedAt?: string\n version: number\n revisions: number\n}\n```\n\n### `JourneyValidationResponse`\n\n```ts\ntype JourneyValidationResponse = {\n valid: boolean\n errors: Array<{\n type?: string\n severity?: "critical" | "high" | "medium" | "low"\n message?: string\n affectedStepIds?: string[]\n count?: number\n autoFix?: {\n feasible?: { ... }\n confidence?: { ... }\n reason?: { ... }\n details?: { ... }\n }\n }>\n warnings?: Array<{\n type?: string\n message?: string\n }>\n}\n```\n\n### `JourneyValidationError`\n\n```ts\ntype JourneyValidationError = {\n error: string\n message: string\n details: Array<{\n pattern?: string\n severity?: "critical" | "high" | "medium" | "low"\n message?: string\n count?: number\n }>\n}\n```\n\n### `S3Reference`\n\n```ts\ntype S3Reference = {\n bucket: string\n key: string\n}\n```\n\n### `TemplateSettings`\n\nTemplate Settings for document generation\n\n```ts\ntype TemplateSettings = {\n custom_margins?: {\n top?: number\n bottom?: number\n }\n suggested_margins?: {\n top?: number\n bottom?: number\n }\n display_margin_guidelines?: boolean\n enable_data_table_margin_autofix?: boolean\n template_with_datatable?: boolean\n enabled_template_settings_persistence?: boolean\n misconfigured_margins?: boolean\n file_entity_id?: string // uuid\n}\n```\n\n### `GenerateDocumentResponse`\n\n```ts\ntype GenerateDocumentResponse = {\n job_id?: string // uuid\n job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED"\n message?: string\n pdf_output?: {\n preview_url?: string\n output_document?: {\n filename?: { ... }\n s3ref?: { ... }\n }\n }\n docx_output?: {\n preview_url?: string\n output_document?: {\n filename?: { ... }\n s3ref?: { ... }\n }\n }\n variable_payload?: {\n additionalProperties?: string\n }\n template_settings?: {\n custom_margins?: {\n top?: { ... }\n bottom?: { ... }\n }\n suggested_margins?: {\n top?: { ... }\n bottom?: { ... }\n }\n display_margin_guidelines?: boolean\n enable_data_table_margin_autofix?: boolean\n template_with_datatable?: boolean\n enabled_template_settings_persistence?: boolean\n misconfigured_margins?: boolean\n file_entity_id?: string // uuid\n }\n}\n```\n\n### `GenerateDocumentRequest`\n\n```ts\ntype GenerateDocumentRequest = {\n file_id: string\n context_data: {\n additionalProperties?: string\n }\n language?: string\n}\n```\n\n### `GetSettingsForJourney`\n\n```ts\ntype GetSettingsForJourney = {\n organizationId?: string\n canary?: boolean\n thirdPartyCookies?: boolean\n}\n```\n\n### `ButtonOption`\n\nA single button option data\n\n```ts\ntype ButtonOption = {\n value?: string\n label?: string\n}\n```\n\n### `ValidationRuleRef`\n\nReferences to validation rules organized by blocks and fields.\nMaps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).\n\n\n```ts\ntype ValidationRuleRef = Record<string, string | Record<string, string>>\n```\n\n### `RuleRef`\n\nField-level rule references within a block.\nMaps field names to rule IDs.\n\n\n```ts\ntype RuleRef = Record<string, string>\n```\n';
5
- export {
6
- journey_default as default
7
- };
package/dist/journey-ATC3Y5AW.cjs DELETED
@@ -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 version: 1,\n source: \'example\',\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {\n "savingMode": "auto",\n "supportedVersion": 0\n },\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n}\n```\n\n</details>\n\n---\n\n### `removeJourney`\n\nRemove journey by id\n\n`DELETE /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getJourneyProducts`\n\nGet products available in the journey by id. requires public journey token to be passed.\n\n`GET /v1/journey/products/{id}`\n\n```ts\nconst { data } = await client.getJourneyProducts({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n source: \'example\',\n postal_code: \'example\',\n city: \'example\',\n street: \'example\',\n street_number: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "type": "string",\n "_schema": "string",\n "_title": "string",\n "name": "string",\n "_id": "string",\n "_org": "string",\n "code": "string",\n "description": "string",\n "feature": [\n {}\n ],\n "product_images": [\n {}\n ],\n "legal_footnote": "string",\n "product_downloads": [\n {}\n ],\n "price": {}\n }\n]\n```\n\n</details>\n\n---\n\n### `createJourney`\n\nCreate a Journey\n\n`POST /v1/journey/configuration`\n\n```ts\nconst { data } = await client.createJourney(\n {\n skipAutomation: \'example\',\n },\n {\n journeyId: \'string\',\n organizationId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n canary: true,\n designId: \'string\',\n templateId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n organizationSettings: {},\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n useAustrianLabels: true,\n enableDarkMode: true,\n accessMode: \'PUBLIC\',\n isPublished: true,\n status: \'string\',\n isActive: true,\n savingProgress: {\n savingMode: \'auto\',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n createdBy: \'string\',\n updatedBy: \'string\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {\n "savingMode": "auto",\n "supportedVersion": 0\n },\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n}\n```\n\n</details>\n\n---\n\n### `updateJourney`\n\nUpdate a Journey\n\n`PUT /v1/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourney(\n null,\n {\n journeyId: \'string\',\n organizationId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n canary: true,\n designId: \'string\',\n templateId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n organizationSettings: {},\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n useAustrianLabels: true,\n enableDarkMode: true,\n accessMode: \'PUBLIC\',\n isPublished: true,\n status: \'string\',\n isActive: true,\n savingProgress: {\n savingMode: \'auto\',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n createdBy: \'string\',\n updatedBy: \'string\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n---\n\n### `patchUpdateJourney`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v1/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourney(\n null,\n {\n journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "createdJourney": {\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {}\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {}\n ],\n "logics": [\n {}\n ],\n "logicsV4": {},\n "contextSchema": [\n {}\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {},\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {},\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {}\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n }\n}\n```\n\n</details>\n\n---\n\n### `searchJourneys`\n\nSearch Journeys\n\n`POST /v1/journey/configuration/search`\n\n```ts\nconst { data } = await client.searchJourneys(\n null,\n {\n q: \'_tags:*Flex*\',\n from: 0,\n size: 25,\n sort: \'_created_at:desc\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "results": [\n {\n "_id": "e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8",\n "_schema": "journey",\n "_title": "Journey Entity Title",\n "_org": "739224",\n "_created_at": "2020-01-01T00:00:00.000Z",\n "_updated_at": "2020-01-01T00:00:00.000Z",\n "_tags": ["Flex"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "journey_name": "Journey Name",\n "journey_id": "de7df470-253e-11ed-9174-116b8a718c0a",\n "journey_type": "Sales template",\n "design": "Design EPILOT",\n "created_by": [\n {\n "id": "12345"\n }\n ],\n "journey_version": "Flex"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `generateDocument`\n\nBuilds document generated from a template with journey values."\n\n`POST /v1/journey/document:generate`\n\n```ts\nconst { data } = await client.generateDocument(\n null,\n {\n file_id: \'1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\',\n context_data: {\n additionalProperties: \'string\'\n },\n language: \'de\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "job_status": "STARTED",\n "message": "string",\n "pdf_output": {\n "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf",\n "output_document": {\n "s3ref": {\n "bucket": "document-api-preview-prod",\n "key": "preview/my-template.pdf"\n }\n }\n },\n "docx_output": {\n "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx",\n "output_document": {\n "s3ref": {\n "bucket": "document-api-preview-prod",\n "key": "preview/my-template.docx"\n }\n }\n },\n "variable_payload": {\n "additionalProperties": "string"\n },\n "template_settings": {\n "custom_margins": {\n "top": 2.54,\n "bottom": 2.54\n },\n "suggested_margins": {\n "top": 2.54,\n "bottom": 2.54\n },\n "display_margin_guidelines": true,\n "enable_data_table_margin_autofix": false,\n "template_with_datatable": false,\n "enabled_template_settings_persistence": false,\n "misconfigured_margins": false,\n "file_entity_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"\n }\n}\n```\n\n</details>\n\n---\n\n### `createJourneyV2`\n\nCreate a Journey\n\n`POST /v2/journey/configuration`\n\n```ts\nconst { data } = await client.createJourneyV2(\n {\n skipAutomation: \'example\',\n },\n {\n journeyId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: {\n text: \'string\',\n align: \'left\'\n }\n },\n safeModeAutomation: true,\n designId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n templateId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n thirdPartyCookies: true,\n accessMode: \'PUBLIC\',\n enableDarkMode: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `updateJourneyV2`\n\nUpdate a Journey\n\n`PUT /v2/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourneyV2(\n null,\n {\n journeyId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: {\n text: \'string\',\n align: \'left\'\n }\n },\n safeModeAutomation: true,\n designId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n templateId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n thirdPartyCookies: true,\n accessMode: \'PUBLIC\',\n enableDarkMode: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `patchUpdateJourneyV2`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v2/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourneyV2(\n null,\n {\n journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyV2`\n\nGet journey by id\n\n`GET /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourneyV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n version: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `removeJourneyV2`\n\nRemove journey by id\n\n`DELETE /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourneyV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getSettingsForJourney`\n\nGet settings related to the journey using journey ID.\n\n`GET /v1/journey/{id}/settings`\n\n```ts\nconst { data } = await client.getSettingsForJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "organizationId": "739224",\n "canary": true,\n "thirdPartyCookies": true\n}\n```\n\n</details>\n\n---\n\n### `getButtonOptions`\n\nGet button options from a csv file.\n\n`GET /v1/journey/button-options`\n\n```ts\nconst { data } = await client.getButtonOptions({\n fileId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "value": "Button Hidden Value",\n "label": "Button Label"\n }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `GetJourneysResponse`\n\n```ts\ntype GetJourneysResponse = object\n```\n\n### `JourneyResponse`\n\n```ts\ntype JourneyResponse = {\n createdJourney?: {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: { ... }\n title?: { ... }\n subTitle?: { ... }\n showStepSubtitle?: { ... }\n showStepper?: { ... }\n showStepperLabels?: { ... }\n hideNextButton?: { ... }\n name: { ... }\n stepId?: { ... }\n schema: { ... }\n uischema: { ... }\n maxWidth?: { ... }\n }>\n design?: {\n logoUrl?: { ... }\n theme?: { ... }\n designTokens?: { ... }\n }\n rules?: Array<{\n type: { ... }\n sourceType: { ... }\n source: { ... }\n target: { ... }\n }>\n logics?: Array<{\n autoGeneratedId?: { ... }\n conditions: { ... }\n actions: { ... }\n }>\n logicsV4?: Record<string, {\n id?: { ... }\n protected?: { ... }\n action?: { ... }\n triggeredOn?: { ... }\n conditions?: { ... }\n settings?: { ... }\n }>\n contextSchema?: Array<{\n id?: { ... }\n type: { ... }\n paramKey: { ... }\n isRequired?: { ... }\n shouldLoadEntity?: { ... }\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: { ... }\n safeModeAutomation?: { ... }\n canary?: { ... }\n designId: { ... }\n templateId?: { ... }\n entityId?: { ... }\n mappingsAutomationId?: { ... }\n targetedCustomer?: { ... }\n description?: { ... }\n organizationSettings?: { ... }\n publicToken?: { ... }\n runtimeEntities?: { ... }\n filePurposes?: { ... }\n entityTags?: { ... }\n addressSuggestionsFileUrl?: { ... }\n addressSuggestionsFileId?: { ... }\n addressSuggestionsCountryCode?: { ... }\n addressSuggestionsEnableAutoComplete?: { ... }\n addressSuggestionsSource?: { ... }\n addressSuggestionsEnableFreeText?: { ... }\n useNewDesign?: { ... }\n useAustrianLabels?: { ... }\n enableDarkMode?: { ... }\n accessMode?: { ... }\n isPublished?: { ... }\n status?: { ... }\n isActive?: { ... }\n savingProgress?: { ... }\n thirdPartyCookies?: { ... }\n }\n validationRules?: Record<string, string | Record<string, string>>\n _manifest?: string // uuid[]\n createdBy?: string\n updatedBy?: string\n __lastModifiedAt?: string\n createdAt: string\n lastModifiedAt: string\n deletedAt?: string\n version: number\n revisions: number\n featureFlags?: Record<string, unknown>\n }\n}\n```\n\n### `JourneyProductsResponse`\n\n```ts\ntype JourneyProductsResponse = Array<{\n type?: string\n _schema?: string\n _title?: string\n name?: string\n _id?: string\n _org?: string\n code?: string\n description?: string\n feature?: unknown[]\n product_images?: unknown[]\n legal_footnote?: string\n product_downloads?: unknown[]\n price?: object\n}>\n```\n\n### `PatchUpdateJourneyRequest`\n\nPatch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\n\n\n```ts\ntype PatchUpdateJourneyRequest = {\n journeyId: string // uuid\n __lastModifiedAt?: string\n}\n```\n\n### `JourneyCreationRequest`\n\n```ts\ntype JourneyCreationRequest = {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n canary?: boolean\n designId: string\n templateId?: string\n entityId?: string\n mappingsAutomationId?: string\n targetedCustomer?: string\n description?: string\n organizationSettings?: Record<string, boolean>\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n useAustrianLabels?: boolean\n enableDarkMode?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record<string, string | Record<string, string>>\n // ...\n}\n```\n\n### `JourneyCreationRequestV2`\n\n```ts\ntype JourneyCreationRequestV2 = {\n journeyId?: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n designId?: string\n entityId?: string\n mappingsAutomationId?: string\n templateId?: string\n targetedCustomer?: string\n description?: string\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n thirdPartyCookies?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n enableDarkMode?: boolean\n }\n validationRules?: Record<string, string | Record<string, string>>\n _manifest?: string // uuid[]\n}\n```\n\n### `SearchJourneysQueryRequest`\n\n```ts\ntype SearchJourneysQueryRequest = {\n q?: string\n from?: number\n size?: number\n sort?: string\n}\n```\n\n### `SearchJourneysResponse`\n\n```ts\ntype SearchJourneysResponse = {\n hits?: number\n results?: Array<{\n _id?: string // uuid\n _schema?: string\n _title?: string\n _org?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _tags?: string[]\n _manifest?: string // uuid[]\n journey_name?: string\n journey_id?: string // uuid\n journey_type?: string\n design?: string\n created_by?: Array<{\n id?: { ... }\n }>\n journey_version?: "Flex"\n }>\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n canary?: boolean\n designId: string\n templateId?: string\n entityId?: string\n mappingsAutomationId?: string\n targetedCustomer?: string\n description?: string\n organizationSettings?: Record<string, boolean>\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n useAustrianLabels?: boolean\n enableDarkMode?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record<string, string | Record<string, string>>\n // ...\n}\n```\n\n### `JourneyFeatureFlags`\n\n```ts\ntype JourneyFeatureFlags = {\n featureFlags?: Record<string, unknown>\n}\n```\n\n### `JourneyAuditInfo`\n\n```ts\ntype JourneyAuditInfo = {\n createdAt: string\n lastModifiedAt: string\n deletedAt?: string\n version: number\n revisions: number\n}\n```\n\n### `JourneyValidationResponse`\n\n```ts\ntype JourneyValidationResponse = {\n valid: boolean\n errors: Array<{\n type?: string\n severity?: "critical" | "high" | "medium" | "low"\n message?: string\n affectedStepIds?: string[]\n count?: number\n autoFix?: {\n feasible?: { ... }\n confidence?: { ... }\n reason?: { ... }\n details?: { ... }\n }\n }>\n warnings?: Array<{\n type?: string\n message?: string\n }>\n}\n```\n\n### `JourneyValidationError`\n\n```ts\ntype JourneyValidationError = {\n error: string\n message: string\n details: Array<{\n pattern?: string\n severity?: "critical" | "high" | "medium" | "low"\n message?: string\n count?: number\n }>\n}\n```\n\n### `S3Reference`\n\n```ts\ntype S3Reference = {\n bucket: string\n key: string\n}\n```\n\n### `TemplateSettings`\n\nTemplate Settings for document generation\n\n```ts\ntype TemplateSettings = {\n custom_margins?: {\n top?: number\n bottom?: number\n }\n suggested_margins?: {\n top?: number\n bottom?: number\n }\n display_margin_guidelines?: boolean\n enable_data_table_margin_autofix?: boolean\n template_with_datatable?: boolean\n enabled_template_settings_persistence?: boolean\n misconfigured_margins?: boolean\n file_entity_id?: string // uuid\n}\n```\n\n### `GenerateDocumentResponse`\n\n```ts\ntype GenerateDocumentResponse = {\n job_id?: string // uuid\n job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED"\n message?: string\n pdf_output?: {\n preview_url?: string\n output_document?: {\n filename?: { ... }\n s3ref?: { ... }\n }\n }\n docx_output?: {\n preview_url?: string\n output_document?: {\n filename?: { ... }\n s3ref?: { ... }\n }\n }\n variable_payload?: {\n additionalProperties?: string\n }\n template_settings?: {\n custom_margins?: {\n top?: { ... }\n bottom?: { ... }\n }\n suggested_margins?: {\n top?: { ... }\n bottom?: { ... }\n }\n display_margin_guidelines?: boolean\n enable_data_table_margin_autofix?: boolean\n template_with_datatable?: boolean\n enabled_template_settings_persistence?: boolean\n misconfigured_margins?: boolean\n file_entity_id?: string // uuid\n }\n}\n```\n\n### `GenerateDocumentRequest`\n\n```ts\ntype GenerateDocumentRequest = {\n file_id: string\n context_data: {\n additionalProperties?: string\n }\n language?: string\n}\n```\n\n### `GetSettingsForJourney`\n\n```ts\ntype GetSettingsForJourney = {\n organizationId?: string\n canary?: boolean\n thirdPartyCookies?: boolean\n}\n```\n\n### `ButtonOption`\n\nA single button option data\n\n```ts\ntype ButtonOption = {\n value?: string\n label?: string\n}\n```\n\n### `ValidationRuleRef`\n\nReferences to validation rules organized by blocks and fields.\nMaps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).\n\n\n```ts\ntype ValidationRuleRef = Record<string, string | Record<string, string>>\n```\n\n### `RuleRef`\n\nField-level rule references within a block.\nMaps field names to rule IDs.\n\n\n```ts\ntype RuleRef = Record<string, string>\n```\n';
5
-
6
-
7
- exports.default = journey_default;
package/dist/user-7ZN2XO7G.cjs DELETED
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/user.json
4
- var user_default = '# User API\n\n- **Base URL:** `https://user.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/user](https://docs.epilot.io/api/user)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.user.signUpUser(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/user\'\n\nconst userClient = getClient()\nauthorize(userClient, () => \'<token>\')\nconst { data } = await userClient.signUpUser(...)\n```\n\n## Operations\n\n**User V2**\n- [`signUpUser`](#signupuser)\n- [`getMeV2`](#getmev2)\n- [`listUsersV2`](#listusersv2)\n- [`getUserV2`](#getuserv2)\n- [`updateUserV2`](#updateuserv2)\n- [`deleteUserV2`](#deleteuserv2)\n- [`inviteUser`](#inviteuser)\n- [`resendUserInvitation`](#resenduserinvitation)\n- [`getGroupsForUser`](#getgroupsforuser)\n- [`verifyEmailWithToken`](#verifyemailwithtoken)\n- [`checkInviteToken`](#checkinvitetoken)\n- [`activateUser`](#activateuser)\n- [`rejectInvite`](#rejectinvite)\n- [`getUserLoginParametersV2`](#getuserloginparametersv2)\n- [`beginPasskeyAuthentication`](#beginpasskeyauthentication)\n- [`beginDiscoverablePasskeyAuthentication`](#begindiscoverablepasskeyauthentication)\n- [`resolveDiscoverableCredential`](#resolvediscoverablecredential)\n- [`beginPasskeyRegistration`](#beginpasskeyregistration)\n- [`completePasskeyRegistration`](#completepasskeyregistration)\n- [`listPasskeys`](#listpasskeys)\n- [`deletePasskey`](#deletepasskey)\n- [`switchOrganization`](#switchorganization)\n\n**Group**\n- [`getGroups`](#getgroups)\n- [`createGroup`](#creategroup)\n- [`getGroup`](#getgroup)\n- [`updateGroup`](#updategroup)\n- [`deleteGroup`](#deletegroup)\n- [`advanceUserAssignment`](#advanceuserassignment)\n\n**Navigation**\n- [`createNavigation`](#createnavigation)\n- [`getNavigation`](#getnavigation)\n\n**User V1**\n- [`getMe`](#getme)\n- [`listUsers`](#listusers)\n- [`getUser`](#getuser)\n- [`getUserLoginParameters`](#getuserloginparameters)\n\n**Schemas**\n- [`NavigationId`](#navigationid)\n- [`Navigation`](#navigation)\n- [`NavigationCreateRequest`](#navigationcreaterequest)\n- [`NavigationConfiguration`](#navigationconfiguration)\n- [`NavigationItem`](#navigationitem)\n- [`NavigationKeyItem`](#navigationkeyitem)\n- [`NavigationGroupItem`](#navigationgroupitem)\n- [`InviteToken`](#invitetoken)\n- [`PartnerInvitationToken`](#partnerinvitationtoken)\n- [`VerificationToken`](#verificationtoken)\n- [`GroupId`](#groupid)\n- [`UserId`](#userid)\n- [`Query`](#query)\n- [`OrganizationId`](#organizationid)\n- [`Limit`](#limit)\n- [`Offset`](#offset)\n- [`Hydrate`](#hydrate)\n- [`Username`](#username)\n- [`UserInvitationPayload`](#userinvitationpayload)\n- [`UserActivationPayload`](#useractivationpayload)\n- [`UserVerificationPayload`](#userverificationpayload)\n- [`UserV2`](#userv2)\n- [`User`](#user)\n- [`LoginParameters`](#loginparameters)\n- [`GroupImageUri`](#groupimageuri)\n- [`CreateGroupReq`](#creategroupreq)\n- [`UpdateGroupReq`](#updategroupreq)\n- [`Group`](#group)\n- [`SignupUserPayload`](#signupuserpayload)\n- [`OrganizationDetail`](#organizationdetail)\n- [`CognitoDetails`](#cognitodetails)\n- [`UserDetail`](#userdetail)\n- [`Organization`](#organization)\n- [`DataPointsResponse`](#datapointsresponse)\n- [`DataPoint`](#datapoint)\n- [`Passkey`](#passkey)\n- [`PasskeyAuthenticationOptions`](#passkeyauthenticationoptions)\n- [`PasskeyRegistrationOptions`](#passkeyregistrationoptions)\n- [`PasskeyRegistrationResponse`](#passkeyregistrationresponse)\n\n### `signUpUser`\n\n`POST /v2/users/public/signup`\n\n```ts\nconst { data } = await client.signUpUser(\n {\n token: \'example\',\n },\n {\n organization_detail: {\n type: \'Vendor\',\n name: \'Epilot\',\n pricing_tier: \'professional\',\n email: \'string\',\n phone: \'string\',\n website: \'string\',\n is_privacy_policy_checked: false,\n is_terms_and_conditions_checked: false\n },\n user_detail: {\n full_name: \'Example user\',\n email: \'user@example.com\',\n password: \'AKjhdakjsdh@!34\'\n },\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "user": {\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n },\n "organization": {\n "id": "string",\n "type": "Vendor",\n "name": "Epilot",\n "signature": "<p>Thanks</p>",\n "symbol": "EPI",\n "pricing_tier": "professional",\n "email": "someone@epilot.cloud",\n "phone": 49123123123,\n "website": "https://epilot.cloud",\n "address": {\n "country": "string",\n "city": "string",\n "postal_code": "string",\n "street": "string",\n "street_number": "string"\n },\n "logo_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png",\n "logo_thumbnail_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png",\n "is_unlicensed_org": false,\n "cognito_details": {\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_user_pool_arn": "arn:aws:cognito-idp:eu-central-1:123456789012:userpool/eu-central-sample"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getMeV2`\n\nGet currently logged in user\n\n`GET /v2/users/me`\n\n```ts\nconst { data } = await client.getMeV2()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listUsersV2`\n\nGet the list of organization users\n\n`GET /v2/users`\n\n```ts\nconst { data } = await client.listUsersV2({\n query: \'example\',\n limit: 1,\n offset: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getUserV2`\n\nGet user details by user id\n\n`GET /v2/users/{id}`\n\n```ts\nconst { data } = await client.getUserV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `updateUserV2`\n\nUpdate user details\n\n`PATCH /v2/users/{id}`\n\n```ts\nconst { data } = await client.updateUserV2(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'string\',\n organization_id: \'string\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n activated_at: \'1970-01-01T00:00:00.000Z\',\n display_name: \'Example User\',\n status: \'Active\',\n email: \'user@example.com\',\n draft_email: \'user@example.com\',\n department: \'Sales\',\n phone: 1234567890,\n secondary_phone: 1234567890,\n mfa_enabled: false,\n phone_verified: true,\n token: \'string\',\n signature: \'<p>Thanks</p>\',\n is_signature_enabled: true,\n preferred_language: \'de\',\n custom_start_page: \'/app/dashboard\',\n custom_navigation: \'5gbe4nkp6jsfq\',\n override_release_channel: \'canary\',\n feature_preferences: {\n feature_name: true\n },\n image_uri: {\n original: \'https://account-profile-images.epilot.cloud/1/avatar.png\',\n thumbnail_32: \'https://account-profile-images.epilot.cloud/1/avatar_32x32.png\'\n },\n favorites: {\n entity_views: {\n opportunity: \'891a5409850abf8b92bd2cb7bdd2844d32ce6bec\',\n order: \'628aee91-7c2f-4047-ab0d-433582a19c49\'\n },\n dashboard: \'751ff121-9ac2-4511-a2e6-851f11287380\'\n },\n email_notification_setting: {\n added_participant_opportunity: true,\n assigned_opportunity: true,\n assigned_task: true,\n comment_opportunity: true,\n deleted_task: true,\n escalated_task: true,\n message_receive_opportunity: true,\n message_send_opportunity: true,\n created_task: true,\n created_opportunity_manual: true,\n created_opportunity_auto: true,\n deleted_opportunity: true\n },\n properties: [\n {\n name: \'profileImageName\',\n value: \'avatar.png\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deleteUserV2`\n\nDelete user by user id\n\n`DELETE /v2/users/{id}`\n\n```ts\nconst { data } = await client.deleteUserV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `inviteUser`\n\nCreates a new user in the caller\'s organization and sends an invite email to activate the user\n\n`POST /v2/users/invite`\n\n```ts\nconst { data } = await client.inviteUser(\n null,\n {\n email: \'test@example.com\',\n language: \'en\',\n roles: [\'123:owner\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `resendUserInvitation`\n\nResend user invitation email\n\n`POST /v2/users/invite:resendEmail`\n\n```ts\nconst { data } = await client.resendUserInvitation(\n null,\n {\n email: \'test@example.com\',\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {\n "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec",\n "order": "628aee91-7c2f-4047-ab0d-433582a19c49"\n },\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getGroupsForUser`\n\nGet groups of a user\n\n`GET /v2/users/{id}/groups`\n\n```ts\nconst { data } = await client.getGroupsForUser({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": [],\n "crt_index": 3\n },\n "users": [\n {}\n ],\n "image_uri": {\n "gradient_colors": ["#0588f0", "#3358d4"]\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `getGroups`\n\nLists groups in organizations you have access to\n\n`GET /v1/groups`\n\n```ts\nconst { data } = await client.getGroups({\n query: \'example\',\n limit: 1,\n offset: 1,\n hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "groups": [\n {\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {},\n "users": [],\n "image_uri": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createGroup`\n\nCreate a new group\n\n`POST /v1/groups`\n\n```ts\nconst { data } = await client.createGroup(\n null,\n {\n name: \'Finance\',\n user_ids: [\'123\', \'456\'],\n image_uri: {\n gradient_colors: [\'#0588f0\', \'#3358d4\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ],\n "image_uri": {\n "gradient_colors": ["#0588f0", "#3358d4"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getGroup`\n\nGet group by id\n\n`GET /v1/groups/{id}`\n\n```ts\nconst { data } = await client.getGroup({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ],\n "image_uri": {\n "gradient_colors": ["#0588f0", "#3358d4"]\n }\n}\n```\n\n</details>\n\n---\n\n### `updateGroup`\n\nUpdate group by id\n\n`PATCH /v1/groups/{id}`\n\n```ts\nconst { data } = await client.updateGroup(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n name: \'Finance\',\n user_ids: [\'123\', \'456\'],\n image_uri: {\n gradient_colors: [\'#0588f0\', \'#3358d4\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ],\n "image_uri": {\n "gradient_colors": ["#0588f0", "#3358d4"]\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteGroup`\n\nDelete group by id\n\n`DELETE /v1/groups/{id}`\n\n```ts\nconst { data } = await client.deleteGroup({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `advanceUserAssignment`\n\nAdvance user assignment to next user in line\n\n`POST /v1/groups/{id}/user:next`\n\n```ts\nconst { data } = await client.advanceUserAssignment({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "Finance",\n "created_at": "2024-02-08T04:44:32.246Z",\n "updated_at": "2024-02-08T04:44:32.246Z",\n "created_by": "123",\n "crt_assignee": {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {\n "feature_name": true\n },\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "favorites": {\n "entity_views": {},\n "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380"\n },\n "email_notification_setting": {\n "added_participant_opportunity": true,\n "assigned_opportunity": true,\n "assigned_task": true,\n "comment_opportunity": true,\n "deleted_task": true,\n "escalated_task": true,\n "message_receive_opportunity": true,\n "message_send_opportunity": true,\n "created_task": true,\n "created_opportunity_manual": true,\n "created_opportunity_auto": true,\n "deleted_opportunity": true\n },\n "properties": [\n {}\n ],\n "crt_index": 3\n },\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "activated_at": "1970-01-01T00:00:00.000Z",\n "display_name": "Example User",\n "status": "Active",\n "email": "user@example.com",\n "draft_email": "user@example.com",\n "department": "Sales",\n "phone": 1234567890,\n "secondary_phone": 1234567890,\n "mfa_enabled": false,\n "phone_verified": true,\n "token": "string",\n "signature": "<p>Thanks</p>",\n "is_signature_enabled": true,\n "preferred_language": "de",\n "custom_start_page": "/app/dashboard",\n "custom_navigation": "5gbe4nkp6jsfq",\n "override_release_channel": "canary",\n "feature_preferences": {},\n "image_uri": {},\n "favorites": {},\n "email_notification_setting": {},\n "properties": []\n }\n ],\n "image_uri": {\n "gradient_colors": ["#0588f0", "#3358d4"]\n }\n}\n```\n\n</details>\n\n---\n\n### `createNavigation`\n\nCreate a new navigation configuration. Navigations are immutable and globally accessible across organizations.\nEach creation generates a new id. To update a navigation, create a new one.\n\n`POST /v2/user/navigations`\n\n```ts\nconst { data } = await client.createNavigation(\n null,\n {\n name: \'Sales Team Navigation\',\n configuration: {\n customer_relations: [\n {\n key: \'dashboard\'\n },\n {\n key: \'contact\'\n }\n ],\n configurations: [\n {\n name: \'Product Catalog\',\n subItems: [\n {\n key: \'product\'\n },\n {\n key: \'price\'\n }\n ]\n },\n {\n key: \'journey\'\n }\n ]\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "5gbe4nkp6jsfq",\n "name": "Sales Team Navigation",\n "configuration": {\n "customer_relations": [\n {\n "key": "dashboard"\n },\n {\n "key": "contact"\n }\n ],\n "configurations": [\n {\n "name": "Product Catalog",\n "subItems": [\n {\n "key": "product"\n },\n {\n "key": "price"\n }\n ]\n },\n {\n "key": "journey"\n }\n ]\n }\n}\n```\n\n</details>\n\n---\n\n### `getNavigation`\n\nGet a navigation configuration by ID\n\n`GET /v2/user/navigations/{id}`\n\n```ts\nconst { data } = await client.getNavigation({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "5gbe4nkp6jsfq",\n "name": "Sales Team Navigation",\n "configuration": {\n "customer_relations": [\n {\n "key": "dashboard"\n },\n {\n "key": "contact"\n }\n ],\n "configurations": [\n {\n "name": "Product Catalog",\n "subItems": [\n {\n "key": "product"\n },\n {\n "key": "price"\n }\n ]\n },\n {\n "key": "journey"\n }\n ]\n }\n}\n```\n\n</details>\n\n---\n\n### `verifyEmailWithToken`\n\nUpdate new email using an verification token\n\n`POST /v2/users/public/verifyEmail`\n\n```ts\nconst { data } = await client.verifyEmailWithToken(\n {\n token: \'example\',\n },\n {\n password: \'AKjhdakjsdh@!34\'\n },\n)\n```\n\n---\n\n### `checkInviteToken`\n\nCheck an invite token\n\n`GET /v2/users/public/checkToken`\n\n```ts\nconst { data } = await client.checkInviteToken({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "invitation_org_id": "string",\n "invitation_org_name": "string",\n "invitation_org_logo_url": "string",\n "invitation_org_logo_thumbnail_url": "string",\n "invitee_user_id": "string",\n "invitee_primary_org_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `activateUser`\n\nActivate user using an invite token\n\n`POST /v2/users/public/activate`\n\n```ts\nconst { data } = await client.activateUser(\n {\n token: \'example\',\n },\n {\n display_name: \'Example User\',\n password: \'AKjhdakjsdh@!34\'\n },\n)\n```\n\n---\n\n### `rejectInvite`\n\nReject an invite\n\n`DELETE /v2/users/public/reject`\n\n```ts\nconst { data } = await client.rejectInvite({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true\n}\n```\n\n</details>\n\n---\n\n### `getUserLoginParametersV2`\n\nGet user organization login parameters by username\n\n`GET /v2/users/public/username/{username}:getLoginParameters`\n\n```ts\nconst { data } = await client.getUserLoginParametersV2({\n username: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "login_parameters": [\n {\n "organization_id": "123",\n "organization_name": "epilot GmbH",\n "organization_type": "Vendor",\n "organization_use": "Production",\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_oauth_domain": "epilot-org-123",\n "cognito_oauth_scopes": ["openid"],\n "oauth_response_type": "code",\n "passkey_enabled": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `beginPasskeyAuthentication`\n\nBegin passkey authentication flow. Returns WebAuthn options and a signed challenge token.\n\n`POST /v2/users/public/passkeys:authenticateBegin`\n\n```ts\nconst { data } = await client.beginPasskeyAuthentication(\n null,\n {\n email: \'user@example.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "options": {},\n "challenge_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `beginDiscoverablePasskeyAuthentication`\n\nBegin discoverable passkey authentication flow (no email required). Returns WebAuthn options with empty allowCredentials for the browser credential picker.\n\n`POST /v2/users/public/passkeys:authenticateBeginDiscoverable`\n\n```ts\nconst { data } = await client.beginDiscoverablePasskeyAuthentication()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "options": {},\n "challenge_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `resolveDiscoverableCredential`\n\nResolve user identity from a discoverable passkey assertion. Returns the user\'s email and login parameters.\n\n`POST /v2/users/public/passkeys:resolveCredential`\n\n```ts\nconst { data } = await client.resolveDiscoverableCredential(\n null,\n {\n challenge_token: \'string\',\n assertion_response: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "email": "user@example.com",\n "organization_id": "string",\n "user_id": "string",\n "login_parameters": [\n {\n "organization_id": "123",\n "organization_name": "epilot GmbH",\n "organization_type": "Vendor",\n "organization_use": "Production",\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_oauth_domain": "epilot-org-123",\n "cognito_oauth_scopes": ["openid"],\n "oauth_response_type": "code",\n "passkey_enabled": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `beginPasskeyRegistration`\n\nBegin passkey registration flow for the authenticated user.\n\n`POST /v2/users/me/passkeys:registerBegin`\n\n```ts\nconst { data } = await client.beginPasskeyRegistration(\n null,\n {\n friendly_name: \'My Laptop\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "options": {},\n "challenge_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `completePasskeyRegistration`\n\nComplete passkey registration by verifying the attestation response.\n\n`POST /v2/users/me/passkeys:registerComplete`\n\n```ts\nconst { data } = await client.completePasskeyRegistration(\n null,\n {\n challenge_token: \'string\',\n registration_response: {},\n friendly_name: \'My Laptop\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "credential_id": "string",\n "friendly_name": "My Laptop",\n "created_at": "1970-01-01T00:00:00.000Z",\n "transports": ["string"],\n "aaguid": "string"\n}\n```\n\n</details>\n\n---\n\n### `listPasskeys`\n\nList all passkeys registered for the authenticated user.\n\n`GET /v2/users/me/passkeys`\n\n```ts\nconst { data } = await client.listPasskeys()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "passkeys": [\n {\n "credential_id": "string",\n "friendly_name": "My Laptop",\n "created_at": "1970-01-01T00:00:00.000Z",\n "transports": ["string"],\n "aaguid": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deletePasskey`\n\nDelete a passkey by credential ID.\n\n`DELETE /v2/users/me/passkeys/{credentialId}`\n\n```ts\nconst { data } = await client.deletePasskey({\n credentialId: \'example\',\n})\n```\n\n---\n\n### `switchOrganization`\n\nSwitch to another organization the user is part of\n\n`POST /v2/users/switchOrganization`\n\n```ts\nconst { data } = await client.switchOrganization(\n null,\n {\n org_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "login_token": "string"\n}\n```\n\n</details>\n\n---\n\n### `getMe`\n\nGet currently logged in user\n\n`GET /v1/users/me`\n\n```ts\nconst { data } = await client.getMe()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listUsers`\n\nLists users in organizations you have access to\n\n`GET /v1/users`\n\n```ts\nconst { data } = await client.listUsers({\n org_ids: [\'...\'],\n query: \'example\',\n limit: 1,\n offset: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "users": [\n {\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getUser`\n\nGet user by id\n\n`GET /v1/users/{id}`\n\n```ts\nconst { data } = await client.getUser({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "organization_id": "string",\n "email": "user@example.com",\n "display_name": "Example user",\n "name": "Example user",\n "preferred_language": "de",\n "signature": "<p>Thanks</p>",\n "custom_navigation": "5gbe4nkp6jsfq",\n "roles": ["Owner"],\n "image_uri": {\n "original": "https://account-profile-images.epilot.cloud/1/avatar.png",\n "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"\n },\n "properties": [\n {\n "name": "profileImageName",\n "value": "avatar.png"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getUserLoginParameters`\n\nGet user organization login parameters by username\n\n`GET /v1/users/username/{username}:getLoginParameters`\n\n```ts\nconst { data } = await client.getUserLoginParameters({\n username: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "login_parameters": [\n {\n "organization_id": "123",\n "organization_name": "epilot GmbH",\n "organization_type": "Vendor",\n "organization_use": "Production",\n "cognito_region": "eu-central-1",\n "cognito_user_pool_id": "eu-central-sample",\n "cognito_user_pool_client_id": "asbkh213ehkquwhdi",\n "cognito_oauth_domain": "epilot-org-123",\n "cognito_oauth_scopes": ["openid"],\n "oauth_response_type": "code",\n "passkey_enabled": true\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `NavigationId`\n\nNavigation unique identifier - a hash of the normalized navigation payload (name + configuration). Identical navigations across orgs will have the same ID.\n\n```ts\ntype NavigationId = string\n```\n\n### `Navigation`\n\nA customized workplace navigation configuration. The ID is a content-hash, so identical configurations will have the same ID.\n\n```ts\ntype Navigation = {\n id: string\n name: string\n configuration: Record<string, Array<{\n key: string\n } | {\n name: string\n subItems: Array<{\n key: { ... }\n }>\n }>>\n}\n```\n\n### `NavigationCreateRequest`\n\nRequest payload to create a new navigation configuration\n\n```ts\ntype NavigationCreateRequest = {\n name: string\n configuration: Record<string, Array<{\n key: string\n } | {\n name: string\n subItems: Array<{\n key: { ... }\n }>\n }>>\n}\n```\n\n### `NavigationConfiguration`\n\nNavigation configuration organized by sections. Each section contains an array of navigation items.\n\n\n```ts\ntype NavigationConfiguration = Record<string, Array<{\n key: string\n} | {\n name: string\n subItems: Array<{\n key: string\n }>\n}>>\n```\n\n### `NavigationItem`\n\nA navigation item - either a simple key item or a group with sub-items\n\n```ts\ntype NavigationItem = {\n key: string\n} | {\n name: string\n subItems: Array<{\n key: string\n }>\n}\n```\n\n### `NavigationKeyItem`\n\nA simple navigation item with a key\n\n```ts\ntype NavigationKeyItem = {\n key: string\n}\n```\n\n### `NavigationGroupItem`\n\nA navigation group containing sub-items\n\n```ts\ntype NavigationGroupItem = {\n name: string\n subItems: Array<{\n key: string\n }>\n}\n```\n\n### `InviteToken`\n\nToken used to invite a user to epilot\n\n```ts\ntype InviteToken = string\n```\n\n### `PartnerInvitationToken`\n\nToken used to invite a partner user to epilot\n\n```ts\ntype PartnerInvitationToken = string\n```\n\n### `VerificationToken`\n\n```ts\ntype VerificationToken = string\n```\n\n### `GroupId`\n\nGroup unique identifier\n\n```ts\ntype GroupId = string\n```\n\n### `UserId`\n\nUser\'s unique identifier\n\n```ts\ntype UserId = string\n```\n\n### `Query`\n\n```ts\ntype Query = string\n```\n\n### `OrganizationId`\n\n```ts\ntype OrganizationId = string\n```\n\n### `Limit`\n\n```ts\ntype Limit = number\n```\n\n### `Offset`\n\n```ts\ntype Offset = number\n```\n\n### `Hydrate`\n\n```ts\ntype Hydrate = boolean\n```\n\n### `Username`\n\n```ts\ntype Username = string\n```\n\n### `UserInvitationPayload`\n\n```ts\ntype UserInvitationPayload = {\n email?: string\n language?: "en" | "de"\n roles?: string[]\n}\n```\n\n### `UserActivationPayload`\n\n```ts\ntype UserActivationPayload = {\n display_name?: string\n password?: string\n}\n```\n\n### `UserVerificationPayload`\n\n```ts\ntype UserVerificationPayload = {\n password?: string\n}\n```\n\n### `UserV2`\n\n```ts\ntype UserV2 = {\n id?: string\n organization_id?: string\n created_at?: string // date-time\n activated_at?: string // date-time\n display_name?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n email?: string // email\n draft_email?: string // email\n department?: string\n phone?: string\n secondary_phone?: string\n mfa_enabled?: boolean\n phone_verified?: boolean\n token?: string\n signature?: string\n is_signature_enabled?: boolean\n preferred_language?: string\n custom_start_page?: string\n custom_navigation?: string\n override_release_channel?: "canary" | "rc" | "stable" | null\n feature_preferences?: Record<string, unknown>\n image_uri?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n favorites?: Record<string, unknown>\n email_notification_setting?: Record<string, unknown>\n properties?: Array<{\n name: string\n value: string\n }>\n}\n```\n\n### `User`\n\n```ts\ntype User = {\n id: string\n organization_id: string\n email: string // email\n display_name?: string\n name: string\n preferred_language: string\n signature?: string\n custom_navigation?: string\n roles: string[]\n image_uri?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n properties: Array<{\n name: string\n value: string\n }>\n}\n```\n\n### `LoginParameters`\n\n```ts\ntype LoginParameters = {\n organization_id?: string\n organization_name?: string\n organization_type?: string\n organization_use?: string\n cognito_region?: string\n cognito_user_pool_id?: string\n cognito_user_pool_client_id?: string\n cognito_oauth_domain?: string\n cognito_oauth_scopes?: string[]\n oauth_response_type?: "code" | "token"\n passkey_enabled?: boolean\n}\n```\n\n### `GroupImageUri`\n\nGroup\'s profile image or gradient colors. Supports uploaded image URLs and generated gradient avatars.\n\n```ts\ntype GroupImageUri = {\n original?: string // uri\n thumbnail_32?: string // uri\n thumbnail_64?: string // uri\n gradient_colors?: string[]\n}\n```\n\n### `CreateGroupReq`\n\n```ts\ntype CreateGroupReq = {\n name: string\n user_ids?: string[]\n image_uri?: {\n original?: string // uri\n thumbnail_32?: string // uri\n thumbnail_64?: string // uri\n gradient_colors?: string[]\n }\n}\n```\n\n### `UpdateGroupReq`\n\n```ts\ntype UpdateGroupReq = {\n name?: string\n user_ids?: string[]\n image_uri?: {\n original?: string // uri\n thumbnail_32?: string // uri\n thumbnail_64?: string // uri\n gradient_colors?: string[]\n }\n}\n```\n\n### `Group`\n\n```ts\ntype Group = {\n id: string\n org_id: string\n name: string\n created_at: string\n updated_at: string\n created_by?: string\n crt_assignee?: {\n id?: string\n organization_id?: string\n created_at?: string // date-time\n activated_at?: string // date-time\n display_name?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n email?: string // email\n draft_email?: string // email\n department?: string\n phone?: string\n secondary_phone?: string\n mfa_enabled?: boolean\n phone_verified?: boolean\n token?: string\n signature?: string\n is_signature_enabled?: boolean\n preferred_language?: string\n custom_start_page?: string\n custom_navigation?: string\n override_release_channel?: "canary" | "rc" | "stable" | null\n feature_preferences?: Record<string, unknown>\n image_uri?: {\n original?: { ... }\n thumbnail_32?: { ... }\n }\n favorites?: Record<string, unknown>\n email_notification_setting?: Record<string, unknown>\n properties?: Array<{\n name: { ... }\n value: { ... }\n }>\n crt_index?: number\n }\n users?: Array<{\n id?: string\n organization_id?: string\n created_at?: string // date-time\n activated_at?: string // date-time\n display_name?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n email?: string // email\n draft_email?: string // email\n department?: string\n phone?: string\n secondary_phone?: string\n mfa_enabled?: boolean\n phone_verified?: boolean\n token?: string\n signature?: string\n is_signature_enabled?: boolean\n preferred_language?: string\n custom_start_page?: string\n custom_navigation?: string\n override_release_channel?: "canary" | "rc" | "stable" | null\n feature_preferences?: Record<string, unknown>\n image_uri?: {\n original?: { ... }\n thumbnail_32?: { ... }\n }\n favorites?: Record<string, unknown>\n email_notification_setting?: Record<string, unknown>\n properties?: Array<{\n name: { ... }\n value: { ... }\n }>\n }>\n image_uri?: {\n original?: string // uri\n thumbnail_32?: string // uri\n thumbnail_64?: string // uri\n gradient_colors?: string[]\n }\n}\n```\n\n### `SignupUserPayload`\n\n```ts\ntype SignupUserPayload = {\n organization_detail?: {\n type: "Vendor" | "Partner"\n name: string\n pricing_tier: string\n email: string\n phone?: string\n website?: string\n is_privacy_policy_checked?: boolean\n is_terms_and_conditions_checked?: boolean\n }\n user_detail?: {\n full_name: string\n email: string // email\n password: string\n }\n language?: "en" | "de"\n}\n```\n\n### `OrganizationDetail`\n\n```ts\ntype OrganizationDetail = {\n type: "Vendor" | "Partner"\n name: string\n pricing_tier: string\n email: string\n phone?: string\n website?: string\n is_privacy_policy_checked?: boolean\n is_terms_and_conditions_checked?: boolean\n}\n```\n\n### `CognitoDetails`\n\n```ts\ntype CognitoDetails = {\n cognito_region?: string\n cognito_user_pool_id?: string\n cognito_user_pool_client_id?: string\n cognito_user_pool_arn?: string\n}\n```\n\n### `UserDetail`\n\n```ts\ntype UserDetail = {\n full_name: string\n email: string // email\n password: string\n}\n```\n\n### `Organization`\n\n```ts\ntype Organization = {\n id?: string\n type?: "Vendor" | "Partner"\n name?: string\n signature?: string\n symbol?: string\n pricing_tier?: string\n email?: string\n phone?: string\n website?: string\n address?: {\n country?: string\n city?: string\n postal_code?: string\n street?: string\n street_number?: string\n }\n logo_url?: string\n logo_thumbnail_url?: string\n is_unlicensed_org?: boolean\n cognito_details?: {\n cognito_region?: string\n cognito_user_pool_id?: string\n cognito_user_pool_client_id?: string\n cognito_user_pool_arn?: string\n }\n}\n```\n\n### `DataPointsResponse`\n\n```ts\ntype DataPointsResponse = Array<{\n id?: number\n actual_users?: number\n max_users_last_month?: number\n non_billable_users_last_month?: number\n}>\n```\n\n### `DataPoint`\n\n```ts\ntype DataPoint = {\n id?: number\n actual_users?: number\n max_users_last_month?: number\n non_billable_users_last_month?: number\n}\n```\n\n### `Passkey`\n\n```ts\ntype Passkey = {\n credential_id?: string\n friendly_name?: string\n created_at?: string // date-time\n transports?: string[]\n aaguid?: string\n}\n```\n\n### `PasskeyAuthenticationOptions`\n\n```ts\ntype PasskeyAuthenticationOptions = {\n options?: object\n challenge_token?: string\n}\n```\n\n### `PasskeyRegistrationOptions`\n\n```ts\ntype PasskeyRegistrationOptions = {\n options?: object\n challenge_token?: string\n}\n```\n\n### `PasskeyRegistrationResponse`\n\n```ts\ntype PasskeyRegistrationResponse = {\n challenge_token: string\n registration_response: object\n friendly_name?: string\n}\n```\n';
5
-
6
-
7
- exports.default = user_default;