@epilot/sdk 2.1.0-rc.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (359) hide show
  1. package/definitions/app.json +38 -0
  2. package/definitions/automation.json +2 -37
  3. package/definitions/blueprint-manifest-runtime.json +1 -1
  4. package/definitions/blueprint-manifest.json +115 -1
  5. package/definitions/customer-portal-runtime.json +1 -1
  6. package/definitions/customer-portal.json +279 -42
  7. package/definitions/data-management.json +10 -0
  8. package/definitions/email-template.json +25 -3
  9. package/definitions/entity.json +205 -3
  10. package/definitions/erp-integration-runtime.json +1 -1
  11. package/definitions/erp-integration.json +472 -13
  12. package/definitions/journey.json +257 -12
  13. package/definitions/kanban.json +630 -78
  14. package/definitions/organization-runtime.json +1 -1
  15. package/definitions/organization.json +614 -51
  16. package/definitions/workflow.json +40 -0
  17. package/dist/README-VG67PX4R.js +7 -0
  18. package/dist/README-W4B35MRN.cjs +7 -0
  19. package/dist/_index-AMVZBT2K.cjs +99 -0
  20. package/dist/_index-S6LFD3ER.js +99 -0
  21. package/dist/access-token-6BJDZSFE.cjs +7 -0
  22. package/dist/access-token-GSQZLDXR.js +7 -0
  23. package/dist/address-HA4RMRNQ.cjs +7 -0
  24. package/dist/address-QVJUGMOG.js +7 -0
  25. package/dist/address-suggestions-74244BAJ.js +7 -0
  26. package/dist/address-suggestions-IUQMYF27.cjs +7 -0
  27. package/dist/ai-agents-IZWFEUSH.js +7 -0
  28. package/dist/ai-agents-PWHKNRCX.cjs +7 -0
  29. package/dist/apis/access-token.cjs +10 -8
  30. package/dist/apis/access-token.js +5 -3
  31. package/dist/apis/address-suggestions.cjs +10 -8
  32. package/dist/apis/address-suggestions.js +5 -3
  33. package/dist/apis/address.cjs +10 -8
  34. package/dist/apis/address.js +5 -3
  35. package/dist/apis/ai-agents.cjs +10 -8
  36. package/dist/apis/ai-agents.js +5 -3
  37. package/dist/apis/app.cjs +10 -8
  38. package/dist/apis/app.js +5 -3
  39. package/dist/apis/audit-logs.cjs +10 -8
  40. package/dist/apis/audit-logs.js +5 -3
  41. package/dist/apis/automation.cjs +10 -8
  42. package/dist/apis/automation.js +5 -3
  43. package/dist/apis/billing.cjs +10 -8
  44. package/dist/apis/billing.js +5 -3
  45. package/dist/apis/blueprint-manifest.cjs +10 -8
  46. package/dist/apis/blueprint-manifest.js +5 -3
  47. package/dist/apis/consent.cjs +10 -8
  48. package/dist/apis/consent.js +5 -3
  49. package/dist/apis/customer-portal.cjs +10 -8
  50. package/dist/apis/customer-portal.js +5 -3
  51. package/dist/apis/dashboard.cjs +10 -8
  52. package/dist/apis/dashboard.js +5 -3
  53. package/dist/apis/data-management.cjs +10 -8
  54. package/dist/apis/data-management.js +5 -3
  55. package/dist/apis/deduplication.cjs +10 -8
  56. package/dist/apis/deduplication.js +5 -3
  57. package/dist/apis/design.cjs +10 -8
  58. package/dist/apis/design.js +5 -3
  59. package/dist/apis/document.cjs +10 -8
  60. package/dist/apis/document.js +5 -3
  61. package/dist/apis/email-settings.cjs +10 -8
  62. package/dist/apis/email-settings.js +5 -3
  63. package/dist/apis/email-template.cjs +10 -8
  64. package/dist/apis/email-template.js +5 -3
  65. package/dist/apis/entity-mapping.cjs +10 -8
  66. package/dist/apis/entity-mapping.js +5 -3
  67. package/dist/apis/entity.cjs +10 -8
  68. package/dist/apis/entity.js +5 -3
  69. package/dist/apis/environments.cjs +10 -8
  70. package/dist/apis/environments.js +5 -3
  71. package/dist/apis/erp-integration.cjs +10 -8
  72. package/dist/apis/erp-integration.js +5 -3
  73. package/dist/apis/event-catalog.cjs +10 -8
  74. package/dist/apis/event-catalog.js +5 -3
  75. package/dist/apis/file.cjs +10 -8
  76. package/dist/apis/file.js +5 -3
  77. package/dist/apis/iban.cjs +10 -8
  78. package/dist/apis/iban.js +5 -3
  79. package/dist/apis/journey.cjs +10 -8
  80. package/dist/apis/journey.js +5 -3
  81. package/dist/apis/kanban.cjs +10 -8
  82. package/dist/apis/kanban.js +5 -3
  83. package/dist/apis/message.cjs +10 -8
  84. package/dist/apis/message.js +5 -3
  85. package/dist/apis/metering.cjs +10 -8
  86. package/dist/apis/metering.js +5 -3
  87. package/dist/apis/notes.cjs +10 -8
  88. package/dist/apis/notes.js +5 -3
  89. package/dist/apis/notification.cjs +10 -8
  90. package/dist/apis/notification.js +5 -3
  91. package/dist/apis/organization.cjs +10 -8
  92. package/dist/apis/organization.d.cts +2 -2
  93. package/dist/apis/organization.d.ts +2 -2
  94. package/dist/apis/organization.js +5 -3
  95. package/dist/apis/partner-directory.cjs +10 -8
  96. package/dist/apis/partner-directory.js +5 -3
  97. package/dist/apis/permissions.cjs +10 -8
  98. package/dist/apis/permissions.js +5 -3
  99. package/dist/apis/pricing-tier.cjs +10 -8
  100. package/dist/apis/pricing-tier.js +5 -3
  101. package/dist/apis/pricing.cjs +10 -8
  102. package/dist/apis/pricing.js +5 -3
  103. package/dist/apis/purpose.cjs +10 -8
  104. package/dist/apis/purpose.js +5 -3
  105. package/dist/apis/sandbox.cjs +10 -8
  106. package/dist/apis/sandbox.js +5 -3
  107. package/dist/apis/submission.cjs +10 -8
  108. package/dist/apis/submission.js +5 -3
  109. package/dist/apis/targeting.cjs +10 -8
  110. package/dist/apis/targeting.js +5 -3
  111. package/dist/apis/template-variables.cjs +10 -8
  112. package/dist/apis/template-variables.js +5 -3
  113. package/dist/apis/user.cjs +10 -8
  114. package/dist/apis/user.js +5 -3
  115. package/dist/apis/validation-rules.cjs +10 -8
  116. package/dist/apis/validation-rules.js +5 -3
  117. package/dist/apis/webhooks.cjs +10 -8
  118. package/dist/apis/webhooks.js +5 -3
  119. package/dist/apis/workflow-definition.cjs +10 -8
  120. package/dist/apis/workflow-definition.js +5 -3
  121. package/dist/apis/workflow.cjs +10 -8
  122. package/dist/apis/workflow.js +5 -3
  123. package/dist/app-IKHWU222.cjs +7 -0
  124. package/dist/app-VLM3SWKA.js +7 -0
  125. package/dist/audit-logs-5VXHOQ7S.js +7 -0
  126. package/dist/audit-logs-D2LFUA2R.cjs +7 -0
  127. package/dist/automation-3HGCK725.cjs +7 -0
  128. package/dist/automation-72VGEJCY.js +7 -0
  129. package/dist/billing-DUWDISHP.cjs +7 -0
  130. package/dist/billing-IPALEAG2.js +7 -0
  131. package/dist/blueprint-manifest-CXSCRQ5X.js +7 -0
  132. package/dist/blueprint-manifest-SHNZPK5O.cjs +7 -0
  133. package/dist/{chunk-6J7CIOKR.js → chunk-2HOJWFQ4.js} +1 -1
  134. package/dist/{chunk-BDIJHJOG.js → chunk-372VUPHN.js} +1 -1
  135. package/dist/{chunk-Q5TESEDZ.cjs → chunk-3HJEWWPS.cjs} +2 -2
  136. package/dist/{chunk-ID6BXIOZ.js → chunk-3N67SSL3.js} +1 -1
  137. package/dist/chunk-3XEP56SV.cjs +204 -0
  138. package/dist/{chunk-7KFKA3AH.cjs → chunk-3ZZ57K3S.cjs} +2 -2
  139. package/dist/{chunk-CVSQT5PV.cjs → chunk-4SWC43JO.cjs} +2 -2
  140. package/dist/{chunk-O3R6C3WW.js → chunk-4VFQTSJQ.js} +1 -1
  141. package/dist/{chunk-LXAJ722U.js → chunk-57QIBYDN.js} +1 -1
  142. package/dist/{chunk-SPZSDRM6.cjs → chunk-5SNJAD6F.cjs} +2 -2
  143. package/dist/{chunk-OI2M6FSB.js → chunk-73H6TVKN.js} +1 -1
  144. package/dist/{chunk-BB7WFIE2.cjs → chunk-A6JOROUC.cjs} +2 -2
  145. package/dist/{chunk-SHPXCOTN.cjs → chunk-AJKH25H2.cjs} +3 -3
  146. package/dist/{chunk-DBNEZWK2.cjs → chunk-ARWMTXJV.cjs} +2 -2
  147. package/dist/{chunk-7BPPP4M2.js → chunk-B3ZGAG7B.js} +1 -1
  148. package/dist/{chunk-5WN2YXNU.cjs → chunk-BH5ZXK4J.cjs} +2 -2
  149. package/dist/{chunk-JM6HKPSC.cjs → chunk-BWFXLUK5.cjs} +2 -2
  150. package/dist/{chunk-V56ZCL54.js → chunk-C6UTZEHH.js} +1 -1
  151. package/dist/{chunk-ZPCMZO2O.js → chunk-CPKBR34V.js} +1 -1
  152. package/dist/{chunk-UTQY2DSM.js → chunk-CWSHYFVZ.js} +1 -1
  153. package/dist/{chunk-5YVVQBA2.js → chunk-DJKSULPK.js} +1 -1
  154. package/dist/{chunk-XLOXC52O.js → chunk-DNJ54L2G.js} +1 -1
  155. package/dist/{chunk-YXPUCBVK.cjs → chunk-DY2D2IW5.cjs} +2 -2
  156. package/dist/{chunk-Z5LLUUFD.cjs → chunk-E26ZO7QM.cjs} +2 -2
  157. package/dist/{chunk-RNKZDJOY.js → chunk-EBCHCYUO.js} +1 -1
  158. package/dist/{chunk-4MO4WLKA.cjs → chunk-EPAIOB5U.cjs} +2 -2
  159. package/dist/{chunk-UX2IZQNM.cjs → chunk-EQZMT2HF.cjs} +2 -2
  160. package/dist/{chunk-U52A2DMK.cjs → chunk-F376L6PP.cjs} +2 -2
  161. package/dist/{chunk-TBBLLEB2.cjs → chunk-F472YLJG.cjs} +2 -2
  162. package/dist/{chunk-W3MM2BSK.cjs → chunk-FXOX3X7E.cjs} +2 -2
  163. package/dist/{chunk-E4IFBCNM.cjs → chunk-G2REP2VZ.cjs} +2 -2
  164. package/dist/{chunk-CFGXI3FX.js → chunk-GLO477NZ.js} +1 -1
  165. package/dist/{chunk-PBNPZ7UX.js → chunk-H4VSK4KF.js} +1 -1
  166. package/dist/{chunk-33TQRYMY.js → chunk-HPSGM6QP.js} +1 -1
  167. package/dist/{chunk-RQKN4WTW.cjs → chunk-HPYHWTTA.cjs} +2 -2
  168. package/dist/{chunk-5RXE7X63.js → chunk-IH4CMOML.js} +2 -2
  169. package/dist/{chunk-VD5TBK2T.cjs → chunk-IMT3IE5M.cjs} +2 -2
  170. package/dist/{chunk-DIP442PL.js → chunk-IP2WWEOU.js} +1 -1
  171. package/dist/{chunk-FCLW3FLF.js → chunk-IS2VB342.js} +1 -1
  172. package/dist/{chunk-UNHWLNE4.js → chunk-ITX53XAZ.js} +1 -1
  173. package/dist/{chunk-KU2XF4TS.cjs → chunk-JXBXDTFG.cjs} +2 -2
  174. package/dist/{chunk-Y4YQEDR3.js → chunk-K62XK7KU.js} +1 -1
  175. package/dist/chunk-KA3TGFJP.js +14 -0
  176. package/dist/{chunk-IXRDP4VP.js → chunk-KBOVBUBM.js} +1 -1
  177. package/dist/{chunk-MKZGM4A6.js → chunk-KPGC2D6E.js} +1 -1
  178. package/dist/{chunk-ZAPA4RPI.js → chunk-KSXTBGIV.js} +1 -1
  179. package/dist/{chunk-PLBIQ2Y7.cjs → chunk-LCIJ4TJ4.cjs} +2 -2
  180. package/dist/{chunk-TUAAE3UC.cjs → chunk-LQOLYXGQ.cjs} +2 -2
  181. package/dist/{chunk-6ADJEPMJ.js → chunk-LSIWCIQV.js} +1 -1
  182. package/dist/{chunk-CBRWUULQ.js → chunk-MHNSZ4HE.js} +1 -1
  183. package/dist/{chunk-WOOKHE7Y.cjs → chunk-MKX4CKAB.cjs} +2 -2
  184. package/dist/{chunk-N2P26AAD.js → chunk-MRTAFRO7.js} +1 -1
  185. package/dist/{chunk-YGULLD73.js → chunk-MRZ7LGKZ.js} +1 -1
  186. package/dist/{chunk-CLMZ2EXW.js → chunk-MSASBR2Y.js} +1 -1
  187. package/dist/{chunk-KEJRWMXR.cjs → chunk-NAWLLC3T.cjs} +2 -2
  188. package/dist/chunk-NJK5F5TF.cjs +21 -0
  189. package/dist/{chunk-HBPCJRZX.cjs → chunk-NLSZVGHK.cjs} +2 -2
  190. package/dist/{chunk-CK36RZXR.js → chunk-O4LRVGOY.js} +1 -1
  191. package/dist/chunk-OG2DMGU6.cjs +14 -0
  192. package/dist/{chunk-TIJGLQKO.js → chunk-OGQKJTXF.js} +1 -1
  193. package/dist/{chunk-UE4XPL43.js → chunk-PETLAONH.js} +1 -1
  194. package/dist/{chunk-MK4ZGXVE.cjs → chunk-PVSS2WPM.cjs} +2 -2
  195. package/dist/{chunk-ONN5COYQ.cjs → chunk-PXITFTJA.cjs} +2 -2
  196. package/dist/{chunk-ZAXYMQ2B.cjs → chunk-QDVPPRWI.cjs} +2 -2
  197. package/dist/{chunk-IPFHV2FV.cjs → chunk-QKERXNJJ.cjs} +2 -2
  198. package/dist/{chunk-ZDJ3J6Z6.cjs → chunk-QLML3IP5.cjs} +2 -2
  199. package/dist/{chunk-YFHQYQII.js → chunk-QVAJ5JP4.js} +1 -1
  200. package/dist/{chunk-S2QF6HG2.cjs → chunk-RD7E4OSJ.cjs} +2 -2
  201. package/dist/{chunk-XIB2G42L.cjs → chunk-RWSA3LXE.cjs} +2 -2
  202. package/dist/{chunk-R6WNZVTA.cjs → chunk-RXSS67VI.cjs} +2 -2
  203. package/dist/{chunk-UXVV3BSC.cjs → chunk-S3ZNESMC.cjs} +2 -2
  204. package/dist/{chunk-YNPRF4BX.js → chunk-S7NDMDRX.js} +1 -1
  205. package/dist/{chunk-HO7KACZZ.cjs → chunk-SK3VYIZ6.cjs} +2 -2
  206. package/dist/{chunk-CX3KG7D2.cjs → chunk-SMGHAG5C.cjs} +2 -2
  207. package/dist/{chunk-D5FJ26GG.js → chunk-T46LODOF.js} +1 -1
  208. package/dist/{chunk-Y4ZMNMYI.js → chunk-TIJWJVKZ.js} +1 -1
  209. package/dist/{chunk-EIILOQ6X.js → chunk-TLWCYLNA.js} +1 -1
  210. package/dist/{chunk-JX45ME2Z.js → chunk-TRJLYZHD.js} +1 -1
  211. package/dist/{chunk-RNBO3DEN.js → chunk-UKKJMCNH.js} +1 -1
  212. package/dist/chunk-ULBEEHG4.js +204 -0
  213. package/dist/{chunk-UDO4JYVU.cjs → chunk-VGTUK3QD.cjs} +2 -2
  214. package/dist/{chunk-4JPVFLVU.js → chunk-VQ7R36AC.js} +1 -1
  215. package/dist/{chunk-IPDIEZBN.cjs → chunk-VVQB5W7U.cjs} +2 -2
  216. package/dist/{chunk-HKZQ56AS.cjs → chunk-VVVATFGK.cjs} +2 -2
  217. package/dist/{chunk-URRL33D5.cjs → chunk-WMTYO5OX.cjs} +2 -2
  218. package/dist/{chunk-U4BMKRG6.js → chunk-WOSSSFXB.js} +1 -1
  219. package/dist/{chunk-OBQIS3KU.js → chunk-WOXXNKTE.js} +1 -1
  220. package/dist/{chunk-WAKSLH7V.cjs → chunk-XKI2OAYV.cjs} +2 -2
  221. package/dist/{chunk-5Y2KLUU6.cjs → chunk-XR4QF6KQ.cjs} +2 -2
  222. package/dist/{chunk-6BERHKDQ.cjs → chunk-XYHTQ523.cjs} +2 -2
  223. package/dist/{chunk-XD6XML3Z.cjs → chunk-XZYZLSUO.cjs} +2 -2
  224. package/dist/chunk-YPSWSI3M.js +21 -0
  225. package/dist/{chunk-4K3MX2J6.js → chunk-YYBIU5BQ.js} +1 -1
  226. package/dist/{chunk-HSGQSTVK.js → chunk-YZA5WZUS.js} +1 -1
  227. package/dist/{chunk-GGBSLAVO.cjs → chunk-Z4LUE424.cjs} +2 -2
  228. package/dist/{chunk-NSOHW3R6.js → chunk-ZV6XYUXS.js} +1 -1
  229. package/dist/consent-CS2ZBZX4.cjs +7 -0
  230. package/dist/consent-NNYHF2N4.js +7 -0
  231. package/dist/customer-portal-D3SLPAHZ.js +7 -0
  232. package/dist/customer-portal-UR3GN4VU.cjs +7 -0
  233. package/dist/dashboard-UHYR5RTY.cjs +7 -0
  234. package/dist/dashboard-UTPGXFW5.js +7 -0
  235. package/dist/data-management-QH2IJ5QV.js +7 -0
  236. package/dist/data-management-TEFRLGSU.cjs +7 -0
  237. package/dist/deduplication-ECVAZVVA.cjs +7 -0
  238. package/dist/deduplication-GYIST22B.js +7 -0
  239. package/dist/design-KUVXMFFK.cjs +7 -0
  240. package/dist/design-YKBXRW5C.js +7 -0
  241. package/dist/document-CY2A2OE7.js +7 -0
  242. package/dist/document-RYQ7MF6U.cjs +7 -0
  243. package/dist/email-settings-TQ5GGDYG.js +7 -0
  244. package/dist/email-settings-TQC34GST.cjs +7 -0
  245. package/dist/email-template-M2VVL4TI.cjs +7 -0
  246. package/dist/email-template-WYROV3UG.js +7 -0
  247. package/dist/entity-FA6PZX6S.js +7 -0
  248. package/dist/entity-IX5NSHPX.cjs +7 -0
  249. package/dist/entity-mapping-7J3IAGKQ.js +7 -0
  250. package/dist/entity-mapping-ZNMFCUKK.cjs +7 -0
  251. package/dist/environments-E3X6NYGX.js +7 -0
  252. package/dist/environments-P2JS4F5N.cjs +7 -0
  253. package/dist/erp-integration-EP2XFEH5.js +7 -0
  254. package/dist/erp-integration-NNV72VFI.cjs +7 -0
  255. package/dist/event-catalog-C45ISVMP.cjs +7 -0
  256. package/dist/event-catalog-D7VJ7WRS.js +7 -0
  257. package/dist/file-UOWBTDIU.cjs +7 -0
  258. package/dist/file-XSN3NAVZ.js +7 -0
  259. package/dist/iban-24GHLFDB.cjs +7 -0
  260. package/dist/iban-LDKYDVQV.js +7 -0
  261. package/dist/index.cjs +107 -100
  262. package/dist/index.d.cts +17 -2
  263. package/dist/index.d.ts +17 -2
  264. package/dist/index.js +58 -51
  265. package/dist/journey-7CKX67M7.js +7 -0
  266. package/dist/journey-EUZ6MVHG.cjs +7 -0
  267. package/dist/kanban-CHTH2ZSY.cjs +7 -0
  268. package/dist/kanban-HI6LL5WY.js +7 -0
  269. package/dist/message-3XZLJR6R.cjs +7 -0
  270. package/dist/message-ZNMCS5YH.js +7 -0
  271. package/dist/metering-DZNZPPY6.cjs +7 -0
  272. package/dist/metering-KOSCPPKB.js +7 -0
  273. package/dist/notes-3AO5GXIT.js +7 -0
  274. package/dist/notes-MPWOQC5J.cjs +7 -0
  275. package/dist/notification-PZOCUYD5.cjs +7 -0
  276. package/dist/notification-VWDZRSFZ.js +7 -0
  277. package/dist/organization-RARYYG2E.cjs +7 -0
  278. package/dist/organization-ZERPH2IH.js +7 -0
  279. package/dist/{organization.d-Bd2Hmk8v.d.cts → organization.d-DqwnNxMg.d.cts} +34 -7
  280. package/dist/{organization.d-Bd2Hmk8v.d.ts → organization.d-DqwnNxMg.d.ts} +34 -7
  281. package/dist/partner-directory-2XMPQWWX.js +7 -0
  282. package/dist/partner-directory-WHNTKQ5E.cjs +7 -0
  283. package/dist/permissions-4T3GFNB4.js +7 -0
  284. package/dist/permissions-FGBIJNN7.cjs +7 -0
  285. package/dist/pricing-4Z4TOETA.cjs +7 -0
  286. package/dist/pricing-C65DTZSX.js +7 -0
  287. package/dist/pricing-tier-NI35WOUP.cjs +7 -0
  288. package/dist/pricing-tier-VUOFK5Q7.js +7 -0
  289. package/dist/purpose-AKOEUHZ4.cjs +7 -0
  290. package/dist/purpose-RBRV3AQZ.js +7 -0
  291. package/dist/sandbox-2KN4X66E.cjs +7 -0
  292. package/dist/sandbox-L2SOOGGR.js +7 -0
  293. package/dist/submission-7BISSPO6.js +7 -0
  294. package/dist/submission-Q24BU4GS.cjs +7 -0
  295. package/dist/targeting-EYGYZD6M.cjs +7 -0
  296. package/dist/targeting-GEJTJN5Z.js +7 -0
  297. package/dist/template-variables-OAYS2E3G.cjs +1148 -0
  298. package/dist/template-variables-VKDJJZUT.js +1148 -0
  299. package/dist/user-EIEOI3OG.js +7 -0
  300. package/dist/user-NJJ7XVKB.cjs +7 -0
  301. package/dist/validation-rules-P6F5P73P.js +7 -0
  302. package/dist/validation-rules-VDU3CIZV.cjs +7 -0
  303. package/dist/webhooks-I7JWU34X.cjs +7 -0
  304. package/dist/webhooks-WPLEHVPX.js +7 -0
  305. package/dist/workflow-3LLURW3H.js +7 -0
  306. package/dist/workflow-RAGQDYXT.cjs +7 -0
  307. package/dist/workflow-definition-B6ELOZUR.cjs +7 -0
  308. package/dist/workflow-definition-D24CRCK2.js +7 -0
  309. package/docs/access-token.md +440 -0
  310. package/docs/address-suggestions.md +256 -0
  311. package/docs/address.md +284 -0
  312. package/docs/ai-agents.md +1891 -0
  313. package/docs/app.md +3388 -0
  314. package/docs/audit-logs.md +242 -0
  315. package/docs/automation.md +4044 -0
  316. package/docs/billing.md +783 -0
  317. package/docs/blueprint-manifest.md +3234 -0
  318. package/docs/consent.md +213 -0
  319. package/docs/customer-portal.md +11399 -0
  320. package/docs/dashboard.md +640 -0
  321. package/docs/data-management.md +883 -0
  322. package/docs/deduplication.md +135 -0
  323. package/docs/design.md +1273 -0
  324. package/docs/document.md +590 -0
  325. package/docs/email-settings.md +1544 -0
  326. package/docs/email-template.md +1197 -0
  327. package/docs/entity-mapping.md +2864 -0
  328. package/docs/entity.md +9595 -0
  329. package/docs/environments.md +259 -0
  330. package/docs/erp-integration.md +4572 -0
  331. package/docs/event-catalog.md +835 -0
  332. package/docs/file.md +1453 -0
  333. package/docs/iban.md +61 -0
  334. package/docs/journey.md +2268 -0
  335. package/docs/kanban.md +882 -0
  336. package/docs/message.md +2122 -0
  337. package/docs/metering.md +1431 -0
  338. package/docs/notes.md +670 -0
  339. package/docs/notification.md +1207 -0
  340. package/docs/organization.md +733 -0
  341. package/docs/partner-directory.md +1197 -0
  342. package/docs/permissions.md +1047 -0
  343. package/docs/pricing-tier.md +81 -0
  344. package/docs/pricing.md +5923 -0
  345. package/docs/purpose.md +283 -0
  346. package/docs/sandbox.md +389 -0
  347. package/docs/submission.md +195 -0
  348. package/docs/targeting.md +959 -0
  349. package/docs/template-variables.md +1141 -0
  350. package/docs/user.md +2555 -0
  351. package/docs/validation-rules.md +1597 -0
  352. package/docs/webhooks.md +996 -0
  353. package/docs/workflow-definition.md +3842 -0
  354. package/docs/workflow.md +4465 -0
  355. package/package.json +3 -2
  356. package/dist/chunk-GMBRXWMD.cjs +0 -14
  357. package/dist/chunk-L43U5IO3.js +0 -14
  358. package/dist/chunk-XE25WERA.js +0 -125
  359. package/dist/chunk-XEQMAKGA.cjs +0 -125
@@ -2,25 +2,33 @@
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
4
  "title": "Organization API",
5
- "description": "Manage epilot tenant organizations",
6
- "version": "1.0.0"
5
+ "description": "The Organization API provides endpoints for managing epilot tenant organizations.\n\n## Overview\n\nThis API allows you to:\n- **Retrieve organization details** - Get information about the current organization or a specific organization by ID\n- **Update organization profiles** - Modify organization name, contact information, address, and branding assets\n- **Manage organization settings** - Configure organization-wide settings such as feature flags and preferences\n- **Branding configuration** - Set organization logos, email signatures, and style settings\n\n## Organization Types\n\nOrganizations can be configured as:\n- **Production** - Live production environments for real business operations\n- **Sandbox** - Test environments linked to a parent production organization\n",
6
+ "version": "1.1.0"
7
7
  },
8
8
  "tags": [
9
9
  {
10
10
  "name": "Organization",
11
- "description": "Organization info"
11
+ "description": "Endpoints for managing organization profiles and information.\n\nOrganizations represent tenant accounts in the epilot platform. Each organization has:\n- Basic profile information (name, contact details, address)\n- Branding assets (logo, email signature)\n- Configuration settings\n- Usage type (Production or Sandbox)\n"
12
12
  },
13
13
  {
14
14
  "name": "Organization Settings",
15
- "description": "Organization Settings"
15
+ "description": "Endpoints for managing organization-wide configuration settings.\n\nSettings are stored as key-value pairs and can include:\n- Feature flags (e.g., double_opt_in)\n- Integration configurations\n- Platform preferences\n\nSettings values can be strings, numbers, booleans, arrays, or objects.\n"
16
16
  },
17
17
  {
18
18
  "name": "Cleanup",
19
- "description": "Internal Cleanup endpoints"
19
+ "description": "Internal endpoints for organization cleanup operations.\n\nThese endpoints are used by internal services to manage the deletion and cleanup\nof organization data across the platform. They track cleanup status per service\nto ensure complete data removal.\n"
20
20
  },
21
21
  {
22
22
  "name": "Internal",
23
- "description": "Internal endpoints"
23
+ "description": "Internal endpoints for platform administration.\n\nThese endpoints are not part of the public API and are used by internal epilot\nservices for administrative operations such as organization provisioning,\ndata aggregation, and cross-organization queries.\n"
24
+ },
25
+ {
26
+ "name": "HubSpot",
27
+ "description": "Internal endpoints for HubSpot CRM integration.\n\nThese endpoints provide access to HubSpot company data synchronized with the\nepilot data warehouse for organization mapping and CRM integration purposes.\n"
28
+ },
29
+ {
30
+ "name": "Feature Settings",
31
+ "description": "Feature flag metadata for the organization settings page.\n\nThis metadata is used by frontend applications to render feature toggles\nwithout hardcoding titles, descriptions, badges, and visibility rules in the UI.\n"
24
32
  }
25
33
  ],
26
34
  "security": [
@@ -33,20 +41,44 @@
33
41
  "get": {
34
42
  "operationId": "getCurrentOrganization",
35
43
  "summary": "getCurrentOrganization",
36
- "description": "Get caller's current organization",
44
+ "description": "Retrieves the organization associated with the authenticated user's current session.\n\nThis endpoint is useful for fetching organization details without knowing the organization ID,\nas it automatically resolves the organization from the authentication token.\n",
37
45
  "tags": [
38
46
  "Organization"
39
47
  ],
40
48
  "responses": {
41
49
  "200": {
42
- "description": "Current organization",
50
+ "description": "The organization associated with the current authenticated user",
43
51
  "content": {
44
52
  "application/json": {
45
53
  "schema": {
46
54
  "$ref": "#/components/schemas/Organization"
55
+ },
56
+ "example": {
57
+ "id": "739224",
58
+ "name": "Epilot",
59
+ "email": "contact@epilot.cloud",
60
+ "phone": "+49123456789",
61
+ "website": "https://epilot.cloud",
62
+ "address": {
63
+ "country": "Germany",
64
+ "city": "Cologne",
65
+ "postal_code": "50667",
66
+ "street": "Im Mediapark",
67
+ "street_number": "8a"
68
+ },
69
+ "organization_use": "Production",
70
+ "created_date": "2021-01-15T10:30:00Z",
71
+ "logo_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png",
72
+ "signature": "<p>Best regards,<br/>The epilot Team</p>"
47
73
  }
48
74
  }
49
75
  }
76
+ },
77
+ "401": {
78
+ "description": "Unauthorized - Invalid or missing authentication token"
79
+ },
80
+ "403": {
81
+ "description": "Forbidden - User does not have permission to access organization data"
50
82
  }
51
83
  }
52
84
  }
@@ -55,7 +87,7 @@
55
87
  "get": {
56
88
  "operationId": "getOrganization",
57
89
  "summary": "getOrganization",
58
- "description": "Get an organization",
90
+ "description": "Retrieves detailed information about a specific organization by its unique identifier.\n\nReturns the organization's profile information including name, contact details,\naddress, branding assets, and configuration.\n",
59
91
  "tags": [
60
92
  "Organization"
61
93
  ],
@@ -67,26 +99,53 @@
67
99
  "$ref": "#/components/schemas/OrganizationId"
68
100
  },
69
101
  "required": true,
70
- "description": "The Id of the organization."
102
+ "description": "The unique identifier of the organization to retrieve"
71
103
  }
72
104
  ],
73
105
  "responses": {
74
106
  "200": {
75
- "description": "The returned organization",
107
+ "description": "Organization details retrieved successfully",
76
108
  "content": {
77
109
  "application/json": {
78
110
  "schema": {
79
111
  "$ref": "#/components/schemas/Organization"
112
+ },
113
+ "example": {
114
+ "id": "739224",
115
+ "name": "Epilot",
116
+ "email": "contact@epilot.cloud",
117
+ "phone": "+49123456789",
118
+ "website": "https://epilot.cloud",
119
+ "address": {
120
+ "country": "Germany",
121
+ "city": "Cologne",
122
+ "postal_code": "50667",
123
+ "street": "Im Mediapark",
124
+ "street_number": "8a"
125
+ },
126
+ "organization_use": "Production",
127
+ "created_date": "2021-01-15T10:30:00Z",
128
+ "logo_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png",
129
+ "signature": "<p>Best regards,<br/>The epilot Team</p>"
80
130
  }
81
131
  }
82
132
  }
133
+ },
134
+ "401": {
135
+ "description": "Unauthorized - Invalid or missing authentication token"
136
+ },
137
+ "403": {
138
+ "description": "Forbidden - User does not have permission to access this organization"
139
+ },
140
+ "404": {
141
+ "description": "Not Found - Organization with the specified ID does not exist"
83
142
  }
84
143
  }
85
144
  },
86
145
  "patch": {
87
146
  "operationId": "updateOrganization",
88
147
  "summary": "updateOrganization",
89
- "description": "Updates an organization",
148
+ "description": "Updates an organization's profile information.\n\nThis endpoint supports partial updates - only the fields provided in the request body\nwill be modified. Fields not included in the request will retain their current values.\n\nCommon use cases:\n- Updating contact information (email, phone, website)\n- Changing the organization name\n- Updating the postal address\n- Setting or updating branding assets (logo_url, logo_thumbnail_url)\n- Configuring the default email signature\n",
90
149
  "tags": [
91
150
  "Organization"
92
151
  ],
@@ -98,21 +157,38 @@
98
157
  "$ref": "#/components/schemas/OrganizationId"
99
158
  },
100
159
  "required": true,
101
- "description": "The Id of the organization."
160
+ "description": "The unique identifier of the organization to update"
102
161
  }
103
162
  ],
104
163
  "requestBody": {
164
+ "description": "Organization fields to update. Only provided fields will be modified.",
165
+ "required": true,
105
166
  "content": {
106
167
  "application/json": {
107
168
  "schema": {
108
169
  "$ref": "#/components/schemas/Organization"
170
+ },
171
+ "example": {
172
+ "name": "Epilot GmbH",
173
+ "email": "info@epilot.cloud",
174
+ "phone": "+49221123456",
175
+ "website": "https://www.epilot.cloud",
176
+ "address": {
177
+ "country": "Germany",
178
+ "city": "Cologne",
179
+ "postal_code": "50667",
180
+ "street": "Im Mediapark",
181
+ "street_number": "8a"
182
+ },
183
+ "logo_url": "https://example.com/new-logo.png",
184
+ "signature": "<p>Kind regards,<br/>The epilot Team</p>"
109
185
  }
110
186
  }
111
187
  }
112
188
  },
113
189
  "responses": {
114
190
  "200": {
115
- "description": "The updated organization",
191
+ "description": "Organization updated successfully",
116
192
  "content": {
117
193
  "application/json": {
118
194
  "schema": {
@@ -120,15 +196,27 @@
120
196
  }
121
197
  }
122
198
  }
199
+ },
200
+ "400": {
201
+ "description": "Bad Request - Invalid request body or field values"
202
+ },
203
+ "401": {
204
+ "description": "Unauthorized - Invalid or missing authentication token"
205
+ },
206
+ "403": {
207
+ "description": "Forbidden - User does not have permission to update this organization"
208
+ },
209
+ "404": {
210
+ "description": "Not Found - Organization with the specified ID does not exist"
123
211
  }
124
212
  }
125
213
  }
126
214
  },
127
215
  "/v2/organization/{org_id}/settings": {
128
216
  "get": {
129
- "description": "Get full organization settings object",
130
217
  "operationId": "getSettings",
131
218
  "summary": "getSettings",
219
+ "description": "Retrieves all configuration settings for an organization.\n\nReturns a key-value map of all settings configured for the organization.\nSettings control various platform features and behaviors including:\n- Feature flags (e.g., double_opt_in, email_tracking)\n- Integration configurations\n- UI preferences\n- Workflow settings\n",
132
220
  "tags": [
133
221
  "Organization Settings"
134
222
  ],
@@ -140,28 +228,55 @@
140
228
  "$ref": "#/components/schemas/OrganizationId"
141
229
  },
142
230
  "required": true,
143
- "description": "The Id of the organization."
231
+ "description": "The unique identifier of the organization"
144
232
  }
145
233
  ],
146
234
  "responses": {
147
235
  "200": {
148
- "description": "Returns the organization settings",
236
+ "description": "Organization settings retrieved successfully",
149
237
  "content": {
150
238
  "application/json": {
151
239
  "schema": {
152
240
  "$ref": "#/components/schemas/Settings"
241
+ },
242
+ "example": {
243
+ "double_opt_in": {
244
+ "enabled": true
245
+ },
246
+ "email_tracking": {
247
+ "enabled": true,
248
+ "track_opens": true,
249
+ "track_clicks": false
250
+ },
251
+ "default_language": "de",
252
+ "workflow_notifications": {
253
+ "enabled": true,
254
+ "channels": [
255
+ "email",
256
+ "in_app"
257
+ ]
258
+ }
153
259
  }
154
260
  }
155
261
  }
262
+ },
263
+ "401": {
264
+ "description": "Unauthorized - Invalid or missing authentication token"
265
+ },
266
+ "403": {
267
+ "description": "Forbidden - User does not have permission to access organization settings"
268
+ },
269
+ "404": {
270
+ "description": "Not Found - Organization with the specified ID does not exist"
156
271
  }
157
272
  }
158
273
  }
159
274
  },
160
275
  "/v2/organization/{org_id}/settings/{key}": {
161
276
  "put": {
162
- "description": "Updates an organization setting",
163
277
  "operationId": "putSettingsValue",
164
278
  "summary": "putSettingsValue",
279
+ "description": "Creates or updates a specific organization setting identified by its key.\n\nThe setting value can be any valid JSON type:\n- String (e.g., \"en\", \"production\")\n- Number (e.g., 100, 3.14)\n- Boolean (e.g., true, false)\n- Object (e.g., {\"enabled\": true, \"threshold\": 50})\n- Array (e.g., [\"email\", \"sms\", \"push\"])\n\nIf the setting key does not exist, it will be created. If it exists, its value\nwill be replaced with the new value.\n",
165
280
  "tags": [
166
281
  "Organization Settings"
167
282
  ],
@@ -173,7 +288,7 @@
173
288
  "$ref": "#/components/schemas/OrganizationId"
174
289
  },
175
290
  "required": true,
176
- "description": "The Id of the organization."
291
+ "description": "The unique identifier of the organization"
177
292
  },
178
293
  {
179
294
  "in": "path",
@@ -182,36 +297,73 @@
182
297
  "type": "string"
183
298
  },
184
299
  "required": true,
185
- "description": "Organization setting key"
300
+ "description": "The setting key to create or update.\nCommon keys include: double_opt_in, email_tracking, default_language, workflow_notifications\n",
301
+ "example": "double_opt_in"
186
302
  }
187
303
  ],
188
304
  "requestBody": {
189
- "description": "Value to set",
305
+ "description": "The value to set for the specified setting key",
306
+ "required": true,
190
307
  "content": {
191
308
  "application/json": {
192
309
  "schema": {
193
310
  "$ref": "#/components/schemas/SettingsValue"
311
+ },
312
+ "examples": {
313
+ "boolean_setting": {
314
+ "summary": "Boolean setting",
315
+ "value": {
316
+ "enabled": true
317
+ }
318
+ },
319
+ "string_setting": {
320
+ "summary": "String setting",
321
+ "value": "de"
322
+ },
323
+ "object_setting": {
324
+ "summary": "Object setting",
325
+ "value": {
326
+ "enabled": true,
327
+ "track_opens": true,
328
+ "track_clicks": false
329
+ }
330
+ }
194
331
  }
195
332
  }
196
333
  }
197
334
  },
198
335
  "responses": {
199
336
  "200": {
200
- "description": "Returns the value of the setting",
337
+ "description": "Setting updated successfully",
201
338
  "content": {
202
339
  "application/json": {
203
340
  "schema": {
204
341
  "$ref": "#/components/schemas/SettingsValue"
342
+ },
343
+ "example": {
344
+ "enabled": true
205
345
  }
206
346
  }
207
347
  }
348
+ },
349
+ "400": {
350
+ "description": "Bad Request - Invalid setting value"
351
+ },
352
+ "401": {
353
+ "description": "Unauthorized - Invalid or missing authentication token"
354
+ },
355
+ "403": {
356
+ "description": "Forbidden - User does not have permission to modify organization settings"
357
+ },
358
+ "404": {
359
+ "description": "Not Found - Organization with the specified ID does not exist"
208
360
  }
209
361
  }
210
362
  },
211
363
  "delete": {
212
- "description": "Updates an organization nsetting",
213
364
  "operationId": "deleteSettingsValue",
214
365
  "summary": "deleteSettingsValue",
366
+ "description": "Removes a specific organization setting identified by its key.\n\nAfter deletion, the setting will no longer appear in the organization's settings\nand any features relying on this setting will use their default behavior.\n",
215
367
  "tags": [
216
368
  "Organization Settings"
217
369
  ],
@@ -223,7 +375,7 @@
223
375
  "$ref": "#/components/schemas/OrganizationId"
224
376
  },
225
377
  "required": true,
226
- "description": "The Id of the organization."
378
+ "description": "The unique identifier of the organization"
227
379
  },
228
380
  {
229
381
  "in": "path",
@@ -232,12 +384,81 @@
232
384
  "type": "string"
233
385
  },
234
386
  "required": true,
235
- "description": "Organization setting key"
387
+ "description": "The setting key to delete",
388
+ "example": "double_opt_in"
236
389
  }
237
390
  ],
238
391
  "responses": {
239
392
  "200": {
240
- "description": "Delete successful"
393
+ "description": "Setting deleted successfully"
394
+ },
395
+ "401": {
396
+ "description": "Unauthorized - Invalid or missing authentication token"
397
+ },
398
+ "403": {
399
+ "description": "Forbidden - User does not have permission to delete organization settings"
400
+ },
401
+ "404": {
402
+ "description": "Not Found - Organization or setting key does not exist"
403
+ }
404
+ }
405
+ }
406
+ },
407
+ "/v2/organization/feature-settings": {
408
+ "get": {
409
+ "operationId": "getOrganizationFeatureSettings",
410
+ "summary": "Get organization feature settings",
411
+ "description": "Returns feature flag metadata for the organization UI.\n\nThis data is static (identical for all organizations) and changes infrequently.\nClients should cache responses using the Cache-Control header.\n",
412
+ "tags": [
413
+ "Feature Settings"
414
+ ],
415
+ "responses": {
416
+ "200": {
417
+ "description": "Feature settings",
418
+ "headers": {
419
+ "cache-control": {
420
+ "schema": {
421
+ "type": "string",
422
+ "example": "public, max-age=3600"
423
+ }
424
+ }
425
+ },
426
+ "content": {
427
+ "application/json": {
428
+ "schema": {
429
+ "$ref": "#/components/schemas/FeatureSettings"
430
+ }
431
+ }
432
+ }
433
+ },
434
+ "401": {
435
+ "description": "Unauthorized - Invalid or missing authentication token"
436
+ }
437
+ }
438
+ }
439
+ },
440
+ "/v2/feature-settings": {
441
+ "get": {
442
+ "operationId": "getFeatureSettings",
443
+ "deprecated": true,
444
+ "summary": "Get platform configuration metadata",
445
+ "description": "Deprecated: use /v2/organization/feature-settings instead.",
446
+ "tags": [
447
+ "Feature Settings"
448
+ ],
449
+ "responses": {
450
+ "200": {
451
+ "description": "Platform configuration metadata",
452
+ "content": {
453
+ "application/json": {
454
+ "schema": {
455
+ "$ref": "#/components/schemas/FeatureSettings"
456
+ }
457
+ }
458
+ }
459
+ },
460
+ "401": {
461
+ "description": "Unauthorized - Invalid or missing authentication token"
241
462
  }
242
463
  }
243
464
  }
@@ -255,10 +476,12 @@
255
476
  "schemas": {
256
477
  "OrganizationId": {
257
478
  "type": "string",
479
+ "description": "Unique identifier for an organization (tenant) in the epilot platform",
258
480
  "example": "739224"
259
481
  },
260
482
  "Organization": {
261
483
  "type": "object",
484
+ "description": "Represents an epilot organization (tenant).\n\nAn organization contains all the configuration, branding, and contact information\nfor a tenant account on the epilot platform.\n",
262
485
  "properties": {
263
486
  "id": {
264
487
  "$ref": "#/components/schemas/OrganizationId"
@@ -316,6 +539,7 @@
316
539
  },
317
540
  "organization_use": {
318
541
  "type": "string",
542
+ "description": "Indicates whether this is a production or sandbox organization.\nSandbox organizations are linked to a parent production organization for testing purposes.\n",
319
543
  "enum": [
320
544
  "Production",
321
545
  "Sandbox"
@@ -324,6 +548,7 @@
324
548
  },
325
549
  "parent_production_org_id": {
326
550
  "type": "string",
551
+ "description": "The ID of the parent production organization.\nOnly set for sandbox organizations to link them to their production counterpart.\n",
327
552
  "nullable": true
328
553
  },
329
554
  "created_date": {
@@ -389,10 +614,20 @@
389
614
  "type": "number",
390
615
  "example": 50,
391
616
  "nullable": true
617
+ },
618
+ "tags": {
619
+ "type": "array",
620
+ "description": "Labels/tags associated with the organization for categorization and filtering.\nUsed internally to classify organizations (e.g., \"enterprise\", \"beta-tester\", \"test org\").\n",
621
+ "items": {
622
+ "type": "string",
623
+ "example": "test org"
624
+ },
625
+ "nullable": true
392
626
  }
393
627
  }
394
628
  },
395
629
  "InternalOrganization": {
630
+ "description": "Extended organization object with internal-only fields.\n\nIncludes all fields from the base Organization schema plus additional\ninternal metadata used for platform administration and support.\n",
396
631
  "allOf": [
397
632
  {
398
633
  "$ref": "#/components/schemas/Organization"
@@ -401,18 +636,26 @@
401
636
  },
402
637
  "SettingKey": {
403
638
  "type": "string",
639
+ "description": "A unique key identifying an organization setting.\nCommon setting keys include: double_opt_in, email_tracking, default_language, workflow_notifications\n",
404
640
  "example": "double_opt_in"
405
641
  },
406
642
  "Settings": {
407
643
  "type": "object",
644
+ "description": "A key-value map of all organization settings.\nKeys are setting identifiers and values can be any valid JSON type.\n",
408
645
  "additionalProperties": true,
409
646
  "example": {
410
647
  "double_opt_in": {
411
648
  "enabled": true
412
- }
649
+ },
650
+ "email_tracking": {
651
+ "enabled": true,
652
+ "track_opens": true
653
+ },
654
+ "default_language": "de"
413
655
  }
414
656
  },
415
657
  "SettingsValue": {
658
+ "description": "The value of an organization setting.\nCan be any valid JSON type: string, number, boolean, array, or object.\n",
416
659
  "anyOf": [
417
660
  {
418
661
  "type": "string"
@@ -441,9 +684,10 @@
441
684
  },
442
685
  "CreateOrganizationRequest": {
443
686
  "type": "object",
687
+ "description": "Request payload for creating a new organization",
444
688
  "properties": {
445
689
  "organization_detail": {
446
- "description": "Organization detail",
690
+ "description": "Core organization information for the new tenant",
447
691
  "type": "object",
448
692
  "required": [
449
693
  "name",
@@ -452,21 +696,22 @@
452
696
  ],
453
697
  "properties": {
454
698
  "name": {
455
- "description": "Organization name",
699
+ "description": "Display name for the organization",
456
700
  "type": "string",
457
701
  "example": "epilot"
458
702
  },
459
703
  "email_address": {
460
- "description": "Organization email address",
704
+ "description": "Primary contact email for the organization",
461
705
  "type": "string",
462
706
  "example": "epilot@epilot.cloud"
463
707
  },
464
708
  "type": {
465
- "description": "type",
709
+ "description": "Organization type classification.\n- Vendor: Primary organization type for epilot customers\n- Partner: Partner organization type\n",
466
710
  "type": "string",
467
711
  "example": "Vendor"
468
712
  },
469
713
  "organization_use": {
714
+ "description": "Whether this is a production or sandbox environment.\nSandbox organizations are for testing and linked to a production org.\n",
470
715
  "type": "string",
471
716
  "enum": [
472
717
  "Production",
@@ -474,24 +719,26 @@
474
719
  ]
475
720
  },
476
721
  "pricing_tier_id": {
477
- "description": "Pricing tier ID",
722
+ "description": "The ULID of the pricing tier to assign to this organization.\nDetermines feature access and billing.\n",
478
723
  "type": "string",
479
724
  "example": "01GEKHZHSN19KK10ZS92Y3WY9B"
480
725
  }
481
726
  }
482
727
  },
483
728
  "owner_user": {
484
- "description": "Owner user will receive invitation",
729
+ "description": "Initial owner user details.\nThis user will receive an invitation email to complete registration\nand become the organization administrator.\n",
485
730
  "type": "object",
486
731
  "required": [
487
732
  "email_address"
488
733
  ],
489
734
  "properties": {
490
735
  "full_name": {
736
+ "description": "Full name of the owner user",
491
737
  "type": "string",
492
738
  "example": "Ny Huynh"
493
739
  },
494
740
  "email_address": {
741
+ "description": "Email address for the invitation (must be unique in the platform)",
495
742
  "type": "string",
496
743
  "example": "ny.huynhthi@axonactive.com"
497
744
  }
@@ -501,25 +748,27 @@
501
748
  },
502
749
  "DataPointsResponse": {
503
750
  "type": "array",
751
+ "description": "List of data point metrics for all organizations",
504
752
  "items": {
505
753
  "$ref": "#/components/schemas/DataPoint"
506
754
  }
507
755
  },
508
756
  "DataPoint": {
509
757
  "type": "object",
758
+ "description": "Data point metrics for a single organization, used for usage tracking and billing",
510
759
  "properties": {
511
760
  "id": {
512
- "description": "Organization id",
761
+ "description": "The organization ID (numeric format)",
513
762
  "type": "number",
514
763
  "example": 206801
515
764
  },
516
765
  "max_customer": {
517
- "description": "Max customer data points last month",
766
+ "description": "Maximum number of customer entities recorded in the previous month.\nUsed as a high-water mark for billing calculations.\n",
518
767
  "type": "number",
519
768
  "example": 10
520
769
  },
521
770
  "actual_customer": {
522
- "description": "Actual customer data points",
771
+ "description": "Current count of customer entities in the organization.\nRepresents the actual usage at the time of the query.\n",
523
772
  "type": "number",
524
773
  "example": 10
525
774
  }
@@ -527,6 +776,7 @@
527
776
  },
528
777
  "OrganizationToCleanup": {
529
778
  "type": "object",
779
+ "description": "Represents an organization that has been marked for deletion and requires cleanup.\nContains metadata about the deletion request.\n",
530
780
  "required": [
531
781
  "org_id",
532
782
  "deleted_at",
@@ -537,11 +787,13 @@
537
787
  "$ref": "#/components/schemas/OrganizationId"
538
788
  },
539
789
  "deleted_at": {
790
+ "description": "Timestamp when the organization was marked for deletion",
540
791
  "type": "string",
541
792
  "format": "date-time",
542
793
  "example": "2021-06-01T00:00:00Z"
543
794
  },
544
795
  "deleted_by": {
796
+ "description": "User ID of the person who initiated the deletion",
545
797
  "type": "string",
546
798
  "example": "123456"
547
799
  }
@@ -549,6 +801,7 @@
549
801
  },
550
802
  "OrganizationCleanupStatus": {
551
803
  "type": "object",
804
+ "description": "Records the cleanup status reported by a specific service for an organization.\nEach service that stores organization data reports its cleanup operations here.\n",
552
805
  "required": [
553
806
  "org_id",
554
807
  "service_name"
@@ -558,36 +811,29 @@
558
811
  "$ref": "#/components/schemas/OrganizationId"
559
812
  },
560
813
  "service_name": {
814
+ "description": "Name of the service reporting its cleanup status",
561
815
  "type": "string",
562
816
  "example": "organization-api"
563
817
  },
564
818
  "operations": {
565
- "example": [
566
- {
567
- "action": "Delete",
568
- "resource": "OrgTable",
569
- "extra_info": "pk: ORG#739224"
570
- },
571
- {
572
- "action": "Archive",
573
- "resource": "s3://my-bucket",
574
- "extra_info": "my-bucket/my-key.txt"
575
- }
576
- ],
819
+ "description": "List of cleanup operations performed by the service.\nEach operation describes what action was taken on which resource.\n",
577
820
  "type": "array",
578
821
  "items": {
579
822
  "type": "object",
580
823
  "additionalProperties": true,
581
824
  "properties": {
582
825
  "action": {
826
+ "description": "The type of cleanup action performed.\nCommon values: Delete, Archive, Purge\n",
583
827
  "type": "string",
584
828
  "example": "Delete"
585
829
  },
586
830
  "resource": {
831
+ "description": "The resource that was cleaned up.\nCan be a table name, S3 bucket, or other resource identifier.\n",
587
832
  "type": "string",
588
833
  "example": "OrgTable"
589
834
  },
590
835
  "extra_info": {
836
+ "description": "Additional context about the cleanup operation",
591
837
  "anyOf": [
592
838
  {
593
839
  "type": "string"
@@ -612,6 +858,326 @@
612
858
  ]
613
859
  }
614
860
  }
861
+ },
862
+ "example": [
863
+ {
864
+ "action": "Delete",
865
+ "resource": "OrgTable",
866
+ "extra_info": "pk: ORG#739224"
867
+ },
868
+ {
869
+ "action": "Archive",
870
+ "resource": "s3://my-bucket",
871
+ "extra_info": "my-bucket/my-key.txt"
872
+ }
873
+ ]
874
+ }
875
+ }
876
+ },
877
+ "HubspotCompany": {
878
+ "type": "object",
879
+ "description": "Represents a company record from HubSpot CRM synchronized to the epilot data warehouse.\nUsed for CRM integration and organization mapping.\n",
880
+ "properties": {
881
+ "company_id": {
882
+ "type": "string",
883
+ "description": "The unique HubSpot company identifier",
884
+ "example": "12345678901"
885
+ },
886
+ "company_name": {
887
+ "type": "string",
888
+ "nullable": true,
889
+ "description": "The display name of the company in HubSpot",
890
+ "example": "Acme Corp"
891
+ },
892
+ "domain": {
893
+ "type": "string",
894
+ "nullable": true,
895
+ "description": "The primary web domain associated with the company",
896
+ "example": "acme.com"
897
+ }
898
+ }
899
+ },
900
+ "HubspotCompaniesResponse": {
901
+ "type": "object",
902
+ "description": "Response containing a list of HubSpot companies matching the search criteria",
903
+ "properties": {
904
+ "results": {
905
+ "type": "array",
906
+ "description": "List of HubSpot companies matching the query",
907
+ "items": {
908
+ "$ref": "#/components/schemas/HubspotCompany"
909
+ }
910
+ },
911
+ "total": {
912
+ "type": "integer",
913
+ "description": "Total number of companies in the response",
914
+ "example": 10
915
+ }
916
+ }
917
+ },
918
+ "HubspotOrganizationData": {
919
+ "type": "object",
920
+ "description": "HubSpot company data associated with an epilot organization.\nContains business metrics and CRM properties synced from HubSpot.\n",
921
+ "properties": {
922
+ "company_id": {
923
+ "type": "string",
924
+ "description": "The unique HubSpot company identifier",
925
+ "example": "5278308807"
926
+ },
927
+ "company_name": {
928
+ "type": "string",
929
+ "nullable": true,
930
+ "description": "The display name of the company in HubSpot",
931
+ "example": "Stadtwerke Meerbusch Willich Netz"
932
+ },
933
+ "domain": {
934
+ "type": "string",
935
+ "nullable": true,
936
+ "description": "The primary web domain associated with the company",
937
+ "example": "stadtwerke-service.de"
938
+ },
939
+ "current_mrr": {
940
+ "type": "string",
941
+ "nullable": true,
942
+ "description": "Current Monthly Recurring Revenue",
943
+ "example": "11033.33"
944
+ },
945
+ "potential_mrr": {
946
+ "type": "string",
947
+ "nullable": true,
948
+ "description": "Potential Monthly Recurring Revenue",
949
+ "example": "20000"
950
+ },
951
+ "company_size": {
952
+ "type": "string",
953
+ "nullable": true,
954
+ "description": "Company size classification",
955
+ "example": "Large"
956
+ },
957
+ "pricing_tier": {
958
+ "type": "string",
959
+ "nullable": true,
960
+ "description": "Current pricing tier",
961
+ "example": "Professional"
962
+ },
963
+ "lifecyclestage": {
964
+ "type": "string",
965
+ "nullable": true,
966
+ "description": "HubSpot lifecycle stage",
967
+ "example": "customer"
968
+ },
969
+ "industry": {
970
+ "type": "string",
971
+ "nullable": true,
972
+ "description": "Industry classification",
973
+ "example": "Energiedienstleister"
974
+ },
975
+ "numberofemployees": {
976
+ "type": "string",
977
+ "nullable": true,
978
+ "description": "Number of employees",
979
+ "example": "200"
980
+ },
981
+ "customer_number": {
982
+ "type": "string",
983
+ "nullable": true,
984
+ "description": "epilot customer number",
985
+ "example": "10031"
986
+ },
987
+ "no_of_users": {
988
+ "type": "string",
989
+ "nullable": true,
990
+ "description": "Number of active users",
991
+ "example": "34"
992
+ },
993
+ "activation_rate": {
994
+ "type": "string",
995
+ "nullable": true,
996
+ "description": "User activation rate",
997
+ "example": "0.647059"
998
+ },
999
+ "active_features": {
1000
+ "type": "string",
1001
+ "nullable": true,
1002
+ "description": "List of active features",
1003
+ "example": "Installer Portal"
1004
+ },
1005
+ "usecases_implemented": {
1006
+ "type": "string",
1007
+ "nullable": true,
1008
+ "description": "Implemented use cases",
1009
+ "example": "GRID: Installations (MGA);GRID: House Connections"
1010
+ },
1011
+ "buyer_journey": {
1012
+ "type": "string",
1013
+ "nullable": true,
1014
+ "description": "Current buyer's journey stage",
1015
+ "example": "Expansion-Ready"
1016
+ },
1017
+ "country": {
1018
+ "type": "string",
1019
+ "nullable": true,
1020
+ "description": "Company country",
1021
+ "example": "Germany"
1022
+ },
1023
+ "city": {
1024
+ "type": "string",
1025
+ "nullable": true,
1026
+ "description": "Company city",
1027
+ "example": "Willich"
1028
+ },
1029
+ "properties": {
1030
+ "type": "object",
1031
+ "additionalProperties": true,
1032
+ "description": "Full HubSpot properties object with all available fields"
1033
+ }
1034
+ }
1035
+ },
1036
+ "FeatureSettings": {
1037
+ "type": "object",
1038
+ "description": "Feature settings metadata served to frontend applications.",
1039
+ "required": [
1040
+ "version",
1041
+ "feature_flags"
1042
+ ],
1043
+ "properties": {
1044
+ "version": {
1045
+ "type": "string",
1046
+ "description": "Schema version for backwards compatibility",
1047
+ "example": "1.0.0"
1048
+ },
1049
+ "feature_flags": {
1050
+ "type": "array",
1051
+ "description": "Feature flag metadata for the settings page",
1052
+ "items": {
1053
+ "$ref": "#/components/schemas/FeatureFlagMetadata"
1054
+ }
1055
+ }
1056
+ }
1057
+ },
1058
+ "FeatureFlagMetadata": {
1059
+ "type": "object",
1060
+ "description": "Metadata for a single feature flag toggle",
1061
+ "required": [
1062
+ "feature_name",
1063
+ "visibility_rules"
1064
+ ],
1065
+ "properties": {
1066
+ "feature_name": {
1067
+ "type": "string",
1068
+ "description": "Unique identifier matching the organization setting key",
1069
+ "example": "canary"
1070
+ },
1071
+ "title": {
1072
+ "$ref": "#/components/schemas/I18nString"
1073
+ },
1074
+ "description": {
1075
+ "$ref": "#/components/schemas/I18nString"
1076
+ },
1077
+ "badge": {
1078
+ "type": "string",
1079
+ "description": "Badge label shown next to the feature toggle",
1080
+ "enum": [
1081
+ "alpha",
1082
+ "beta",
1083
+ "new",
1084
+ "advanced",
1085
+ "experiment",
1086
+ "deprecated"
1087
+ ]
1088
+ },
1089
+ "confetti": {
1090
+ "type": "boolean",
1091
+ "description": "Whether to show confetti animation when enabled"
1092
+ },
1093
+ "one_way": {
1094
+ "type": "boolean",
1095
+ "description": "Whether the toggle can only be turned on (not off)"
1096
+ },
1097
+ "reverse_checked": {
1098
+ "type": "boolean",
1099
+ "description": "Whether the toggle value is inverted (checked = disabled)"
1100
+ },
1101
+ "is_visible_for_partner": {
1102
+ "type": "boolean",
1103
+ "description": "Whether this feature is visible for partner organizations"
1104
+ },
1105
+ "visibility_rules": {
1106
+ "type": "array",
1107
+ "description": "Rules that must ALL pass for this feature to be visible (implicit AND)",
1108
+ "items": {
1109
+ "$ref": "#/components/schemas/VisibilityRule"
1110
+ }
1111
+ }
1112
+ }
1113
+ },
1114
+ "I18nString": {
1115
+ "type": "object",
1116
+ "description": "Internationalized string with a translation key and optional default value",
1117
+ "required": [
1118
+ "key"
1119
+ ],
1120
+ "properties": {
1121
+ "key": {
1122
+ "type": "string",
1123
+ "description": "Translation key for i18n lookup",
1124
+ "example": "canary_setting.title"
1125
+ },
1126
+ "default_value": {
1127
+ "type": "string",
1128
+ "description": "Fallback value when translation is not available",
1129
+ "example": "Canary Updates"
1130
+ }
1131
+ }
1132
+ },
1133
+ "VisibilityRule": {
1134
+ "type": "object",
1135
+ "description": "A rule that determines feature visibility. Rules are combined with AND logic\nat the top level. Supports boolean combinators (and, or, not) for complex logic.\n",
1136
+ "required": [
1137
+ "type"
1138
+ ],
1139
+ "properties": {
1140
+ "type": {
1141
+ "type": "string",
1142
+ "description": "The rule type discriminator",
1143
+ "enum": [
1144
+ "always",
1145
+ "never",
1146
+ "advanced_mode",
1147
+ "pricing_tier",
1148
+ "feature_flag",
1149
+ "permission",
1150
+ "setting_enabled",
1151
+ "flag_enabled",
1152
+ "not",
1153
+ "and",
1154
+ "or"
1155
+ ]
1156
+ },
1157
+ "setting_key": {
1158
+ "type": "string",
1159
+ "description": "Setting key for pricing_tier and setting_enabled rules"
1160
+ },
1161
+ "flag_name": {
1162
+ "type": "string",
1163
+ "description": "Flag name for feature_flag and flag_enabled rules"
1164
+ },
1165
+ "action": {
1166
+ "type": "string",
1167
+ "description": "Permission action for permission rules"
1168
+ },
1169
+ "resource": {
1170
+ "type": "string",
1171
+ "description": "Optional resource for permission rules"
1172
+ },
1173
+ "rule": {
1174
+ "$ref": "#/components/schemas/VisibilityRule"
1175
+ },
1176
+ "rules": {
1177
+ "type": "array",
1178
+ "description": "Child rules for and/or combinators",
1179
+ "items": {
1180
+ "$ref": "#/components/schemas/VisibilityRule"
615
1181
  }
616
1182
  }
617
1183
  }
@@ -619,9 +1185,6 @@
619
1185
  }
620
1186
  },
621
1187
  "servers": [
622
- {
623
- "url": "https://organization-v2.sls.epilot.io"
624
- },
625
1188
  {
626
1189
  "url": "https://organization-v2.sls.epilot.io"
627
1190
  }