@epilot/sdk 2.7.0 → 2.7.2

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 (247) hide show
  1. package/definitions/app.json +101 -8
  2. package/definitions/configuration-hub-runtime.json +1 -1
  3. package/definitions/configuration-hub.json +623 -0
  4. package/definitions/customer-portal-runtime.json +1 -1
  5. package/definitions/customer-portal.json +505 -6
  6. package/definitions/design-runtime.json +1 -1
  7. package/definitions/design.json +52 -12
  8. package/definitions/email-settings-runtime.json +1 -1
  9. package/definitions/email-settings.json +86 -4
  10. package/definitions/file-runtime.json +1 -1
  11. package/definitions/file.json +262 -4
  12. package/definitions/journey-runtime.json +1 -1
  13. package/definitions/journey.json +21 -1
  14. package/definitions/notes-runtime.json +1 -1
  15. package/definitions/notes.json +123 -1
  16. package/definitions/pricing.json +149 -404
  17. package/dist/apis/access-token.cjs +6 -6
  18. package/dist/apis/access-token.js +1 -1
  19. package/dist/apis/address-suggestions.cjs +6 -6
  20. package/dist/apis/address-suggestions.js +1 -1
  21. package/dist/apis/address.cjs +6 -6
  22. package/dist/apis/address.js +1 -1
  23. package/dist/apis/ai-agents.cjs +6 -6
  24. package/dist/apis/ai-agents.js +1 -1
  25. package/dist/apis/app.cjs +6 -6
  26. package/dist/apis/app.d.cts +2 -2
  27. package/dist/apis/app.d.ts +2 -2
  28. package/dist/apis/app.js +1 -1
  29. package/dist/apis/audit-logs.cjs +6 -6
  30. package/dist/apis/audit-logs.js +1 -1
  31. package/dist/apis/automation.cjs +6 -6
  32. package/dist/apis/automation.js +1 -1
  33. package/dist/apis/billing.cjs +6 -6
  34. package/dist/apis/billing.js +1 -1
  35. package/dist/apis/blueprint-manifest.cjs +6 -6
  36. package/dist/apis/blueprint-manifest.js +1 -1
  37. package/dist/apis/calendar.cjs +6 -6
  38. package/dist/apis/calendar.js +1 -1
  39. package/dist/apis/configuration-hub.cjs +8 -8
  40. package/dist/apis/configuration-hub.d.cts +2 -2
  41. package/dist/apis/configuration-hub.d.ts +2 -2
  42. package/dist/apis/configuration-hub.js +2 -2
  43. package/dist/apis/consent.cjs +6 -6
  44. package/dist/apis/consent.js +1 -1
  45. package/dist/apis/customer-portal.cjs +8 -8
  46. package/dist/apis/customer-portal.d.cts +2 -2
  47. package/dist/apis/customer-portal.d.ts +2 -2
  48. package/dist/apis/customer-portal.js +2 -2
  49. package/dist/apis/dashboard.cjs +6 -6
  50. package/dist/apis/dashboard.js +1 -1
  51. package/dist/apis/data-governance.cjs +6 -6
  52. package/dist/apis/data-governance.js +1 -1
  53. package/dist/apis/deduplication.cjs +6 -6
  54. package/dist/apis/deduplication.js +1 -1
  55. package/dist/apis/design.cjs +8 -8
  56. package/dist/apis/design.d.cts +2 -2
  57. package/dist/apis/design.d.ts +2 -2
  58. package/dist/apis/design.js +2 -2
  59. package/dist/apis/document.cjs +6 -6
  60. package/dist/apis/document.js +1 -1
  61. package/dist/apis/email-settings.cjs +8 -8
  62. package/dist/apis/email-settings.d.cts +2 -2
  63. package/dist/apis/email-settings.d.ts +2 -2
  64. package/dist/apis/email-settings.js +2 -2
  65. package/dist/apis/email-template.cjs +6 -6
  66. package/dist/apis/email-template.js +1 -1
  67. package/dist/apis/entity-mapping.cjs +6 -6
  68. package/dist/apis/entity-mapping.js +1 -1
  69. package/dist/apis/entity.cjs +6 -6
  70. package/dist/apis/entity.js +1 -1
  71. package/dist/apis/environments.cjs +6 -6
  72. package/dist/apis/environments.js +1 -1
  73. package/dist/apis/event-catalog.cjs +6 -6
  74. package/dist/apis/event-catalog.js +1 -1
  75. package/dist/apis/file.cjs +8 -8
  76. package/dist/apis/file.d.cts +2 -2
  77. package/dist/apis/file.d.ts +2 -2
  78. package/dist/apis/file.js +2 -2
  79. package/dist/apis/iban.cjs +6 -6
  80. package/dist/apis/iban.js +1 -1
  81. package/dist/apis/integration-toolkit.cjs +6 -6
  82. package/dist/apis/integration-toolkit.js +1 -1
  83. package/dist/apis/journey.cjs +8 -8
  84. package/dist/apis/journey.d.cts +2 -2
  85. package/dist/apis/journey.d.ts +2 -2
  86. package/dist/apis/journey.js +2 -2
  87. package/dist/apis/kanban.cjs +6 -6
  88. package/dist/apis/kanban.js +1 -1
  89. package/dist/apis/message.cjs +6 -6
  90. package/dist/apis/message.js +1 -1
  91. package/dist/apis/metering.cjs +6 -6
  92. package/dist/apis/metering.js +1 -1
  93. package/dist/apis/notes.cjs +8 -8
  94. package/dist/apis/notes.d.cts +2 -2
  95. package/dist/apis/notes.d.ts +2 -2
  96. package/dist/apis/notes.js +2 -2
  97. package/dist/apis/notification.cjs +6 -6
  98. package/dist/apis/notification.js +1 -1
  99. package/dist/apis/organization.cjs +6 -6
  100. package/dist/apis/organization.js +1 -1
  101. package/dist/apis/partner-directory.cjs +6 -6
  102. package/dist/apis/partner-directory.js +1 -1
  103. package/dist/apis/permissions.cjs +6 -6
  104. package/dist/apis/permissions.js +1 -1
  105. package/dist/apis/pricing-tier.cjs +6 -6
  106. package/dist/apis/pricing-tier.js +1 -1
  107. package/dist/apis/pricing.cjs +6 -6
  108. package/dist/apis/pricing.d.cts +2 -2
  109. package/dist/apis/pricing.d.ts +2 -2
  110. package/dist/apis/pricing.js +1 -1
  111. package/dist/apis/purpose.cjs +6 -6
  112. package/dist/apis/purpose.js +1 -1
  113. package/dist/apis/query.cjs +6 -6
  114. package/dist/apis/query.js +1 -1
  115. package/dist/apis/sandbox.cjs +6 -6
  116. package/dist/apis/sandbox.js +1 -1
  117. package/dist/apis/sharing.cjs +6 -6
  118. package/dist/apis/sharing.js +1 -1
  119. package/dist/apis/submission.cjs +6 -6
  120. package/dist/apis/submission.js +1 -1
  121. package/dist/apis/target.cjs +6 -6
  122. package/dist/apis/target.js +1 -1
  123. package/dist/apis/targeting.cjs +6 -6
  124. package/dist/apis/targeting.js +1 -1
  125. package/dist/apis/template-variables.cjs +6 -6
  126. package/dist/apis/template-variables.js +1 -1
  127. package/dist/apis/user.cjs +6 -6
  128. package/dist/apis/user.js +1 -1
  129. package/dist/apis/validation-rules.cjs +6 -6
  130. package/dist/apis/validation-rules.js +1 -1
  131. package/dist/apis/webhooks.cjs +6 -6
  132. package/dist/apis/webhooks.js +1 -1
  133. package/dist/apis/workflow-definition.cjs +6 -6
  134. package/dist/apis/workflow-definition.js +1 -1
  135. package/dist/apis/workflow.cjs +6 -6
  136. package/dist/apis/workflow.js +1 -1
  137. package/dist/{app-SSF545U7.cjs → app-74LECFMK.cjs} +1 -1
  138. package/dist/{app-34OBBTA4.js → app-GNUHCGPO.js} +1 -1
  139. package/dist/{app.d--5n0FQQ4.d.cts → app.d-BOR23dso.d.cts} +104 -4
  140. package/dist/{app.d--5n0FQQ4.d.ts → app.d-BOR23dso.d.ts} +104 -4
  141. package/dist/chunk-3APTSPY4.js +14 -0
  142. package/dist/{chunk-JB7LITSP.js → chunk-IVLR4CQF.js} +31 -22
  143. package/dist/chunk-JOUTFBLN.js +14 -0
  144. package/dist/chunk-KCPVNRDL.js +14 -0
  145. package/dist/chunk-KJPOUJBU.cjs +14 -0
  146. package/dist/chunk-LAWKCWVU.cjs +14 -0
  147. package/dist/{chunk-ZSONBZIF.cjs → chunk-MOLFG5L4.cjs} +1 -1
  148. package/dist/chunk-OPXGJKZR.cjs +14 -0
  149. package/dist/chunk-P4NA7NWG.js +14 -0
  150. package/dist/chunk-PTEJYAYJ.js +14 -0
  151. package/dist/{chunk-35CN2YFK.cjs → chunk-SOPJ42HW.cjs} +31 -22
  152. package/dist/chunk-WHXYES2D.cjs +14 -0
  153. package/dist/{chunk-RW5JOHG7.js → chunk-WIQXF7DD.js} +1 -1
  154. package/dist/{chunk-ONOGGR6Q.js → chunk-WW6DVKJR.js} +1 -1
  155. package/dist/chunk-YI5YGTAH.cjs +14 -0
  156. package/dist/{chunk-M2SSGV7K.cjs → chunk-ZOQUGWQL.cjs} +1 -1
  157. package/dist/configuration-hub-E7S4JB2T.js +7 -0
  158. package/dist/configuration-hub-Q5JBYB52.cjs +7 -0
  159. package/dist/{configuration-hub-runtime-L6IOERSP.js → configuration-hub-runtime-CXME7TCX.js} +1 -1
  160. package/dist/{configuration-hub-runtime-I5Y67CXD.cjs → configuration-hub-runtime-QVLJKEZD.cjs} +2 -2
  161. package/dist/configuration-hub.d-CbSJDa7k.d.cts +1096 -0
  162. package/dist/configuration-hub.d-CbSJDa7k.d.ts +1096 -0
  163. package/dist/customer-portal-IBM3K2EZ.cjs +7 -0
  164. package/dist/customer-portal-XPYKMIIA.js +7 -0
  165. package/dist/{customer-portal-runtime-OEXTSMSE.cjs → customer-portal-runtime-IYHJ3RME.cjs} +2 -2
  166. package/dist/{customer-portal-runtime-N4NWQ67M.js → customer-portal-runtime-ZYU3WIXY.js} +1 -1
  167. package/dist/{customer-portal.d-ChSEioI5.d.cts → customer-portal.d-CTTCBAZI.d.cts} +764 -14
  168. package/dist/{customer-portal.d-ChSEioI5.d.ts → customer-portal.d-CTTCBAZI.d.ts} +764 -14
  169. package/dist/design-DUFBH5ZB.js +7 -0
  170. package/dist/design-W3D3UPGB.cjs +7 -0
  171. package/dist/design-runtime-3RHYNHUV.cjs +5 -0
  172. package/dist/{design-runtime-QMJM4FAF.js → design-runtime-DLMA4EHQ.js} +1 -1
  173. package/dist/{design.d-BRre8iLg.d.cts → design.d-DzSDu8cy.d.cts} +41 -3
  174. package/dist/{design.d-BRre8iLg.d.ts → design.d-DzSDu8cy.d.ts} +41 -3
  175. package/dist/email-settings-YJ4X5VFU.cjs +7 -0
  176. package/dist/email-settings-YUK3DXFJ.js +7 -0
  177. package/dist/{email-settings-runtime-EGIJ2AVQ.js → email-settings-runtime-BXRZV4M5.js} +1 -1
  178. package/dist/{email-settings-runtime-WGVLI7N6.cjs → email-settings-runtime-FWJQBQBK.cjs} +2 -2
  179. package/dist/{email-settings.d-B7Q_xT25.d.cts → email-settings.d-UJ0C3jPI.d.cts} +108 -9
  180. package/dist/{email-settings.d-B7Q_xT25.d.ts → email-settings.d-UJ0C3jPI.d.ts} +108 -9
  181. package/dist/file-P2FUUER2.js +7 -0
  182. package/dist/file-XTY74SIX.cjs +7 -0
  183. package/dist/file-runtime-24S3QPA7.cjs +5 -0
  184. package/dist/{file-runtime-B6AAGZQF.js → file-runtime-BIRMXYRH.js} +1 -1
  185. package/dist/{file.d-DcTJxjp7.d.cts → file.d-DTlrbI40.d.cts} +2336 -19
  186. package/dist/{file.d-DcTJxjp7.d.ts → file.d-DTlrbI40.d.ts} +2336 -19
  187. package/dist/index.cjs +22 -22
  188. package/dist/index.d.cts +9 -9
  189. package/dist/index.d.ts +9 -9
  190. package/dist/index.js +8 -8
  191. package/dist/journey-4DIIPRU4.js +7 -0
  192. package/dist/journey-ATC3Y5AW.cjs +7 -0
  193. package/dist/{journey-runtime-SPBL3F32.cjs → journey-runtime-G2O5C3N2.cjs} +2 -2
  194. package/dist/{journey-runtime-YXIAOTMD.js → journey-runtime-RI2LJO5S.js} +1 -1
  195. package/dist/{journey.d-ClXO0xK8.d.cts → journey.d-BenIUWaO.d.cts} +9 -3
  196. package/dist/{journey.d-ClXO0xK8.d.ts → journey.d-BenIUWaO.d.ts} +9 -3
  197. package/dist/notes-6JESMRLW.js +7 -0
  198. package/dist/notes-SLEUSNP4.cjs +7 -0
  199. package/dist/{notes-runtime-CVNAVKPP.js → notes-runtime-I4SWR3PZ.js} +1 -1
  200. package/dist/notes-runtime-YWTRRNH5.cjs +5 -0
  201. package/dist/{notes.d-BcV_m5fe.d.cts → notes.d-rbcyHfiB.d.cts} +101 -3
  202. package/dist/{notes.d-BcV_m5fe.d.ts → notes.d-rbcyHfiB.d.ts} +101 -3
  203. package/dist/pricing-F7HQ6BWC.cjs +7 -0
  204. package/dist/pricing-YCD4EUGI.js +7 -0
  205. package/dist/{pricing.d-BHpMU4KU.d.cts → pricing.d-exMaGWm1.d.cts} +140 -280
  206. package/dist/{pricing.d-BHpMU4KU.d.ts → pricing.d-exMaGWm1.d.ts} +140 -280
  207. package/docs/app.md +34 -10
  208. package/docs/configuration-hub.md +660 -0
  209. package/docs/customer-portal.md +602 -174
  210. package/docs/design.md +81 -4
  211. package/docs/email-settings.md +67 -3
  212. package/docs/file.md +101 -2
  213. package/docs/journey.md +2 -0
  214. package/docs/notes.md +47 -1
  215. package/docs/pricing.md +269 -218
  216. package/package.json +1 -1
  217. package/dist/chunk-4W22EIRF.cjs +0 -14
  218. package/dist/chunk-5OBMZHRL.cjs +0 -14
  219. package/dist/chunk-E2WMGOM5.js +0 -14
  220. package/dist/chunk-EFWPEVXI.js +0 -14
  221. package/dist/chunk-EIIIKDOJ.cjs +0 -14
  222. package/dist/chunk-KEI3GHDY.cjs +0 -14
  223. package/dist/chunk-KIWRGUKM.js +0 -14
  224. package/dist/chunk-MB6NKETA.cjs +0 -14
  225. package/dist/chunk-VSZEOCIE.js +0 -14
  226. package/dist/chunk-Z6HGUGXK.js +0 -14
  227. package/dist/configuration-hub-A3S6ND6R.cjs +0 -7
  228. package/dist/configuration-hub-PMAW44U5.js +0 -7
  229. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  230. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  231. package/dist/customer-portal-5I7ZGQDU.cjs +0 -7
  232. package/dist/customer-portal-YL2YMPZL.js +0 -7
  233. package/dist/design-DROLIWS3.js +0 -7
  234. package/dist/design-XZKOZLTR.cjs +0 -7
  235. package/dist/design-runtime-OXEXKZVG.cjs +0 -5
  236. package/dist/email-settings-CKFJU4WZ.js +0 -7
  237. package/dist/email-settings-NQJJKS2P.cjs +0 -7
  238. package/dist/file-UOWBTDIU.cjs +0 -7
  239. package/dist/file-XSN3NAVZ.js +0 -7
  240. package/dist/file-runtime-SFZIKODF.cjs +0 -5
  241. package/dist/journey-KDR5EU3W.js +0 -7
  242. package/dist/journey-REBN4TGQ.cjs +0 -7
  243. package/dist/notes-K2IIFCX3.cjs +0 -7
  244. package/dist/notes-Q7JGS7O3.js +0 -7
  245. package/dist/notes-runtime-E3YYF74V.cjs +0 -5
  246. package/dist/pricing-FODHQFCB.cjs +0 -7
  247. package/dist/pricing-XRIDVZFC.js +0 -7
package/dist/design-DUFBH5ZB.js ADDED
@@ -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
+ };
package/dist/design-W3D3UPGB.cjs ADDED
@@ -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;
package/dist/design-runtime-3RHYNHUV.cjs ADDED
@@ -0,0 +1,5 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
+
3
+ var _chunkWHXYES2Dcjs = require('./chunk-WHXYES2D.cjs');
4
+ require('./chunk-NJK5F5TF.cjs');
5
+ exports. default = _chunkWHXYES2Dcjs.require_design_runtime.call(void 0, );
package/dist/{design-runtime-QMJM4FAF.js → design-runtime-DLMA4EHQ.js} RENAMED
@@ -1,5 +1,5 @@
1
1
  import {
2
2
  require_design_runtime
3
- } from "./chunk-KIWRGUKM.js";
3
+ } from "./chunk-P4NA7NWG.js";
4
4
  import "./chunk-YPSWSI3M.js";
5
5
  export default require_design_runtime();
package/dist/{design.d-BRre8iLg.d.cts → design.d-DzSDu8cy.d.cts} RENAMED
@@ -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 };
package/dist/{design.d-BRre8iLg.d.ts → design.d-DzSDu8cy.d.ts} RENAMED
@@ -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 };
package/dist/email-settings-YJ4X5VFU.cjs ADDED
@@ -0,0 +1,7 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
+
3
+ // src/docs/email-settings.json
4
+ var email_settings_default = '# Messaging Settings API\n\n- **Base URL:** `https://email-settings.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/email-settings](https://docs.epilot.io/api/email-settings)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.emailSettings.provisionEpilotEmailAddress(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/email-settings\'\n\nconst emailSettingsClient = getClient()\nauthorize(emailSettingsClient, () => \'<token>\')\nconst { data } = await emailSettingsClient.provisionEpilotEmailAddress(...)\n```\n\n## Operations\n\n**Email addresses**\n- [`provisionEpilotEmailAddress`](#provisionepilotemailaddress)\n- [`setEmailAddressPrimary`](#setemailaddressprimary)\n- [`getEmailAddress`](#getemailaddress)\n- [`deleteEmailAddress`](#deleteemailaddress)\n- [`updateEmailAddress`](#updateemailaddress)\n- [`listEmailAddresses`](#listemailaddresses)\n- [`addEmailAddress`](#addemailaddress)\n\n**Shared inboxes**\n- [`getSharedInbox`](#getsharedinbox)\n- [`deleteSharedInbox`](#deletesharedinbox)\n- [`updateSharedInbox`](#updatesharedinbox)\n- [`listSharedInboxes`](#listsharedinboxes)\n- [`addSharedInbox`](#addsharedinbox)\n\n**Inbox buckets**\n- [`listInboxBuckets`](#listinboxbuckets)\n\n**O365 Outlook Connection**\n- [`connectOutlook`](#connectoutlook)\n- [`getOutlookConnectionStatus`](#getoutlookconnectionstatus)\n- [`disconnectOutlook`](#disconnectoutlook)\n- [`connectOutlookMailbox`](#connectoutlookmailbox)\n- [`disconnectOutlookMailbox`](#disconnectoutlookmailbox)\n- [`startMailboxSync`](#startmailboxsync)\n- [`getMailboxSyncStatus`](#getmailboxsyncstatus)\n- [`retryMailboxSync`](#retrymailboxsync)\n- [`getConnectedOutlookEmails`](#getconnectedoutlookemails)\n- [`outlookOAuthCallback`](#outlookoauthcallback)\n\n**Channels**\n- [`connectMsTeams`](#connectmsteams)\n- [`disconnectMsTeams`](#disconnectmsteams)\n- [`getMsTeamsStatus`](#getmsteamsstatus)\n\n**Settings**\n- [`getSettings`](#getsettings)\n- [`addSetting`](#addsetting)\n- [`deleteSetting`](#deletesetting)\n- [`updateSetting`](#updatesetting)\n\n**Domains**\n- [`addDomain`](#adddomain)\n- [`deleteDomain`](#deletedomain)\n- [`getDomains`](#getdomains)\n- [`verifyNameServers`](#verifynameservers)\n- [`verifyDnsRecords`](#verifydnsrecords)\n- [`verifyDomain`](#verifydomain)\n\n**Schemas**\n- [`ConnectOutlookRequest`](#connectoutlookrequest)\n- [`MailboxSyncStatus`](#mailboxsyncstatus)\n- [`MailboxSyncStatuses`](#mailboxsyncstatuses)\n- [`MailboxSyncFolderStatuses`](#mailboxsyncfolderstatuses)\n- [`MailboxSyncTimeframePeriods`](#mailboxsynctimeframeperiods)\n- [`InboxBucketResponse`](#inboxbucketresponse)\n- [`ProvisionEpilotEmailAddressPayload`](#provisionepilotemailaddresspayload)\n- [`SetEmailAddressPrimaryPayload`](#setemailaddressprimarypayload)\n- [`UpdateEmailAddressPayload`](#updateemailaddresspayload)\n- [`CreateEmailAddressPayload`](#createemailaddresspayload)\n- [`EmailAddressResponse`](#emailaddressresponse)\n- [`ErrorResponse`](#errorresponse)\n- [`SettingMeta`](#settingmeta)\n- [`UpdateSharedInboxPayload`](#updatesharedinboxpayload)\n- [`CreateSharedInboxPayload`](#createsharedinboxpayload)\n- [`SharedInboxResponse`](#sharedinboxresponse)\n- [`SettingsResponse`](#settingsresponse)\n- [`ConnectedOutlookEmail`](#connectedoutlookemail)\n- [`OutlookConnectionError`](#outlookconnectionerror)\n- [`OutlookConnectionStatus`](#outlookconnectionstatus)\n- [`SignatureSetting`](#signaturesetting)\n- [`EmailDomainSetting`](#emaildomainsetting)\n- [`EmailAddressSetting`](#emailaddresssetting)\n- [`WhitelistEmailAddressSetting`](#whitelistemailaddresssetting)\n- [`RestrictDuplicatesWithinSetting`](#restrictduplicateswithinsetting)\n- [`SettingType`](#settingtype)\n- [`Setting`](#setting)\n- [`Domain`](#domain)\n\n### `provisionEpilotEmailAddress`\n\nProvisions or reactivates an epilot-managed email address for the organization.\n\n`PUT /v2/email-settings/email-addresses/epilot:provision`\n\n```ts\nconst { data } = await client.provisionEpilotEmailAddress(\n null,\n {\n address: \'mycompany@epilot.cloud\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `setEmailAddressPrimary`\n\nSets the specified email address as the primary address for the organization.\n\n`POST /v2/email-settings/email-addresses/primary`\n\n```ts\nconst { data } = await client.setEmailAddressPrimary(\n null,\n {\n address: \'sales@yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `getEmailAddress`\n\nRetrieves the details of a specific email address by its ID.\n\n`GET /v2/email-settings/email-addresses/{id}`\n\n```ts\nconst { data } = await client.getEmailAddress({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `deleteEmailAddress`\n\nPermanently deletes an email address from the organization.\n\n`DELETE /v2/email-settings/email-addresses/{id}`\n\n```ts\nconst { data } = await client.deleteEmailAddress({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `updateEmailAddress`\n\nUpdates the configuration of an existing email address.\n\n`PUT /v2/email-settings/email-addresses/{id}`\n\n```ts\nconst { data } = await client.updateEmailAddress(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n name: \'Sales Team\',\n user_ids: [\'user-123\', \'user-456\'],\n group_ids: [\'group-789\'],\n default_signature_id: \'sig-abc\',\n shared_inbox_id: \'inbox-xyz\',\n is_active: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `listEmailAddresses`\n\nRetrieves all email addresses configured for the organization.\n\n`GET /v2/email-settings/email-addresses`\n\n```ts\nconst { data } = await client.listEmailAddresses()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n }\n]\n```\n\n</details>\n\n---\n\n### `addEmailAddress`\n\nAdds a new email address to the organization.\n\n`POST /v2/email-settings/email-addresses`\n\n```ts\nconst { data } = await client.addEmailAddress(\n null,\n {\n address: \'support@yourcompany.com\',\n name: \'Customer Support\',\n user_ids: [\'user-123\'],\n group_ids: [\'group-456\'],\n default_signature_id: \'sig-789\',\n shared_inbox_id: \'inbox-abc\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `getSharedInbox`\n\nRetrieves the details of a specific shared inbox by its ID.\n\n`GET /v2/email-settings/shared-inboxes/{id}`\n\n```ts\nconst { data } = await client.getSharedInbox({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "name": "Customer Support",\n "color": "#4CAF50",\n "assignees": ["user-123", "user-456"],\n "description": "Incoming customer support requests",\n "bucket_id": "bucket-xyz"\n}\n```\n\n</details>\n\n---\n\n### `deleteSharedInbox`\n\nDeletes a shared inbox and reroutes all associated emails to a successor inbox.\n\n`DELETE /v2/email-settings/shared-inboxes/{id}`\n\n```ts\nconst { data } = await client.deleteSharedInbox({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n successorInboxId: \'example\',\n})\n```\n\n---\n\n### `updateSharedInbox`\n\nUpdates the configuration of an existing shared inbox.\n\n`PUT /v2/email-settings/shared-inboxes/{id}`\n\n```ts\nconst { data } = await client.updateSharedInbox(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n color: \'#4CAF50\',\n name: \'Customer Support\',\n assignees: [\'user-123\', \'user-456\'],\n description: \'Incoming customer support requests\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "name": "Customer Support",\n "color": "#4CAF50",\n "assignees": ["user-123", "user-456"],\n "description": "Incoming customer support requests",\n "bucket_id": "bucket-xyz"\n}\n```\n\n</details>\n\n---\n\n### `listSharedInboxes`\n\nRetrieves all shared inboxes configured for the organization.\n\n`GET /v2/email-settings/shared-inboxes`\n\n```ts\nconst { data } = await client.listSharedInboxes()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "name": "Customer Support",\n "color": "#4CAF50",\n "assignees": ["user-123", "user-456"],\n "description": "Incoming customer support requests",\n "bucket_id": "bucket-xyz"\n }\n]\n```\n\n</details>\n\n---\n\n### `addSharedInbox`\n\nCreates a new shared inbox for the organization.\n\n`POST /v2/email-settings/shared-inboxes`\n\n```ts\nconst { data } = await client.addSharedInbox(\n null,\n {\n id: \'support-inbox\',\n color: \'#2196F3\',\n name: \'Sales Inquiries\',\n assignees: [\'user-123\', \'user-456\'],\n description: \'Inbound sales and pricing requests\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "name": "Customer Support",\n "color": "#4CAF50",\n "assignees": ["user-123", "user-456"],\n "description": "Incoming customer support requests",\n "bucket_id": "bucket-xyz"\n}\n```\n\n</details>\n\n---\n\n### `listInboxBuckets`\n\nRetrieves all inbox buckets for the organization.\n\n`GET /v2/email-settings/inbox-buckets`\n\n```ts\nconst { data } = await client.listInboxBuckets()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "bucket-abc",\n "inbox_id": "inbox-xyz"\n }\n]\n```\n\n</details>\n\n---\n\n### `connectOutlook`\n\nReturns the Microsoft authorization URL for Outlook OAuth.\n\n`POST /v2/outlook/connect`\n\n```ts\nconst { data } = await client.connectOutlook(\n null,\n {\n mail: true,\n calendar: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "authorization_url": "string"\n}\n```\n\n</details>\n\n---\n\n### `getOutlookConnectionStatus`\n\nReturns all Microsoft 365 / Outlook connections for the organization.\nSupports multiple connections (one per Azure AD tenant).\n\n`GET /v2/outlook/connection/status`\n\n```ts\nconst { data } = await client.getOutlookConnectionStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connections": [\n {\n "status": "connected",\n "action": "connect",\n "action_reason": "expired",\n "connected_by_display_name": "string",\n "connected_by_email": "user@example.com",\n "connected_by_user_id": "string",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "tenant_id": "string",\n "scopes": ["string"],\n "expires_at": "1970-01-01T00:00:00.000Z",\n "is_token_valid": true\n }\n ],\n "has_connections": true,\n "teams_enabled": true\n}\n```\n\n</details>\n\n---\n\n### `disconnectOutlook`\n\nRemoves the Microsoft 365 / Outlook connection for a specific tenant.\nThis deletes the stored tokens and disconnects the integration.\n\n`POST /v2/outlook/connection/disconnect`\n\n```ts\nconst { data } = await client.disconnectOutlook(\n null,\n {\n tenant_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true,\n "tenant_id": "string",\n "affected_shared_inboxes": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `connectMsTeams`\n\nConnects Microsoft Teams channel (click-to-call deep links, meetings) for the organization.\nRequires an active Microsoft 365 / Outlook connection.\n\n`POST /v2/channels/msteams/connect`\n\n```ts\nconst { data } = await client.connectMsTeams()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connected": true,\n "connected_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `disconnectMsTeams`\n\nDisconnects Microsoft Teams channel for the organization.\n\n`POST /v2/channels/msteams/disconnect`\n\n```ts\nconst { data } = await client.disconnectMsTeams()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connected": true\n}\n```\n\n</details>\n\n---\n\n### `getMsTeamsStatus`\n\nReturns the connection status of the Microsoft Teams channel for the organization.\n\n`GET /v2/channels/msteams/status`\n\n```ts\nconst { data } = await client.getMsTeamsStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connected": true,\n "connected_at": "1970-01-01T00:00:00.000Z",\n "connected_by_user_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `connectOutlookMailbox`\n\nConnects an Outlook mailbox:\n 1. Validates the user has access to the mailbox via Microsoft Graph API\n 2. Creates a mapping between the email address of the mailbox and the outlook connection\n 3. E\n\n`POST /v2/outlook/mailbox/connect`\n\n```ts\nconst { data } = await client.connectOutlookMailbox(\n null,\n {\n email: \'user@example.com\',\n shared_inbox_id: \'default\',\n mailboxSyncTimeframe: \'5m\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "email_address": {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456",\n "address": "sales@yourcompany.com",\n "name": "Sales Team",\n "user_ids": ["user-123", "user-456"],\n "group_ids": ["group-789"],\n "default_signature_id": "sig-abc",\n "shared_inbox_id": "inbox-xyz",\n "is_active": true,\n "is_primary": false,\n "is_epilot_email_address": false\n },\n "outlook_email": "user@example.com",\n "tenant_id": "string",\n "provider": "outlook"\n}\n```\n\n</details>\n\n---\n\n### `disconnectOutlookMailbox`\n\nDisconnect Outlook Mailbox\n\n`POST /v2/outlook/mailbox/{email}/disconnect`\n\n```ts\nconst { data } = await client.disconnectOutlookMailbox({\n email: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true,\n "email": "user@example.com"\n}\n```\n\n</details>\n\n---\n\n### `startMailboxSync`\n\nStart Mailbox Sync\n\n`POST /v2/outlook/mailbox/{email}/sync`\n\n```ts\nconst { data } = await client.startMailboxSync(\n {\n email: \'example\',\n },\n {\n timeframe: \'5m\'\n },\n)\n```\n\n---\n\n### `getMailboxSyncStatus`\n\nGet Mailbox Sync Status\n\n`GET /v2/outlook/mailbox/{email}/sync/status`\n\n```ts\nconst { data } = await client.getMailboxSyncStatus({\n email: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "execution_id": "string",\n "status": "RUNNING",\n "timeframe": "5m",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "inbox": {\n "status": "PENDING",\n "total_messages": 0,\n "processed_messages": 0,\n "failed_messages": 0\n },\n "sent_items": {\n "status": "PENDING",\n "total_messages": 0,\n "processed_messages": 0,\n "failed_messages": 0\n }\n}\n```\n\n</details>\n\n---\n\n### `retryMailboxSync`\n\nRetry Failed Messages\n\n`POST /v2/outlook/mailbox/{email}/sync/retry`\n\n```ts\nconst { data } = await client.retryMailboxSync(\n {\n email: \'example\',\n },\n {\n sync_id: \'string\',\n scope: \'all_failed\',\n message_ids: [\'string\']\n },\n)\n```\n\n---\n\n### `getConnectedOutlookEmails`\n\nReturns all Outlook email addresses connected to the organization.\n\n`GET /v2/outlook/mailbox/mappings`\n\n```ts\nconst { data } = await client.getConnectedOutlookEmails()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "outlook_emails": [\n {\n "outlook_email": "user@example.com",\n "tenant_id": "string",\n "provider": "outlook",\n "connected_at": "1970-01-01T00:00:00.000Z",\n "connected_by_user_id": "string"\n }\n ],\n "count": 0\n}\n```\n\n</details>\n\n---\n\n### `outlookOAuthCallback`\n\nExchanges authorization code for tokens and stores them.\n\n`GET /v2/outlook/oauth/callback`\n\n```ts\nconst { data } = await client.outlookOAuthCallback({\n code: \'example\',\n state: \'example\',\n session_state: \'example\',\n error: \'example\',\n error_description: \'example\',\n error_subcode: \'example\',\n client_info: \'example\',\n error_uri: \'example\',\n admin_consent: \'example\',\n tenant: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "connected": true,\n "expires_at": "1970-01-01T00:00:00.000Z",\n "scope": "string"\n}\n```\n\n</details>\n\n---\n\n### `getSettings`\n\nRetrieves settings of a specific type for the organization.\n\n`GET /v1/email-settings`\n\n```ts\nconst { data } = await client.getSettings({\n type: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `addSetting`\n\nCreates a new setting of the specified type.\n\n`POST /v1/email-settings`\n\n```ts\nconst { data } = await client.addSetting(\n null,\n {\n id: \'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7\',\n name: \'Default Signature\',\n org_id: \'org-123\',\n type: \'signature\',\n value: \'Best regards, The Team\',\n html: \'<p>Best regards,<br/><strong>The Team</strong></p>\',\n created_at: \'2024-01-15T10:30:00Z\',\n updated_at: \'2024-01-20T14:45:00Z\',\n created_by: \'user-123\',\n updated_by: \'user-456\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `deleteSetting`\n\nDeletes a setting by its ID and type.\n\n`DELETE /v1/email-settings`\n\n```ts\nconst { data } = await client.deleteSetting(\n null,\n {\n type: \'signature\',\n id: \'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n}\n```\n\n</details>\n\n---\n\n### `updateSetting`\n\nUpdates an existing setting identified by its ID.\n\n`POST /v1/email-settings/{id}`\n\n```ts\nconst { data } = await client.updateSetting(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7\',\n name: \'Default Signature\',\n org_id: \'org-123\',\n type: \'signature\',\n value: \'Best regards, The Team\',\n html: \'<p>Best regards,<br/><strong>The Team</strong></p>\',\n created_at: \'2024-01-15T10:30:00Z\',\n updated_at: \'2024-01-20T14:45:00Z\',\n created_by: \'user-123\',\n updated_by: \'user-456\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n}\n```\n\n</details>\n\n---\n\n### `addDomain`\n\nAdds a custom email domain to the organization.\n\n`POST /v1/email-settings/domain`\n\n```ts\nconst { data } = await client.addDomain(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `deleteDomain`\n\nRemoves a custom email domain from the organization.\n\n`DELETE /v1/email-settings/domain`\n\n```ts\nconst { data } = await client.deleteDomain(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n---\n\n### `getDomains`\n\nRetrieves all custom email domains for the organization.\n\n`GET /v1/email-settings/domain`\n\n```ts\nconst { data } = await client.getDomains()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["string"]\n```\n\n</details>\n\n---\n\n### `verifyNameServers`\n\nVerifies that the domain\'s name server (NS) records are correctly configured.\n\n`POST /v1/email-settings/domain/name-servers:verify`\n\n```ts\nconst { data } = await client.verifyNameServers(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `verifyDnsRecords`\n\nVerifies that the domain\'s DNS records (MX, TXT, CNAME) are correctly configured\nin the customer\'s DNS provider.\n\n`POST /v1/email-settings/domain/dns-records:verify`\n\n```ts\nconst { data } = await client.verifyDnsRecords(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n### `verifyDomain`\n\nVerifies ownership and configuration of a custom email domain.\n\n`POST /v1/email-settings/domain:verify`\n\n```ts\nconst { data } = await client.verifyDomain(\n null,\n {\n domain: \'mail.yourcompany.com\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n "name": "Default Signature",\n "org_id": "org-123",\n "type": "signature",\n "value": "Best regards, The Team",\n "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n "created_at": "2024-01-15T10:30:00Z",\n "updated_at": "2024-01-20T14:45:00Z",\n "created_by": "user-123",\n "updated_by": "user-456"\n }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConnectOutlookRequest`\n\nFeature flags selecting which Microsoft Graph scopes to request.\nAt least one flag must be true. Passing a superset of previously\ngranted features triggers incremental consent for the delta only.\n\n\n```ts\ntype ConnectOutlookRequest = {\n mail?: boolean\n calendar?: boolean\n}\n```\n\n### `MailboxSyncStatus`\n\n```ts\ntype MailboxSyncStatus = {\n execution_id: string\n status: "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED"\n timeframe: "5m" | "1w" | "2w" | "1m"\n started_at: string // date-time\n completed_at?: string // date-time\n inbox?: {\n status?: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED"\n total_messages?: number\n processed_messages?: number\n failed_messages?: number\n }\n sent_items?: {\n status?: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED"\n total_messages?: number\n processed_messages?: number\n failed_messages?: number\n }\n}\n```\n\n### `MailboxSyncStatuses`\n\n```ts\ntype MailboxSyncStatuses = "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED"\n```\n\n### `MailboxSyncFolderStatuses`\n\n```ts\ntype MailboxSyncFolderStatuses = "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED"\n```\n\n### `MailboxSyncTimeframePeriods`\n\n```ts\ntype MailboxSyncTimeframePeriods = "5m" | "1w" | "2w" | "1m"\n```\n\n### `InboxBucketResponse`\n\nInbox bucket representing the storage container for a shared inbox.\n\n```ts\ntype InboxBucketResponse = {\n id: string\n inbox_id: string\n}\n```\n\n### `ProvisionEpilotEmailAddressPayload`\n\nRequest payload for provisioning an epilot-managed email address.\n\n```ts\ntype ProvisionEpilotEmailAddressPayload = {\n address: string\n}\n```\n\n### `SetEmailAddressPrimaryPayload`\n\nRequest payload for setting an email address as the organization\'s primary address.\n\n```ts\ntype SetEmailAddressPrimaryPayload = {\n address: string\n}\n```\n\n### `UpdateEmailAddressPayload`\n\nRequest payload for updating an email address configuration.\nAll fields are optional; only provided fields will be updated.\n\n\n```ts\ntype UpdateEmailAddressPayload = {\n name?: string\n user_ids?: string[]\n group_ids?: string[]\n default_signature_id?: string\n shared_inbox_id?: string\n is_active?: boolean\n}\n```\n\n### `CreateEmailAddressPayload`\n\nRequest payload for creating a new email address.\n\n```ts\ntype CreateEmailAddressPayload = {\n address: string\n name?: string\n user_ids?: string[]\n group_ids?: string[]\n default_signature_id?: string\n shared_inbox_id?: string\n}\n```\n\n### `EmailAddressResponse`\n\nEmail address configuration with all associated metadata.\n\n```ts\ntype EmailAddressResponse = {\n id: string\n created_at: string // date-time\n updated_at?: string // date-time\n created_by?: string\n updated_by?: string\n address: string\n name?: string\n user_ids?: string[]\n group_ids?: string[]\n default_signature_id?: string\n shared_inbox_id?: string\n is_active?: boolean\n is_primary?: boolean\n is_epilot_email_address?: boolean\n}\n```\n\n### `ErrorResponse`\n\nStandard error response format for all API errors.\n\n```ts\ntype ErrorResponse = {\n error: string\n status: number\n}\n```\n\n### `SettingMeta`\n\nCommon metadata fields for all settings and resources.\n\n```ts\ntype SettingMeta = {\n id: string\n created_at: string // date-time\n updated_at?: string // date-time\n created_by?: string\n updated_by?: string\n}\n```\n\n### `UpdateSharedInboxPayload`\n\nRequest payload for updating a shared inbox configuration.\nAll fields are optional; only provided fields will be updated.\n\n\n```ts\ntype UpdateSharedInboxPayload = {\n color?: string\n name?: string\n assignees?: string[]\n description?: string\n}\n```\n\n### `CreateSharedInboxPayload`\n\nRequest payload for creating a new shared inbox.\n\n```ts\ntype CreateSharedInboxPayload = {\n id?: string\n color: string\n name: string\n assignees?: string[]\n description?: string\n}\n```\n\n### `SharedInboxResponse`\n\nShared inbox configuration with all associated metadata.\n\n```ts\ntype SharedInboxResponse = {\n id: string\n created_at: string // date-time\n updated_at?: string // date-time\n created_by?: string\n updated_by?: string\n name: string\n color: string\n assignees: string[]\n description?: string\n bucket_id: string\n}\n```\n\n### `SettingsResponse`\n\n```ts\ntype SettingsResponse = Array<{\n id?: string\n name?: string\n org_id?: string\n type: "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n value?: string\n html?: string\n created_at?: string\n updated_at?: string\n created_by?: string\n updated_by?: string\n}> | {\n id?: string\n name?: string\n org_id?: string\n type: "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n value?: string\n html?: string\n created_at?: string\n updated_at?: string\n created_by?: string\n updated_by?: string\n}\n```\n\n### `ConnectedOutlookEmail`\n\nMapping between an Outlook email and its Outlook Connection.\nThis tracks which provider/tenant provisions each Outlook email.\n\n\n```ts\ntype ConnectedOutlookEmail = {\n outlook_email: string // email\n tenant_id?: string\n provider?: "outlook"\n connected_at?: string // date-time\n connected_by_user_id?: string\n}\n```\n\n### `OutlookConnectionError`\n\n```ts\ntype OutlookConnectionError = {\n error: string\n error_description?: string\n admin_consent_url?: string // uri\n}\n```\n\n### `OutlookConnectionStatus`\n\n```ts\ntype OutlookConnectionStatus = {\n status: "connected" | "expired" | "pending_auth" | "not_connected"\n action: "connect" | "authorize" | "reconnect" | "none"\n action_reason?: "expired" | "permission_update"\n connected_by_display_name?: string\n connected_by_email?: string // email\n connected_by_user_id?: string\n connected_at?: string // date-time\n updated_at?: string // date-time\n tenant_id: string\n scopes?: string[]\n expires_at?: string // date-time\n is_token_valid?: boolean\n}\n```\n\n### `SignatureSetting`\n\nSetting that allows to add a signature.\n\n```ts\ntype SignatureSetting = "signature"\n```\n\n### `EmailDomainSetting`\n\nSetting that allows to add a custom domain. For e.g; doe.com\n\n```ts\ntype EmailDomainSetting = "email_domain"\n```\n\n### `EmailAddressSetting`\n\nSetting that allows to add an email address on the custom domain. For e.g; john@doe.com\n\n```ts\ntype EmailAddressSetting = "email_address"\n```\n\n### `WhitelistEmailAddressSetting`\n\n- Setting that specifies a list of addresses exempt from being flagged as duplicate emails.\n- An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.\n\n\n```ts\ntype WhitelistEmailAddressSetting = "whitelist_email_address"\n```\n\n### `RestrictDuplicatesWithinSetting`\n\n- Restrict duplicates within:\n * 10s\n * 5m\n * 1d\n * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.\n- Defaults to 3 minutes\n- Negative values will be treated same as positive values\n- If not set, defaults to 3 min\n- If set as\n\n```ts\ntype RestrictDuplicatesWithinSetting = "restrict_duplicates_within"\n```\n\n### `SettingType`\n\n```ts\ntype SettingType = "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n```\n\n### `Setting`\n\nGeneric setting object used for various email configuration types.\nThe applicable fields depend on the setting type:\n- **signature**: Uses `name`, `value` (plain text), and `html` (rich text)\n- **email_domain**: Uses `value` (domain name)\n- **whitelist_email_address**: Uses `value` (email address)\n-\n\n```ts\ntype Setting = {\n id?: string\n name?: string\n org_id?: string\n type: "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n value?: string\n html?: string\n created_at?: string\n updated_at?: string\n created_by?: string\n updated_by?: string\n}\n```\n\n### `Domain`\n\nCustom email domain configuration.\n\n```ts\ntype Domain = {\n domain?: string\n}\n```\n';
5
+
6
+
7
+ exports.default = email_settings_default;