@epilot/sdk 2.8.0-rc.0 → 2.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +0 -1
  3. package/definitions/automation.json +120 -0
  4. package/definitions/blueprint-manifest-runtime.json +1 -1
  5. package/definitions/blueprint-manifest.json +744 -20
  6. package/definitions/customer-portal-runtime.json +1 -1
  7. package/definitions/customer-portal.json +317 -26
  8. package/definitions/design.json +51 -1
  9. package/definitions/event-catalog-runtime.json +1 -1
  10. package/definitions/event-catalog.json +168 -12
  11. package/definitions/file-runtime.json +1 -1
  12. package/definitions/file.json +152 -4
  13. package/definitions/integration-toolkit-runtime.json +1 -1
  14. package/definitions/integration-toolkit.json +782 -13
  15. package/definitions/notes-runtime.json +1 -1
  16. package/definitions/notes.json +123 -1
  17. package/definitions/pricing.json +224 -406
  18. package/definitions/targeting-runtime.json +1 -1
  19. package/definitions/targeting.json +257 -7
  20. package/definitions/webhooks.json +31 -0
  21. package/dist/README-46VYEGGW.js +7 -0
  22. package/dist/README-IVBISSWB.cjs +7 -0
  23. package/dist/{_index-YTOJUFGD.js → _index-5FB6F5YY.js} +0 -3
  24. package/dist/{_index-HTUXYSTD.cjs → _index-DB2VV4PQ.cjs} +1 -4
  25. package/dist/apis/access-token.cjs +6 -6
  26. package/dist/apis/access-token.js +1 -1
  27. package/dist/apis/address-suggestions.cjs +6 -6
  28. package/dist/apis/address-suggestions.js +1 -1
  29. package/dist/apis/address.cjs +6 -6
  30. package/dist/apis/address.js +1 -1
  31. package/dist/apis/ai-agents.cjs +6 -6
  32. package/dist/apis/ai-agents.js +1 -1
  33. package/dist/apis/app.cjs +6 -6
  34. package/dist/apis/app.js +1 -1
  35. package/dist/apis/audit-logs.cjs +6 -6
  36. package/dist/apis/audit-logs.js +1 -1
  37. package/dist/apis/automation.cjs +6 -6
  38. package/dist/apis/automation.d.cts +2 -2
  39. package/dist/apis/automation.d.ts +2 -2
  40. package/dist/apis/automation.js +1 -1
  41. package/dist/apis/billing.cjs +6 -6
  42. package/dist/apis/billing.js +1 -1
  43. package/dist/apis/blueprint-manifest.cjs +8 -8
  44. package/dist/apis/blueprint-manifest.d.cts +2 -2
  45. package/dist/apis/blueprint-manifest.d.ts +2 -2
  46. package/dist/apis/blueprint-manifest.js +2 -2
  47. package/dist/apis/calendar.cjs +6 -6
  48. package/dist/apis/calendar.js +1 -1
  49. package/dist/apis/configuration-hub.cjs +6 -6
  50. package/dist/apis/configuration-hub.js +1 -1
  51. package/dist/apis/consent.cjs +6 -6
  52. package/dist/apis/consent.js +1 -1
  53. package/dist/apis/customer-portal.cjs +8 -8
  54. package/dist/apis/customer-portal.d.cts +2 -2
  55. package/dist/apis/customer-portal.d.ts +2 -2
  56. package/dist/apis/customer-portal.js +2 -2
  57. package/dist/apis/dashboard.cjs +6 -6
  58. package/dist/apis/dashboard.js +1 -1
  59. package/dist/apis/data-governance.cjs +6 -6
  60. package/dist/apis/data-governance.js +1 -1
  61. package/dist/apis/deduplication.cjs +6 -6
  62. package/dist/apis/deduplication.js +1 -1
  63. package/dist/apis/design.cjs +6 -6
  64. package/dist/apis/design.d.cts +2 -2
  65. package/dist/apis/design.d.ts +2 -2
  66. package/dist/apis/design.js +1 -1
  67. package/dist/apis/document.cjs +6 -6
  68. package/dist/apis/document.js +1 -1
  69. package/dist/apis/email-settings.cjs +6 -6
  70. package/dist/apis/email-settings.js +1 -1
  71. package/dist/apis/email-template.cjs +6 -6
  72. package/dist/apis/email-template.js +1 -1
  73. package/dist/apis/entity-mapping.cjs +6 -6
  74. package/dist/apis/entity-mapping.js +1 -1
  75. package/dist/apis/entity.cjs +6 -6
  76. package/dist/apis/entity.js +1 -1
  77. package/dist/apis/environments.cjs +6 -6
  78. package/dist/apis/environments.js +1 -1
  79. package/dist/apis/event-catalog.cjs +8 -8
  80. package/dist/apis/event-catalog.d.cts +2 -2
  81. package/dist/apis/event-catalog.d.ts +2 -2
  82. package/dist/apis/event-catalog.js +2 -2
  83. package/dist/apis/file.cjs +8 -8
  84. package/dist/apis/file.d.cts +2 -2
  85. package/dist/apis/file.d.ts +2 -2
  86. package/dist/apis/file.js +2 -2
  87. package/dist/apis/iban.cjs +6 -6
  88. package/dist/apis/iban.js +1 -1
  89. package/dist/apis/integration-toolkit.cjs +8 -8
  90. package/dist/apis/integration-toolkit.d.cts +2 -2
  91. package/dist/apis/integration-toolkit.d.ts +2 -2
  92. package/dist/apis/integration-toolkit.js +2 -2
  93. package/dist/apis/journey.cjs +6 -6
  94. package/dist/apis/journey.js +1 -1
  95. package/dist/apis/kanban.cjs +6 -6
  96. package/dist/apis/kanban.js +1 -1
  97. package/dist/apis/message.cjs +6 -6
  98. package/dist/apis/message.js +1 -1
  99. package/dist/apis/metering.cjs +6 -6
  100. package/dist/apis/metering.js +1 -1
  101. package/dist/apis/notes.cjs +8 -8
  102. package/dist/apis/notes.d.cts +2 -2
  103. package/dist/apis/notes.d.ts +2 -2
  104. package/dist/apis/notes.js +2 -2
  105. package/dist/apis/notification.cjs +6 -6
  106. package/dist/apis/notification.js +1 -1
  107. package/dist/apis/organization.cjs +6 -6
  108. package/dist/apis/organization.js +1 -1
  109. package/dist/apis/partner-directory.cjs +6 -6
  110. package/dist/apis/partner-directory.js +1 -1
  111. package/dist/apis/permissions.cjs +6 -6
  112. package/dist/apis/permissions.js +1 -1
  113. package/dist/apis/pricing-tier.cjs +6 -6
  114. package/dist/apis/pricing-tier.js +1 -1
  115. package/dist/apis/pricing.cjs +6 -6
  116. package/dist/apis/pricing.d.cts +2 -2
  117. package/dist/apis/pricing.d.ts +2 -2
  118. package/dist/apis/pricing.js +1 -1
  119. package/dist/apis/purpose.cjs +6 -6
  120. package/dist/apis/purpose.js +1 -1
  121. package/dist/apis/query.cjs +6 -6
  122. package/dist/apis/query.js +1 -1
  123. package/dist/apis/sandbox.cjs +6 -6
  124. package/dist/apis/sandbox.js +1 -1
  125. package/dist/apis/sharing.cjs +6 -6
  126. package/dist/apis/sharing.js +1 -1
  127. package/dist/apis/submission.cjs +6 -6
  128. package/dist/apis/submission.js +1 -1
  129. package/dist/apis/target.cjs +6 -6
  130. package/dist/apis/target.js +1 -1
  131. package/dist/apis/targeting.cjs +8 -8
  132. package/dist/apis/targeting.d.cts +2 -2
  133. package/dist/apis/targeting.d.ts +2 -2
  134. package/dist/apis/targeting.js +2 -2
  135. package/dist/apis/template-variables.cjs +6 -6
  136. package/dist/apis/template-variables.js +1 -1
  137. package/dist/apis/user.cjs +6 -6
  138. package/dist/apis/user.js +1 -1
  139. package/dist/apis/validation-rules.cjs +6 -6
  140. package/dist/apis/validation-rules.js +1 -1
  141. package/dist/apis/webhooks.cjs +6 -6
  142. package/dist/apis/webhooks.d.cts +2 -2
  143. package/dist/apis/webhooks.d.ts +2 -2
  144. package/dist/apis/webhooks.js +1 -1
  145. package/dist/apis/workflow-definition.cjs +6 -6
  146. package/dist/apis/workflow-definition.js +1 -1
  147. package/dist/apis/workflow.cjs +6 -6
  148. package/dist/apis/workflow.js +1 -1
  149. package/dist/automation-S6NFS5KU.cjs +7 -0
  150. package/dist/automation-W75XZG7B.js +7 -0
  151. package/dist/{automation.d-Du6-uiz5.d.cts → automation.d-DS_YXDE8.d.cts} +300 -1
  152. package/dist/{automation.d-Du6-uiz5.d.ts → automation.d-DS_YXDE8.d.ts} +300 -1
  153. package/dist/blueprint-manifest-6DEYW5MW.js +7 -0
  154. package/dist/blueprint-manifest-GCV7H74X.cjs +7 -0
  155. package/dist/{blueprint-manifest-runtime-QN2IECSA.cjs → blueprint-manifest-runtime-EIDOROIQ.cjs} +2 -2
  156. package/dist/{blueprint-manifest-runtime-5UN52LW5.js → blueprint-manifest-runtime-FRLU3ZSF.js} +1 -1
  157. package/dist/{blueprint-manifest.d-BPyzoR0X.d.ts → blueprint-manifest.d-B8yDxagC.d.cts} +572 -6
  158. package/dist/{blueprint-manifest.d-BPyzoR0X.d.cts → blueprint-manifest.d-B8yDxagC.d.ts} +572 -6
  159. package/dist/chunk-4M5V6BIT.cjs +14 -0
  160. package/dist/chunk-4YBWMDFP.js +14 -0
  161. package/dist/{chunk-KJPOUJBU.cjs → chunk-5ZXGKLB6.cjs} +1 -1
  162. package/dist/{chunk-PTEJYAYJ.js → chunk-774ASAAH.js} +1 -1
  163. package/dist/{chunk-WM74R3BD.js → chunk-7V7ECXTZ.js} +1 -1
  164. package/dist/{chunk-54KWFSCM.js → chunk-ALMZO57K.js} +21 -23
  165. package/dist/chunk-FDS727SL.cjs +14 -0
  166. package/dist/{chunk-4FFGRWLS.cjs → chunk-I53TWOTX.cjs} +1 -1
  167. package/dist/chunk-LSPXLT3A.js +14 -0
  168. package/dist/chunk-M4FO2MI4.js +14 -0
  169. package/dist/chunk-MCK2QUSD.cjs +14 -0
  170. package/dist/chunk-NGHCQ2FA.cjs +14 -0
  171. package/dist/chunk-RDVFQOCQ.js +14 -0
  172. package/dist/{chunk-RW5JOHG7.js → chunk-WIQXF7DD.js} +1 -1
  173. package/dist/{chunk-F5Z6I7TF.cjs → chunk-WPBRWQPL.cjs} +21 -23
  174. package/dist/{chunk-M2SSGV7K.cjs → chunk-ZOQUGWQL.cjs} +1 -1
  175. package/dist/customer-portal-4DXHY42V.js +7 -0
  176. package/dist/customer-portal-5OSGSYGF.cjs +7 -0
  177. package/dist/{customer-portal-runtime-IYHJ3RME.cjs → customer-portal-runtime-HA6CPWB4.cjs} +2 -2
  178. package/dist/{customer-portal-runtime-ZYU3WIXY.js → customer-portal-runtime-TDHV2YVY.js} +1 -1
  179. package/dist/{customer-portal.d-CTTCBAZI.d.cts → customer-portal.d-BRwiQehb.d.cts} +763 -31
  180. package/dist/{customer-portal.d-CTTCBAZI.d.ts → customer-portal.d-BRwiQehb.d.ts} +763 -31
  181. package/dist/data-governance-2U5UU4GM.cjs +7 -0
  182. package/dist/data-governance-36Y33JVG.js +7 -0
  183. package/dist/design-DUFBH5ZB.js +7 -0
  184. package/dist/design-W3D3UPGB.cjs +7 -0
  185. package/dist/{design.d-BRre8iLg.d.ts → design.d-DzSDu8cy.d.cts} +41 -3
  186. package/dist/{design.d-BRre8iLg.d.cts → design.d-DzSDu8cy.d.ts} +41 -3
  187. package/dist/event-catalog-3YOQ46ZW.js +7 -0
  188. package/dist/event-catalog-HLWUT7RM.cjs +7 -0
  189. package/dist/{event-catalog-runtime-N262TQ3Y.js → event-catalog-runtime-JUSLF3UR.js} +1 -1
  190. package/dist/{event-catalog-runtime-B2BPKQVG.cjs → event-catalog-runtime-RH7542GL.cjs} +2 -2
  191. package/dist/{event-catalog.d-mQJLSYUo.d.ts → event-catalog.d-CXbUn8T1.d.cts} +199 -36
  192. package/dist/{event-catalog.d-mQJLSYUo.d.cts → event-catalog.d-CXbUn8T1.d.ts} +199 -36
  193. package/dist/file-2MSILSPP.cjs +7 -0
  194. package/dist/file-JVFTT5RZ.js +7 -0
  195. package/dist/file-runtime-7AWKNQU6.cjs +5 -0
  196. package/dist/{file-runtime-BIRMXYRH.js → file-runtime-DKGFS44O.js} +1 -1
  197. package/dist/{file.d-DTlrbI40.d.cts → file.d-BjlMgTwj.d.cts} +218 -5
  198. package/dist/{file.d-DTlrbI40.d.ts → file.d-BjlMgTwj.d.ts} +218 -5
  199. package/dist/index.cjs +27 -35
  200. package/dist/index.d.cts +56 -58
  201. package/dist/index.d.ts +56 -58
  202. package/dist/index.js +16 -24
  203. package/dist/integration-toolkit-27Z3VZBZ.cjs +7 -0
  204. package/dist/integration-toolkit-NRLZZFVS.js +7 -0
  205. package/dist/{integration-toolkit-runtime-YHTU4X5J.cjs → integration-toolkit-runtime-FY7QVFL6.cjs} +2 -2
  206. package/dist/{integration-toolkit-runtime-YR4CIMKH.js → integration-toolkit-runtime-HCJ5QLCR.js} +1 -1
  207. package/dist/{integration-toolkit.d-BstNqiJb.d.cts → integration-toolkit.d-BW9RK5G-.d.cts} +1672 -27
  208. package/dist/{integration-toolkit.d-BstNqiJb.d.ts → integration-toolkit.d-BW9RK5G-.d.ts} +1672 -27
  209. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  210. package/dist/notes-6JESMRLW.js +7 -0
  211. package/dist/notes-SLEUSNP4.cjs +7 -0
  212. package/dist/{notes-runtime-CVNAVKPP.js → notes-runtime-I4SWR3PZ.js} +1 -1
  213. package/dist/notes-runtime-YWTRRNH5.cjs +5 -0
  214. package/dist/{notes.d-BcV_m5fe.d.cts → notes.d-rbcyHfiB.d.cts} +101 -3
  215. package/dist/{notes.d-BcV_m5fe.d.ts → notes.d-rbcyHfiB.d.ts} +101 -3
  216. package/dist/pricing-5Y7TZHMR.js +7 -0
  217. package/dist/pricing-BJUABPHU.cjs +7 -0
  218. package/dist/{pricing.d-BHpMU4KU.d.cts → pricing.d-gPt5L7wp.d.cts} +151 -280
  219. package/dist/{pricing.d-BHpMU4KU.d.ts → pricing.d-gPt5L7wp.d.ts} +151 -280
  220. package/dist/targeting-DAFJBPIZ.cjs +7 -0
  221. package/dist/targeting-TGPCRRI6.js +7 -0
  222. package/dist/{targeting-runtime-M2VSTKFT.js → targeting-runtime-D5YUPZQM.js} +1 -1
  223. package/dist/{targeting-runtime-6JFMP262.cjs → targeting-runtime-MLMOM7CK.cjs} +2 -2
  224. package/dist/{targeting.d-BNmcVsNS.d.cts → targeting.d-DxHQbn7-.d.cts} +197 -3
  225. package/dist/{targeting.d-BNmcVsNS.d.ts → targeting.d-DxHQbn7-.d.ts} +197 -3
  226. package/dist/webhooks-6CUXSTPH.cjs +7 -0
  227. package/dist/webhooks-DTNKNJEN.js +7 -0
  228. package/dist/{webhooks.d-ByePoUWs.d.cts → webhooks.d-DKZOMj1P.d.cts} +37 -0
  229. package/dist/{webhooks.d-ByePoUWs.d.ts → webhooks.d-DKZOMj1P.d.ts} +37 -0
  230. package/docs/automation.md +180 -37
  231. package/docs/blueprint-manifest.md +728 -68
  232. package/docs/customer-portal.md +465 -56
  233. package/docs/data-governance.md +17 -17
  234. package/docs/design.md +80 -3
  235. package/docs/event-catalog.md +126 -13
  236. package/docs/file.md +113 -0
  237. package/docs/integration-toolkit.md +488 -19
  238. package/docs/notes.md +47 -1
  239. package/docs/pricing.md +290 -219
  240. package/docs/targeting.md +158 -4
  241. package/docs/webhooks.md +11 -2
  242. package/package.json +11 -21
  243. package/definitions/focus-pocus-runtime.json +0 -1
  244. package/definitions/focus-pocus.json +0 -757
  245. package/dist/README-37TXN4EL.cjs +0 -7
  246. package/dist/README-Z2WITBOR.js +0 -7
  247. package/dist/apis/focus-pocus.cjs +0 -38
  248. package/dist/apis/focus-pocus.d.cts +0 -18
  249. package/dist/apis/focus-pocus.d.ts +0 -18
  250. package/dist/apis/focus-pocus.js +0 -38
  251. package/dist/automation-BMO7ZFTN.cjs +0 -7
  252. package/dist/automation-MEZTSUR3.js +0 -7
  253. package/dist/blueprint-manifest-DBEY5PPI.js +0 -7
  254. package/dist/blueprint-manifest-IEQ6YBY7.cjs +0 -7
  255. package/dist/chunk-3APTSPY4.js +0 -14
  256. package/dist/chunk-5WNEYQII.cjs +0 -14
  257. package/dist/chunk-A6FYGWQ7.cjs +0 -14
  258. package/dist/chunk-BTTPWE2P.js +0 -14
  259. package/dist/chunk-CBDKPGO5.cjs +0 -14
  260. package/dist/chunk-L544VG3B.cjs +0 -14
  261. package/dist/chunk-O2YVXGPZ.js +0 -14
  262. package/dist/chunk-OCMIXJWC.js +0 -14
  263. package/dist/chunk-OPXGJKZR.cjs +0 -14
  264. package/dist/chunk-P42Q6HOW.js +0 -14
  265. package/dist/customer-portal-DR6XFCTQ.js +0 -7
  266. package/dist/customer-portal-PNFBVIAH.cjs +0 -7
  267. package/dist/data-governance-QYFHBCNB.cjs +0 -7
  268. package/dist/data-governance-YS2NA6W4.js +0 -7
  269. package/dist/design-EWZQZ5KX.js +0 -7
  270. package/dist/design-MUUYXB2J.cjs +0 -7
  271. package/dist/event-catalog-37B6JC7G.js +0 -7
  272. package/dist/event-catalog-5JBHJJ2I.cjs +0 -7
  273. package/dist/file-P2FUUER2.js +0 -7
  274. package/dist/file-XTY74SIX.cjs +0 -7
  275. package/dist/file-runtime-24S3QPA7.cjs +0 -5
  276. package/dist/focus-pocus-JGXH42OF.cjs +0 -7
  277. package/dist/focus-pocus-XVDVUYL6.js +0 -7
  278. package/dist/focus-pocus-runtime-QXBBYVX7.js +0 -5
  279. package/dist/focus-pocus-runtime-X6GQ3WI4.cjs +0 -5
  280. package/dist/focus-pocus.d-BRFGe53G.d.cts +0 -489
  281. package/dist/focus-pocus.d-BRFGe53G.d.ts +0 -489
  282. package/dist/integration-toolkit-3I3IPVFN.cjs +0 -7
  283. package/dist/integration-toolkit-XAFQXNQY.js +0 -7
  284. package/dist/notes-K2IIFCX3.cjs +0 -7
  285. package/dist/notes-Q7JGS7O3.js +0 -7
  286. package/dist/notes-runtime-E3YYF74V.cjs +0 -5
  287. package/dist/pricing-R5ENSVPQ.cjs +0 -7
  288. package/dist/pricing-X27CCRI6.js +0 -7
  289. package/dist/targeting-74BV7F7H.cjs +0 -7
  290. package/dist/targeting-W5EKJYR2.js +0 -7
  291. package/dist/webhooks-NZHJBT64.js +0 -7
  292. package/dist/webhooks-SK2STDKR.cjs +0 -7
  293. package/docs/focus-pocus.md +0 -460
@@ -0,0 +1,7 @@
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;
@@ -0,0 +1,7 @@
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
+ };
@@ -0,0 +1,7 @@
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.sls.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- [`ParseThemeFromDesignResp`](#parsethemefromdesignresp)\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 "theme": "NEW",\n "design": {\n "id": "string",\n "last_modified_at": "string",\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string",\n "file_id": "string"\n }\n },\n "palette": {\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 "typography": {\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": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n }\n },\n "custom_theme": "string",\n "use_custom_theme": true,\n "journey_design_tokens": {}\n }\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 "file_id": "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 "file_id": "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 file_id?: 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 file_id?: 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 file_id?: 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 file_id?: 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\n### `ParseThemeFromDesignResp`\n\n```ts\ntype ParseThemeFromDesignResp = {\n theme?: "NEW" | "OLD"\n design?: {\n id?: string\n last_modified_at?: string\n style_name?: string\n style?: {\n logo?: { ... }\n palette?: { ... }\n typography?: { ... }\n }\n custom_theme?: string\n use_custom_theme?: boolean\n journey_design_tokens?: object\n }\n}\n```\n';
5
+ export {
6
+ design_default as default
7
+ };
@@ -0,0 +1,7 @@
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.sls.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- [`ParseThemeFromDesignResp`](#parsethemefromdesignresp)\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 "theme": "NEW",\n "design": {\n "id": "string",\n "last_modified_at": "string",\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string",\n "file_id": "string"\n }\n },\n "palette": {\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 "typography": {\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": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n }\n },\n "custom_theme": "string",\n "use_custom_theme": true,\n "journey_design_tokens": {}\n }\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 "file_id": "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 "file_id": "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 file_id?: 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 file_id?: 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 file_id?: 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 file_id?: 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\n### `ParseThemeFromDesignResp`\n\n```ts\ntype ParseThemeFromDesignResp = {\n theme?: "NEW" | "OLD"\n design?: {\n id?: string\n last_modified_at?: string\n style_name?: string\n style?: {\n logo?: { ... }\n palette?: { ... }\n typography?: { ... }\n }\n custom_theme?: string\n use_custom_theme?: boolean\n journey_design_tokens?: object\n }\n}\n```\n';
5
+
6
+
7
+ exports.default = design_default;
@@ -641,6 +641,10 @@ declare namespace Components {
641
641
  file_type?: "LOGO" | "FONT" | "IMAGE";
642
642
  s3_object_key: string;
643
643
  url: string;
644
+ /**
645
+ * ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping.
646
+ */
647
+ file_id?: string;
644
648
  }
645
649
  export interface FontData {
646
650
  font_id: string;
@@ -1220,6 +1224,10 @@ declare namespace Components {
1220
1224
  file_type?: "LOGO" | "FONT" | "IMAGE";
1221
1225
  s3_object_key: string;
1222
1226
  url: string;
1227
+ /**
1228
+ * ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping.
1229
+ */
1230
+ file_id?: string;
1223
1231
  }[];
1224
1232
  export interface ItemMetada {
1225
1233
  id?: string;
@@ -1483,6 +1491,32 @@ declare namespace Components {
1483
1491
  navbar: string;
1484
1492
  portal_login_background?: string;
1485
1493
  }
1494
+ export interface ParseThemeFromDesignResp {
1495
+ theme?: /**
1496
+ * Type of theme to be parsed and returned
1497
+ * example:
1498
+ * NEW
1499
+ */
1500
+ Theme;
1501
+ design?: {
1502
+ id?: string;
1503
+ last_modified_at?: string;
1504
+ style_name?: string;
1505
+ style?: {
1506
+ logo?: LogoData;
1507
+ palette?: PaletteData;
1508
+ typography?: TypographyData;
1509
+ };
1510
+ custom_theme?: string;
1511
+ use_custom_theme?: boolean;
1512
+ /**
1513
+ * Design tokens for journey customization (renamed from design_tokens)
1514
+ */
1515
+ journey_design_tokens?: {
1516
+ [key: string]: any;
1517
+ };
1518
+ };
1519
+ }
1486
1520
  export interface RemoveConsumerReq {
1487
1521
  consumer_id: /**
1488
1522
  * Id of the design
@@ -1781,6 +1815,10 @@ declare namespace Components {
1781
1815
  file_type?: "LOGO" | "FONT" | "IMAGE";
1782
1816
  s3_object_key: string;
1783
1817
  url: string;
1818
+ /**
1819
+ * ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping.
1820
+ */
1821
+ file_id?: string;
1784
1822
  }
1785
1823
  export interface WidgetData {
1786
1824
  id: string;
@@ -1954,8 +1992,7 @@ declare namespace Paths {
1954
1992
  theme: Parameters.Theme;
1955
1993
  }
1956
1994
  namespace Responses {
1957
- export interface $200 {
1958
- }
1995
+ export type $200 = Components.Schemas.ParseThemeFromDesignResp;
1959
1996
  export type $400 = Components.Schemas.ErrorResp;
1960
1997
  export type $401 = Components.Schemas.ErrorResp;
1961
1998
  export interface $404 {
@@ -2333,6 +2370,7 @@ type ItemMetada = Components.Schemas.ItemMetada;
2333
2370
  type Journey = Components.Schemas.Journey;
2334
2371
  type LogoData = Components.Schemas.LogoData;
2335
2372
  type PaletteData = Components.Schemas.PaletteData;
2373
+ type ParseThemeFromDesignResp = Components.Schemas.ParseThemeFromDesignResp;
2336
2374
  type RemoveConsumerReq = Components.Schemas.RemoveConsumerReq;
2337
2375
  type ShapeData = Components.Schemas.ShapeData;
2338
2376
  type Theme = Components.Schemas.Theme;
@@ -2343,4 +2381,4 @@ type UploadFileRes = Components.Schemas.UploadFileRes;
2343
2381
  type WidgetData = Components.Schemas.WidgetData;
2344
2382
  type WidgetPortalData = Components.Schemas.WidgetPortalData;
2345
2383
 
2346
- export { type AddConsumerReq as A, type BrandItem as B, type Client as C, type DesignId as D, type ErrorResp as E, type FileData as F, type GetAllDesignsRes as G, type ItemMetada as I, type Journey as J, type LogoData as L, type OperationMethods as O, Paths as P, type RemoveConsumerReq as R, type ShapeData as S, type Theme as T, type UpdateDesignReq as U, type WidgetData as W, Components as a, type PathsDictionary as b, type AddDesignReq as c, type AddDesignRes as d, type Application as e, type ConsumerData as f, type Custom_Style as g, type CustomerPortalData as h, type DesignItem as i, type DesignParameters as j, type FontData as k, type FontResponseUrl as l, type GetBrandsRes as m, type GetDesignRes as n, type GetFilesRes as o, type PaletteData as p, type TypographyData as q, type UploadFileReq as r, type UploadFileRes as s, type WidgetPortalData as t };
2384
+ export { type AddConsumerReq as A, type BrandItem as B, type Client as C, type DesignId as D, type ErrorResp as E, type FileData as F, type GetAllDesignsRes as G, type ItemMetada as I, type Journey as J, type LogoData as L, type OperationMethods as O, Paths as P, type RemoveConsumerReq as R, type ShapeData as S, type Theme as T, type UpdateDesignReq as U, type WidgetData as W, Components as a, type PathsDictionary as b, type AddDesignReq as c, type AddDesignRes as d, type Application as e, type ConsumerData as f, type Custom_Style as g, type CustomerPortalData as h, type DesignItem as i, type DesignParameters as j, type FontData as k, type FontResponseUrl as l, type GetBrandsRes as m, type GetDesignRes as n, type GetFilesRes as o, type PaletteData as p, type ParseThemeFromDesignResp as q, type TypographyData as r, type UploadFileReq as s, type UploadFileRes as t, type WidgetPortalData as u };
@@ -641,6 +641,10 @@ declare namespace Components {
641
641
  file_type?: "LOGO" | "FONT" | "IMAGE";
642
642
  s3_object_key: string;
643
643
  url: string;
644
+ /**
645
+ * ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping.
646
+ */
647
+ file_id?: string;
644
648
  }
645
649
  export interface FontData {
646
650
  font_id: string;
@@ -1220,6 +1224,10 @@ declare namespace Components {
1220
1224
  file_type?: "LOGO" | "FONT" | "IMAGE";
1221
1225
  s3_object_key: string;
1222
1226
  url: string;
1227
+ /**
1228
+ * ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping.
1229
+ */
1230
+ file_id?: string;
1223
1231
  }[];
1224
1232
  export interface ItemMetada {
1225
1233
  id?: string;
@@ -1483,6 +1491,32 @@ declare namespace Components {
1483
1491
  navbar: string;
1484
1492
  portal_login_background?: string;
1485
1493
  }
1494
+ export interface ParseThemeFromDesignResp {
1495
+ theme?: /**
1496
+ * Type of theme to be parsed and returned
1497
+ * example:
1498
+ * NEW
1499
+ */
1500
+ Theme;
1501
+ design?: {
1502
+ id?: string;
1503
+ last_modified_at?: string;
1504
+ style_name?: string;
1505
+ style?: {
1506
+ logo?: LogoData;
1507
+ palette?: PaletteData;
1508
+ typography?: TypographyData;
1509
+ };
1510
+ custom_theme?: string;
1511
+ use_custom_theme?: boolean;
1512
+ /**
1513
+ * Design tokens for journey customization (renamed from design_tokens)
1514
+ */
1515
+ journey_design_tokens?: {
1516
+ [key: string]: any;
1517
+ };
1518
+ };
1519
+ }
1486
1520
  export interface RemoveConsumerReq {
1487
1521
  consumer_id: /**
1488
1522
  * Id of the design
@@ -1781,6 +1815,10 @@ declare namespace Components {
1781
1815
  file_type?: "LOGO" | "FONT" | "IMAGE";
1782
1816
  s3_object_key: string;
1783
1817
  url: string;
1818
+ /**
1819
+ * ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping.
1820
+ */
1821
+ file_id?: string;
1784
1822
  }
1785
1823
  export interface WidgetData {
1786
1824
  id: string;
@@ -1954,8 +1992,7 @@ declare namespace Paths {
1954
1992
  theme: Parameters.Theme;
1955
1993
  }
1956
1994
  namespace Responses {
1957
- export interface $200 {
1958
- }
1995
+ export type $200 = Components.Schemas.ParseThemeFromDesignResp;
1959
1996
  export type $400 = Components.Schemas.ErrorResp;
1960
1997
  export type $401 = Components.Schemas.ErrorResp;
1961
1998
  export interface $404 {
@@ -2333,6 +2370,7 @@ type ItemMetada = Components.Schemas.ItemMetada;
2333
2370
  type Journey = Components.Schemas.Journey;
2334
2371
  type LogoData = Components.Schemas.LogoData;
2335
2372
  type PaletteData = Components.Schemas.PaletteData;
2373
+ type ParseThemeFromDesignResp = Components.Schemas.ParseThemeFromDesignResp;
2336
2374
  type RemoveConsumerReq = Components.Schemas.RemoveConsumerReq;
2337
2375
  type ShapeData = Components.Schemas.ShapeData;
2338
2376
  type Theme = Components.Schemas.Theme;
@@ -2343,4 +2381,4 @@ type UploadFileRes = Components.Schemas.UploadFileRes;
2343
2381
  type WidgetData = Components.Schemas.WidgetData;
2344
2382
  type WidgetPortalData = Components.Schemas.WidgetPortalData;
2345
2383
 
2346
- export { type AddConsumerReq as A, type BrandItem as B, type Client as C, type DesignId as D, type ErrorResp as E, type FileData as F, type GetAllDesignsRes as G, type ItemMetada as I, type Journey as J, type LogoData as L, type OperationMethods as O, Paths as P, type RemoveConsumerReq as R, type ShapeData as S, type Theme as T, type UpdateDesignReq as U, type WidgetData as W, Components as a, type PathsDictionary as b, type AddDesignReq as c, type AddDesignRes as d, type Application as e, type ConsumerData as f, type Custom_Style as g, type CustomerPortalData as h, type DesignItem as i, type DesignParameters as j, type FontData as k, type FontResponseUrl as l, type GetBrandsRes as m, type GetDesignRes as n, type GetFilesRes as o, type PaletteData as p, type TypographyData as q, type UploadFileReq as r, type UploadFileRes as s, type WidgetPortalData as t };
2384
+ export { type AddConsumerReq as A, type BrandItem as B, type Client as C, type DesignId as D, type ErrorResp as E, type FileData as F, type GetAllDesignsRes as G, type ItemMetada as I, type Journey as J, type LogoData as L, type OperationMethods as O, Paths as P, type RemoveConsumerReq as R, type ShapeData as S, type Theme as T, type UpdateDesignReq as U, type WidgetData as W, Components as a, type PathsDictionary as b, type AddDesignReq as c, type AddDesignRes as d, type Application as e, type ConsumerData as f, type Custom_Style as g, type CustomerPortalData as h, type DesignItem as i, type DesignParameters as j, type FontData as k, type FontResponseUrl as l, type GetBrandsRes as m, type GetDesignRes as n, type GetFilesRes as o, type PaletteData as p, type ParseThemeFromDesignResp as q, type TypographyData as r, type UploadFileReq as s, type UploadFileRes as t, type WidgetPortalData as u };