@epilot/sdk 2.7.1 → 2.8.0-rc.0

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 (214) hide show
  1. package/README.md +1 -0
  2. package/definitions/app.json +101 -8
  3. package/definitions/configuration-hub-runtime.json +1 -1
  4. package/definitions/configuration-hub.json +623 -0
  5. package/definitions/customer-portal.json +72 -58
  6. package/definitions/design-runtime.json +1 -1
  7. package/definitions/design.json +1 -11
  8. package/definitions/focus-pocus-runtime.json +1 -0
  9. package/definitions/focus-pocus.json +757 -0
  10. package/definitions/journey-runtime.json +1 -1
  11. package/definitions/journey.json +21 -1
  12. package/dist/README-37TXN4EL.cjs +7 -0
  13. package/dist/README-Z2WITBOR.js +7 -0
  14. package/dist/{_index-DB2VV4PQ.cjs → _index-HTUXYSTD.cjs} +4 -1
  15. package/dist/{_index-5FB6F5YY.js → _index-YTOJUFGD.js} +3 -0
  16. package/dist/apis/access-token.cjs +6 -6
  17. package/dist/apis/access-token.js +1 -1
  18. package/dist/apis/address-suggestions.cjs +6 -6
  19. package/dist/apis/address-suggestions.js +1 -1
  20. package/dist/apis/address.cjs +6 -6
  21. package/dist/apis/address.js +1 -1
  22. package/dist/apis/ai-agents.cjs +6 -6
  23. package/dist/apis/ai-agents.js +1 -1
  24. package/dist/apis/app.cjs +6 -6
  25. package/dist/apis/app.d.cts +2 -2
  26. package/dist/apis/app.d.ts +2 -2
  27. package/dist/apis/app.js +1 -1
  28. package/dist/apis/audit-logs.cjs +6 -6
  29. package/dist/apis/audit-logs.js +1 -1
  30. package/dist/apis/automation.cjs +6 -6
  31. package/dist/apis/automation.js +1 -1
  32. package/dist/apis/billing.cjs +6 -6
  33. package/dist/apis/billing.js +1 -1
  34. package/dist/apis/blueprint-manifest.cjs +6 -6
  35. package/dist/apis/blueprint-manifest.js +1 -1
  36. package/dist/apis/calendar.cjs +6 -6
  37. package/dist/apis/calendar.js +1 -1
  38. package/dist/apis/configuration-hub.cjs +8 -8
  39. package/dist/apis/configuration-hub.d.cts +2 -2
  40. package/dist/apis/configuration-hub.d.ts +2 -2
  41. package/dist/apis/configuration-hub.js +2 -2
  42. package/dist/apis/consent.cjs +6 -6
  43. package/dist/apis/consent.js +1 -1
  44. package/dist/apis/customer-portal.cjs +6 -6
  45. package/dist/apis/customer-portal.d.cts +2 -2
  46. package/dist/apis/customer-portal.d.ts +2 -2
  47. package/dist/apis/customer-portal.js +1 -1
  48. package/dist/apis/dashboard.cjs +6 -6
  49. package/dist/apis/dashboard.js +1 -1
  50. package/dist/apis/data-governance.cjs +6 -6
  51. package/dist/apis/data-governance.js +1 -1
  52. package/dist/apis/deduplication.cjs +6 -6
  53. package/dist/apis/deduplication.js +1 -1
  54. package/dist/apis/design.cjs +8 -8
  55. package/dist/apis/design.js +2 -2
  56. package/dist/apis/document.cjs +6 -6
  57. package/dist/apis/document.js +1 -1
  58. package/dist/apis/email-settings.cjs +6 -6
  59. package/dist/apis/email-settings.js +1 -1
  60. package/dist/apis/email-template.cjs +6 -6
  61. package/dist/apis/email-template.js +1 -1
  62. package/dist/apis/entity-mapping.cjs +6 -6
  63. package/dist/apis/entity-mapping.js +1 -1
  64. package/dist/apis/entity.cjs +6 -6
  65. package/dist/apis/entity.js +1 -1
  66. package/dist/apis/environments.cjs +6 -6
  67. package/dist/apis/environments.js +1 -1
  68. package/dist/apis/event-catalog.cjs +6 -6
  69. package/dist/apis/event-catalog.js +1 -1
  70. package/dist/apis/file.cjs +6 -6
  71. package/dist/apis/file.js +1 -1
  72. package/dist/apis/focus-pocus.cjs +38 -0
  73. package/dist/apis/focus-pocus.d.cts +18 -0
  74. package/dist/apis/focus-pocus.d.ts +18 -0
  75. package/dist/apis/focus-pocus.js +38 -0
  76. package/dist/apis/iban.cjs +6 -6
  77. package/dist/apis/iban.js +1 -1
  78. package/dist/apis/integration-toolkit.cjs +6 -6
  79. package/dist/apis/integration-toolkit.js +1 -1
  80. package/dist/apis/journey.cjs +8 -8
  81. package/dist/apis/journey.d.cts +2 -2
  82. package/dist/apis/journey.d.ts +2 -2
  83. package/dist/apis/journey.js +2 -2
  84. package/dist/apis/kanban.cjs +6 -6
  85. package/dist/apis/kanban.js +1 -1
  86. package/dist/apis/message.cjs +6 -6
  87. package/dist/apis/message.js +1 -1
  88. package/dist/apis/metering.cjs +6 -6
  89. package/dist/apis/metering.js +1 -1
  90. package/dist/apis/notes.cjs +6 -6
  91. package/dist/apis/notes.js +1 -1
  92. package/dist/apis/notification.cjs +6 -6
  93. package/dist/apis/notification.js +1 -1
  94. package/dist/apis/organization.cjs +6 -6
  95. package/dist/apis/organization.js +1 -1
  96. package/dist/apis/partner-directory.cjs +6 -6
  97. package/dist/apis/partner-directory.js +1 -1
  98. package/dist/apis/permissions.cjs +6 -6
  99. package/dist/apis/permissions.js +1 -1
  100. package/dist/apis/pricing-tier.cjs +6 -6
  101. package/dist/apis/pricing-tier.js +1 -1
  102. package/dist/apis/pricing.cjs +6 -6
  103. package/dist/apis/pricing.js +1 -1
  104. package/dist/apis/purpose.cjs +6 -6
  105. package/dist/apis/purpose.js +1 -1
  106. package/dist/apis/query.cjs +6 -6
  107. package/dist/apis/query.js +1 -1
  108. package/dist/apis/sandbox.cjs +6 -6
  109. package/dist/apis/sandbox.js +1 -1
  110. package/dist/apis/sharing.cjs +6 -6
  111. package/dist/apis/sharing.js +1 -1
  112. package/dist/apis/submission.cjs +6 -6
  113. package/dist/apis/submission.js +1 -1
  114. package/dist/apis/target.cjs +6 -6
  115. package/dist/apis/target.js +1 -1
  116. package/dist/apis/targeting.cjs +6 -6
  117. package/dist/apis/targeting.js +1 -1
  118. package/dist/apis/template-variables.cjs +6 -6
  119. package/dist/apis/template-variables.js +1 -1
  120. package/dist/apis/user.cjs +6 -6
  121. package/dist/apis/user.js +1 -1
  122. package/dist/apis/validation-rules.cjs +6 -6
  123. package/dist/apis/validation-rules.js +1 -1
  124. package/dist/apis/webhooks.cjs +6 -6
  125. package/dist/apis/webhooks.js +1 -1
  126. package/dist/apis/workflow-definition.cjs +6 -6
  127. package/dist/apis/workflow-definition.js +1 -1
  128. package/dist/apis/workflow.cjs +6 -6
  129. package/dist/apis/workflow.js +1 -1
  130. package/dist/{app-SSF545U7.cjs → app-74LECFMK.cjs} +1 -1
  131. package/dist/{app-34OBBTA4.js → app-GNUHCGPO.js} +1 -1
  132. package/dist/{app.d--5n0FQQ4.d.cts → app.d-BOR23dso.d.cts} +104 -4
  133. package/dist/{app.d--5n0FQQ4.d.ts → app.d-BOR23dso.d.ts} +104 -4
  134. package/dist/bin/cli.js +1 -1
  135. package/dist/{chunk-SCMAZ73K.js → chunk-54KWFSCM.js} +30 -19
  136. package/dist/chunk-A6FYGWQ7.cjs +14 -0
  137. package/dist/{chunk-R7XDTILZ.cjs → chunk-F5Z6I7TF.cjs} +30 -19
  138. package/dist/chunk-JOUTFBLN.js +14 -0
  139. package/dist/chunk-LAWKCWVU.cjs +14 -0
  140. package/dist/{chunk-ZSONBZIF.cjs → chunk-MOLFG5L4.cjs} +1 -1
  141. package/dist/chunk-P42Q6HOW.js +14 -0
  142. package/dist/chunk-P4NA7NWG.js +14 -0
  143. package/dist/chunk-WHXYES2D.cjs +14 -0
  144. package/dist/{chunk-ONOGGR6Q.js → chunk-WW6DVKJR.js} +1 -1
  145. package/dist/configuration-hub-E7S4JB2T.js +7 -0
  146. package/dist/configuration-hub-Q5JBYB52.cjs +7 -0
  147. package/dist/{configuration-hub-runtime-L6IOERSP.js → configuration-hub-runtime-CXME7TCX.js} +1 -1
  148. package/dist/{configuration-hub-runtime-I5Y67CXD.cjs → configuration-hub-runtime-QVLJKEZD.cjs} +2 -2
  149. package/dist/configuration-hub.d-CbSJDa7k.d.cts +1096 -0
  150. package/dist/configuration-hub.d-CbSJDa7k.d.ts +1096 -0
  151. package/dist/customer-portal-DR6XFCTQ.js +7 -0
  152. package/dist/customer-portal-PNFBVIAH.cjs +7 -0
  153. package/dist/{customer-portal.d-C7ZCbjiY.d.cts → customer-portal.d-CTTCBAZI.d.cts} +217 -61
  154. package/dist/{customer-portal.d-C7ZCbjiY.d.ts → customer-portal.d-CTTCBAZI.d.ts} +217 -61
  155. package/dist/data-governance-QYFHBCNB.cjs +7 -0
  156. package/dist/data-governance-YS2NA6W4.js +7 -0
  157. package/dist/design-EWZQZ5KX.js +7 -0
  158. package/dist/design-MUUYXB2J.cjs +7 -0
  159. package/dist/design-runtime-3RHYNHUV.cjs +5 -0
  160. package/dist/{design-runtime-QMJM4FAF.js → design-runtime-DLMA4EHQ.js} +1 -1
  161. package/dist/focus-pocus-JGXH42OF.cjs +7 -0
  162. package/dist/focus-pocus-XVDVUYL6.js +7 -0
  163. package/dist/focus-pocus-runtime-QXBBYVX7.js +5 -0
  164. package/dist/focus-pocus-runtime-X6GQ3WI4.cjs +5 -0
  165. package/dist/focus-pocus.d-BRFGe53G.d.cts +489 -0
  166. package/dist/focus-pocus.d-BRFGe53G.d.ts +489 -0
  167. package/dist/index.cjs +29 -21
  168. package/dist/index.d.cts +55 -53
  169. package/dist/index.d.ts +55 -53
  170. package/dist/index.js +20 -12
  171. package/dist/journey-4DIIPRU4.js +7 -0
  172. package/dist/journey-ATC3Y5AW.cjs +7 -0
  173. package/dist/{journey-runtime-SPBL3F32.cjs → journey-runtime-G2O5C3N2.cjs} +2 -2
  174. package/dist/{journey-runtime-YXIAOTMD.js → journey-runtime-RI2LJO5S.js} +1 -1
  175. package/dist/{journey.d-ClXO0xK8.d.cts → journey.d-BenIUWaO.d.cts} +9 -3
  176. package/dist/{journey.d-ClXO0xK8.d.ts → journey.d-BenIUWaO.d.ts} +9 -3
  177. package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
  178. package/dist/pricing-R5ENSVPQ.cjs +7 -0
  179. package/dist/pricing-X27CCRI6.js +7 -0
  180. package/dist/targeting-74BV7F7H.cjs +7 -0
  181. package/dist/targeting-W5EKJYR2.js +7 -0
  182. package/docs/app.md +34 -10
  183. package/docs/configuration-hub.md +660 -0
  184. package/docs/customer-portal.md +223 -161
  185. package/docs/data-governance.md +17 -17
  186. package/docs/design.md +1 -1
  187. package/docs/focus-pocus.md +460 -0
  188. package/docs/journey.md +2 -0
  189. package/docs/pricing.md +1 -1
  190. package/docs/targeting.md +4 -4
  191. package/package.json +10 -1
  192. package/dist/README-46VYEGGW.js +0 -7
  193. package/dist/README-IVBISSWB.cjs +0 -7
  194. package/dist/chunk-EIIIKDOJ.cjs +0 -14
  195. package/dist/chunk-KIWRGUKM.js +0 -14
  196. package/dist/chunk-MB6NKETA.cjs +0 -14
  197. package/dist/chunk-VSZEOCIE.js +0 -14
  198. package/dist/configuration-hub-A3S6ND6R.cjs +0 -7
  199. package/dist/configuration-hub-PMAW44U5.js +0 -7
  200. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  201. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  202. package/dist/customer-portal-7HYSBH7H.cjs +0 -7
  203. package/dist/customer-portal-X4LJX6AU.js +0 -7
  204. package/dist/data-governance-2U5UU4GM.cjs +0 -7
  205. package/dist/data-governance-36Y33JVG.js +0 -7
  206. package/dist/design-DROLIWS3.js +0 -7
  207. package/dist/design-XZKOZLTR.cjs +0 -7
  208. package/dist/design-runtime-OXEXKZVG.cjs +0 -5
  209. package/dist/journey-KDR5EU3W.js +0 -7
  210. package/dist/journey-REBN4TGQ.cjs +0 -7
  211. package/dist/pricing-FODHQFCB.cjs +0 -7
  212. package/dist/pricing-XRIDVZFC.js +0 -7
  213. package/dist/targeting-EYGYZD6M.cjs +0 -7
  214. package/dist/targeting-GEJTJN5Z.js +0 -7
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/data-governance.json
4
- var data_governance_default = '# Data Governance API\n\n- **Base URL:** `https://data-governance.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/data-governance](https://docs.epilot.io/api/data-governance)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataGovernance.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-governance\'\n\nconst dataGovernanceClient = getClient()\nauthorize(dataGovernanceClient, () => \'<token>\')\nconst { data } = await dataGovernanceClient.queryEntities(...)\n```\n\n## Operations\n\n**Query**\n- [`queryEntities`](#queryentities)\n\n**Auditable Jobs**\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`createJobForConfig`](#createjobforconfig)\n- [`listJobs`](#listjobs)\n\n**Data Lifecycle Configs**\n- [`getConfig`](#getconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\n\n**Schemas**\n- [`ConfigType`](#configtype)\n- [`JobStatus`](#jobstatus)\n- [`JobTrigger`](#jobtrigger)\n- [`JobReportFormat`](#jobreportformat)\n- [`JobReport`](#jobreport)\n- [`CreateJobRequest`](#createjobrequest)\n- [`JobDetails`](#jobdetails)\n- [`UpdateJobRequest`](#updatejobrequest)\n- [`Job`](#job)\n- [`ListJobsResponse`](#listjobsresponse)\n- [`JobReportUrlResponse`](#jobreporturlresponse)\n- [`QueryFilterType`](#queryfiltertype)\n- [`QueryFilter`](#queryfilter)\n- [`QueryConfig`](#queryconfig)\n- [`QueryEntitiesRequest`](#queryentitiesrequest)\n- [`QueryEntitiesResult`](#queryentitiesresult)\n- [`ConfigSchedule`](#configschedule)\n- [`IntervalConfigSchedule`](#intervalconfigschedule)\n- [`UpsertConfigRequest`](#upsertconfigrequest)\n- [`Config`](#config)\n- [`DeletionRelationEntitySchema`](#deletionrelationentityschema)\n- [`ListConfigsResponse`](#listconfigsresponse)\n\n### `queryEntities`\n\nQuery entities matching a data lifecycle config\n\n`POST /data-governance/v1/{entity_schema}/query`\n\n```ts\nconst { data } = await client.queryEntities(\n {\n entity_schema: \'example\',\n },\n {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\'],\n workflow_status: [\'CLOSED\']\n }\n ],\n from: 0,\n size: 0,\n hydrate: true,\n fields: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `createJob`\n\nCreate a new job run\n\n`POST /data-governance/v1/{entity_schema}/jobs`\n\n```ts\nconst { data } = await client.createJob(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n config_id: \'string\',\n scheduled_for: \'1970-01-01\',\n status: \'in_progress\',\n started_at: \'1970-01-01T00:00:00.000Z\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateJob`\n\nUpdate an existing job run\n\n`PATCH /data-governance/v1/{entity_schema}/jobs/{job_id}`\n\n```ts\nconst { data } = await client.updateJob(\n {\n entity_schema: \'example\',\n job_id: \'example\',\n },\n {\n status: \'in_progress\',\n details: {},\n completed_at: \'1970-01-01T00:00:00.000Z\',\n error: \'string\',\n report: {\n bucket: \'string\',\n key: \'string\',\n format: \'csv\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJob`\n\nGet a job by ID\n\n`GET /data-governance/v1/jobs/{job_id}`\n\n```ts\nconst { data } = await client.getJob({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJobReportUrl`\n\nGet report download URL for a job\n\n`GET /data-governance/v1/jobs/{job_id}/report-url`\n\n```ts\nconst { data } = await client.getJobReportUrl({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "url": "string",\n "expires_in": 0\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet a config by ID\n\n`GET /data-governance/v1/configs/{config_id}`\n\n```ts\nconst { data } = await client.getConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createJobForConfig`\n\nTrigger a manual job run for a config\n\n`POST /data-governance/v1/configs/{config_id}/jobs`\n\n```ts\nconst { data } = await client.createJobForConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `upsertConfig`\n\nCreate or update a data lifecycle config\n\n`POST /data-governance/v1/{entity_schema}/configs`\n\n```ts\nconst { data } = await client.upsertConfig(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n query: {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\'],\n workflow_status: [\'CLOSED\']\n }\n ]\n },\n schedule: {\n frequency: \'interval\',\n interval_days: 1,\n start_date: \'1970-01-01\',\n end_date: \'1970-01-01\'\n },\n relations_for_deletion: [\'contact\'],\n enabled: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listConfigs`\n\nList data lifecycle configs\n\n`GET /data-governance/v1/configs`\n\n```ts\nconst { data } = await client.listConfigs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n next_run_at: \'example\',\n enabled: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "configs": [\n {\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `listJobs`\n\nList job runs\n\n`GET /data-governance/v1/jobs`\n\n```ts\nconst { data } = await client.listJobs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n status: \'example\',\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "jobs": [\n {\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConfigType`\n\nThe governance action type. Determines what operation is performed on\nmatched entities when a job runs. Currently only `deletion` is supported.\n\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\nCurrent execution status of a job run.\n- `in_progress` \u2014 the job is actively processing entities.\n- `success` \u2014 the job completed without critical errors.\n- `failed` \u2014 the job terminated due to an error.\n\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\nIndicates how the job was initiated.\n- `schedule` \u2014 automatically created by the background scheduler.\n- `manual` \u2014 explicitly triggered by a user via the API.\n\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\nFile format of the job report. Currently only CSV is supported.\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\nReference to a report file stored in S3 that details the outcome of a\njob run (e.g., which entities were deleted or failed).\n\n\n```ts\ntype JobReport = {\n bucket?: string\n key?: string\n format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\nRequest payload for creating a new job run.\n\n```ts\ntype CreateJobRequest = {\n type: "deletion"\n config_id: string\n scheduled_for: string // date\n status?: "in_progress" | "success" | "failed"\n started_at?: string // date-time\n}\n```\n\n### `JobDetails`\n\nType-specific job outcome payload. The shape depends on the config type.\nFor `deletion` jobs, typical fields include:\n- `matched_count` \u2014 total entities matched by the query\n- `deleted_count` \u2014 entities successfully deleted\n- `failed_count` \u2014 entities that could not be deleted\n\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\nPartial update payload for an existing job. Only the fields provided\nwill be merged into the job record.\n\n\n```ts\ntype UpdateJobRequest = {\n status?: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n}\n```\n\n### `Job`\n\nRepresents a single execution run of a data lifecycle config. Tracks the\nfull lifecycle from creation through completion, including outcome\ndetails and an optional downloadable report.\n\n\n```ts\ntype Job = {\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n}\n```\n\n### `ListJobsResponse`\n\nPaginated response containing a list of job runs.\n\n```ts\ntype ListJobsResponse = {\n jobs?: Array<{\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: { ... }\n key?: { ... }\n format?: { ... }\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n }>\n cursor?: string\n}\n```\n\n### `JobReportUrlResponse`\n\nContains a time-limited pre-signed URL to download a job report.\n\n```ts\ntype JobReportUrlResponse = {\n url?: string\n expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\nPredefined data governance filter types that can be layered on top of\na saved view to narrow down target entities:\n- `entity_workflows_only_in_closed_or_cancelled_status` \u2014 include only\n entities whose own workflows are all in a closed/cancelled state.\n- `no_related_entities` \u2014 include only entitie\n\n```ts\ntype QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n```\n\n### `QueryFilter`\n\nA single governance filter condition applied during entity querying.\nThe required and optional fields depend on the `type`.\n\n\n```ts\ntype QueryFilter = {\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n}\n```\n\n### `QueryConfig`\n\nDefines the query used by a data lifecycle config to identify target\nentities. Combines a saved view with optional governance filters.\n\n\n```ts\ntype QueryConfig = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n }>\n}\n```\n\n### `QueryEntitiesRequest`\n\nRequest body for the query endpoint. Extends `QueryConfig` with\npagination and projection options.\n\n\n```ts\ntype QueryEntitiesRequest = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n }>\n from?: number\n size?: number\n hydrate?: boolean\n fields?: string[]\n}\n```\n\n### `QueryEntitiesResult`\n\nResponse from the entity query endpoint.\n\n```ts\ntype QueryEntitiesResult = {\n hits?: number\n results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\n\n```ts\ntype ConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `IntervalConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\n\n```ts\ntype IntervalConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `UpsertConfigRequest`\n\nRequest payload for creating or updating a data lifecycle config.\n\n```ts\ntype UpsertConfigRequest = {\n type: "deletion"\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n workflow_status?: { ... }\n }>\n }\n schedule: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n enabled?: boolean\n}\n```\n\n### `Config`\n\nA data lifecycle config defining an automated policy (e.g., scheduled\nentity deletion) for a specific entity schema.\n\n\n```ts\ntype Config = {\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n workflow_status?: { ... }\n }>\n }\n schedule?: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n}\n```\n\n### `DeletionRelationEntitySchema`\n\nEntity schema slug that can be specified as a cascading deletion\ntarget. When a primary entity is deleted, related entities of these\nschemas are also removed.\n\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\nPaginated response containing a list of data lifecycle configs.\n\n```ts\ntype ListConfigsResponse = {\n configs?: Array<{\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: { ... }\n include_deleted?: { ... }\n filters?: { ... }\n }\n schedule?: {\n frequency: { ... }\n interval_days: { ... }\n start_date?: { ... }\n end_date?: { ... }\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n }>\n cursor?: string\n}\n```\n';
5
-
6
-
7
- exports.default = data_governance_default;
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/data-governance.json
4
- var data_governance_default = '# Data Governance API\n\n- **Base URL:** `https://data-governance.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/data-governance](https://docs.epilot.io/api/data-governance)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataGovernance.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-governance\'\n\nconst dataGovernanceClient = getClient()\nauthorize(dataGovernanceClient, () => \'<token>\')\nconst { data } = await dataGovernanceClient.queryEntities(...)\n```\n\n## Operations\n\n**Query**\n- [`queryEntities`](#queryentities)\n\n**Auditable Jobs**\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`createJobForConfig`](#createjobforconfig)\n- [`listJobs`](#listjobs)\n\n**Data Lifecycle Configs**\n- [`getConfig`](#getconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\n\n**Schemas**\n- [`ConfigType`](#configtype)\n- [`JobStatus`](#jobstatus)\n- [`JobTrigger`](#jobtrigger)\n- [`JobReportFormat`](#jobreportformat)\n- [`JobReport`](#jobreport)\n- [`CreateJobRequest`](#createjobrequest)\n- [`JobDetails`](#jobdetails)\n- [`UpdateJobRequest`](#updatejobrequest)\n- [`Job`](#job)\n- [`ListJobsResponse`](#listjobsresponse)\n- [`JobReportUrlResponse`](#jobreporturlresponse)\n- [`QueryFilterType`](#queryfiltertype)\n- [`QueryFilter`](#queryfilter)\n- [`QueryConfig`](#queryconfig)\n- [`QueryEntitiesRequest`](#queryentitiesrequest)\n- [`QueryEntitiesResult`](#queryentitiesresult)\n- [`ConfigSchedule`](#configschedule)\n- [`IntervalConfigSchedule`](#intervalconfigschedule)\n- [`UpsertConfigRequest`](#upsertconfigrequest)\n- [`Config`](#config)\n- [`DeletionRelationEntitySchema`](#deletionrelationentityschema)\n- [`ListConfigsResponse`](#listconfigsresponse)\n\n### `queryEntities`\n\nQuery entities matching a data lifecycle config\n\n`POST /data-governance/v1/{entity_schema}/query`\n\n```ts\nconst { data } = await client.queryEntities(\n {\n entity_schema: \'example\',\n },\n {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\'],\n workflow_status: [\'CLOSED\']\n }\n ],\n from: 0,\n size: 0,\n hydrate: true,\n fields: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `createJob`\n\nCreate a new job run\n\n`POST /data-governance/v1/{entity_schema}/jobs`\n\n```ts\nconst { data } = await client.createJob(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n config_id: \'string\',\n scheduled_for: \'1970-01-01\',\n status: \'in_progress\',\n started_at: \'1970-01-01T00:00:00.000Z\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateJob`\n\nUpdate an existing job run\n\n`PATCH /data-governance/v1/{entity_schema}/jobs/{job_id}`\n\n```ts\nconst { data } = await client.updateJob(\n {\n entity_schema: \'example\',\n job_id: \'example\',\n },\n {\n status: \'in_progress\',\n details: {},\n completed_at: \'1970-01-01T00:00:00.000Z\',\n error: \'string\',\n report: {\n bucket: \'string\',\n key: \'string\',\n format: \'csv\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJob`\n\nGet a job by ID\n\n`GET /data-governance/v1/jobs/{job_id}`\n\n```ts\nconst { data } = await client.getJob({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJobReportUrl`\n\nGet report download URL for a job\n\n`GET /data-governance/v1/jobs/{job_id}/report-url`\n\n```ts\nconst { data } = await client.getJobReportUrl({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "url": "string",\n "expires_in": 0\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet a config by ID\n\n`GET /data-governance/v1/configs/{config_id}`\n\n```ts\nconst { data } = await client.getConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createJobForConfig`\n\nTrigger a manual job run for a config\n\n`POST /data-governance/v1/configs/{config_id}/jobs`\n\n```ts\nconst { data } = await client.createJobForConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `upsertConfig`\n\nCreate or update a data lifecycle config\n\n`POST /data-governance/v1/{entity_schema}/configs`\n\n```ts\nconst { data } = await client.upsertConfig(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n query: {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\'],\n workflow_status: [\'CLOSED\']\n }\n ]\n },\n schedule: {\n frequency: \'interval\',\n interval_days: 1,\n start_date: \'1970-01-01\',\n end_date: \'1970-01-01\'\n },\n relations_for_deletion: [\'contact\'],\n enabled: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listConfigs`\n\nList data lifecycle configs\n\n`GET /data-governance/v1/configs`\n\n```ts\nconst { data } = await client.listConfigs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n next_run_at: \'example\',\n enabled: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "configs": [\n {\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `listJobs`\n\nList job runs\n\n`GET /data-governance/v1/jobs`\n\n```ts\nconst { data } = await client.listJobs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n status: \'example\',\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "jobs": [\n {\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConfigType`\n\nThe governance action type. Determines what operation is performed on\nmatched entities when a job runs. Currently only `deletion` is supported.\n\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\nCurrent execution status of a job run.\n- `in_progress` \u2014 the job is actively processing entities.\n- `success` \u2014 the job completed without critical errors.\n- `failed` \u2014 the job terminated due to an error.\n\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\nIndicates how the job was initiated.\n- `schedule` \u2014 automatically created by the background scheduler.\n- `manual` \u2014 explicitly triggered by a user via the API.\n\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\nFile format of the job report. Currently only CSV is supported.\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\nReference to a report file stored in S3 that details the outcome of a\njob run (e.g., which entities were deleted or failed).\n\n\n```ts\ntype JobReport = {\n bucket?: string\n key?: string\n format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\nRequest payload for creating a new job run.\n\n```ts\ntype CreateJobRequest = {\n type: "deletion"\n config_id: string\n scheduled_for: string // date\n status?: "in_progress" | "success" | "failed"\n started_at?: string // date-time\n}\n```\n\n### `JobDetails`\n\nType-specific job outcome payload. The shape depends on the config type.\nFor `deletion` jobs, typical fields include:\n- `matched_count` \u2014 total entities matched by the query\n- `deleted_count` \u2014 entities successfully deleted\n- `failed_count` \u2014 entities that could not be deleted\n\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\nPartial update payload for an existing job. Only the fields provided\nwill be merged into the job record.\n\n\n```ts\ntype UpdateJobRequest = {\n status?: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n}\n```\n\n### `Job`\n\nRepresents a single execution run of a data lifecycle config. Tracks the\nfull lifecycle from creation through completion, including outcome\ndetails and an optional downloadable report.\n\n\n```ts\ntype Job = {\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n}\n```\n\n### `ListJobsResponse`\n\nPaginated response containing a list of job runs.\n\n```ts\ntype ListJobsResponse = {\n jobs?: Array<{\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: { ... }\n key?: { ... }\n format?: { ... }\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n }>\n cursor?: string\n}\n```\n\n### `JobReportUrlResponse`\n\nContains a time-limited pre-signed URL to download a job report.\n\n```ts\ntype JobReportUrlResponse = {\n url?: string\n expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\nPredefined data governance filter types that can be layered on top of\na saved view to narrow down target entities:\n- `entity_workflows_only_in_closed_or_cancelled_status` \u2014 include only\n entities whose own workflows are all in a closed/cancelled state.\n- `no_related_entities` \u2014 include only entitie\n\n```ts\ntype QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n```\n\n### `QueryFilter`\n\nA single governance filter condition applied during entity querying.\nThe required and optional fields depend on the `type`.\n\n\n```ts\ntype QueryFilter = {\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n}\n```\n\n### `QueryConfig`\n\nDefines the query used by a data lifecycle config to identify target\nentities. Combines a saved view with optional governance filters.\n\n\n```ts\ntype QueryConfig = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n }>\n}\n```\n\n### `QueryEntitiesRequest`\n\nRequest body for the query endpoint. Extends `QueryConfig` with\npagination and projection options.\n\n\n```ts\ntype QueryEntitiesRequest = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n }>\n from?: number\n size?: number\n hydrate?: boolean\n fields?: string[]\n}\n```\n\n### `QueryEntitiesResult`\n\nResponse from the entity query endpoint.\n\n```ts\ntype QueryEntitiesResult = {\n hits?: number\n results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\n\n```ts\ntype ConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `IntervalConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\n\n```ts\ntype IntervalConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `UpsertConfigRequest`\n\nRequest payload for creating or updating a data lifecycle config.\n\n```ts\ntype UpsertConfigRequest = {\n type: "deletion"\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n workflow_status?: { ... }\n }>\n }\n schedule: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n enabled?: boolean\n}\n```\n\n### `Config`\n\nA data lifecycle config defining an automated policy (e.g., scheduled\nentity deletion) for a specific entity schema.\n\n\n```ts\ntype Config = {\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n workflow_status?: { ... }\n }>\n }\n schedule?: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n}\n```\n\n### `DeletionRelationEntitySchema`\n\nEntity schema slug that can be specified as a cascading deletion\ntarget. When a primary entity is deleted, related entities of these\nschemas are also removed.\n\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\nPaginated response containing a list of data lifecycle configs.\n\n```ts\ntype ListConfigsResponse = {\n configs?: Array<{\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: { ... }\n include_deleted?: { ... }\n filters?: { ... }\n }\n schedule?: {\n frequency: { ... }\n interval_days: { ... }\n start_date?: { ... }\n end_date?: { ... }\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n }>\n cursor?: string\n}\n```\n';
5
- export {
6
- data_governance_default as default
7
- };
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/design.json
4
- var design_default = '# Design Builder API v2\n\n- **Base URL:** `https://design-builder-api.{environment}.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.design.getAllDesigns(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/design\'\n\nconst designClient = getClient()\nauthorize(designClient, () => \'<token>\')\nconst { data } = await designClient.getAllDesigns(...)\n```\n\n## Operations\n\n**design-builder**\n- [`getAllDesigns`](#getalldesigns)\n- [`addDesign`](#adddesign)\n- [`getDesign`](#getdesign)\n- [`deleteDesign`](#deletedesign)\n- [`updateDesign`](#updatedesign)\n- [`getThemeFromDesign`](#getthemefromdesign)\n- [`uploadFile`](#uploadfile)\n- [`getFiles`](#getfiles)\n- [`getConsumerDesign`](#getconsumerdesign)\n- [`addConsumer`](#addconsumer)\n- [`removeConsumer`](#removeconsumer)\n\n**Schemas**\n- [`UploadFileReq`](#uploadfilereq)\n- [`UploadFileRes`](#uploadfileres)\n- [`GetFilesRes`](#getfilesres)\n- [`GetAllDesignsRes`](#getalldesignsres)\n- [`GetBrandsRes`](#getbrandsres)\n- [`AddDesignReq`](#adddesignreq)\n- [`AddDesignRes`](#adddesignres)\n- [`GetDesignRes`](#getdesignres)\n- [`UpdateDesignReq`](#updatedesignreq)\n- [`ItemMetada`](#itemmetada)\n- [`AddConsumerReq`](#addconsumerreq)\n- [`RemoveConsumerReq`](#removeconsumerreq)\n- [`DesignItem`](#designitem)\n- [`BrandItem`](#branditem)\n- [`Custom_Style`](#custom_style)\n- [`Journey`](#journey)\n- [`ConsumerData`](#consumerdata)\n- [`WidgetData`](#widgetdata)\n- [`CustomerPortalData`](#customerportaldata)\n- [`LogoData`](#logodata)\n- [`PaletteData`](#palettedata)\n- [`TypographyData`](#typographydata)\n- [`ShapeData`](#shapedata)\n- [`FontData`](#fontdata)\n- [`FontResponseUrl`](#fontresponseurl)\n- [`WidgetPortalData`](#widgetportaldata)\n- [`ErrorResp`](#errorresp)\n- [`FileData`](#filedata)\n- [`DesignId`](#designid)\n- [`Theme`](#theme)\n- [`Application`](#application)\n- [`DesignParameters`](#designparameters)\n\n### `getAllDesigns`\n\nScan all designs linked to a organization, based in orgId attribute from JWT auth token\n\n`GET /v1/designs`\n\n```ts\nconst { data } = await client.getAllDesigns()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "designs": [\n {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {},\n "style_name": "string",\n "style": {},\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `addDesign`\n\nCreate a brand new design linked to a organization, based in orgId attribute from JWT auth token\n\n`POST /v1/designs`\n\n```ts\nconst { data } = await client.addDesign(\n null,\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: { /* ... */ },\n palette: { /* ... */ },\n typography: { /* ... */ },\n shape: { /* ... */ },\n consumer: { /* ... */ }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\',\n accent_color: \'string\',\n outline_color: \'string\',\n divider_color: \'string\',\n link_color: \'string\',\n link_hover_color: \'string\',\n font_size_scale: \'xs\',\n topbar_height: 0,\n topbar_logo_alignment: \'flex-start\',\n logo_size: 0,\n input_background: \'string\',\n input_border_color: \'string\',\n input_text_color: \'string\',\n input_label_color: \'string\',\n input_border_radius: 0,\n input_height: 0,\n input_variant: \'outlined\',\n button_primary_bg: \'string\',\n button_primary_text: \'string\',\n button_primary_hover_bg: \'string\',\n button_primary_hover_text: \'string\',\n button_outlined_border: \'string\',\n button_outlined_text: \'string\',\n button_outlined_hover_bg: \'string\',\n button_outlined_hover_text: \'string\',\n button_ghost_bg: \'string\',\n button_ghost_text: \'string\',\n button_ghost_hover_bg: \'string\',\n button_ghost_hover_text: \'string\',\n button_border_radius: 0,\n button_height: 0,\n card_background: \'string\',\n card_border_color: \'string\',\n card_variant: \'shadow\',\n summary_card_background: \'string\',\n toggle_selected_bg: \'string\',\n toggle_selected_text: \'string\',\n toggle_hover_bg: \'string\',\n toggle_hover_text: \'string\',\n toggle_border_color: \'string\',\n dropdown_hover_bg: \'string\',\n dropdown_hover_text: \'string\',\n dropdown_selected_bg: \'string\',\n dropdown_selected_text: \'string\',\n switch_unchecked_color: \'string\',\n switch_unchecked_bg: \'string\',\n switch_border_radius: 0,\n checkbox_unchecked_color: \'string\',\n checkbox_label_color: \'string\',\n radio_unchecked_color: \'string\',\n radio_label_color: \'string\',\n datepicker_selected_bg: \'string\',\n datepicker_selected_color: \'string\',\n datepicker_border_radius: 0,\n chip_background: \'string\',\n chip_hover_background: \'string\',\n chip_text_color: \'string\',\n chip_hover_text_color: \'string\'\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {},\n "palette": {},\n "typography": {},\n "shape": {},\n "consumer": {}\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string",\n "accent_color": "string",\n "outline_color": "string",\n "divider_color": "string",\n "link_color": "string",\n "link_hover_color": "string",\n "font_size_scale": "xs",\n "topbar_height": 0,\n "topbar_logo_alignment": "flex-start",\n "logo_size": 0,\n "input_background": "string",\n "input_border_color": "string",\n "input_text_color": "string",\n "input_label_color": "string",\n "input_border_radius": 0,\n "input_height": 0,\n "input_variant": "outlined",\n "button_primary_bg": "string",\n "button_primary_text": "string",\n "button_primary_hover_bg": "string",\n "button_primary_hover_text": "string",\n "button_outlined_border": "string",\n "button_outlined_text": "string",\n "button_outlined_hover_bg": "string",\n "button_outlined_hover_text": "string",\n "button_ghost_bg": "string",\n "button_ghost_text": "string",\n "button_ghost_hover_bg": "string",\n "button_ghost_hover_text": "string",\n "button_border_radius": 0,\n "button_height": 0,\n "card_background": "string",\n "card_border_color": "string",\n "card_variant": "shadow",\n "summary_card_background": "string",\n "toggle_selected_bg": "string",\n "toggle_selected_text": "string",\n "toggle_hover_bg": "string",\n "toggle_hover_text": "string",\n "toggle_border_color": "string",\n "dropdown_hover_bg": "string",\n "dropdown_hover_text": "string",\n "dropdown_selected_bg": "string",\n "dropdown_selected_text": "string",\n "switch_unchecked_color": "string",\n "switch_unchecked_bg": "string",\n "switch_border_radius": 0,\n "checkbox_unchecked_color": "string",\n "checkbox_label_color": "string",\n "radio_unchecked_color": "string",\n "radio_label_color": "string",\n "datepicker_selected_bg": "string",\n "datepicker_selected_color": "string",\n "datepicker_border_radius": 0,\n "chip_background": "string",\n "chip_hover_background": "string",\n "chip_text_color": "string",\n "chip_hover_text_color": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.getDesign({\n designId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {},\n "palette": {},\n "typography": {},\n "shape": {},\n "consumer": {}\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string",\n "accent_color": "string",\n "outline_color": "string",\n "divider_color": "string",\n "link_color": "string",\n "link_hover_color": "string",\n "font_size_scale": "xs",\n "topbar_height": 0,\n "topbar_logo_alignment": "flex-start",\n "logo_size": 0,\n "input_background": "string",\n "input_border_color": "string",\n "input_text_color": "string",\n "input_label_color": "string",\n "input_border_radius": 0,\n "input_height": 0,\n "input_variant": "outlined",\n "button_primary_bg": "string",\n "button_primary_text": "string",\n "button_primary_hover_bg": "string",\n "button_primary_hover_text": "string",\n "button_outlined_border": "string",\n "button_outlined_text": "string",\n "button_outlined_hover_bg": "string",\n "button_outlined_hover_text": "string",\n "button_ghost_bg": "string",\n "button_ghost_text": "string",\n "button_ghost_hover_bg": "string",\n "button_ghost_hover_text": "string",\n "button_border_radius": 0,\n "button_height": 0,\n "card_background": "string",\n "card_border_color": "string",\n "card_variant": "shadow",\n "summary_card_background": "string",\n "toggle_selected_bg": "string",\n "toggle_selected_text": "string",\n "toggle_hover_bg": "string",\n "toggle_hover_text": "string",\n "toggle_border_color": "string",\n "dropdown_hover_bg": "string",\n "dropdown_hover_text": "string",\n "dropdown_selected_bg": "string",\n "dropdown_selected_text": "string",\n "switch_unchecked_color": "string",\n "switch_unchecked_bg": "string",\n "switch_border_radius": 0,\n "checkbox_unchecked_color": "string",\n "checkbox_label_color": "string",\n "radio_unchecked_color": "string",\n "radio_label_color": "string",\n "datepicker_selected_bg": "string",\n "datepicker_selected_color": "string",\n "datepicker_border_radius": 0,\n "chip_background": "string",\n "chip_hover_background": "string",\n "chip_text_color": "string",\n "chip_hover_text_color": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteDesign`\n\nSearch and delete for a especific design owned by user organization\n\n`DELETE /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.deleteDesign({\n designId: \'example\',\n})\n```\n\n---\n\n### `updateDesign`\n\nUpdate a especific design owned by user organization\n\n`PUT /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.updateDesign(\n {\n designId: \'example\',\n },\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: { /* ... */ },\n palette: { /* ... */ },\n typography: { /* ... */ },\n shape: { /* ... */ },\n consumer: { /* ... */ }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\',\n accent_color: \'string\',\n outline_color: \'string\',\n divider_color: \'string\',\n link_color: \'string\',\n link_hover_color: \'string\',\n font_size_scale: \'xs\',\n topbar_height: 0,\n topbar_logo_alignment: \'flex-start\',\n logo_size: 0,\n input_background: \'string\',\n input_border_color: \'string\',\n input_text_color: \'string\',\n input_label_color: \'string\',\n input_border_radius: 0,\n input_height: 0,\n input_variant: \'outlined\',\n button_primary_bg: \'string\',\n button_primary_text: \'string\',\n button_primary_hover_bg: \'string\',\n button_primary_hover_text: \'string\',\n button_outlined_border: \'string\',\n button_outlined_text: \'string\',\n button_outlined_hover_bg: \'string\',\n button_outlined_hover_text: \'string\',\n button_ghost_bg: \'string\',\n button_ghost_text: \'string\',\n button_ghost_hover_bg: \'string\',\n button_ghost_hover_text: \'string\',\n button_border_radius: 0,\n button_height: 0,\n card_background: \'string\',\n card_border_color: \'string\',\n card_variant: \'shadow\',\n summary_card_background: \'string\',\n toggle_selected_bg: \'string\',\n toggle_selected_text: \'string\',\n toggle_hover_bg: \'string\',\n toggle_hover_text: \'string\',\n toggle_border_color: \'string\',\n dropdown_hover_bg: \'string\',\n dropdown_hover_text: \'string\',\n dropdown_selected_bg: \'string\',\n dropdown_selected_text: \'string\',\n switch_unchecked_color: \'string\',\n switch_unchecked_bg: \'string\',\n switch_border_radius: 0,\n checkbox_unchecked_color: \'string\',\n checkbox_label_color: \'string\',\n radio_unchecked_color: \'string\',\n radio_label_color: \'string\',\n datepicker_selected_bg: \'string\',\n datepicker_selected_color: \'string\',\n datepicker_border_radius: 0,\n chip_background: \'string\',\n chip_hover_background: \'string\',\n chip_text_color: \'string\',\n chip_hover_text_color: \'string\'\n }\n }\n },\n)\n```\n\n---\n\n### `getThemeFromDesign`\n\nSearch for a especific design owned by user organization and parse them to a new or old theme\n\n`GET /v1/designs/{designId}/parse`\n\n```ts\nconst { data } = await client.getThemeFromDesign({\n designId: \'example\',\n orgId: \'example\',\n theme: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `uploadFile`\n\nUpload a new file for the user organization bucket\n\n`POST /v1/designs/files`\n\n```ts\nconst { data } = await client.uploadFile()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n}\n```\n\n</details>\n\n---\n\n### `getFiles`\n\nList all files for the user organization bucket\n\n`GET /v1/designs/files`\n\n```ts\nconst { data } = await client.getFiles({\n type: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConsumerDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/consumer/{application}/{consumerId}`\n\n```ts\nconst { data } = await client.getConsumerDesign({\n consumerId: \'example\',\n application: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {},\n "palette": {},\n "typography": {},\n "shape": {},\n "consumer": {}\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string",\n "accent_color": "string",\n "outline_color": "string",\n "divider_color": "string",\n "link_color": "string",\n "link_hover_color": "string",\n "font_size_scale": "xs",\n "topbar_height": 0,\n "topbar_logo_alignment": "flex-start",\n "logo_size": 0,\n "input_background": "string",\n "input_border_color": "string",\n "input_text_color": "string",\n "input_label_color": "string",\n "input_border_radius": 0,\n "input_height": 0,\n "input_variant": "outlined",\n "button_primary_bg": "string",\n "button_primary_text": "string",\n "button_primary_hover_bg": "string",\n "button_primary_hover_text": "string",\n "button_outlined_border": "string",\n "button_outlined_text": "string",\n "button_outlined_hover_bg": "string",\n "button_outlined_hover_text": "string",\n "button_ghost_bg": "string",\n "button_ghost_text": "string",\n "button_ghost_hover_bg": "string",\n "button_ghost_hover_text": "string",\n "button_border_radius": 0,\n "button_height": 0,\n "card_background": "string",\n "card_border_color": "string",\n "card_variant": "shadow",\n "summary_card_background": "string",\n "toggle_selected_bg": "string",\n "toggle_selected_text": "string",\n "toggle_hover_bg": "string",\n "toggle_hover_text": "string",\n "toggle_border_color": "string",\n "dropdown_hover_bg": "string",\n "dropdown_hover_text": "string",\n "dropdown_selected_bg": "string",\n "dropdown_selected_text": "string",\n "switch_unchecked_color": "string",\n "switch_unchecked_bg": "string",\n "switch_border_radius": 0,\n "checkbox_unchecked_color": "string",\n "checkbox_label_color": "string",\n "radio_unchecked_color": "string",\n "radio_label_color": "string",\n "datepicker_selected_bg": "string",\n "datepicker_selected_color": "string",\n "datepicker_border_radius": 0,\n "chip_background": "string",\n "chip_hover_background": "string",\n "chip_text_color": "string",\n "chip_hover_text_color": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `addConsumer`\n\nAdd a consumer that uses a specific design\n\n`PUT /v1/designs/addConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.addConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n consumer_name: \'string\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n### `removeConsumer`\n\nRemove a consumer that uses a specific design\n\n`PUT /v1/designs/removeConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.removeConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n## Schemas\n\n### `UploadFileReq`\n\n```ts\ntype UploadFileReq = {\n file_type: "LOGO" | "FONT" | "IMAGE"\n file_data: string // base64\n display_name?: string\n file_name: string\n}\n```\n\n### `UploadFileRes`\n\n```ts\ntype UploadFileRes = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n}\n```\n\n### `GetFilesRes`\n\n```ts\ntype GetFilesRes = Array<{\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n}>\n```\n\n### `GetAllDesignsRes`\n\n```ts\ntype GetAllDesignsRes = {\n designs?: Array<{\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }>\n}\n```\n\n### `GetBrandsRes`\n\n```ts\ntype GetBrandsRes = {\n brands?: Array<{\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n }>\n}\n```\n\n### `AddDesignReq`\n\n```ts\ntype AddDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `AddDesignRes`\n\n```ts\ntype AddDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `GetDesignRes`\n\n```ts\ntype GetDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `UpdateDesignReq`\n\n```ts\ntype UpdateDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `ItemMetada`\n\n```ts\ntype ItemMetada = {\n id?: string\n created_at?: string\n created_by?: string\n edited?: boolean\n last_modified_at?: string\n}\n```\n\n### `AddConsumerReq`\n\n```ts\ntype AddConsumerReq = {\n consumer_id: string\n consumer_name: string\n should_delete?: string\n}\n```\n\n### `RemoveConsumerReq`\n\n```ts\ntype RemoveConsumerReq = {\n consumer_id: string\n should_delete?: string\n}\n```\n\n### `DesignItem`\n\n```ts\ntype DesignItem = {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: string\n fullname?: string\n name?: string\n userid?: string\n }\n style_name: string\n style: {\n logo?: {\n main?: { ... }\n }\n palette: {\n primary: { ... }\n secondary: { ... }\n error: { ... }\n background: { ... }\n paper: { ... }\n navbar: { ... }\n portal_login_background?: { ... }\n }\n typography: {\n font: { ... }\n primary: { ... }\n secondary: { ... }\n }\n shape?: {\n border_radius?: { ... }\n }\n consumer: {\n widgets: { ... }\n customer_portals: { ... }\n }\n }\n is_default?: boolean\n _manifest?: string[]\n}\n```\n\n### `BrandItem`\n\n```ts\ntype BrandItem = {\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n}\n```\n\n### `Custom_Style`\n\n```ts\ntype Custom_Style = {\n custom_theme?: string\n use_custom_theme?: boolean\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n design_tokens?: {\n coupon?: string\n cashback?: string\n custom_css?: string\n accent_color?: string\n outline_color?: string\n divider_color?: string\n link_color?: string\n link_hover_color?: string\n font_size_scale?: "xs" | "sm" | "md" | "lg" | "xl"\n topbar_height?: number\n topbar_logo_alignment?: "flex-start" | "center" | "flex-end"\n logo_size?: number\n input_background?: string\n input_border_color?: string\n input_text_color?: string\n input_label_color?: string\n input_border_radius?: number\n input_height?: number\n input_variant?: "outlined" | "filled" | "underlined"\n button_primary_bg?: string\n button_primary_text?: string\n button_primary_hover_bg?: string\n button_primary_hover_text?: string\n button_outlined_border?: string\n button_outlined_text?: string\n button_outlined_hover_bg?: string\n button_outlined_hover_text?: string\n button_ghost_bg?: string\n button_ghost_text?: string\n button_ghost_hover_bg?: string\n button_ghost_hover_text?: string\n button_border_radius?: number\n button_height?: number\n card_background?: string\n card_border_color?: string\n card_variant?: "shadow" | "outlined"\n summary_card_background?: string\n toggle_selected_bg?: string\n toggle_selected_text?: string\n toggle_hover_bg?: string\n toggle_hover_text?: string\n toggle_border_color?: string\n dropdown_hover_bg?: string\n dropdown_hover_text?: string\n dropdown_selected_bg?: string\n dropdown_selected_text?: string\n switch_unchecked_color?: string\n switch_unchecked_bg?: string\n switch_border_radius?: number\n checkbox_unchecked_color?: string\n checkbox_label_color?: string\n radio_unchecked_color?: string\n radio_label_color?: string\n datepicker_selected_bg?: string\n datepicker_selected_color?: string\n datepicker_border_radius?: number\n chip_background?: string\n chip_hover_background?: string\n chip_text_color?: string\n chip_hover_text_color?: string\n }\n}\n```\n\n### `ConsumerData`\n\n```ts\ntype ConsumerData = {\n widgets: Array<{\n id: string\n name: string\n }>\n customer_portals: Array<{\n id: string\n name: string\n }>\n}\n```\n\n### `WidgetData`\n\n```ts\ntype WidgetData = {\n id: string\n name: string\n}\n```\n\n### `CustomerPortalData`\n\n```ts\ntype CustomerPortalData = {\n id: string\n name: string\n}\n```\n\n### `LogoData`\n\n```ts\ntype LogoData = {\n main?: {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n }\n}\n```\n\n### `PaletteData`\n\n```ts\ntype PaletteData = {\n primary: string\n secondary: string\n error: string\n background: string\n paper: string\n navbar: string\n portal_login_background?: string\n}\n```\n\n### `TypographyData`\n\n```ts\ntype TypographyData = {\n font: {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: { ... }\n url?: { ... }\n }>\n }\n primary: string\n secondary: string\n}\n```\n\n### `ShapeData`\n\n```ts\ntype ShapeData = {\n border_radius?: number\n}\n```\n\n### `FontData`\n\n```ts\ntype FontData = {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n }>\n}\n```\n\n### `FontResponseUrl`\n\n```ts\ntype FontResponseUrl = {\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n}\n```\n\n### `WidgetPortalData`\n\n```ts\ntype WidgetPortalData = {\n id: string\n name: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n error?: object\n}\n```\n\n### `FileData`\n\n```ts\ntype FileData = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n}\n```\n\n### `DesignId`\n\nId of the design\n\n```ts\ntype DesignId = string\n```\n\n### `Theme`\n\nType of theme to be parsed and returned\n\n```ts\ntype Theme = "NEW" | "OLD"\n```\n\n### `Application`\n\nType of application that uses the design\n\n```ts\ntype Application = string\n```\n\n### `DesignParameters`\n\n```ts\ntype DesignParameters = {\n designId?: string\n theme?: "NEW" | "OLD"\n application?: string\n}\n```\n';
5
- export {
6
- design_default as default
7
- };
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/design.json
4
- var design_default = '# Design Builder API v2\n\n- **Base URL:** `https://design-builder-api.{environment}.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.design.getAllDesigns(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/design\'\n\nconst designClient = getClient()\nauthorize(designClient, () => \'<token>\')\nconst { data } = await designClient.getAllDesigns(...)\n```\n\n## Operations\n\n**design-builder**\n- [`getAllDesigns`](#getalldesigns)\n- [`addDesign`](#adddesign)\n- [`getDesign`](#getdesign)\n- [`deleteDesign`](#deletedesign)\n- [`updateDesign`](#updatedesign)\n- [`getThemeFromDesign`](#getthemefromdesign)\n- [`uploadFile`](#uploadfile)\n- [`getFiles`](#getfiles)\n- [`getConsumerDesign`](#getconsumerdesign)\n- [`addConsumer`](#addconsumer)\n- [`removeConsumer`](#removeconsumer)\n\n**Schemas**\n- [`UploadFileReq`](#uploadfilereq)\n- [`UploadFileRes`](#uploadfileres)\n- [`GetFilesRes`](#getfilesres)\n- [`GetAllDesignsRes`](#getalldesignsres)\n- [`GetBrandsRes`](#getbrandsres)\n- [`AddDesignReq`](#adddesignreq)\n- [`AddDesignRes`](#adddesignres)\n- [`GetDesignRes`](#getdesignres)\n- [`UpdateDesignReq`](#updatedesignreq)\n- [`ItemMetada`](#itemmetada)\n- [`AddConsumerReq`](#addconsumerreq)\n- [`RemoveConsumerReq`](#removeconsumerreq)\n- [`DesignItem`](#designitem)\n- [`BrandItem`](#branditem)\n- [`Custom_Style`](#custom_style)\n- [`Journey`](#journey)\n- [`ConsumerData`](#consumerdata)\n- [`WidgetData`](#widgetdata)\n- [`CustomerPortalData`](#customerportaldata)\n- [`LogoData`](#logodata)\n- [`PaletteData`](#palettedata)\n- [`TypographyData`](#typographydata)\n- [`ShapeData`](#shapedata)\n- [`FontData`](#fontdata)\n- [`FontResponseUrl`](#fontresponseurl)\n- [`WidgetPortalData`](#widgetportaldata)\n- [`ErrorResp`](#errorresp)\n- [`FileData`](#filedata)\n- [`DesignId`](#designid)\n- [`Theme`](#theme)\n- [`Application`](#application)\n- [`DesignParameters`](#designparameters)\n\n### `getAllDesigns`\n\nScan all designs linked to a organization, based in orgId attribute from JWT auth token\n\n`GET /v1/designs`\n\n```ts\nconst { data } = await client.getAllDesigns()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "designs": [\n {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {},\n "style_name": "string",\n "style": {},\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `addDesign`\n\nCreate a brand new design linked to a organization, based in orgId attribute from JWT auth token\n\n`POST /v1/designs`\n\n```ts\nconst { data } = await client.addDesign(\n null,\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: { /* ... */ },\n palette: { /* ... */ },\n typography: { /* ... */ },\n shape: { /* ... */ },\n consumer: { /* ... */ }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\',\n accent_color: \'string\',\n outline_color: \'string\',\n divider_color: \'string\',\n link_color: \'string\',\n link_hover_color: \'string\',\n font_size_scale: \'xs\',\n topbar_height: 0,\n topbar_logo_alignment: \'flex-start\',\n logo_size: 0,\n input_background: \'string\',\n input_border_color: \'string\',\n input_text_color: \'string\',\n input_label_color: \'string\',\n input_border_radius: 0,\n input_height: 0,\n input_variant: \'outlined\',\n button_primary_bg: \'string\',\n button_primary_text: \'string\',\n button_primary_hover_bg: \'string\',\n button_primary_hover_text: \'string\',\n button_outlined_border: \'string\',\n button_outlined_text: \'string\',\n button_outlined_hover_bg: \'string\',\n button_outlined_hover_text: \'string\',\n button_ghost_bg: \'string\',\n button_ghost_text: \'string\',\n button_ghost_hover_bg: \'string\',\n button_ghost_hover_text: \'string\',\n button_border_radius: 0,\n button_height: 0,\n card_background: \'string\',\n card_border_color: \'string\',\n card_variant: \'shadow\',\n summary_card_background: \'string\',\n toggle_selected_bg: \'string\',\n toggle_selected_text: \'string\',\n toggle_hover_bg: \'string\',\n toggle_hover_text: \'string\',\n toggle_border_color: \'string\',\n dropdown_hover_bg: \'string\',\n dropdown_hover_text: \'string\',\n dropdown_selected_bg: \'string\',\n dropdown_selected_text: \'string\',\n switch_unchecked_color: \'string\',\n switch_unchecked_bg: \'string\',\n switch_border_radius: 0,\n checkbox_unchecked_color: \'string\',\n checkbox_label_color: \'string\',\n radio_unchecked_color: \'string\',\n radio_label_color: \'string\',\n datepicker_selected_bg: \'string\',\n datepicker_selected_color: \'string\',\n datepicker_border_radius: 0,\n chip_background: \'string\',\n chip_hover_background: \'string\',\n chip_text_color: \'string\',\n chip_hover_text_color: \'string\'\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {},\n "palette": {},\n "typography": {},\n "shape": {},\n "consumer": {}\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string",\n "accent_color": "string",\n "outline_color": "string",\n "divider_color": "string",\n "link_color": "string",\n "link_hover_color": "string",\n "font_size_scale": "xs",\n "topbar_height": 0,\n "topbar_logo_alignment": "flex-start",\n "logo_size": 0,\n "input_background": "string",\n "input_border_color": "string",\n "input_text_color": "string",\n "input_label_color": "string",\n "input_border_radius": 0,\n "input_height": 0,\n "input_variant": "outlined",\n "button_primary_bg": "string",\n "button_primary_text": "string",\n "button_primary_hover_bg": "string",\n "button_primary_hover_text": "string",\n "button_outlined_border": "string",\n "button_outlined_text": "string",\n "button_outlined_hover_bg": "string",\n "button_outlined_hover_text": "string",\n "button_ghost_bg": "string",\n "button_ghost_text": "string",\n "button_ghost_hover_bg": "string",\n "button_ghost_hover_text": "string",\n "button_border_radius": 0,\n "button_height": 0,\n "card_background": "string",\n "card_border_color": "string",\n "card_variant": "shadow",\n "summary_card_background": "string",\n "toggle_selected_bg": "string",\n "toggle_selected_text": "string",\n "toggle_hover_bg": "string",\n "toggle_hover_text": "string",\n "toggle_border_color": "string",\n "dropdown_hover_bg": "string",\n "dropdown_hover_text": "string",\n "dropdown_selected_bg": "string",\n "dropdown_selected_text": "string",\n "switch_unchecked_color": "string",\n "switch_unchecked_bg": "string",\n "switch_border_radius": 0,\n "checkbox_unchecked_color": "string",\n "checkbox_label_color": "string",\n "radio_unchecked_color": "string",\n "radio_label_color": "string",\n "datepicker_selected_bg": "string",\n "datepicker_selected_color": "string",\n "datepicker_border_radius": 0,\n "chip_background": "string",\n "chip_hover_background": "string",\n "chip_text_color": "string",\n "chip_hover_text_color": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.getDesign({\n designId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {},\n "palette": {},\n "typography": {},\n "shape": {},\n "consumer": {}\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string",\n "accent_color": "string",\n "outline_color": "string",\n "divider_color": "string",\n "link_color": "string",\n "link_hover_color": "string",\n "font_size_scale": "xs",\n "topbar_height": 0,\n "topbar_logo_alignment": "flex-start",\n "logo_size": 0,\n "input_background": "string",\n "input_border_color": "string",\n "input_text_color": "string",\n "input_label_color": "string",\n "input_border_radius": 0,\n "input_height": 0,\n "input_variant": "outlined",\n "button_primary_bg": "string",\n "button_primary_text": "string",\n "button_primary_hover_bg": "string",\n "button_primary_hover_text": "string",\n "button_outlined_border": "string",\n "button_outlined_text": "string",\n "button_outlined_hover_bg": "string",\n "button_outlined_hover_text": "string",\n "button_ghost_bg": "string",\n "button_ghost_text": "string",\n "button_ghost_hover_bg": "string",\n "button_ghost_hover_text": "string",\n "button_border_radius": 0,\n "button_height": 0,\n "card_background": "string",\n "card_border_color": "string",\n "card_variant": "shadow",\n "summary_card_background": "string",\n "toggle_selected_bg": "string",\n "toggle_selected_text": "string",\n "toggle_hover_bg": "string",\n "toggle_hover_text": "string",\n "toggle_border_color": "string",\n "dropdown_hover_bg": "string",\n "dropdown_hover_text": "string",\n "dropdown_selected_bg": "string",\n "dropdown_selected_text": "string",\n "switch_unchecked_color": "string",\n "switch_unchecked_bg": "string",\n "switch_border_radius": 0,\n "checkbox_unchecked_color": "string",\n "checkbox_label_color": "string",\n "radio_unchecked_color": "string",\n "radio_label_color": "string",\n "datepicker_selected_bg": "string",\n "datepicker_selected_color": "string",\n "datepicker_border_radius": 0,\n "chip_background": "string",\n "chip_hover_background": "string",\n "chip_text_color": "string",\n "chip_hover_text_color": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteDesign`\n\nSearch and delete for a especific design owned by user organization\n\n`DELETE /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.deleteDesign({\n designId: \'example\',\n})\n```\n\n---\n\n### `updateDesign`\n\nUpdate a especific design owned by user organization\n\n`PUT /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.updateDesign(\n {\n designId: \'example\',\n },\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: { /* ... */ },\n palette: { /* ... */ },\n typography: { /* ... */ },\n shape: { /* ... */ },\n consumer: { /* ... */ }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\',\n accent_color: \'string\',\n outline_color: \'string\',\n divider_color: \'string\',\n link_color: \'string\',\n link_hover_color: \'string\',\n font_size_scale: \'xs\',\n topbar_height: 0,\n topbar_logo_alignment: \'flex-start\',\n logo_size: 0,\n input_background: \'string\',\n input_border_color: \'string\',\n input_text_color: \'string\',\n input_label_color: \'string\',\n input_border_radius: 0,\n input_height: 0,\n input_variant: \'outlined\',\n button_primary_bg: \'string\',\n button_primary_text: \'string\',\n button_primary_hover_bg: \'string\',\n button_primary_hover_text: \'string\',\n button_outlined_border: \'string\',\n button_outlined_text: \'string\',\n button_outlined_hover_bg: \'string\',\n button_outlined_hover_text: \'string\',\n button_ghost_bg: \'string\',\n button_ghost_text: \'string\',\n button_ghost_hover_bg: \'string\',\n button_ghost_hover_text: \'string\',\n button_border_radius: 0,\n button_height: 0,\n card_background: \'string\',\n card_border_color: \'string\',\n card_variant: \'shadow\',\n summary_card_background: \'string\',\n toggle_selected_bg: \'string\',\n toggle_selected_text: \'string\',\n toggle_hover_bg: \'string\',\n toggle_hover_text: \'string\',\n toggle_border_color: \'string\',\n dropdown_hover_bg: \'string\',\n dropdown_hover_text: \'string\',\n dropdown_selected_bg: \'string\',\n dropdown_selected_text: \'string\',\n switch_unchecked_color: \'string\',\n switch_unchecked_bg: \'string\',\n switch_border_radius: 0,\n checkbox_unchecked_color: \'string\',\n checkbox_label_color: \'string\',\n radio_unchecked_color: \'string\',\n radio_label_color: \'string\',\n datepicker_selected_bg: \'string\',\n datepicker_selected_color: \'string\',\n datepicker_border_radius: 0,\n chip_background: \'string\',\n chip_hover_background: \'string\',\n chip_text_color: \'string\',\n chip_hover_text_color: \'string\'\n }\n }\n },\n)\n```\n\n---\n\n### `getThemeFromDesign`\n\nSearch for a especific design owned by user organization and parse them to a new or old theme\n\n`GET /v1/designs/{designId}/parse`\n\n```ts\nconst { data } = await client.getThemeFromDesign({\n designId: \'example\',\n orgId: \'example\',\n theme: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `uploadFile`\n\nUpload a new file for the user organization bucket\n\n`POST /v1/designs/files`\n\n```ts\nconst { data } = await client.uploadFile()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n}\n```\n\n</details>\n\n---\n\n### `getFiles`\n\nList all files for the user organization bucket\n\n`GET /v1/designs/files`\n\n```ts\nconst { data } = await client.getFiles({\n type: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConsumerDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/consumer/{application}/{consumerId}`\n\n```ts\nconst { data } = await client.getConsumerDesign({\n consumerId: \'example\',\n application: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {},\n "palette": {},\n "typography": {},\n "shape": {},\n "consumer": {}\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string",\n "accent_color": "string",\n "outline_color": "string",\n "divider_color": "string",\n "link_color": "string",\n "link_hover_color": "string",\n "font_size_scale": "xs",\n "topbar_height": 0,\n "topbar_logo_alignment": "flex-start",\n "logo_size": 0,\n "input_background": "string",\n "input_border_color": "string",\n "input_text_color": "string",\n "input_label_color": "string",\n "input_border_radius": 0,\n "input_height": 0,\n "input_variant": "outlined",\n "button_primary_bg": "string",\n "button_primary_text": "string",\n "button_primary_hover_bg": "string",\n "button_primary_hover_text": "string",\n "button_outlined_border": "string",\n "button_outlined_text": "string",\n "button_outlined_hover_bg": "string",\n "button_outlined_hover_text": "string",\n "button_ghost_bg": "string",\n "button_ghost_text": "string",\n "button_ghost_hover_bg": "string",\n "button_ghost_hover_text": "string",\n "button_border_radius": 0,\n "button_height": 0,\n "card_background": "string",\n "card_border_color": "string",\n "card_variant": "shadow",\n "summary_card_background": "string",\n "toggle_selected_bg": "string",\n "toggle_selected_text": "string",\n "toggle_hover_bg": "string",\n "toggle_hover_text": "string",\n "toggle_border_color": "string",\n "dropdown_hover_bg": "string",\n "dropdown_hover_text": "string",\n "dropdown_selected_bg": "string",\n "dropdown_selected_text": "string",\n "switch_unchecked_color": "string",\n "switch_unchecked_bg": "string",\n "switch_border_radius": 0,\n "checkbox_unchecked_color": "string",\n "checkbox_label_color": "string",\n "radio_unchecked_color": "string",\n "radio_label_color": "string",\n "datepicker_selected_bg": "string",\n "datepicker_selected_color": "string",\n "datepicker_border_radius": 0,\n "chip_background": "string",\n "chip_hover_background": "string",\n "chip_text_color": "string",\n "chip_hover_text_color": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `addConsumer`\n\nAdd a consumer that uses a specific design\n\n`PUT /v1/designs/addConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.addConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n consumer_name: \'string\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n### `removeConsumer`\n\nRemove a consumer that uses a specific design\n\n`PUT /v1/designs/removeConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.removeConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n## Schemas\n\n### `UploadFileReq`\n\n```ts\ntype UploadFileReq = {\n file_type: "LOGO" | "FONT" | "IMAGE"\n file_data: string // base64\n display_name?: string\n file_name: string\n}\n```\n\n### `UploadFileRes`\n\n```ts\ntype UploadFileRes = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n}\n```\n\n### `GetFilesRes`\n\n```ts\ntype GetFilesRes = Array<{\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n}>\n```\n\n### `GetAllDesignsRes`\n\n```ts\ntype GetAllDesignsRes = {\n designs?: Array<{\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }>\n}\n```\n\n### `GetBrandsRes`\n\n```ts\ntype GetBrandsRes = {\n brands?: Array<{\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n }>\n}\n```\n\n### `AddDesignReq`\n\n```ts\ntype AddDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `AddDesignRes`\n\n```ts\ntype AddDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `GetDesignRes`\n\n```ts\ntype GetDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `UpdateDesignReq`\n\n```ts\ntype UpdateDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n accent_color?: { ... }\n outline_color?: { ... }\n divider_color?: { ... }\n link_color?: { ... }\n link_hover_color?: { ... }\n font_size_scale?: { ... }\n topbar_height?: { ... }\n topbar_logo_alignment?: { ... }\n logo_size?: { ... }\n input_background?: { ... }\n input_border_color?: { ... }\n input_text_color?: { ... }\n input_label_color?: { ... }\n input_border_radius?: { ... }\n input_height?: { ... }\n input_variant?: { ... }\n button_primary_bg?: { ... }\n button_primary_text?: { ... }\n button_primary_hover_bg?: { ... }\n button_primary_hover_text?: { ... }\n button_outlined_border?: { ... }\n button_outlined_text?: { ... }\n button_outlined_hover_bg?: { ... }\n button_outlined_hover_text?: { ... }\n button_ghost_bg?: { ... }\n button_ghost_text?: { ... }\n button_ghost_hover_bg?: { ... }\n button_ghost_hover_text?: { ... }\n button_border_radius?: { ... }\n button_height?: { ... }\n card_background?: { ... }\n card_border_color?: { ... }\n card_variant?: { ... }\n summary_card_background?: { ... }\n toggle_selected_bg?: { ... }\n toggle_selected_text?: { ... }\n toggle_hover_bg?: { ... }\n toggle_hover_text?: { ... }\n toggle_border_color?: { ... }\n dropdown_hover_bg?: { ... }\n dropdown_hover_text?: { ... }\n dropdown_selected_bg?: { ... }\n dropdown_selected_text?: { ... }\n switch_unchecked_color?: { ... }\n switch_unchecked_bg?: { ... }\n switch_border_radius?: { ... }\n checkbox_unchecked_color?: { ... }\n checkbox_label_color?: { ... }\n radio_unchecked_color?: { ... }\n radio_label_color?: { ... }\n datepicker_selected_bg?: { ... }\n datepicker_selected_color?: { ... }\n datepicker_border_radius?: { ... }\n chip_background?: { ... }\n chip_hover_background?: { ... }\n chip_text_color?: { ... }\n chip_hover_text_color?: { ... }\n }\n }\n}\n```\n\n### `ItemMetada`\n\n```ts\ntype ItemMetada = {\n id?: string\n created_at?: string\n created_by?: string\n edited?: boolean\n last_modified_at?: string\n}\n```\n\n### `AddConsumerReq`\n\n```ts\ntype AddConsumerReq = {\n consumer_id: string\n consumer_name: string\n should_delete?: string\n}\n```\n\n### `RemoveConsumerReq`\n\n```ts\ntype RemoveConsumerReq = {\n consumer_id: string\n should_delete?: string\n}\n```\n\n### `DesignItem`\n\n```ts\ntype DesignItem = {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: string\n fullname?: string\n name?: string\n userid?: string\n }\n style_name: string\n style: {\n logo?: {\n main?: { ... }\n }\n palette: {\n primary: { ... }\n secondary: { ... }\n error: { ... }\n background: { ... }\n paper: { ... }\n navbar: { ... }\n portal_login_background?: { ... }\n }\n typography: {\n font: { ... }\n primary: { ... }\n secondary: { ... }\n }\n shape?: {\n border_radius?: { ... }\n }\n consumer: {\n widgets: { ... }\n customer_portals: { ... }\n }\n }\n is_default?: boolean\n _manifest?: string[]\n}\n```\n\n### `BrandItem`\n\n```ts\ntype BrandItem = {\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n}\n```\n\n### `Custom_Style`\n\n```ts\ntype Custom_Style = {\n custom_theme?: string\n use_custom_theme?: boolean\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n design_tokens?: {\n coupon?: string\n cashback?: string\n custom_css?: string\n accent_color?: string\n outline_color?: string\n divider_color?: string\n link_color?: string\n link_hover_color?: string\n font_size_scale?: "xs" | "sm" | "md" | "lg" | "xl"\n topbar_height?: number\n topbar_logo_alignment?: "flex-start" | "center" | "flex-end"\n logo_size?: number\n input_background?: string\n input_border_color?: string\n input_text_color?: string\n input_label_color?: string\n input_border_radius?: number\n input_height?: number\n input_variant?: "outlined" | "filled" | "underlined"\n button_primary_bg?: string\n button_primary_text?: string\n button_primary_hover_bg?: string\n button_primary_hover_text?: string\n button_outlined_border?: string\n button_outlined_text?: string\n button_outlined_hover_bg?: string\n button_outlined_hover_text?: string\n button_ghost_bg?: string\n button_ghost_text?: string\n button_ghost_hover_bg?: string\n button_ghost_hover_text?: string\n button_border_radius?: number\n button_height?: number\n card_background?: string\n card_border_color?: string\n card_variant?: "shadow" | "outlined"\n summary_card_background?: string\n toggle_selected_bg?: string\n toggle_selected_text?: string\n toggle_hover_bg?: string\n toggle_hover_text?: string\n toggle_border_color?: string\n dropdown_hover_bg?: string\n dropdown_hover_text?: string\n dropdown_selected_bg?: string\n dropdown_selected_text?: string\n switch_unchecked_color?: string\n switch_unchecked_bg?: string\n switch_border_radius?: number\n checkbox_unchecked_color?: string\n checkbox_label_color?: string\n radio_unchecked_color?: string\n radio_label_color?: string\n datepicker_selected_bg?: string\n datepicker_selected_color?: string\n datepicker_border_radius?: number\n chip_background?: string\n chip_hover_background?: string\n chip_text_color?: string\n chip_hover_text_color?: string\n }\n}\n```\n\n### `ConsumerData`\n\n```ts\ntype ConsumerData = {\n widgets: Array<{\n id: string\n name: string\n }>\n customer_portals: Array<{\n id: string\n name: string\n }>\n}\n```\n\n### `WidgetData`\n\n```ts\ntype WidgetData = {\n id: string\n name: string\n}\n```\n\n### `CustomerPortalData`\n\n```ts\ntype CustomerPortalData = {\n id: string\n name: string\n}\n```\n\n### `LogoData`\n\n```ts\ntype LogoData = {\n main?: {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n }\n}\n```\n\n### `PaletteData`\n\n```ts\ntype PaletteData = {\n primary: string\n secondary: string\n error: string\n background: string\n paper: string\n navbar: string\n portal_login_background?: string\n}\n```\n\n### `TypographyData`\n\n```ts\ntype TypographyData = {\n font: {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: { ... }\n url?: { ... }\n }>\n }\n primary: string\n secondary: string\n}\n```\n\n### `ShapeData`\n\n```ts\ntype ShapeData = {\n border_radius?: number\n}\n```\n\n### `FontData`\n\n```ts\ntype FontData = {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n }>\n}\n```\n\n### `FontResponseUrl`\n\n```ts\ntype FontResponseUrl = {\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n}\n```\n\n### `WidgetPortalData`\n\n```ts\ntype WidgetPortalData = {\n id: string\n name: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n error?: object\n}\n```\n\n### `FileData`\n\n```ts\ntype FileData = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT" | "IMAGE"\n s3_object_key: string\n url: string\n}\n```\n\n### `DesignId`\n\nId of the design\n\n```ts\ntype DesignId = string\n```\n\n### `Theme`\n\nType of theme to be parsed and returned\n\n```ts\ntype Theme = "NEW" | "OLD"\n```\n\n### `Application`\n\nType of application that uses the design\n\n```ts\ntype Application = string\n```\n\n### `DesignParameters`\n\n```ts\ntype DesignParameters = {\n designId?: string\n theme?: "NEW" | "OLD"\n application?: string\n}\n```\n';
5
-
6
-
7
- exports.default = design_default;
@@ -1,5 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
-
3
- var _chunkEIIIKDOJcjs = require('./chunk-EIIIKDOJ.cjs');
4
- require('./chunk-NJK5F5TF.cjs');
5
- exports. default = _chunkEIIIKDOJcjs.require_design_runtime.call(void 0, );
@@ -1,7 +0,0 @@
1
- import "./chunk-YPSWSI3M.js";
2
-
3
- // src/docs/journey.json
4
- var journey_default = '# Journey API\n\n- **Base URL:** `https://journey-config.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/journey](https://docs.epilot.io/api/journey)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.journey.getJourneysByOrgId(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/journey\'\n\nconst journeyClient = getClient()\nauthorize(journeyClient, () => \'<token>\')\nconst { data } = await journeyClient.getJourneysByOrgId(...)\n```\n\n## Operations\n\n**Journeys**\n- [`getJourneysByOrgId`](#getjourneysbyorgid)\n- [`getJourney`](#getjourney)\n- [`removeJourney`](#removejourney)\n- [`getJourneyProducts`](#getjourneyproducts)\n- [`createJourney`](#createjourney)\n- [`updateJourney`](#updatejourney)\n- [`patchUpdateJourney`](#patchupdatejourney)\n- [`searchJourneys`](#searchjourneys)\n- [`generateDocument`](#generatedocument)\n- [`getSettingsForJourney`](#getsettingsforjourney)\n- [`getButtonOptions`](#getbuttonoptions)\n\n**Journeys V2**\n- [`createJourneyV2`](#createjourneyv2)\n- [`updateJourneyV2`](#updatejourneyv2)\n- [`patchUpdateJourneyV2`](#patchupdatejourneyv2)\n- [`getJourneyV2`](#getjourneyv2)\n- [`removeJourneyV2`](#removejourneyv2)\n\n**Schemas**\n- [`GetJourneysResponse`](#getjourneysresponse)\n- [`JourneyResponse`](#journeyresponse)\n- [`JourneyProductsResponse`](#journeyproductsresponse)\n- [`PatchUpdateJourneyRequest`](#patchupdatejourneyrequest)\n- [`JourneyCreationRequest`](#journeycreationrequest)\n- [`JourneyCreationRequestV2`](#journeycreationrequestv2)\n- [`SearchJourneysQueryRequest`](#searchjourneysqueryrequest)\n- [`SearchJourneysResponse`](#searchjourneysresponse)\n- [`Journey`](#journey)\n- [`JourneyFeatureFlags`](#journeyfeatureflags)\n- [`JourneyAuditInfo`](#journeyauditinfo)\n- [`JourneyValidationResponse`](#journeyvalidationresponse)\n- [`JourneyValidationError`](#journeyvalidationerror)\n- [`S3Reference`](#s3reference)\n- [`TemplateSettings`](#templatesettings)\n- [`GenerateDocumentResponse`](#generatedocumentresponse)\n- [`GenerateDocumentRequest`](#generatedocumentrequest)\n- [`GetSettingsForJourney`](#getsettingsforjourney)\n- [`ButtonOption`](#buttonoption)\n- [`ValidationRuleRef`](#validationruleref)\n- [`RuleRef`](#ruleref)\n\n### `getJourneysByOrgId`\n\nGet all journeys by organization id\n\n`GET /v1/journey/organization/{id}`\n\n```ts\nconst { data } = await client.getJourneysByOrgId({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getJourney`\n\nGet journey by id. Private journeys requires valid private token to be passed\n\n`GET /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n source: \'example\',\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {\n "savingMode": "auto",\n "supportedVersion": 0\n },\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n}\n```\n\n</details>\n\n---\n\n### `removeJourney`\n\nRemove journey by id\n\n`DELETE /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getJourneyProducts`\n\nGet products available in the journey by id. requires public journey token to be passed.\n\n`GET /v1/journey/products/{id}`\n\n```ts\nconst { data } = await client.getJourneyProducts({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n source: \'example\',\n postal_code: \'example\',\n city: \'example\',\n street: \'example\',\n street_number: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "type": "string",\n "_schema": "string",\n "_title": "string",\n "name": "string",\n "_id": "string",\n "_org": "string",\n "code": "string",\n "description": "string",\n "feature": [\n {}\n ],\n "product_images": [\n {}\n ],\n "legal_footnote": "string",\n "product_downloads": [\n {}\n ],\n "price": {}\n }\n]\n```\n\n</details>\n\n---\n\n### `createJourney`\n\nCreate a Journey\n\n`POST /v1/journey/configuration`\n\n```ts\nconst { data } = await client.createJourney(\n {\n skipAutomation: \'example\',\n },\n {\n journeyId: \'string\',\n organizationId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n canary: true,\n designId: \'string\',\n templateId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n organizationSettings: {},\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n useAustrianLabels: true,\n enableDarkMode: true,\n accessMode: \'PUBLIC\',\n isPublished: true,\n status: \'string\',\n isActive: true,\n savingProgress: {\n savingMode: \'auto\',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n createdBy: \'string\',\n updatedBy: \'string\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {\n "savingMode": "auto",\n "supportedVersion": 0\n },\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n}\n```\n\n</details>\n\n---\n\n### `updateJourney`\n\nUpdate a Journey\n\n`PUT /v1/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourney(\n null,\n {\n journeyId: \'string\',\n organizationId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n canary: true,\n designId: \'string\',\n templateId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n organizationSettings: {},\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n useAustrianLabels: true,\n enableDarkMode: true,\n accessMode: \'PUBLIC\',\n isPublished: true,\n status: \'string\',\n isActive: true,\n savingProgress: {\n savingMode: \'auto\',\n supportedVersion: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n createdBy: \'string\',\n updatedBy: \'string\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n---\n\n### `patchUpdateJourney`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v1/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourney(\n null,\n {\n journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "createdJourney": {\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {}\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {}\n ],\n "logics": [\n {}\n ],\n "logicsV4": {},\n "contextSchema": [\n {}\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {},\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {},\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {}\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n }\n}\n```\n\n</details>\n\n---\n\n### `searchJourneys`\n\nSearch Journeys\n\n`POST /v1/journey/configuration/search`\n\n```ts\nconst { data } = await client.searchJourneys(\n null,\n {\n q: \'_tags:*Flex*\',\n from: 0,\n size: 25,\n sort: \'_created_at:desc\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "results": [\n {\n "_id": "e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8",\n "_schema": "journey",\n "_title": "Journey Entity Title",\n "_org": "739224",\n "_created_at": "2020-01-01T00:00:00.000Z",\n "_updated_at": "2020-01-01T00:00:00.000Z",\n "_tags": ["Flex"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "journey_name": "Journey Name",\n "journey_id": "de7df470-253e-11ed-9174-116b8a718c0a",\n "journey_type": "Sales template",\n "design": "Design EPILOT",\n "created_by": [\n {\n "id": "12345"\n }\n ],\n "journey_version": "Flex"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `generateDocument`\n\nBuilds document generated from a template with journey values."\n\n`POST /v1/journey/document:generate`\n\n```ts\nconst { data } = await client.generateDocument(\n null,\n {\n file_id: \'1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\',\n context_data: {\n additionalProperties: \'string\'\n },\n language: \'de\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "job_status": "STARTED",\n "message": "string",\n "pdf_output": {\n "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf",\n "output_document": {\n "s3ref": {\n "bucket": "document-api-preview-prod",\n "key": "preview/my-template.pdf"\n }\n }\n },\n "docx_output": {\n "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx",\n "output_document": {\n "s3ref": {\n "bucket": "document-api-preview-prod",\n "key": "preview/my-template.docx"\n }\n }\n },\n "variable_payload": {\n "additionalProperties": "string"\n },\n "template_settings": {\n "custom_margins": {\n "top": 2.54,\n "bottom": 2.54\n },\n "suggested_margins": {\n "top": 2.54,\n "bottom": 2.54\n },\n "display_margin_guidelines": true,\n "enable_data_table_margin_autofix": false,\n "template_with_datatable": false,\n "enabled_template_settings_persistence": false,\n "misconfigured_margins": false,\n "file_entity_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"\n }\n}\n```\n\n</details>\n\n---\n\n### `createJourneyV2`\n\nCreate a Journey\n\n`POST /v2/journey/configuration`\n\n```ts\nconst { data } = await client.createJourneyV2(\n {\n skipAutomation: \'example\',\n },\n {\n journeyId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: {\n text: \'string\',\n align: \'left\'\n }\n },\n safeModeAutomation: true,\n designId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n templateId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n thirdPartyCookies: true,\n accessMode: \'PUBLIC\',\n enableDarkMode: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `updateJourneyV2`\n\nUpdate a Journey\n\n`PUT /v2/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourneyV2(\n null,\n {\n journeyId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: {\n text: \'string\',\n align: \'left\'\n }\n },\n safeModeAutomation: true,\n designId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n templateId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n thirdPartyCookies: true,\n accessMode: \'PUBLIC\',\n enableDarkMode: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: {\n field1: \'rule456\',\n field2: \'rule789\'\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `patchUpdateJourneyV2`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v2/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourneyV2(\n null,\n {\n journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyV2`\n\nGet journey by id\n\n`GET /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourneyV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {\n "text": "string",\n "align": "left"\n }\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "enableDarkMode": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": {\n "field1": "rule456",\n "field2": "rule789"\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `removeJourneyV2`\n\nRemove journey by id\n\n`DELETE /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourneyV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getSettingsForJourney`\n\nGet settings related to the journey using journey ID.\n\n`GET /v1/journey/{id}/settings`\n\n```ts\nconst { data } = await client.getSettingsForJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "organizationId": "739224",\n "canary": true,\n "thirdPartyCookies": true\n}\n```\n\n</details>\n\n---\n\n### `getButtonOptions`\n\nGet button options from a csv file.\n\n`GET /v1/journey/button-options`\n\n```ts\nconst { data } = await client.getButtonOptions({\n fileId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "value": "Button Hidden Value",\n "label": "Button Label"\n }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `GetJourneysResponse`\n\n```ts\ntype GetJourneysResponse = object\n```\n\n### `JourneyResponse`\n\n```ts\ntype JourneyResponse = {\n createdJourney?: {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: { ... }\n title?: { ... }\n subTitle?: { ... }\n showStepSubtitle?: { ... }\n showStepper?: { ... }\n showStepperLabels?: { ... }\n hideNextButton?: { ... }\n name: { ... }\n stepId?: { ... }\n schema: { ... }\n uischema: { ... }\n maxWidth?: { ... }\n }>\n design?: {\n logoUrl?: { ... }\n theme?: { ... }\n designTokens?: { ... }\n }\n rules?: Array<{\n type: { ... }\n sourceType: { ... }\n source: { ... }\n target: { ... }\n }>\n logics?: Array<{\n autoGeneratedId?: { ... }\n conditions: { ... }\n actions: { ... }\n }>\n logicsV4?: Record<string, {\n id?: { ... }\n protected?: { ... }\n action?: { ... }\n triggeredOn?: { ... }\n conditions?: { ... }\n settings?: { ... }\n }>\n contextSchema?: Array<{\n id?: { ... }\n type: { ... }\n paramKey: { ... }\n isRequired?: { ... }\n shouldLoadEntity?: { ... }\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: { ... }\n safeModeAutomation?: { ... }\n canary?: { ... }\n designId: { ... }\n templateId?: { ... }\n entityId?: { ... }\n mappingsAutomationId?: { ... }\n targetedCustomer?: { ... }\n description?: { ... }\n organizationSettings?: { ... }\n publicToken?: { ... }\n runtimeEntities?: { ... }\n filePurposes?: { ... }\n entityTags?: { ... }\n addressSuggestionsFileUrl?: { ... }\n addressSuggestionsFileId?: { ... }\n addressSuggestionsCountryCode?: { ... }\n addressSuggestionsEnableAutoComplete?: { ... }\n addressSuggestionsSource?: { ... }\n addressSuggestionsEnableFreeText?: { ... }\n useNewDesign?: { ... }\n useAustrianLabels?: { ... }\n enableDarkMode?: { ... }\n accessMode?: { ... }\n isPublished?: { ... }\n status?: { ... }\n isActive?: { ... }\n savingProgress?: { ... }\n thirdPartyCookies?: { ... }\n }\n validationRules?: Record<string, string | Record<string, string>>\n _manifest?: string // uuid[]\n createdBy?: string\n updatedBy?: string\n __lastModifiedAt?: string\n createdAt: string\n lastModifiedAt: string\n deletedAt?: string\n version: number\n revisions: number\n featureFlags?: Record<string, unknown>\n }\n}\n```\n\n### `JourneyProductsResponse`\n\n```ts\ntype JourneyProductsResponse = Array<{\n type?: string\n _schema?: string\n _title?: string\n name?: string\n _id?: string\n _org?: string\n code?: string\n description?: string\n feature?: unknown[]\n product_images?: unknown[]\n legal_footnote?: string\n product_downloads?: unknown[]\n price?: object\n}>\n```\n\n### `PatchUpdateJourneyRequest`\n\nPatch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\n\n\n```ts\ntype PatchUpdateJourneyRequest = {\n journeyId: string // uuid\n __lastModifiedAt?: string\n}\n```\n\n### `JourneyCreationRequest`\n\n```ts\ntype JourneyCreationRequest = {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n canary?: boolean\n designId: string\n templateId?: string\n entityId?: string\n mappingsAutomationId?: string\n targetedCustomer?: string\n description?: string\n organizationSettings?: Record<string, boolean>\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n useAustrianLabels?: boolean\n enableDarkMode?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record<string, string | Record<string, string>>\n // ...\n}\n```\n\n### `JourneyCreationRequestV2`\n\n```ts\ntype JourneyCreationRequestV2 = {\n journeyId?: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n designId?: string\n entityId?: string\n mappingsAutomationId?: string\n templateId?: string\n targetedCustomer?: string\n description?: string\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n thirdPartyCookies?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n enableDarkMode?: boolean\n }\n validationRules?: Record<string, string | Record<string, string>>\n _manifest?: string // uuid[]\n}\n```\n\n### `SearchJourneysQueryRequest`\n\n```ts\ntype SearchJourneysQueryRequest = {\n q?: string\n from?: number\n size?: number\n sort?: string\n}\n```\n\n### `SearchJourneysResponse`\n\n```ts\ntype SearchJourneysResponse = {\n hits?: number\n results?: Array<{\n _id?: string // uuid\n _schema?: string\n _title?: string\n _org?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _tags?: string[]\n _manifest?: string // uuid[]\n journey_name?: string\n journey_id?: string // uuid\n journey_type?: string\n design?: string\n created_by?: Array<{\n id?: { ... }\n }>\n journey_version?: "Flex"\n }>\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n }>\n journey_type?: string\n protected?: boolean\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n canary?: boolean\n designId: string\n templateId?: string\n entityId?: string\n mappingsAutomationId?: string\n targetedCustomer?: string\n description?: string\n organizationSettings?: Record<string, boolean>\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n useAustrianLabels?: boolean\n enableDarkMode?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n isPublished?: boolean\n status?: string\n isActive?: boolean\n savingProgress?: {\n savingMode?: { ... }\n supportedVersion?: { ... }\n }\n thirdPartyCookies?: boolean\n }\n validationRules?: Record<string, string | Record<string, string>>\n // ...\n}\n```\n\n### `JourneyFeatureFlags`\n\n```ts\ntype JourneyFeatureFlags = {\n featureFlags?: Record<string, unknown>\n}\n```\n\n### `JourneyAuditInfo`\n\n```ts\ntype JourneyAuditInfo = {\n createdAt: string\n lastModifiedAt: string\n deletedAt?: string\n version: number\n revisions: number\n}\n```\n\n### `JourneyValidationResponse`\n\n```ts\ntype JourneyValidationResponse = {\n valid: boolean\n errors: Array<{\n type?: string\n severity?: "critical" | "high" | "medium" | "low"\n message?: string\n affectedStepIds?: string[]\n count?: number\n autoFix?: {\n feasible?: { ... }\n confidence?: { ... }\n reason?: { ... }\n details?: { ... }\n }\n }>\n warnings?: Array<{\n type?: string\n message?: string\n }>\n}\n```\n\n### `JourneyValidationError`\n\n```ts\ntype JourneyValidationError = {\n error: string\n message: string\n details: Array<{\n pattern?: string\n severity?: "critical" | "high" | "medium" | "low"\n message?: string\n count?: number\n }>\n}\n```\n\n### `S3Reference`\n\n```ts\ntype S3Reference = {\n bucket: string\n key: string\n}\n```\n\n### `TemplateSettings`\n\nTemplate Settings for document generation\n\n```ts\ntype TemplateSettings = {\n custom_margins?: {\n top?: number\n bottom?: number\n }\n suggested_margins?: {\n top?: number\n bottom?: number\n }\n display_margin_guidelines?: boolean\n enable_data_table_margin_autofix?: boolean\n template_with_datatable?: boolean\n enabled_template_settings_persistence?: boolean\n misconfigured_margins?: boolean\n file_entity_id?: string // uuid\n}\n```\n\n### `GenerateDocumentResponse`\n\n```ts\ntype GenerateDocumentResponse = {\n job_id?: string // uuid\n job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED"\n message?: string\n pdf_output?: {\n preview_url?: string\n output_document?: {\n filename?: { ... }\n s3ref?: { ... }\n }\n }\n docx_output?: {\n preview_url?: string\n output_document?: {\n filename?: { ... }\n s3ref?: { ... }\n }\n }\n variable_payload?: {\n additionalProperties?: string\n }\n template_settings?: {\n custom_margins?: {\n top?: { ... }\n bottom?: { ... }\n }\n suggested_margins?: {\n top?: { ... }\n bottom?: { ... }\n }\n display_margin_guidelines?: boolean\n enable_data_table_margin_autofix?: boolean\n template_with_datatable?: boolean\n enabled_template_settings_persistence?: boolean\n misconfigured_margins?: boolean\n file_entity_id?: string // uuid\n }\n}\n```\n\n### `GenerateDocumentRequest`\n\n```ts\ntype GenerateDocumentRequest = {\n file_id: string\n context_data: {\n additionalProperties?: string\n }\n language?: string\n}\n```\n\n### `GetSettingsForJourney`\n\n```ts\ntype GetSettingsForJourney = {\n organizationId?: string\n canary?: boolean\n thirdPartyCookies?: boolean\n}\n```\n\n### `ButtonOption`\n\nA single button option data\n\n```ts\ntype ButtonOption = {\n value?: string\n label?: string\n}\n```\n\n### `ValidationRuleRef`\n\nReferences to validation rules organized by blocks and fields.\nMaps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).\n\n\n```ts\ntype ValidationRuleRef = Record<string, string | Record<string, string>>\n```\n\n### `RuleRef`\n\nField-level rule references within a block.\nMaps field names to rule IDs.\n\n\n```ts\ntype RuleRef = Record<string, string>\n```\n';
5
- export {
6
- journey_default as default
7
- };