@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
@@ -0,0 +1,3234 @@
1
+ # Blueprint Manifest API
2
+
3
+ - **Base URL:** `https://blueprint-manifest.sls.epilot.io`
4
+ - **Full API Docs:** [https://docs.epilot.io/api/blueprint-manifest](https://docs.epilot.io/api/blueprint-manifest)
5
+
6
+ ## Usage
7
+
8
+ ```ts
9
+ import { epilot } from '@epilot/sdk'
10
+
11
+ epilot.authorize(() => '<token>')
12
+ const { data } = await epilot.blueprintManifest.getJob(...)
13
+ ```
14
+
15
+ ### Tree-shakeable import
16
+
17
+ ```ts
18
+ import { getClient, authorize } from '@epilot/sdk/blueprint-manifest'
19
+
20
+ const blueprintManifestClient = getClient()
21
+ authorize(blueprintManifestClient, () => '<token>')
22
+ const { data } = await blueprintManifestClient.getJob(...)
23
+ ```
24
+
25
+ ## Operations
26
+
27
+ **Import**
28
+ - [`uploadManifest`](#uploadmanifest)
29
+
30
+ **Blueprints**
31
+ - [`listBlueprints`](#listblueprints)
32
+ - [`createBlueprint`](#createblueprint)
33
+ - [`listInstalledMarketplaceBlueprints`](#listinstalledmarketplaceblueprints)
34
+ - [`preInstallBlueprint`](#preinstallblueprint)
35
+ - [`getBlueprintPreview`](#getblueprintpreview)
36
+ - [`installBlueprint`](#installblueprint)
37
+ - [`getBlueprint`](#getblueprint)
38
+ - [`updateBlueprint`](#updateblueprint)
39
+ - [`deleteBlueprint`](#deleteblueprint)
40
+ - [`validateBlueprint`](#validateblueprint)
41
+ - [`exportBlueprint`](#exportblueprint)
42
+ - [`listMarketplaceSlugs`](#listmarketplaceslugs)
43
+ - [`publishBlueprint`](#publishblueprint)
44
+ - [`formatBlueprintDescription`](#formatblueprintdescription)
45
+ - [`addBlueprintResource`](#addblueprintresource)
46
+ - [`syncDependencies`](#syncdependencies)
47
+ - [`bulkAddBlueprintResources`](#bulkaddblueprintresources)
48
+ - [`bulkUpdateBlueprintResources`](#bulkupdateblueprintresources)
49
+ - [`bulkDeleteBlueprintResources`](#bulkdeleteblueprintresources)
50
+ - [`updateBlueprintResource`](#updateblueprintresource)
51
+ - [`deleteBlueprintResource`](#deleteblueprintresource)
52
+
53
+ **Jobs**
54
+ - [`listBlueprintJobs`](#listblueprintjobs)
55
+ - [`getBlueprintJob`](#getblueprintjob)
56
+ - [`continueInstallationJob`](#continueinstallationjob)
57
+ - [`cancelBlueprintJob`](#cancelblueprintjob)
58
+
59
+ **Schemas**
60
+ - [`BlueprintID`](#blueprintid)
61
+ - [`BlueprintResourceID`](#blueprintresourceid)
62
+ - [`CommonBlueprintFields`](#commonblueprintfields)
63
+ - [`BlueprintResource`](#blueprintresource)
64
+ - [`BlueprintPreview`](#blueprintpreview)
65
+ - [`CustomBlueprint`](#customblueprint)
66
+ - [`FileBlueprint`](#fileblueprint)
67
+ - [`MarketplaceBlueprint`](#marketplaceblueprint)
68
+ - [`InstalledMarketplaceBlueprintItem`](#installedmarketplaceblueprintitem)
69
+ - [`DeployedBlueprint`](#deployedblueprint)
70
+ - [`AppBlueprint`](#appblueprint)
71
+ - [`Blueprint`](#blueprint)
72
+ - [`BlueprintJobID`](#blueprintjobid)
73
+ - [`CommonBlueprintJobFields`](#commonblueprintjobfields)
74
+ - [`BlueprintExportJob`](#blueprintexportjob)
75
+ - [`BlueprintInstallationJob`](#blueprintinstallationjob)
76
+ - [`BlueprintJob`](#blueprintjob)
77
+ - [`BlueprintDependenciesSyncJob`](#blueprintdependenciessyncjob)
78
+ - [`BlueprintValidateJob`](#blueprintvalidatejob)
79
+ - [`BlueprintJobEvent`](#blueprintjobevent)
80
+ - [`BlueprintInstallationJobOptions`](#blueprintinstallationjoboptions)
81
+ - [`ManifestID`](#manifestid)
82
+ - [`JobID`](#jobid)
83
+ - [`ManifestSource`](#manifestsource)
84
+ - [`Manifest`](#manifest)
85
+ - [`ManifestItem`](#manifestitem)
86
+ - [`JobStatus`](#jobstatus)
87
+ - [`ResourceNodeType`](#resourcenodetype)
88
+ - [`PlanChanges`](#planchanges)
89
+ - [`CommonResourceNode`](#commonresourcenode)
90
+ - [`RootResourceNode`](#rootresourcenode)
91
+ - [`VirtualResourceNodeGroup`](#virtualresourcenodegroup)
92
+ - [`ResourceNode`](#resourcenode)
93
+ - [`Job`](#job)
94
+ - [`UploadFilePayload`](#uploadfilepayload)
95
+ - [`S3Reference`](#s3reference)
96
+ - [`CommonManifestFields`](#commonmanifestfields)
97
+ - [`ManifestTimestampFields`](#manifesttimestampfields)
98
+ - [`CommonImportFields`](#commonimportfields)
99
+ - [`CommonMarkdownFields`](#commonmarkdownfields)
100
+ - [`PreInstallRequirements`](#preinstallrequirements)
101
+ - [`BlueprintInstallStatus`](#blueprintinstallstatus)
102
+ - [`FormattedErrorCodes`](#formattederrorcodes)
103
+ - [`FormattedErrorData`](#formattederrordata)
104
+ - [`FormattedError`](#formattederror)
105
+ - [`CallerIdentity`](#calleridentity)
106
+ - [`SelectedResources`](#selectedresources)
107
+ - [`ResourceReplacement`](#resourcereplacement)
108
+ - [`PutManifestPayload`](#putmanifestpayload)
109
+
110
+ ### `uploadManifest`
111
+
112
+ Create pre-signed S3 URL to upload a manifest file.
113
+
114
+ `POST /v1/blueprint-manifest:uploadManifest`
115
+
116
+ ```ts
117
+ const { data } = await client.uploadManifest(
118
+ null,
119
+ {
120
+ filename: 'example.manifest.zip'
121
+ },
122
+ )
123
+ ```
124
+
125
+ <details>
126
+ <summary>Response</summary>
127
+
128
+ ```json
129
+ {
130
+ "s3ref": {
131
+ "bucket": "blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw",
132
+ "key": "templates/main.tf"
133
+ },
134
+ "upload_url": "https://epilot-dev-blueprints.s3.eu-central-1.amazonaws.com/templates/document.pdf"
135
+ }
136
+ ```
137
+
138
+ </details>
139
+
140
+ ---
141
+
142
+ ### `listBlueprints`
143
+
144
+ List Custom and Installed Blueprints
145
+
146
+ `GET /v2/blueprint-manifest/blueprints`
147
+
148
+ ```ts
149
+ const { data } = await client.listBlueprints({
150
+ archived: true,
151
+ })
152
+ ```
153
+
154
+ <details>
155
+ <summary>Response</summary>
156
+
157
+ ```json
158
+ {
159
+ "total": 1,
160
+ "results": [
161
+ {
162
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
163
+ "title": "string",
164
+ "slug": "string",
165
+ "description": {
166
+ "preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
167
+ "postinstall": "This is the content of the postinstall.md file\n"
168
+ },
169
+ "version": "string",
170
+ "deployments": [
171
+ {
172
+ "source_org_id": "string",
173
+ "source_blueprint_id": "string",
174
+ "destination_org_id": "string",
175
+ "destination_blueprint_id": "string",
176
+ "triggered_at": "1970-01-01T00:00:00.000Z"
177
+ }
178
+ ],
179
+ "is_verified": true,
180
+ "installation_status": "IN_PROGRESS",
181
+ "created_at": "1970-01-01T00:00:00.000Z",
182
+ "updated_at": "1970-01-01T00:00:00.000Z",
183
+ "created_by": {
184
+ "name": "manifest@epilot.cloud",
185
+ "org_id": "911690",
186
+ "user_id": "11001045",
187
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
188
+ },
189
+ "updated_by": {
190
+ "name": "manifest@epilot.cloud",
191
+ "org_id": "911690",
192
+ "user_id": "11001045",
193
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
194
+ },
195
+ "installation_job_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
196
+ "source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
197
+ "archived": false,
198
+ "docs_url": "string",
199
+ "recommended_apps": ["string"],
200
+ "required_features": {
201
+ "enabled": ["string"],
202
+ "disabled": ["string"]
203
+ },
204
+ "zip_file_name": "string",
205
+ "resources": [
206
+ {
207
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
208
+ "name": "string",
209
+ "type": "designbuilder",
210
+ "address": "string",
211
+ "is_root": true,
212
+ "is_ready": true,
213
+ "is_hidden": true,
214
+ "is_disabled": false,
215
+ "hard_dependencies": ["designbuilder"],
216
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
217
+ "depends_on_addresses": ["string"],
218
+ "impact_on_install": ["create"],
219
+ "impact_on_install_reason": ["string"]
220
+ }
221
+ ],
222
+ "source_type": "string"
223
+ }
224
+ ]
225
+ }
226
+ ```
227
+
228
+ </details>
229
+
230
+ ---
231
+
232
+ ### `createBlueprint`
233
+
234
+ Create a Blueprint
235
+
236
+ `POST /v2/blueprint-manifest/blueprints`
237
+
238
+ ```ts
239
+ const { data } = await client.createBlueprint(
240
+ null,
241
+ {
242
+ id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
243
+ title: 'string',
244
+ slug: 'string',
245
+ description: {
246
+ preinstall: 'This is the content of the preinstall.md file which contains the blueprint description.
247
+ ',
248
+ postinstall: 'This is the content of the postinstall.md file
249
+ '
250
+ },
251
+ version: 'string',
252
+ deployments: [
253
+ {
254
+ source_org_id: 'string',
255
+ source_blueprint_id: 'string',
256
+ destination_org_id: 'string',
257
+ destination_blueprint_id: 'string',
258
+ triggered_at: '1970-01-01T00:00:00.000Z'
259
+ }
260
+ ],
261
+ is_verified: true,
262
+ installation_status: 'IN_PROGRESS',
263
+ created_at: '1970-01-01T00:00:00.000Z',
264
+ updated_at: '1970-01-01T00:00:00.000Z',
265
+ created_by: {
266
+ name: 'manifest@epilot.cloud',
267
+ org_id: '911690',
268
+ user_id: '11001045',
269
+ token_id: 'api_5ZugdRXasLfWBypHi93Fk'
270
+ },
271
+ updated_by: {
272
+ name: 'manifest@epilot.cloud',
273
+ org_id: '911690',
274
+ user_id: '11001045',
275
+ token_id: 'api_5ZugdRXasLfWBypHi93Fk'
276
+ },
277
+ installation_job_ids: ['c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341'],
278
+ source_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
279
+ archived: false,
280
+ docs_url: 'string',
281
+ recommended_apps: ['string'],
282
+ required_features: {
283
+ enabled: ['string'],
284
+ disabled: ['string']
285
+ },
286
+ zip_file_name: 'string',
287
+ resources: [
288
+ {
289
+ id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
290
+ name: 'string',
291
+ type: 'designbuilder',
292
+ address: 'string',
293
+ is_root: true,
294
+ is_ready: true,
295
+ is_hidden: true,
296
+ is_disabled: false,
297
+ hard_dependencies: ['designbuilder'],
298
+ parent_resource_ids: ['c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341'],
299
+ depends_on_addresses: ['string'],
300
+ impact_on_install: ['create'],
301
+ impact_on_install_reason: ['string']
302
+ }
303
+ ],
304
+ source_type: 'string'
305
+ },
306
+ )
307
+ ```
308
+
309
+ <details>
310
+ <summary>Response</summary>
311
+
312
+ ```json
313
+ {
314
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
315
+ "title": "string",
316
+ "slug": "string",
317
+ "description": {
318
+ "preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
319
+ "postinstall": "This is the content of the postinstall.md file\n"
320
+ },
321
+ "version": "string",
322
+ "deployments": [
323
+ {
324
+ "source_org_id": "string",
325
+ "source_blueprint_id": "string",
326
+ "destination_org_id": "string",
327
+ "destination_blueprint_id": "string",
328
+ "triggered_at": "1970-01-01T00:00:00.000Z"
329
+ }
330
+ ],
331
+ "is_verified": true,
332
+ "installation_status": "IN_PROGRESS",
333
+ "created_at": "1970-01-01T00:00:00.000Z",
334
+ "updated_at": "1970-01-01T00:00:00.000Z",
335
+ "created_by": {
336
+ "name": "manifest@epilot.cloud",
337
+ "org_id": "911690",
338
+ "user_id": "11001045",
339
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
340
+ },
341
+ "updated_by": {
342
+ "name": "manifest@epilot.cloud",
343
+ "org_id": "911690",
344
+ "user_id": "11001045",
345
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
346
+ },
347
+ "installation_job_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
348
+ "source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
349
+ "archived": false,
350
+ "docs_url": "string",
351
+ "recommended_apps": ["string"],
352
+ "required_features": {
353
+ "enabled": ["string"],
354
+ "disabled": ["string"]
355
+ },
356
+ "zip_file_name": "string",
357
+ "resources": [
358
+ {
359
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
360
+ "name": "string",
361
+ "type": "designbuilder",
362
+ "address": "string",
363
+ "is_root": true,
364
+ "is_ready": true,
365
+ "is_hidden": true,
366
+ "is_disabled": false,
367
+ "hard_dependencies": ["designbuilder"],
368
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
369
+ "depends_on_addresses": ["string"],
370
+ "impact_on_install": ["create"],
371
+ "impact_on_install_reason": ["string"]
372
+ }
373
+ ],
374
+ "source_type": "string"
375
+ }
376
+ ```
377
+
378
+ </details>
379
+
380
+ ---
381
+
382
+ ### `listInstalledMarketplaceBlueprints`
383
+
384
+ List installed Marketplace Blueprints for the organization.
385
+ When multiple blueprints have the same slug, returns only the most recently created one.
386
+
387
+ `GET /v2/blueprint-manifest/blueprints:marketplace`
388
+
389
+ ```ts
390
+ const { data } = await client.listInstalledMarketplaceBlueprints()
391
+ ```
392
+
393
+ <details>
394
+ <summary>Response</summary>
395
+
396
+ ```json
397
+ {
398
+ "total": 1,
399
+ "results": [
400
+ {
401
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
402
+ "slug": "solar-b2b",
403
+ "version": "v1.0.0",
404
+ "created_at": "1970-01-01T00:00:00.000Z",
405
+ "created_by": {
406
+ "name": "manifest@epilot.cloud",
407
+ "org_id": "911690",
408
+ "user_id": "11001045",
409
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
410
+ },
411
+ "updated_at": "1970-01-01T00:00:00.000Z",
412
+ "updated_by": {
413
+ "name": "manifest@epilot.cloud",
414
+ "org_id": "911690",
415
+ "user_id": "11001045",
416
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
417
+ },
418
+ "has_update_available": true,
419
+ "latest_marketplace_version": "v2.0.0",
420
+ "installation_link": "string"
421
+ }
422
+ ]
423
+ }
424
+ ```
425
+
426
+ </details>
427
+
428
+ ---
429
+
430
+ ### `preInstallBlueprint`
431
+
432
+ Pre-install a Blueprint based on a blueprint file
433
+
434
+ `POST /v2/blueprint-manifest/blueprints:pre-install`
435
+
436
+ ```ts
437
+ const { data } = await client.preInstallBlueprint(
438
+ null,
439
+ {
440
+ blueprint_file: 'string',
441
+ source_blueprint_type: 'marketplace',
442
+ slug: 'string'
443
+ },
444
+ )
445
+ ```
446
+
447
+ <details>
448
+ <summary>Response</summary>
449
+
450
+ ```json
451
+ {
452
+ "id": "string",
453
+ "org_id": "string",
454
+ "title": "string",
455
+ "description": {
456
+ "preinstall": "string"
457
+ },
458
+ "version": "string",
459
+ "slug": "string",
460
+ "source_type": "marketplace",
461
+ "blueprint_file_s3_key": "string",
462
+ "is_verified": true,
463
+ "docs_url": "string",
464
+ "recommended_apps": ["string"],
465
+ "created_at": "1970-01-01T00:00:00.000Z",
466
+ "created_by": {
467
+ "name": "manifest@epilot.cloud",
468
+ "org_id": "911690",
469
+ "user_id": "11001045",
470
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
471
+ },
472
+ "is_updating": true,
473
+ "resources": [
474
+ {
475
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
476
+ "name": "string",
477
+ "type": "designbuilder",
478
+ "address": "string",
479
+ "is_root": true,
480
+ "is_ready": true,
481
+ "is_hidden": true,
482
+ "is_disabled": false,
483
+ "hard_dependencies": ["designbuilder"],
484
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
485
+ "depends_on_addresses": ["string"],
486
+ "impact_on_install": ["create"],
487
+ "impact_on_install_reason": ["string"]
488
+ }
489
+ ]
490
+ }
491
+ ```
492
+
493
+ </details>
494
+
495
+ ---
496
+
497
+ ### `getBlueprintPreview`
498
+
499
+ Get Blueprint Preview by ID
500
+
501
+ `GET /v2/blueprint-manifest/blueprints:preview/{preview_id}`
502
+
503
+ ```ts
504
+ const { data } = await client.getBlueprintPreview({
505
+ preview_id: 'example',
506
+ })
507
+ ```
508
+
509
+ <details>
510
+ <summary>Response</summary>
511
+
512
+ ```json
513
+ {
514
+ "id": "string",
515
+ "org_id": "string",
516
+ "title": "string",
517
+ "description": {
518
+ "preinstall": "string"
519
+ },
520
+ "version": "string",
521
+ "slug": "string",
522
+ "source_type": "marketplace",
523
+ "blueprint_file_s3_key": "string",
524
+ "is_verified": true,
525
+ "docs_url": "string",
526
+ "recommended_apps": ["string"],
527
+ "created_at": "1970-01-01T00:00:00.000Z",
528
+ "created_by": {
529
+ "name": "manifest@epilot.cloud",
530
+ "org_id": "911690",
531
+ "user_id": "11001045",
532
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
533
+ },
534
+ "is_updating": true,
535
+ "resources": [
536
+ {
537
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
538
+ "name": "string",
539
+ "type": "designbuilder",
540
+ "address": "string",
541
+ "is_root": true,
542
+ "is_ready": true,
543
+ "is_hidden": true,
544
+ "is_disabled": false,
545
+ "hard_dependencies": ["designbuilder"],
546
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
547
+ "depends_on_addresses": ["string"],
548
+ "impact_on_install": ["create"],
549
+ "impact_on_install_reason": ["string"]
550
+ }
551
+ ]
552
+ }
553
+ ```
554
+
555
+ </details>
556
+
557
+ ---
558
+
559
+ ### `installBlueprint`
560
+
561
+ Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource
562
+
563
+ `POST /v2/blueprint-manifest/blueprint:install`
564
+
565
+ ```ts
566
+ const { data } = await client.installBlueprint(
567
+ null,
568
+ {
569
+ source_org_id: 'string',
570
+ source_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
571
+ source_blueprint_file: 'string',
572
+ destination_org_id: 'string',
573
+ destination_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
574
+ options: {
575
+ resources_to_ignore: ['string']
576
+ },
577
+ mode: 'simple',
578
+ source_blueprint_type: 'marketplace',
579
+ slug: 'string'
580
+ },
581
+ )
582
+ ```
583
+
584
+ ---
585
+
586
+ ### `getBlueprint`
587
+
588
+ Get Blueprint by ID
589
+
590
+ `GET /v2/blueprint-manifest/blueprints/{blueprint_id}`
591
+
592
+ ```ts
593
+ const { data } = await client.getBlueprint({
594
+ blueprint_id: 'example',
595
+ })
596
+ ```
597
+
598
+ <details>
599
+ <summary>Response</summary>
600
+
601
+ ```json
602
+ {
603
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
604
+ "title": "string",
605
+ "slug": "string",
606
+ "description": {
607
+ "preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
608
+ "postinstall": "This is the content of the postinstall.md file\n"
609
+ },
610
+ "version": "string",
611
+ "deployments": [
612
+ {
613
+ "source_org_id": "string",
614
+ "source_blueprint_id": "string",
615
+ "destination_org_id": "string",
616
+ "destination_blueprint_id": "string",
617
+ "triggered_at": "1970-01-01T00:00:00.000Z"
618
+ }
619
+ ],
620
+ "is_verified": true,
621
+ "installation_status": "IN_PROGRESS",
622
+ "created_at": "1970-01-01T00:00:00.000Z",
623
+ "updated_at": "1970-01-01T00:00:00.000Z",
624
+ "created_by": {
625
+ "name": "manifest@epilot.cloud",
626
+ "org_id": "911690",
627
+ "user_id": "11001045",
628
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
629
+ },
630
+ "updated_by": {
631
+ "name": "manifest@epilot.cloud",
632
+ "org_id": "911690",
633
+ "user_id": "11001045",
634
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
635
+ },
636
+ "installation_job_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
637
+ "source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
638
+ "archived": false,
639
+ "docs_url": "string",
640
+ "recommended_apps": ["string"],
641
+ "required_features": {
642
+ "enabled": ["string"],
643
+ "disabled": ["string"]
644
+ },
645
+ "zip_file_name": "string",
646
+ "resources": [
647
+ {
648
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
649
+ "name": "string",
650
+ "type": "designbuilder",
651
+ "address": "string",
652
+ "is_root": true,
653
+ "is_ready": true,
654
+ "is_hidden": true,
655
+ "is_disabled": false,
656
+ "hard_dependencies": ["designbuilder"],
657
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
658
+ "depends_on_addresses": ["string"],
659
+ "impact_on_install": ["create"],
660
+ "impact_on_install_reason": ["string"]
661
+ }
662
+ ],
663
+ "source_type": "string"
664
+ }
665
+ ```
666
+
667
+ </details>
668
+
669
+ ---
670
+
671
+ ### `updateBlueprint`
672
+
673
+ Update a Blueprint
674
+
675
+ `PUT /v2/blueprint-manifest/blueprints/{blueprint_id}`
676
+
677
+ ```ts
678
+ const { data } = await client.updateBlueprint(
679
+ {
680
+ blueprint_id: 'example',
681
+ },
682
+ {
683
+ id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
684
+ title: 'string',
685
+ slug: 'string',
686
+ description: {
687
+ preinstall: 'This is the content of the preinstall.md file which contains the blueprint description.
688
+ ',
689
+ postinstall: 'This is the content of the postinstall.md file
690
+ '
691
+ },
692
+ version: 'string',
693
+ deployments: [
694
+ {
695
+ source_org_id: 'string',
696
+ source_blueprint_id: 'string',
697
+ destination_org_id: 'string',
698
+ destination_blueprint_id: 'string',
699
+ triggered_at: '1970-01-01T00:00:00.000Z'
700
+ }
701
+ ],
702
+ is_verified: true,
703
+ installation_status: 'IN_PROGRESS',
704
+ created_at: '1970-01-01T00:00:00.000Z',
705
+ updated_at: '1970-01-01T00:00:00.000Z',
706
+ created_by: {
707
+ name: 'manifest@epilot.cloud',
708
+ org_id: '911690',
709
+ user_id: '11001045',
710
+ token_id: 'api_5ZugdRXasLfWBypHi93Fk'
711
+ },
712
+ updated_by: {
713
+ name: 'manifest@epilot.cloud',
714
+ org_id: '911690',
715
+ user_id: '11001045',
716
+ token_id: 'api_5ZugdRXasLfWBypHi93Fk'
717
+ },
718
+ installation_job_ids: ['c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341'],
719
+ source_blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
720
+ archived: false,
721
+ docs_url: 'string',
722
+ recommended_apps: ['string'],
723
+ required_features: {
724
+ enabled: ['string'],
725
+ disabled: ['string']
726
+ },
727
+ zip_file_name: 'string',
728
+ resources: [
729
+ {
730
+ id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
731
+ name: 'string',
732
+ type: 'designbuilder',
733
+ address: 'string',
734
+ is_root: true,
735
+ is_ready: true,
736
+ is_hidden: true,
737
+ is_disabled: false,
738
+ hard_dependencies: ['designbuilder'],
739
+ parent_resource_ids: ['c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341'],
740
+ depends_on_addresses: ['string'],
741
+ impact_on_install: ['create'],
742
+ impact_on_install_reason: ['string']
743
+ }
744
+ ],
745
+ source_type: 'string'
746
+ },
747
+ )
748
+ ```
749
+
750
+ <details>
751
+ <summary>Response</summary>
752
+
753
+ ```json
754
+ {
755
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
756
+ "title": "string",
757
+ "slug": "string",
758
+ "description": {
759
+ "preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
760
+ "postinstall": "This is the content of the postinstall.md file\n"
761
+ },
762
+ "version": "string",
763
+ "deployments": [
764
+ {
765
+ "source_org_id": "string",
766
+ "source_blueprint_id": "string",
767
+ "destination_org_id": "string",
768
+ "destination_blueprint_id": "string",
769
+ "triggered_at": "1970-01-01T00:00:00.000Z"
770
+ }
771
+ ],
772
+ "is_verified": true,
773
+ "installation_status": "IN_PROGRESS",
774
+ "created_at": "1970-01-01T00:00:00.000Z",
775
+ "updated_at": "1970-01-01T00:00:00.000Z",
776
+ "created_by": {
777
+ "name": "manifest@epilot.cloud",
778
+ "org_id": "911690",
779
+ "user_id": "11001045",
780
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
781
+ },
782
+ "updated_by": {
783
+ "name": "manifest@epilot.cloud",
784
+ "org_id": "911690",
785
+ "user_id": "11001045",
786
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
787
+ },
788
+ "installation_job_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
789
+ "source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
790
+ "archived": false,
791
+ "docs_url": "string",
792
+ "recommended_apps": ["string"],
793
+ "required_features": {
794
+ "enabled": ["string"],
795
+ "disabled": ["string"]
796
+ },
797
+ "zip_file_name": "string",
798
+ "resources": [
799
+ {
800
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
801
+ "name": "string",
802
+ "type": "designbuilder",
803
+ "address": "string",
804
+ "is_root": true,
805
+ "is_ready": true,
806
+ "is_hidden": true,
807
+ "is_disabled": false,
808
+ "hard_dependencies": ["designbuilder"],
809
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
810
+ "depends_on_addresses": ["string"],
811
+ "impact_on_install": ["create"],
812
+ "impact_on_install_reason": ["string"]
813
+ }
814
+ ],
815
+ "source_type": "string"
816
+ }
817
+ ```
818
+
819
+ </details>
820
+
821
+ ---
822
+
823
+ ### `deleteBlueprint`
824
+
825
+ Delete a Blueprint
826
+
827
+ `DELETE /v2/blueprint-manifest/blueprints/{blueprint_id}`
828
+
829
+ ```ts
830
+ const { data } = await client.deleteBlueprint({
831
+ blueprint_id: 'example',
832
+ })
833
+ ```
834
+
835
+ <details>
836
+ <summary>Response</summary>
837
+
838
+ ```json
839
+ {
840
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
841
+ "title": "string",
842
+ "slug": "string",
843
+ "description": {
844
+ "preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
845
+ "postinstall": "This is the content of the postinstall.md file\n"
846
+ },
847
+ "version": "string",
848
+ "deployments": [
849
+ {
850
+ "source_org_id": "string",
851
+ "source_blueprint_id": "string",
852
+ "destination_org_id": "string",
853
+ "destination_blueprint_id": "string",
854
+ "triggered_at": "1970-01-01T00:00:00.000Z"
855
+ }
856
+ ],
857
+ "is_verified": true,
858
+ "installation_status": "IN_PROGRESS",
859
+ "created_at": "1970-01-01T00:00:00.000Z",
860
+ "updated_at": "1970-01-01T00:00:00.000Z",
861
+ "created_by": {
862
+ "name": "manifest@epilot.cloud",
863
+ "org_id": "911690",
864
+ "user_id": "11001045",
865
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
866
+ },
867
+ "updated_by": {
868
+ "name": "manifest@epilot.cloud",
869
+ "org_id": "911690",
870
+ "user_id": "11001045",
871
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
872
+ },
873
+ "installation_job_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
874
+ "source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
875
+ "archived": false,
876
+ "docs_url": "string",
877
+ "recommended_apps": ["string"],
878
+ "required_features": {
879
+ "enabled": ["string"],
880
+ "disabled": ["string"]
881
+ },
882
+ "zip_file_name": "string",
883
+ "resources": [
884
+ {
885
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
886
+ "name": "string",
887
+ "type": "designbuilder",
888
+ "address": "string",
889
+ "is_root": true,
890
+ "is_ready": true,
891
+ "is_hidden": true,
892
+ "is_disabled": false,
893
+ "hard_dependencies": ["designbuilder"],
894
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
895
+ "depends_on_addresses": ["string"],
896
+ "impact_on_install": ["create"],
897
+ "impact_on_install_reason": ["string"]
898
+ }
899
+ ],
900
+ "source_type": "string"
901
+ }
902
+ ```
903
+
904
+ </details>
905
+
906
+ ---
907
+
908
+ ### `validateBlueprint`
909
+
910
+ Start a blueprint validation job. Validates Terraform for the blueprint (all types).
911
+ Returns 202 Accepted with job_id. Poll GET /jobs/{job_id} for status, valid, and errors.
912
+
913
+ `POST /v2/blueprint-manifest/blueprints/{blueprint_id}/validate`
914
+
915
+ ```ts
916
+ const { data } = await client.validateBlueprint({
917
+ blueprint_id: 'example',
918
+ })
919
+ ```
920
+
921
+ ---
922
+
923
+ ### `exportBlueprint`
924
+
925
+ Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.
926
+
927
+ `POST /v2/blueprint-manifest/blueprints/{blueprint_id}:export`
928
+
929
+ ```ts
930
+ const { data } = await client.exportBlueprint(
931
+ {
932
+ blueprint_id: 'example',
933
+ },
934
+ {
935
+ destination_org_id: 'string',
936
+ destination_blueprint_id: 'string',
937
+ validate: true
938
+ },
939
+ )
940
+ ```
941
+
942
+ ---
943
+
944
+ ### `listMarketplaceSlugs`
945
+
946
+ List all available marketplace blueprint slugs from Webflow CMS.
947
+ Returns cached results when available.
948
+
949
+ `GET /v2/blueprint-manifest/marketplace/slugs`
950
+
951
+ ```ts
952
+ const { data } = await client.listMarketplaceSlugs()
953
+ ```
954
+
955
+ <details>
956
+ <summary>Response</summary>
957
+
958
+ ```json
959
+ {
960
+ "results": [
961
+ {
962
+ "slug": "wallbox_b2c",
963
+ "version": "v1.0.0",
964
+ "name": "Wallbox B2C",
965
+ "installation_link": "https://portal.epilot.cloud/app/blueprints/install/marketplace/wallbox_b2c?s3Ref=https://example.com/blueprint.zip"
966
+ }
967
+ ]
968
+ }
969
+ ```
970
+
971
+ </details>
972
+
973
+ ---
974
+
975
+ ### `publishBlueprint`
976
+
977
+ Publish a blueprint to the marketplace. Exports the blueprint, uploads it to file-api with public access, and updates the Webflow CMS listing.
978
+
979
+ `POST /v2/blueprint-manifest/blueprints:publish`
980
+
981
+ ```ts
982
+ const { data } = await client.publishBlueprint(
983
+ null,
984
+ {
985
+ blueprint_id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
986
+ slug: 'string',
987
+ version: 'string',
988
+ name: 'string'
989
+ },
990
+ )
991
+ ```
992
+
993
+ ---
994
+
995
+ ### `formatBlueprintDescription`
996
+
997
+ Format a blueprint description as markdown using AI.
998
+
999
+ `POST /v2/blueprint-manifest/blueprints/{blueprint_id}:format-description`
1000
+
1001
+ ```ts
1002
+ const { data } = await client.formatBlueprintDescription(
1003
+ {
1004
+ blueprint_id: 'example',
1005
+ },
1006
+ {
1007
+ text: 'string'
1008
+ },
1009
+ )
1010
+ ```
1011
+
1012
+ <details>
1013
+ <summary>Response</summary>
1014
+
1015
+ ```json
1016
+ {
1017
+ "markdown": "string"
1018
+ }
1019
+ ```
1020
+
1021
+ </details>
1022
+
1023
+ ---
1024
+
1025
+ ### `addBlueprintResource`
1026
+
1027
+ Add a resource to a Blueprint
1028
+
1029
+ `POST /v2/blueprint-manifest/blueprints/{blueprint_id}/resources`
1030
+
1031
+ ```ts
1032
+ const { data } = await client.addBlueprintResource(
1033
+ {
1034
+ blueprint_id: 'example',
1035
+ add_dependencies: true,
1036
+ },
1037
+ {
1038
+ id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
1039
+ name: 'string',
1040
+ type: 'designbuilder',
1041
+ address: 'string',
1042
+ is_root: true,
1043
+ is_ready: true,
1044
+ is_hidden: true,
1045
+ is_disabled: false,
1046
+ hard_dependencies: ['designbuilder'],
1047
+ parent_resource_ids: ['c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341'],
1048
+ depends_on_addresses: ['string'],
1049
+ impact_on_install: ['create'],
1050
+ impact_on_install_reason: ['string']
1051
+ },
1052
+ )
1053
+ ```
1054
+
1055
+ <details>
1056
+ <summary>Response</summary>
1057
+
1058
+ ```json
1059
+ {
1060
+ "resources": [
1061
+ {
1062
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1063
+ "name": "string",
1064
+ "type": "designbuilder",
1065
+ "address": "string",
1066
+ "is_root": true,
1067
+ "is_ready": true,
1068
+ "is_hidden": true,
1069
+ "is_disabled": false,
1070
+ "hard_dependencies": ["designbuilder"],
1071
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
1072
+ "depends_on_addresses": ["string"],
1073
+ "impact_on_install": ["create"],
1074
+ "impact_on_install_reason": ["string"]
1075
+ }
1076
+ ]
1077
+ }
1078
+ ```
1079
+
1080
+ </details>
1081
+
1082
+ ---
1083
+
1084
+ ### `syncDependencies`
1085
+
1086
+ Sync dependencies of all root resources in a Blueprint
1087
+
1088
+ `POST /v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies`
1089
+
1090
+ ```ts
1091
+ const { data } = await client.syncDependencies({
1092
+ blueprint_id: 'example',
1093
+ })
1094
+ ```
1095
+
1096
+ ---
1097
+
1098
+ ### `bulkAddBlueprintResources`
1099
+
1100
+ Bulk Add resources in a Blueprint
1101
+
1102
+ `POST /v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk`
1103
+
1104
+ ```ts
1105
+ const { data } = await client.bulkAddBlueprintResources(
1106
+ {
1107
+ blueprint_id: 'example',
1108
+ add_dependencies: true,
1109
+ },
1110
+ [
1111
+ {
1112
+ id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
1113
+ name: 'string',
1114
+ type: 'designbuilder',
1115
+ address: 'string',
1116
+ is_root: true,
1117
+ is_ready: true,
1118
+ is_hidden: true,
1119
+ is_disabled: false,
1120
+ hard_dependencies: ['designbuilder'],
1121
+ parent_resource_ids: ['c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341'],
1122
+ depends_on_addresses: ['string'],
1123
+ impact_on_install: ['create'],
1124
+ impact_on_install_reason: ['string']
1125
+ }
1126
+ ],
1127
+ )
1128
+ ```
1129
+
1130
+ <details>
1131
+ <summary>Response</summary>
1132
+
1133
+ ```json
1134
+ {
1135
+ "resources": [
1136
+ {
1137
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1138
+ "name": "string",
1139
+ "type": "designbuilder",
1140
+ "address": "string",
1141
+ "is_root": true,
1142
+ "is_ready": true,
1143
+ "is_hidden": true,
1144
+ "is_disabled": false,
1145
+ "hard_dependencies": ["designbuilder"],
1146
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
1147
+ "depends_on_addresses": ["string"],
1148
+ "impact_on_install": ["create"],
1149
+ "impact_on_install_reason": ["string"]
1150
+ }
1151
+ ]
1152
+ }
1153
+ ```
1154
+
1155
+ </details>
1156
+
1157
+ ---
1158
+
1159
+ ### `bulkUpdateBlueprintResources`
1160
+
1161
+ Bulk update resources in a Blueprint
1162
+
1163
+ `PUT /v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk`
1164
+
1165
+ ```ts
1166
+ const { data } = await client.bulkUpdateBlueprintResources(
1167
+ {
1168
+ blueprint_id: 'example',
1169
+ },
1170
+ [
1171
+ {
1172
+ id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
1173
+ name: 'string',
1174
+ type: 'designbuilder',
1175
+ address: 'string',
1176
+ is_root: true,
1177
+ is_ready: true,
1178
+ is_hidden: true,
1179
+ is_disabled: false,
1180
+ hard_dependencies: ['designbuilder'],
1181
+ parent_resource_ids: ['c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341'],
1182
+ depends_on_addresses: ['string'],
1183
+ impact_on_install: ['create'],
1184
+ impact_on_install_reason: ['string']
1185
+ }
1186
+ ],
1187
+ )
1188
+ ```
1189
+
1190
+ <details>
1191
+ <summary>Response</summary>
1192
+
1193
+ ```json
1194
+ {
1195
+ "resources": [
1196
+ {
1197
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1198
+ "name": "string",
1199
+ "type": "designbuilder",
1200
+ "address": "string",
1201
+ "is_root": true,
1202
+ "is_ready": true,
1203
+ "is_hidden": true,
1204
+ "is_disabled": false,
1205
+ "hard_dependencies": ["designbuilder"],
1206
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
1207
+ "depends_on_addresses": ["string"],
1208
+ "impact_on_install": ["create"],
1209
+ "impact_on_install_reason": ["string"]
1210
+ }
1211
+ ]
1212
+ }
1213
+ ```
1214
+
1215
+ </details>
1216
+
1217
+ ---
1218
+
1219
+ ### `bulkDeleteBlueprintResources`
1220
+
1221
+ Bulk delete resources in a Blueprint
1222
+
1223
+ `DELETE /v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk`
1224
+
1225
+ ```ts
1226
+ const { data } = await client.bulkDeleteBlueprintResources(
1227
+ {
1228
+ blueprint_id: 'example',
1229
+ },
1230
+ ['c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341'],
1231
+ )
1232
+ ```
1233
+
1234
+ <details>
1235
+ <summary>Response</summary>
1236
+
1237
+ ```json
1238
+ {
1239
+ "resources": [
1240
+ {
1241
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1242
+ "name": "string",
1243
+ "type": "designbuilder",
1244
+ "address": "string",
1245
+ "is_root": true,
1246
+ "is_ready": true,
1247
+ "is_hidden": true,
1248
+ "is_disabled": false,
1249
+ "hard_dependencies": ["designbuilder"],
1250
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
1251
+ "depends_on_addresses": ["string"],
1252
+ "impact_on_install": ["create"],
1253
+ "impact_on_install_reason": ["string"]
1254
+ }
1255
+ ]
1256
+ }
1257
+ ```
1258
+
1259
+ </details>
1260
+
1261
+ ---
1262
+
1263
+ ### `updateBlueprintResource`
1264
+
1265
+ Update a resource in a Blueprint
1266
+
1267
+ `PUT /v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}`
1268
+
1269
+ ```ts
1270
+ const { data } = await client.updateBlueprintResource(
1271
+ {
1272
+ blueprint_id: 'example',
1273
+ resource_id: 'example',
1274
+ },
1275
+ {
1276
+ id: 'c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341',
1277
+ name: 'string',
1278
+ type: 'designbuilder',
1279
+ address: 'string',
1280
+ is_root: true,
1281
+ is_ready: true,
1282
+ is_hidden: true,
1283
+ is_disabled: false,
1284
+ hard_dependencies: ['designbuilder'],
1285
+ parent_resource_ids: ['c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341'],
1286
+ depends_on_addresses: ['string'],
1287
+ impact_on_install: ['create'],
1288
+ impact_on_install_reason: ['string']
1289
+ },
1290
+ )
1291
+ ```
1292
+
1293
+ <details>
1294
+ <summary>Response</summary>
1295
+
1296
+ ```json
1297
+ {
1298
+ "resources": [
1299
+ {
1300
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1301
+ "name": "string",
1302
+ "type": "designbuilder",
1303
+ "address": "string",
1304
+ "is_root": true,
1305
+ "is_ready": true,
1306
+ "is_hidden": true,
1307
+ "is_disabled": false,
1308
+ "hard_dependencies": ["designbuilder"],
1309
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
1310
+ "depends_on_addresses": ["string"],
1311
+ "impact_on_install": ["create"],
1312
+ "impact_on_install_reason": ["string"]
1313
+ }
1314
+ ]
1315
+ }
1316
+ ```
1317
+
1318
+ </details>
1319
+
1320
+ ---
1321
+
1322
+ ### `deleteBlueprintResource`
1323
+
1324
+ Delete a resource from a Blueprint
1325
+
1326
+ `DELETE /v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}`
1327
+
1328
+ ```ts
1329
+ const { data } = await client.deleteBlueprintResource({
1330
+ blueprint_id: 'example',
1331
+ resource_id: 'example',
1332
+ })
1333
+ ```
1334
+
1335
+ <details>
1336
+ <summary>Response</summary>
1337
+
1338
+ ```json
1339
+ {
1340
+ "resources": [
1341
+ {
1342
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1343
+ "name": "string",
1344
+ "type": "designbuilder",
1345
+ "address": "string",
1346
+ "is_root": true,
1347
+ "is_ready": true,
1348
+ "is_hidden": true,
1349
+ "is_disabled": false,
1350
+ "hard_dependencies": ["designbuilder"],
1351
+ "parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
1352
+ "depends_on_addresses": ["string"],
1353
+ "impact_on_install": ["create"],
1354
+ "impact_on_install_reason": ["string"]
1355
+ }
1356
+ ]
1357
+ }
1358
+ ```
1359
+
1360
+ </details>
1361
+
1362
+ ---
1363
+
1364
+ ### `listBlueprintJobs`
1365
+
1366
+ List Blueprint Jobs
1367
+
1368
+ `GET /v2/blueprint-manifest/jobs`
1369
+
1370
+ ```ts
1371
+ const { data } = await client.listBlueprintJobs()
1372
+ ```
1373
+
1374
+ <details>
1375
+ <summary>Response</summary>
1376
+
1377
+ ```json
1378
+ {
1379
+ "total": 1,
1380
+ "results": [
1381
+ {
1382
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1383
+ "events": [
1384
+ {
1385
+ "timestamp": "1970-01-01T00:00:00.000Z",
1386
+ "message": "string",
1387
+ "errors": [
1388
+ {
1389
+ "error": "string",
1390
+ "code": "dependency_extraction",
1391
+ "data": {
1392
+ "formattedResource": {
1393
+ "id": "string",
1394
+ "name": "string",
1395
+ "type": "string"
1396
+ },
1397
+ "resource": "string",
1398
+ "resourceDependency": "string",
1399
+ "resources": ["string"],
1400
+ "addresses": ["string"],
1401
+ "originalError": "string"
1402
+ }
1403
+ }
1404
+ ],
1405
+ "level": "info",
1406
+ "data": {
1407
+ "installed_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1408
+ "export_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1409
+ "resources": 0
1410
+ }
1411
+ }
1412
+ ],
1413
+ "triggered_at": "1970-01-01T00:00:00.000Z",
1414
+ "created_by": {
1415
+ "name": "manifest@epilot.cloud",
1416
+ "org_id": "911690",
1417
+ "user_id": "11001045",
1418
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
1419
+ },
1420
+ "blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1421
+ "status": "IN_PROGRESS",
1422
+ "download_file": {
1423
+ "bucket": "blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw",
1424
+ "key": "templates/main.tf"
1425
+ }
1426
+ }
1427
+ ]
1428
+ }
1429
+ ```
1430
+
1431
+ </details>
1432
+
1433
+ ---
1434
+
1435
+ ### `getBlueprintJob`
1436
+
1437
+ Get Job
1438
+
1439
+ `GET /v2/blueprint-manifest/jobs/{job_id}`
1440
+
1441
+ ```ts
1442
+ const { data } = await client.getBlueprintJob({
1443
+ job_id: 'example',
1444
+ })
1445
+ ```
1446
+
1447
+ <details>
1448
+ <summary>Response</summary>
1449
+
1450
+ ```json
1451
+ {
1452
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1453
+ "events": [
1454
+ {
1455
+ "timestamp": "1970-01-01T00:00:00.000Z",
1456
+ "message": "string",
1457
+ "errors": [
1458
+ {
1459
+ "error": "string",
1460
+ "code": "dependency_extraction",
1461
+ "data": {
1462
+ "formattedResource": {
1463
+ "id": "string",
1464
+ "name": "string",
1465
+ "type": "string"
1466
+ },
1467
+ "resource": "string",
1468
+ "resourceDependency": "string",
1469
+ "resources": ["string"],
1470
+ "addresses": ["string"],
1471
+ "originalError": "string"
1472
+ }
1473
+ }
1474
+ ],
1475
+ "level": "info",
1476
+ "data": {
1477
+ "installed_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1478
+ "export_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1479
+ "resources": 0
1480
+ }
1481
+ }
1482
+ ],
1483
+ "triggered_at": "1970-01-01T00:00:00.000Z",
1484
+ "created_by": {
1485
+ "name": "manifest@epilot.cloud",
1486
+ "org_id": "911690",
1487
+ "user_id": "11001045",
1488
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
1489
+ },
1490
+ "blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1491
+ "status": "IN_PROGRESS",
1492
+ "download_file": {
1493
+ "bucket": "blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw",
1494
+ "key": "templates/main.tf"
1495
+ }
1496
+ }
1497
+ ```
1498
+
1499
+ </details>
1500
+
1501
+ ---
1502
+
1503
+ ### `continueInstallationJob`
1504
+
1505
+ Continue Installation Job
1506
+
1507
+ `POST /v2/blueprint-manifest/jobs/{job_id}:continue`
1508
+
1509
+ ```ts
1510
+ const { data } = await client.continueInstallationJob(
1511
+ {
1512
+ job_id: 'example',
1513
+ },
1514
+ {
1515
+ resources_to_ignore: ['string']
1516
+ },
1517
+ )
1518
+ ```
1519
+
1520
+ <details>
1521
+ <summary>Response</summary>
1522
+
1523
+ ```json
1524
+ {
1525
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1526
+ "events": [
1527
+ {
1528
+ "timestamp": "1970-01-01T00:00:00.000Z",
1529
+ "message": "string",
1530
+ "errors": [
1531
+ {
1532
+ "error": "string",
1533
+ "code": "dependency_extraction",
1534
+ "data": {
1535
+ "formattedResource": {
1536
+ "id": "string",
1537
+ "name": "string",
1538
+ "type": "string"
1539
+ },
1540
+ "resource": "string",
1541
+ "resourceDependency": "string",
1542
+ "resources": ["string"],
1543
+ "addresses": ["string"],
1544
+ "originalError": "string"
1545
+ }
1546
+ }
1547
+ ],
1548
+ "level": "info",
1549
+ "data": {
1550
+ "installed_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1551
+ "export_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1552
+ "resources": 0
1553
+ }
1554
+ }
1555
+ ],
1556
+ "triggered_at": "1970-01-01T00:00:00.000Z",
1557
+ "created_by": {
1558
+ "name": "manifest@epilot.cloud",
1559
+ "org_id": "911690",
1560
+ "user_id": "11001045",
1561
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
1562
+ },
1563
+ "source_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1564
+ "source_blueprint_type": "custom",
1565
+ "source_org_id": "string",
1566
+ "source_blueprint_file": "string",
1567
+ "destination_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1568
+ "destination_org_id": "string",
1569
+ "slug": "string",
1570
+ "status": "IN_PROGRESS"
1571
+ }
1572
+ ```
1573
+
1574
+ </details>
1575
+
1576
+ ---
1577
+
1578
+ ### `cancelBlueprintJob`
1579
+
1580
+ Cancel Blueprint Job
1581
+
1582
+ `POST /v2/blueprint-manifest/jobs/{job_id}:cancel`
1583
+
1584
+ ```ts
1585
+ const { data } = await client.cancelBlueprintJob({
1586
+ job_id: 'example',
1587
+ })
1588
+ ```
1589
+
1590
+ <details>
1591
+ <summary>Response</summary>
1592
+
1593
+ ```json
1594
+ {
1595
+ "id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1596
+ "events": [
1597
+ {
1598
+ "timestamp": "1970-01-01T00:00:00.000Z",
1599
+ "message": "string",
1600
+ "errors": [
1601
+ {
1602
+ "error": "string",
1603
+ "code": "dependency_extraction",
1604
+ "data": {
1605
+ "formattedResource": {
1606
+ "id": "string",
1607
+ "name": "string",
1608
+ "type": "string"
1609
+ },
1610
+ "resource": "string",
1611
+ "resourceDependency": "string",
1612
+ "resources": ["string"],
1613
+ "addresses": ["string"],
1614
+ "originalError": "string"
1615
+ }
1616
+ }
1617
+ ],
1618
+ "level": "info",
1619
+ "data": {
1620
+ "installed_blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1621
+ "export_job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1622
+ "resources": 0
1623
+ }
1624
+ }
1625
+ ],
1626
+ "triggered_at": "1970-01-01T00:00:00.000Z",
1627
+ "created_by": {
1628
+ "name": "manifest@epilot.cloud",
1629
+ "org_id": "911690",
1630
+ "user_id": "11001045",
1631
+ "token_id": "api_5ZugdRXasLfWBypHi93Fk"
1632
+ },
1633
+ "blueprint_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
1634
+ "status": "IN_PROGRESS",
1635
+ "download_file": {
1636
+ "bucket": "blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw",
1637
+ "key": "templates/main.tf"
1638
+ }
1639
+ }
1640
+ ```
1641
+
1642
+ </details>
1643
+
1644
+ ---
1645
+
1646
+ ## Schemas
1647
+
1648
+ ### `BlueprintID`
1649
+
1650
+ ID of a blueprint
1651
+
1652
+ ```ts
1653
+ type BlueprintID = string
1654
+ ```
1655
+
1656
+ ### `BlueprintResourceID`
1657
+
1658
+ ID of a blueprint resource
1659
+
1660
+ ```ts
1661
+ type BlueprintResourceID = string
1662
+ ```
1663
+
1664
+ ### `CommonBlueprintFields`
1665
+
1666
+ ```ts
1667
+ type CommonBlueprintFields = {
1668
+ id?: string
1669
+ title: string
1670
+ slug?: string
1671
+ description?: {
1672
+ preinstall?: string
1673
+ postinstall?: string
1674
+ }
1675
+ version?: string
1676
+ deployments?: Array<{
1677
+ source_org_id?: string
1678
+ source_blueprint_id?: string
1679
+ destination_org_id?: string
1680
+ destination_blueprint_id?: string
1681
+ triggered_at?: string // date-time
1682
+ }>
1683
+ is_verified?: boolean
1684
+ installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED"
1685
+ created_at?: string // date-time
1686
+ updated_at?: string // date-time
1687
+ created_by?: {
1688
+ name?: unknown
1689
+ org_id: string
1690
+ user_id?: string
1691
+ token_id?: string
1692
+ }
1693
+ updated_by?: {
1694
+ name?: unknown
1695
+ org_id: string
1696
+ user_id?: string
1697
+ token_id?: string
1698
+ }
1699
+ installation_job_ids?: string[]
1700
+ source_blueprint_id?: string
1701
+ archived?: boolean
1702
+ docs_url?: string
1703
+ recommended_apps?: string[]
1704
+ required_features?: {
1705
+ enabled?: string[]
1706
+ disabled?: string[]
1707
+ }
1708
+ zip_file_name?: string
1709
+ }
1710
+ ```
1711
+
1712
+ ### `BlueprintResource`
1713
+
1714
+ ```ts
1715
+ type BlueprintResource = {
1716
+ id: string
1717
+ name?: string
1718
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
1719
+ address?: string
1720
+ is_root?: boolean
1721
+ is_ready?: boolean
1722
+ is_hidden?: boolean
1723
+ is_disabled?: boolean
1724
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"[]
1725
+ parent_resource_ids?: string[]
1726
+ depends_on_addresses?: string[]
1727
+ impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
1728
+ impact_on_install_reason?: string[]
1729
+ }
1730
+ ```
1731
+
1732
+ ### `BlueprintPreview`
1733
+
1734
+ Preview data for a blueprint before installation. Stored temporarily with TTL.
1735
+
1736
+ ```ts
1737
+ type BlueprintPreview = {
1738
+ id: string
1739
+ org_id: string
1740
+ title: string
1741
+ description?: {
1742
+ preinstall?: string
1743
+ }
1744
+ version?: string
1745
+ slug?: string
1746
+ source_type: "marketplace" | "file"
1747
+ blueprint_file_s3_key: string
1748
+ is_verified: boolean
1749
+ docs_url?: string
1750
+ recommended_apps?: string[]
1751
+ created_at: string // date-time
1752
+ created_by: {
1753
+ name?: unknown
1754
+ org_id: string
1755
+ user_id?: string
1756
+ token_id?: string
1757
+ }
1758
+ is_updating: boolean
1759
+ resources: Array<{
1760
+ id: string
1761
+ name?: string
1762
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
1763
+ address?: string
1764
+ is_root?: boolean
1765
+ is_ready?: boolean
1766
+ is_hidden?: boolean
1767
+ is_disabled?: boolean
1768
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"[]
1769
+ parent_resource_ids?: string[]
1770
+ depends_on_addresses?: string[]
1771
+ impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
1772
+ impact_on_install_reason?: string[]
1773
+ }>
1774
+ }
1775
+ ```
1776
+
1777
+ ### `CustomBlueprint`
1778
+
1779
+ ```ts
1780
+ type CustomBlueprint = {
1781
+ id?: string
1782
+ title: string
1783
+ slug?: string
1784
+ description?: {
1785
+ preinstall?: string
1786
+ postinstall?: string
1787
+ }
1788
+ version?: string
1789
+ deployments?: Array<{
1790
+ source_org_id?: string
1791
+ source_blueprint_id?: string
1792
+ destination_org_id?: string
1793
+ destination_blueprint_id?: string
1794
+ triggered_at?: string // date-time
1795
+ }>
1796
+ is_verified?: boolean
1797
+ installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED"
1798
+ created_at?: string // date-time
1799
+ updated_at?: string // date-time
1800
+ created_by?: {
1801
+ name?: unknown
1802
+ org_id: string
1803
+ user_id?: string
1804
+ token_id?: string
1805
+ }
1806
+ updated_by?: {
1807
+ name?: unknown
1808
+ org_id: string
1809
+ user_id?: string
1810
+ token_id?: string
1811
+ }
1812
+ installation_job_ids?: string[]
1813
+ source_blueprint_id?: string
1814
+ archived?: boolean
1815
+ docs_url?: string
1816
+ recommended_apps?: string[]
1817
+ required_features?: {
1818
+ enabled?: string[]
1819
+ disabled?: string[]
1820
+ }
1821
+ zip_file_name?: string
1822
+ resources?: Array<{
1823
+ id: string
1824
+ name?: string
1825
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
1826
+ address?: string
1827
+ is_root?: boolean
1828
+ is_ready?: boolean
1829
+ is_hidden?: boolean
1830
+ is_disabled?: boolean
1831
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"[]
1832
+ parent_resource_ids?: string[]
1833
+ depends_on_addresses?: string[]
1834
+ impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
1835
+ impact_on_install_reason?: string[]
1836
+ }>
1837
+ source_type?: string
1838
+ }
1839
+ ```
1840
+
1841
+ ### `FileBlueprint`
1842
+
1843
+ ```ts
1844
+ type FileBlueprint = {
1845
+ id?: string
1846
+ title: string
1847
+ slug?: string
1848
+ description?: {
1849
+ preinstall?: string
1850
+ postinstall?: string
1851
+ }
1852
+ version?: string
1853
+ deployments?: Array<{
1854
+ source_org_id?: string
1855
+ source_blueprint_id?: string
1856
+ destination_org_id?: string
1857
+ destination_blueprint_id?: string
1858
+ triggered_at?: string // date-time
1859
+ }>
1860
+ is_verified?: boolean
1861
+ installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED"
1862
+ created_at?: string // date-time
1863
+ updated_at?: string // date-time
1864
+ created_by?: {
1865
+ name?: unknown
1866
+ org_id: string
1867
+ user_id?: string
1868
+ token_id?: string
1869
+ }
1870
+ updated_by?: {
1871
+ name?: unknown
1872
+ org_id: string
1873
+ user_id?: string
1874
+ token_id?: string
1875
+ }
1876
+ installation_job_ids?: string[]
1877
+ source_blueprint_id?: string
1878
+ archived?: boolean
1879
+ docs_url?: string
1880
+ recommended_apps?: string[]
1881
+ required_features?: {
1882
+ enabled?: string[]
1883
+ disabled?: string[]
1884
+ }
1885
+ zip_file_name?: string
1886
+ source_type?: string
1887
+ resources?: Array<{
1888
+ id: string
1889
+ name?: string
1890
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
1891
+ address?: string
1892
+ is_root?: boolean
1893
+ is_ready?: boolean
1894
+ is_hidden?: boolean
1895
+ is_disabled?: boolean
1896
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"[]
1897
+ parent_resource_ids?: string[]
1898
+ depends_on_addresses?: string[]
1899
+ impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
1900
+ impact_on_install_reason?: string[]
1901
+ }>
1902
+ }
1903
+ ```
1904
+
1905
+ ### `MarketplaceBlueprint`
1906
+
1907
+ ```ts
1908
+ type MarketplaceBlueprint = {
1909
+ id?: string
1910
+ title: string
1911
+ slug?: string
1912
+ description?: {
1913
+ preinstall?: string
1914
+ postinstall?: string
1915
+ }
1916
+ version?: string
1917
+ deployments?: Array<{
1918
+ source_org_id?: string
1919
+ source_blueprint_id?: string
1920
+ destination_org_id?: string
1921
+ destination_blueprint_id?: string
1922
+ triggered_at?: string // date-time
1923
+ }>
1924
+ is_verified?: boolean
1925
+ installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED"
1926
+ created_at?: string // date-time
1927
+ updated_at?: string // date-time
1928
+ created_by?: {
1929
+ name?: unknown
1930
+ org_id: string
1931
+ user_id?: string
1932
+ token_id?: string
1933
+ }
1934
+ updated_by?: {
1935
+ name?: unknown
1936
+ org_id: string
1937
+ user_id?: string
1938
+ token_id?: string
1939
+ }
1940
+ installation_job_ids?: string[]
1941
+ source_blueprint_id?: string
1942
+ archived?: boolean
1943
+ docs_url?: string
1944
+ recommended_apps?: string[]
1945
+ required_features?: {
1946
+ enabled?: string[]
1947
+ disabled?: string[]
1948
+ }
1949
+ zip_file_name?: string
1950
+ source_type?: string
1951
+ resources?: Array<{
1952
+ id: string
1953
+ name?: string
1954
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
1955
+ address?: string
1956
+ is_root?: boolean
1957
+ is_ready?: boolean
1958
+ is_hidden?: boolean
1959
+ is_disabled?: boolean
1960
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"[]
1961
+ parent_resource_ids?: string[]
1962
+ depends_on_addresses?: string[]
1963
+ impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
1964
+ impact_on_install_reason?: string[]
1965
+ }>
1966
+ has_update_available?: boolean
1967
+ latest_marketplace_version?: string
1968
+ installation_link?: string
1969
+ }
1970
+ ```
1971
+
1972
+ ### `InstalledMarketplaceBlueprintItem`
1973
+
1974
+ Summary of an installed marketplace blueprint for version tracking
1975
+
1976
+ ```ts
1977
+ type InstalledMarketplaceBlueprintItem = {
1978
+ id: string
1979
+ slug: string
1980
+ version?: string
1981
+ created_at?: string // date-time
1982
+ created_by?: {
1983
+ name?: unknown
1984
+ org_id: string
1985
+ user_id?: string
1986
+ token_id?: string
1987
+ }
1988
+ updated_at?: string // date-time
1989
+ updated_by?: {
1990
+ name?: unknown
1991
+ org_id: string
1992
+ user_id?: string
1993
+ token_id?: string
1994
+ }
1995
+ has_update_available?: boolean
1996
+ latest_marketplace_version?: string
1997
+ installation_link?: string
1998
+ }
1999
+ ```
2000
+
2001
+ ### `DeployedBlueprint`
2002
+
2003
+ ```ts
2004
+ type DeployedBlueprint = {
2005
+ id?: string
2006
+ title: string
2007
+ slug?: string
2008
+ description?: {
2009
+ preinstall?: string
2010
+ postinstall?: string
2011
+ }
2012
+ version?: string
2013
+ deployments?: Array<{
2014
+ source_org_id?: string
2015
+ source_blueprint_id?: string
2016
+ destination_org_id?: string
2017
+ destination_blueprint_id?: string
2018
+ triggered_at?: string // date-time
2019
+ }>
2020
+ is_verified?: boolean
2021
+ installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED"
2022
+ created_at?: string // date-time
2023
+ updated_at?: string // date-time
2024
+ created_by?: {
2025
+ name?: unknown
2026
+ org_id: string
2027
+ user_id?: string
2028
+ token_id?: string
2029
+ }
2030
+ updated_by?: {
2031
+ name?: unknown
2032
+ org_id: string
2033
+ user_id?: string
2034
+ token_id?: string
2035
+ }
2036
+ installation_job_ids?: string[]
2037
+ source_blueprint_id?: string
2038
+ archived?: boolean
2039
+ docs_url?: string
2040
+ recommended_apps?: string[]
2041
+ required_features?: {
2042
+ enabled?: string[]
2043
+ disabled?: string[]
2044
+ }
2045
+ zip_file_name?: string
2046
+ source_type?: string
2047
+ resources?: Array<{
2048
+ id: string
2049
+ name?: string
2050
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2051
+ address?: string
2052
+ is_root?: boolean
2053
+ is_ready?: boolean
2054
+ is_hidden?: boolean
2055
+ is_disabled?: boolean
2056
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"[]
2057
+ parent_resource_ids?: string[]
2058
+ depends_on_addresses?: string[]
2059
+ impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2060
+ impact_on_install_reason?: string[]
2061
+ }>
2062
+ }
2063
+ ```
2064
+
2065
+ ### `AppBlueprint`
2066
+
2067
+ ```ts
2068
+ type AppBlueprint = {
2069
+ id?: string
2070
+ title: string
2071
+ slug?: string
2072
+ description?: {
2073
+ preinstall?: string
2074
+ postinstall?: string
2075
+ }
2076
+ version?: string
2077
+ deployments?: Array<{
2078
+ source_org_id?: string
2079
+ source_blueprint_id?: string
2080
+ destination_org_id?: string
2081
+ destination_blueprint_id?: string
2082
+ triggered_at?: string // date-time
2083
+ }>
2084
+ is_verified?: boolean
2085
+ installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED"
2086
+ created_at?: string // date-time
2087
+ updated_at?: string // date-time
2088
+ created_by?: {
2089
+ name?: unknown
2090
+ org_id: string
2091
+ user_id?: string
2092
+ token_id?: string
2093
+ }
2094
+ updated_by?: {
2095
+ name?: unknown
2096
+ org_id: string
2097
+ user_id?: string
2098
+ token_id?: string
2099
+ }
2100
+ installation_job_ids?: string[]
2101
+ source_blueprint_id?: string
2102
+ archived?: boolean
2103
+ docs_url?: string
2104
+ recommended_apps?: string[]
2105
+ required_features?: {
2106
+ enabled?: string[]
2107
+ disabled?: string[]
2108
+ }
2109
+ zip_file_name?: string
2110
+ source_type?: string
2111
+ resources?: Array<{
2112
+ id: string
2113
+ name?: string
2114
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2115
+ address?: string
2116
+ is_root?: boolean
2117
+ is_ready?: boolean
2118
+ is_hidden?: boolean
2119
+ is_disabled?: boolean
2120
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"[]
2121
+ parent_resource_ids?: string[]
2122
+ depends_on_addresses?: string[]
2123
+ impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2124
+ impact_on_install_reason?: string[]
2125
+ }>
2126
+ }
2127
+ ```
2128
+
2129
+ ### `Blueprint`
2130
+
2131
+ ```ts
2132
+ type Blueprint = {
2133
+ id?: string
2134
+ title: string
2135
+ slug?: string
2136
+ description?: {
2137
+ preinstall?: string
2138
+ postinstall?: string
2139
+ }
2140
+ version?: string
2141
+ deployments?: Array<{
2142
+ source_org_id?: string
2143
+ source_blueprint_id?: string
2144
+ destination_org_id?: string
2145
+ destination_blueprint_id?: string
2146
+ triggered_at?: string // date-time
2147
+ }>
2148
+ is_verified?: boolean
2149
+ installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED"
2150
+ created_at?: string // date-time
2151
+ updated_at?: string // date-time
2152
+ created_by?: {
2153
+ name?: unknown
2154
+ org_id: string
2155
+ user_id?: string
2156
+ token_id?: string
2157
+ }
2158
+ updated_by?: {
2159
+ name?: unknown
2160
+ org_id: string
2161
+ user_id?: string
2162
+ token_id?: string
2163
+ }
2164
+ installation_job_ids?: string[]
2165
+ source_blueprint_id?: string
2166
+ archived?: boolean
2167
+ docs_url?: string
2168
+ recommended_apps?: string[]
2169
+ required_features?: {
2170
+ enabled?: string[]
2171
+ disabled?: string[]
2172
+ }
2173
+ zip_file_name?: string
2174
+ resources?: Array<{
2175
+ id: string
2176
+ name?: string
2177
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2178
+ address?: string
2179
+ is_root?: boolean
2180
+ is_ready?: boolean
2181
+ is_hidden?: boolean
2182
+ is_disabled?: boolean
2183
+ hard_dependencies?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"[]
2184
+ parent_resource_ids?: string[]
2185
+ depends_on_addresses?: string[]
2186
+ impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2187
+ impact_on_install_reason?: string[]
2188
+ }>
2189
+ source_type?: string
2190
+ } | {
2191
+ id?: string
2192
+ title: string
2193
+ slug?: string
2194
+ description?: {
2195
+ preinstall?: string
2196
+ postinstall?: string
2197
+ }
2198
+ version?: string
2199
+ deployments?: Array<{
2200
+ source_org_id?: string
2201
+ source_blueprint_id?: string
2202
+ destination_org_id?: string
2203
+ destination_blueprint_id?: string
2204
+ triggered_at?: string // date-time
2205
+ }>
2206
+ is_verified?: boolean
2207
+ installation_status?: "IN_PROGRESS" | "CANCELED" | "PARTIAL" | "SUCCESS" | "FAILED"
2208
+ created_at?: string // date-time
2209
+ updated_at?: string // date-time
2210
+ created_by?: {
2211
+ name?: unknown
2212
+ org_id: string
2213
+ user_id?: string
2214
+ token_id?: string
2215
+ }
2216
+ updated_by?: {
2217
+ name?: unknown
2218
+ org_id: string
2219
+ user_id?: string
2220
+ token_id?: string
2221
+ }
2222
+ installation_job_ids?: string[]
2223
+ source_blueprint_id?: string
2224
+ archived?: boolean
2225
+ docs_url?: string
2226
+ recommended_apps?: string[]
2227
+ required_features?: {
2228
+ enabled?: string[]
2229
+ disabled?: string[]
2230
+ }
2231
+ zip_file_name?: string
2232
+ // ...
2233
+ }
2234
+ ```
2235
+
2236
+ ### `BlueprintJobID`
2237
+
2238
+ ID of a job
2239
+
2240
+ ```ts
2241
+ type BlueprintJobID = string
2242
+ ```
2243
+
2244
+ ### `CommonBlueprintJobFields`
2245
+
2246
+ ```ts
2247
+ type CommonBlueprintJobFields = {
2248
+ id?: string
2249
+ events?: Array<{
2250
+ timestamp?: string // date-time
2251
+ message?: string
2252
+ errors?: Array<{
2253
+ error?: { ... }
2254
+ code?: { ... }
2255
+ data?: { ... }
2256
+ }>
2257
+ level?: "info" | "warning" | "error"
2258
+ data?: {
2259
+ installed_blueprint_id?: { ... }
2260
+ export_job_id?: { ... }
2261
+ resources?: { ... }
2262
+ }
2263
+ }>
2264
+ triggered_at?: string // date-time
2265
+ created_by?: {
2266
+ name?: unknown
2267
+ org_id: string
2268
+ user_id?: string
2269
+ token_id?: string
2270
+ }
2271
+ }
2272
+ ```
2273
+
2274
+ ### `BlueprintExportJob`
2275
+
2276
+ ```ts
2277
+ type BlueprintExportJob = {
2278
+ id?: string
2279
+ events?: Array<{
2280
+ timestamp?: string // date-time
2281
+ message?: string
2282
+ errors?: Array<{
2283
+ error?: { ... }
2284
+ code?: { ... }
2285
+ data?: { ... }
2286
+ }>
2287
+ level?: "info" | "warning" | "error"
2288
+ data?: {
2289
+ installed_blueprint_id?: { ... }
2290
+ export_job_id?: { ... }
2291
+ resources?: { ... }
2292
+ }
2293
+ }>
2294
+ triggered_at?: string // date-time
2295
+ created_by?: {
2296
+ name?: unknown
2297
+ org_id: string
2298
+ user_id?: string
2299
+ token_id?: string
2300
+ }
2301
+ blueprint_id?: string
2302
+ status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED"
2303
+ download_file?: {
2304
+ bucket: string
2305
+ key: string
2306
+ }
2307
+ }
2308
+ ```
2309
+
2310
+ ### `BlueprintInstallationJob`
2311
+
2312
+ ```ts
2313
+ type BlueprintInstallationJob = {
2314
+ id?: string
2315
+ events?: Array<{
2316
+ timestamp?: string // date-time
2317
+ message?: string
2318
+ errors?: Array<{
2319
+ error?: { ... }
2320
+ code?: { ... }
2321
+ data?: { ... }
2322
+ }>
2323
+ level?: "info" | "warning" | "error"
2324
+ data?: {
2325
+ installed_blueprint_id?: { ... }
2326
+ export_job_id?: { ... }
2327
+ resources?: { ... }
2328
+ }
2329
+ }>
2330
+ triggered_at?: string // date-time
2331
+ created_by?: {
2332
+ name?: unknown
2333
+ org_id: string
2334
+ user_id?: string
2335
+ token_id?: string
2336
+ }
2337
+ source_blueprint_id?: string
2338
+ source_blueprint_type?: "custom" | "file" | "marketplace" | "deploy" | "app"
2339
+ source_org_id?: string
2340
+ source_blueprint_file?: string
2341
+ destination_blueprint_id?: string
2342
+ destination_org_id?: string
2343
+ slug?: string
2344
+ status?: "IN_PROGRESS" | "WAITING_USER_ACTION" | "CANCELED" | "SUCCESS" | "FAILED"
2345
+ }
2346
+ ```
2347
+
2348
+ ### `BlueprintJob`
2349
+
2350
+ ```ts
2351
+ type BlueprintJob = {
2352
+ id?: string
2353
+ events?: Array<{
2354
+ timestamp?: string // date-time
2355
+ message?: string
2356
+ errors?: Array<{
2357
+ error?: { ... }
2358
+ code?: { ... }
2359
+ data?: { ... }
2360
+ }>
2361
+ level?: "info" | "warning" | "error"
2362
+ data?: {
2363
+ installed_blueprint_id?: { ... }
2364
+ export_job_id?: { ... }
2365
+ resources?: { ... }
2366
+ }
2367
+ }>
2368
+ triggered_at?: string // date-time
2369
+ created_by?: {
2370
+ name?: unknown
2371
+ org_id: string
2372
+ user_id?: string
2373
+ token_id?: string
2374
+ }
2375
+ blueprint_id?: string
2376
+ status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED"
2377
+ download_file?: {
2378
+ bucket: string
2379
+ key: string
2380
+ }
2381
+ } | {
2382
+ id?: string
2383
+ events?: Array<{
2384
+ timestamp?: string // date-time
2385
+ message?: string
2386
+ errors?: Array<{
2387
+ error?: { ... }
2388
+ code?: { ... }
2389
+ data?: { ... }
2390
+ }>
2391
+ level?: "info" | "warning" | "error"
2392
+ data?: {
2393
+ installed_blueprint_id?: { ... }
2394
+ export_job_id?: { ... }
2395
+ resources?: { ... }
2396
+ }
2397
+ }>
2398
+ triggered_at?: string // date-time
2399
+ created_by?: {
2400
+ name?: unknown
2401
+ org_id: string
2402
+ user_id?: string
2403
+ token_id?: string
2404
+ }
2405
+ source_blueprint_id?: string
2406
+ source_blueprint_type?: "custom" | "file" | "marketplace" | "deploy" | "app"
2407
+ source_org_id?: string
2408
+ source_blueprint_file?: string
2409
+ destination_blueprint_id?: string
2410
+ destination_org_id?: string
2411
+ slug?: string
2412
+ status?: "IN_PROGRESS" | "WAITING_USER_ACTION" | "CANCELED" | "SUCCESS" | "FAILED"
2413
+ } | {
2414
+ id?: string
2415
+ events?: Array<{
2416
+ timestamp?: string // date-time
2417
+ message?: string
2418
+ errors?: Array<{
2419
+ error?: { ... }
2420
+ code?: { ... }
2421
+ data?: { ... }
2422
+ }>
2423
+ level?: "info" | "warning" | "error"
2424
+ data?: {
2425
+ installed_blueprint_id?: { ... }
2426
+ export_job_id?: { ... }
2427
+ resources?: { ... }
2428
+ }
2429
+ }>
2430
+ triggered_at?: string // date-time
2431
+ created_by?: {
2432
+ name?: unknown
2433
+ org_id: string
2434
+ user_id?: string
2435
+ token_id?: string
2436
+ }
2437
+ blueprint_id?: string
2438
+ status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED"
2439
+ } | {
2440
+ id?: string
2441
+ events?: Array<{
2442
+ timestamp?: string // date-time
2443
+ message?: string
2444
+ errors?: Array<{
2445
+ error?: { ... }
2446
+ code?: { ... }
2447
+ data?: { ... }
2448
+ }>
2449
+ level?: "info" | "warning" | "error"
2450
+ data?: {
2451
+ // ...
2452
+ }
2453
+ ```
2454
+
2455
+ ### `BlueprintDependenciesSyncJob`
2456
+
2457
+ ```ts
2458
+ type BlueprintDependenciesSyncJob = {
2459
+ id?: string
2460
+ events?: Array<{
2461
+ timestamp?: string // date-time
2462
+ message?: string
2463
+ errors?: Array<{
2464
+ error?: { ... }
2465
+ code?: { ... }
2466
+ data?: { ... }
2467
+ }>
2468
+ level?: "info" | "warning" | "error"
2469
+ data?: {
2470
+ installed_blueprint_id?: { ... }
2471
+ export_job_id?: { ... }
2472
+ resources?: { ... }
2473
+ }
2474
+ }>
2475
+ triggered_at?: string // date-time
2476
+ created_by?: {
2477
+ name?: unknown
2478
+ org_id: string
2479
+ user_id?: string
2480
+ token_id?: string
2481
+ }
2482
+ blueprint_id?: string
2483
+ status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED"
2484
+ }
2485
+ ```
2486
+
2487
+ ### `BlueprintValidateJob`
2488
+
2489
+ ```ts
2490
+ type BlueprintValidateJob = {
2491
+ id?: string
2492
+ events?: Array<{
2493
+ timestamp?: string // date-time
2494
+ message?: string
2495
+ errors?: Array<{
2496
+ error?: { ... }
2497
+ code?: { ... }
2498
+ data?: { ... }
2499
+ }>
2500
+ level?: "info" | "warning" | "error"
2501
+ data?: {
2502
+ installed_blueprint_id?: { ... }
2503
+ export_job_id?: { ... }
2504
+ resources?: { ... }
2505
+ }
2506
+ }>
2507
+ triggered_at?: string // date-time
2508
+ created_by?: {
2509
+ name?: unknown
2510
+ org_id: string
2511
+ user_id?: string
2512
+ token_id?: string
2513
+ }
2514
+ blueprint_id?: string
2515
+ status?: "IN_PROGRESS" | "SUCCESS" | "FAILED"
2516
+ valid?: boolean
2517
+ errors?: Array<{
2518
+ error?: string | object
2519
+ code?: "dependency_extraction" | "resource_not_found" | "resource_fetch_api_error" | "resource_fetch_unknown_error" | "terraform_cli_process_error" | "terraform_import_block_process_error" | "terraform_init_error" | "terraform_validate_error" | "terraform_plan_error" | "terraform_apply_error" | "terraform_show_error" | "generic_error" | "bad_request" | "forbidden" | "conflict" | "not_found" | "undeclared_resource" | "invalid_readonly_attribute" | "invalid_attribute_value" | "unsupported_attribute" | "self_referential_block" | "circular_dependency" | "state_mismatch" | "import_nonexistent_object" | "provider_install_error" | "stale_blueprint"
2520
+ data?: {
2521
+ formattedResource?: { ... }
2522
+ resource?: { ... }
2523
+ resourceDependency?: { ... }
2524
+ resources?: { ... }
2525
+ addresses?: { ... }
2526
+ originalError?: { ... }
2527
+ }
2528
+ }>
2529
+ }
2530
+ ```
2531
+
2532
+ ### `BlueprintJobEvent`
2533
+
2534
+ ```ts
2535
+ type BlueprintJobEvent = {
2536
+ timestamp?: string // date-time
2537
+ message?: string
2538
+ errors?: Array<{
2539
+ error?: string | object
2540
+ code?: "dependency_extraction" | "resource_not_found" | "resource_fetch_api_error" | "resource_fetch_unknown_error" | "terraform_cli_process_error" | "terraform_import_block_process_error" | "terraform_init_error" | "terraform_validate_error" | "terraform_plan_error" | "terraform_apply_error" | "terraform_show_error" | "generic_error" | "bad_request" | "forbidden" | "conflict" | "not_found" | "undeclared_resource" | "invalid_readonly_attribute" | "invalid_attribute_value" | "unsupported_attribute" | "self_referential_block" | "circular_dependency" | "state_mismatch" | "import_nonexistent_object" | "provider_install_error" | "stale_blueprint"
2541
+ data?: {
2542
+ formattedResource?: { ... }
2543
+ resource?: { ... }
2544
+ resourceDependency?: { ... }
2545
+ resources?: { ... }
2546
+ addresses?: { ... }
2547
+ originalError?: { ... }
2548
+ }
2549
+ }>
2550
+ level?: "info" | "warning" | "error"
2551
+ data?: {
2552
+ installed_blueprint_id?: string
2553
+ export_job_id?: string
2554
+ resources?: number
2555
+ }
2556
+ }
2557
+ ```
2558
+
2559
+ ### `BlueprintInstallationJobOptions`
2560
+
2561
+ ```ts
2562
+ type BlueprintInstallationJobOptions = {
2563
+ resources_to_ignore?: string[]
2564
+ }
2565
+ ```
2566
+
2567
+ ### `ManifestID`
2568
+
2569
+ ID of an imported / installed manifest
2570
+
2571
+ ```ts
2572
+ type ManifestID = string
2573
+ ```
2574
+
2575
+ ### `JobID`
2576
+
2577
+ ID of an import or export job (state machine)
2578
+
2579
+ ```ts
2580
+ type JobID = string
2581
+ ```
2582
+
2583
+ ### `ManifestSource`
2584
+
2585
+ ```ts
2586
+ type ManifestSource = "file" | "marketplace" | "sandbox"
2587
+ ```
2588
+
2589
+ ### `Manifest`
2590
+
2591
+ ```ts
2592
+ type Manifest = {
2593
+ import_job_id?: string
2594
+ previous_jobs_ids?: string[]
2595
+ previous_jobs?: Array<{
2596
+ job_id?: string
2597
+ job_status?: "PENDING" | "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED"
2598
+ manifest_file_path?: string
2599
+ message?: string
2600
+ timestamp?: string // date-time
2601
+ plan_file_content?: string
2602
+ resources_to_export?: Array<{
2603
+ id: { ... }
2604
+ type: { ... }
2605
+ name?: { ... }
2606
+ source_id?: { ... }
2607
+ is_virtual?: { ... }
2608
+ address?: { ... }
2609
+ dependencies?: { ... }
2610
+ changes?: { ... }
2611
+ changes_reason?: { ... }
2612
+ }> | {
2613
+ id: { ... }
2614
+ type: { ... }
2615
+ name?: { ... }
2616
+ source_id?: { ... }
2617
+ is_virtual?: { ... }
2618
+ address?: { ... }
2619
+ dependencies?: { ... }
2620
+ changes?: { ... }
2621
+ changes_reason?: { ... }
2622
+ }
2623
+ large_resources_to_export_url?: string
2624
+ resources_to_import?: Array<{
2625
+ id: { ... }
2626
+ type: { ... }
2627
+ name?: { ... }
2628
+ source_id?: { ... }
2629
+ is_virtual?: { ... }
2630
+ address?: { ... }
2631
+ dependencies?: { ... }
2632
+ changes?: { ... }
2633
+ changes_reason?: { ... }
2634
+ }> | {
2635
+ id: { ... }
2636
+ type: { ... }
2637
+ name?: { ... }
2638
+ source_id?: { ... }
2639
+ is_virtual?: { ... }
2640
+ address?: { ... }
2641
+ dependencies?: { ... }
2642
+ changes?: { ... }
2643
+ changes_reason?: { ... }
2644
+ }
2645
+ large_resources_to_import_url?: string
2646
+ resource_replacements?: Array<{
2647
+ originalAddress: { ... }
2648
+ replacementId: { ... }
2649
+ replacementName?: { ... }
2650
+ }>
2651
+ is_verified?: boolean
2652
+ errors?: Array<{
2653
+ error?: { ... }
2654
+ code?: { ... }
2655
+ data?: { ... }
2656
+ }>
2657
+ source_type?: "file" | "marketplace" | "sandbox"
2658
+ imported_resources?: Array<{
2659
+ id: { ... }
2660
+ type: { ... }
2661
+ name?: { ... }
2662
+ source_id?: { ... }
2663
+ is_virtual?: { ... }
2664
+ address?: { ... }
2665
+ dependencies?: { ... }
2666
+ changes?: { ... }
2667
+ changes_reason?: { ... }
2668
+ }> | {
2669
+ id: { ... }
2670
+ type: { ... }
2671
+ name?: { ... }
2672
+ source_id?: { ... }
2673
+ is_virtual?: { ... }
2674
+ address?: { ... }
2675
+ dependencies?: { ... }
2676
+ changes?: { ... }
2677
+ changes_reason?: { ... }
2678
+ }
2679
+ large_imported_resources_url?: string // uri
2680
+ markdown?: {
2681
+ manifest?: { ... }
2682
+ preinstall?: { ... }
2683
+ postinstall?: { ... }
2684
+ }
2685
+ manifest_id?: string
2686
+ source_blueprint_name?: string
2687
+ source_blueprint_slug?: string
2688
+ source_blueprint_version?: string
2689
+ pre_install_requirements?: string[]
2690
+ source_blueprint_file?: string
2691
+ docs_link?: string
2692
+ // ...
2693
+ }
2694
+ ```
2695
+
2696
+ ### `ManifestItem`
2697
+
2698
+ ```ts
2699
+ type ManifestItem = {
2700
+ manifest_id?: string
2701
+ source_type?: "file" | "marketplace" | "sandbox"
2702
+ source_blueprint_name?: string
2703
+ source_blueprint_slug?: string
2704
+ source_blueprint_version?: string
2705
+ pre_install_requirements?: string[]
2706
+ source_blueprint_file?: string
2707
+ docs_link?: string
2708
+ source_blueprint_file_ref?: {
2709
+ bucket: string
2710
+ key: string
2711
+ }
2712
+ install_status?: "SUCCESS" | "PARTIAL" | "FAILED"
2713
+ install_status_description?: string
2714
+ is_verified?: boolean
2715
+ created_by?: {
2716
+ name?: unknown
2717
+ org_id: string
2718
+ user_id?: string
2719
+ token_id?: string
2720
+ }
2721
+ updated_by?: {
2722
+ name?: unknown
2723
+ org_id: string
2724
+ user_id?: string
2725
+ token_id?: string
2726
+ }
2727
+ manifest_version?: string
2728
+ selected_resources_url?: string
2729
+ ready_imported_resources_url?: string
2730
+ deployed_from?: {
2731
+ source_organization_id?: string
2732
+ source_manifest_id?: string
2733
+ source_organization_type?: "sandbox" | "production"
2734
+ last_triggered_at?: string // date-time
2735
+ }
2736
+ deployed_to?: Array<{
2737
+ destination_organization_id?: string
2738
+ destination_manifest_id?: string
2739
+ destination_organization_type?: "sandbox" | "production"
2740
+ last_triggered_at?: string // date-time
2741
+ }>
2742
+ created_at?: string // date-time
2743
+ updated_at?: string // date-time
2744
+ }
2745
+ ```
2746
+
2747
+ ### `JobStatus`
2748
+
2749
+ ```ts
2750
+ type JobStatus = "PENDING" | "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED"
2751
+ ```
2752
+
2753
+ ### `ResourceNodeType`
2754
+
2755
+ Type of the resource
2756
+
2757
+ ```ts
2758
+ type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2759
+ ```
2760
+
2761
+ ### `PlanChanges`
2762
+
2763
+ ```ts
2764
+ type PlanChanges = "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2765
+ ```
2766
+
2767
+ ### `CommonResourceNode`
2768
+
2769
+ ```ts
2770
+ type CommonResourceNode = {
2771
+ id: string
2772
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2773
+ name?: string
2774
+ source_id?: string
2775
+ is_virtual?: boolean
2776
+ }
2777
+ ```
2778
+
2779
+ ### `RootResourceNode`
2780
+
2781
+ ```ts
2782
+ type RootResourceNode = {
2783
+ id: string
2784
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2785
+ name?: string
2786
+ source_id?: string
2787
+ is_virtual?: boolean
2788
+ address?: string
2789
+ dependencies?: Array<{
2790
+ id: string
2791
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2792
+ name?: string
2793
+ source_id?: string
2794
+ is_virtual?: true
2795
+ dependencies?: Array<{
2796
+ id: { ... }
2797
+ type: { ... }
2798
+ name?: { ... }
2799
+ source_id?: { ... }
2800
+ is_virtual?: { ... }
2801
+ address?: { ... }
2802
+ dependencies?: { ... }
2803
+ parents?: { ... }
2804
+ changes?: { ... }
2805
+ changes_reason?: { ... }
2806
+ }>
2807
+ }>
2808
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2809
+ changes_reason?: string[]
2810
+ }
2811
+ ```
2812
+
2813
+ ### `VirtualResourceNodeGroup`
2814
+
2815
+ ```ts
2816
+ type VirtualResourceNodeGroup = {
2817
+ id: string
2818
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2819
+ name?: string
2820
+ source_id?: string
2821
+ is_virtual?: true
2822
+ dependencies?: Array<{
2823
+ id: string
2824
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2825
+ name?: string
2826
+ source_id?: string
2827
+ is_virtual?: boolean
2828
+ address?: string
2829
+ dependencies?: Array<{
2830
+ id: { ... }
2831
+ type: { ... }
2832
+ name?: { ... }
2833
+ source_id?: { ... }
2834
+ is_virtual?: { ... }
2835
+ address?: { ... }
2836
+ dependencies?: { ... }
2837
+ parents?: { ... }
2838
+ changes?: { ... }
2839
+ changes_reason?: { ... }
2840
+ }>
2841
+ parents?: Array<{
2842
+ id?: { ... }
2843
+ type?: { ... }
2844
+ }>
2845
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2846
+ changes_reason?: string[]
2847
+ }>
2848
+ }
2849
+ ```
2850
+
2851
+ ### `ResourceNode`
2852
+
2853
+ ```ts
2854
+ type ResourceNode = {
2855
+ id: string
2856
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2857
+ name?: string
2858
+ source_id?: string
2859
+ is_virtual?: boolean
2860
+ address?: string
2861
+ dependencies?: Array<{
2862
+ id: string
2863
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2864
+ name?: string
2865
+ source_id?: string
2866
+ is_virtual?: boolean
2867
+ address?: string
2868
+ dependencies?: Array<{
2869
+ id: { ... }
2870
+ type: { ... }
2871
+ name?: { ... }
2872
+ source_id?: { ... }
2873
+ is_virtual?: { ... }
2874
+ address?: { ... }
2875
+ dependencies?: { ... }
2876
+ parents?: { ... }
2877
+ changes?: { ... }
2878
+ changes_reason?: { ... }
2879
+ }>
2880
+ parents?: Array<{
2881
+ id?: { ... }
2882
+ type?: { ... }
2883
+ }>
2884
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2885
+ changes_reason?: string[]
2886
+ }>
2887
+ parents?: Array<{
2888
+ id?: string
2889
+ type?: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2890
+ }>
2891
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2892
+ changes_reason?: string[]
2893
+ }
2894
+ ```
2895
+
2896
+ ### `Job`
2897
+
2898
+ ```ts
2899
+ type Job = {
2900
+ job_id?: string
2901
+ job_status?: "PENDING" | "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED"
2902
+ manifest_file_path?: string
2903
+ message?: string
2904
+ timestamp?: string // date-time
2905
+ plan_file_content?: string
2906
+ resources_to_export?: Array<{
2907
+ id: string
2908
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2909
+ name?: string
2910
+ source_id?: string
2911
+ is_virtual?: boolean
2912
+ address?: string
2913
+ dependencies?: Array<{
2914
+ id: { ... }
2915
+ type: { ... }
2916
+ name?: { ... }
2917
+ source_id?: { ... }
2918
+ is_virtual?: { ... }
2919
+ dependencies?: { ... }
2920
+ }>
2921
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2922
+ changes_reason?: string[]
2923
+ }> | {
2924
+ id: string
2925
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2926
+ name?: string
2927
+ source_id?: string
2928
+ is_virtual?: boolean
2929
+ address?: string
2930
+ dependencies?: Array<{
2931
+ id: { ... }
2932
+ type: { ... }
2933
+ name?: { ... }
2934
+ source_id?: { ... }
2935
+ is_virtual?: { ... }
2936
+ dependencies?: { ... }
2937
+ }>
2938
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2939
+ changes_reason?: string[]
2940
+ }
2941
+ large_resources_to_export_url?: string
2942
+ resources_to_import?: Array<{
2943
+ id: string
2944
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2945
+ name?: string
2946
+ source_id?: string
2947
+ is_virtual?: boolean
2948
+ address?: string
2949
+ dependencies?: Array<{
2950
+ id: { ... }
2951
+ type: { ... }
2952
+ name?: { ... }
2953
+ source_id?: { ... }
2954
+ is_virtual?: { ... }
2955
+ dependencies?: { ... }
2956
+ }>
2957
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2958
+ changes_reason?: string[]
2959
+ }> | {
2960
+ id: string
2961
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
2962
+ name?: string
2963
+ source_id?: string
2964
+ is_virtual?: boolean
2965
+ address?: string
2966
+ dependencies?: Array<{
2967
+ id: { ... }
2968
+ type: { ... }
2969
+ name?: { ... }
2970
+ source_id?: { ... }
2971
+ is_virtual?: { ... }
2972
+ dependencies?: { ... }
2973
+ }>
2974
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
2975
+ changes_reason?: string[]
2976
+ }
2977
+ large_resources_to_import_url?: string
2978
+ resource_replacements?: Array<{
2979
+ originalAddress: string
2980
+ replacementId: string
2981
+ replacementName?: string
2982
+ }>
2983
+ is_verified?: boolean
2984
+ errors?: Array<{
2985
+ error?: string | object
2986
+ code?: "dependency_extraction" | "resource_not_found" | "resource_fetch_api_error" | "resource_fetch_unknown_error" | "terraform_cli_process_error" | "terraform_import_block_process_error" | "terraform_init_error" | "terraform_validate_error" | "terraform_plan_error" | "terraform_apply_error" | "terraform_show_error" | "generic_error" | "bad_request" | "forbidden" | "conflict" | "not_found" | "undeclared_resource" | "invalid_readonly_attribute" | "invalid_attribute_value" | "unsupported_attribute" | "self_referential_block" | "circular_dependency" | "state_mismatch" | "import_nonexistent_object" | "provider_install_error" | "stale_blueprint"
2987
+ data?: {
2988
+ formattedResource?: { ... }
2989
+ resource?: { ... }
2990
+ resourceDependency?: { ... }
2991
+ resources?: { ... }
2992
+ addresses?: { ... }
2993
+ originalError?: { ... }
2994
+ }
2995
+ }>
2996
+ source_type?: "file" | "marketplace" | "sandbox"
2997
+ imported_resources?: Array<{
2998
+ id: string
2999
+ // ...
3000
+ }
3001
+ ```
3002
+
3003
+ ### `UploadFilePayload`
3004
+
3005
+ ```ts
3006
+ type UploadFilePayload = {
3007
+ filename: string
3008
+ }
3009
+ ```
3010
+
3011
+ ### `S3Reference`
3012
+
3013
+ ```ts
3014
+ type S3Reference = {
3015
+ bucket: string
3016
+ key: string
3017
+ }
3018
+ ```
3019
+
3020
+ ### `CommonManifestFields`
3021
+
3022
+ ```ts
3023
+ type CommonManifestFields = {
3024
+ manifest_id?: string
3025
+ source_type?: "file" | "marketplace" | "sandbox"
3026
+ source_blueprint_name?: string
3027
+ source_blueprint_slug?: string
3028
+ source_blueprint_version?: string
3029
+ pre_install_requirements?: string[]
3030
+ source_blueprint_file?: string
3031
+ docs_link?: string
3032
+ source_blueprint_file_ref?: {
3033
+ bucket: string
3034
+ key: string
3035
+ }
3036
+ install_status?: "SUCCESS" | "PARTIAL" | "FAILED"
3037
+ install_status_description?: string
3038
+ is_verified?: boolean
3039
+ created_by?: {
3040
+ name?: unknown
3041
+ org_id: string
3042
+ user_id?: string
3043
+ token_id?: string
3044
+ }
3045
+ updated_by?: {
3046
+ name?: unknown
3047
+ org_id: string
3048
+ user_id?: string
3049
+ token_id?: string
3050
+ }
3051
+ manifest_version?: string
3052
+ selected_resources_url?: string
3053
+ ready_imported_resources_url?: string
3054
+ deployed_from?: {
3055
+ source_organization_id?: string
3056
+ source_manifest_id?: string
3057
+ source_organization_type?: "sandbox" | "production"
3058
+ last_triggered_at?: string // date-time
3059
+ }
3060
+ deployed_to?: Array<{
3061
+ destination_organization_id?: string
3062
+ destination_manifest_id?: string
3063
+ destination_organization_type?: "sandbox" | "production"
3064
+ last_triggered_at?: string // date-time
3065
+ }>
3066
+ }
3067
+ ```
3068
+
3069
+ ### `ManifestTimestampFields`
3070
+
3071
+ ```ts
3072
+ type ManifestTimestampFields = {
3073
+ created_at?: string // date-time
3074
+ updated_at?: string // date-time
3075
+ }
3076
+ ```
3077
+
3078
+ ### `CommonImportFields`
3079
+
3080
+ ```ts
3081
+ type CommonImportFields = {
3082
+ source_type?: "file" | "marketplace" | "sandbox"
3083
+ imported_resources?: Array<{
3084
+ id: string
3085
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
3086
+ name?: string
3087
+ source_id?: string
3088
+ is_virtual?: boolean
3089
+ address?: string
3090
+ dependencies?: Array<{
3091
+ id: { ... }
3092
+ type: { ... }
3093
+ name?: { ... }
3094
+ source_id?: { ... }
3095
+ is_virtual?: { ... }
3096
+ dependencies?: { ... }
3097
+ }>
3098
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
3099
+ changes_reason?: string[]
3100
+ }> | {
3101
+ id: string
3102
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
3103
+ name?: string
3104
+ source_id?: string
3105
+ is_virtual?: boolean
3106
+ address?: string
3107
+ dependencies?: Array<{
3108
+ id: { ... }
3109
+ type: { ... }
3110
+ name?: { ... }
3111
+ source_id?: { ... }
3112
+ is_virtual?: { ... }
3113
+ dependencies?: { ... }
3114
+ }>
3115
+ changes?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored"[]
3116
+ changes_reason?: string[]
3117
+ }
3118
+ large_imported_resources_url?: string // uri
3119
+ }
3120
+ ```
3121
+
3122
+ ### `CommonMarkdownFields`
3123
+
3124
+ ```ts
3125
+ type CommonMarkdownFields = {
3126
+ markdown?: {
3127
+ manifest?: string
3128
+ preinstall?: string
3129
+ postinstall?: string
3130
+ }
3131
+ }
3132
+ ```
3133
+
3134
+ ### `PreInstallRequirements`
3135
+
3136
+ List of feature settings that must be enabled before installing the blueprint
3137
+
3138
+ ```ts
3139
+ type PreInstallRequirements = string[]
3140
+ ```
3141
+
3142
+ ### `BlueprintInstallStatus`
3143
+
3144
+ ```ts
3145
+ type BlueprintInstallStatus = "SUCCESS" | "PARTIAL" | "FAILED"
3146
+ ```
3147
+
3148
+ ### `FormattedErrorCodes`
3149
+
3150
+ ```ts
3151
+ type FormattedErrorCodes = "dependency_extraction" | "resource_not_found" | "resource_fetch_api_error" | "resource_fetch_unknown_error" | "terraform_cli_process_error" | "terraform_import_block_process_error" | "terraform_init_error" | "terraform_validate_error" | "terraform_plan_error" | "terraform_apply_error" | "terraform_show_error" | "generic_error" | "bad_request" | "forbidden" | "conflict" | "not_found" | "undeclared_resource" | "invalid_readonly_attribute" | "invalid_attribute_value" | "unsupported_attribute" | "self_referential_block" | "circular_dependency" | "state_mismatch" | "import_nonexistent_object" | "provider_install_error" | "stale_blueprint"
3152
+ ```
3153
+
3154
+ ### `FormattedErrorData`
3155
+
3156
+ ```ts
3157
+ type FormattedErrorData = {
3158
+ id?: string
3159
+ name?: string
3160
+ type?: string
3161
+ }
3162
+ ```
3163
+
3164
+ ### `FormattedError`
3165
+
3166
+ ```ts
3167
+ type FormattedError = {
3168
+ error?: string | object
3169
+ code?: "dependency_extraction" | "resource_not_found" | "resource_fetch_api_error" | "resource_fetch_unknown_error" | "terraform_cli_process_error" | "terraform_import_block_process_error" | "terraform_init_error" | "terraform_validate_error" | "terraform_plan_error" | "terraform_apply_error" | "terraform_show_error" | "generic_error" | "bad_request" | "forbidden" | "conflict" | "not_found" | "undeclared_resource" | "invalid_readonly_attribute" | "invalid_attribute_value" | "unsupported_attribute" | "self_referential_block" | "circular_dependency" | "state_mismatch" | "import_nonexistent_object" | "provider_install_error" | "stale_blueprint"
3170
+ data?: {
3171
+ formattedResource?: {
3172
+ id?: { ... }
3173
+ name?: { ... }
3174
+ type?: { ... }
3175
+ }
3176
+ resource?: string
3177
+ resourceDependency?: string
3178
+ resources?: string[]
3179
+ addresses?: string[]
3180
+ originalError?: string
3181
+ }
3182
+ }
3183
+ ```
3184
+
3185
+ ### `CallerIdentity`
3186
+
3187
+ ```ts
3188
+ type CallerIdentity = {
3189
+ name?: unknown
3190
+ org_id: string
3191
+ user_id?: string
3192
+ token_id?: string
3193
+ }
3194
+ ```
3195
+
3196
+ ### `SelectedResources`
3197
+
3198
+ ```ts
3199
+ type SelectedResources = {
3200
+ exported_root_resources: Array<{
3201
+ id: string
3202
+ type: "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template"
3203
+ address?: string
3204
+ }>
3205
+ selected_resources: string[]
3206
+ pipeline_id?: string
3207
+ }
3208
+ ```
3209
+
3210
+ ### `ResourceReplacement`
3211
+
3212
+ ```ts
3213
+ type ResourceReplacement = {
3214
+ originalAddress: string
3215
+ replacementId: string
3216
+ replacementName?: string
3217
+ }
3218
+ ```
3219
+
3220
+ ### `PutManifestPayload`
3221
+
3222
+ ```ts
3223
+ type PutManifestPayload = {
3224
+ source_blueprint_name?: string
3225
+ markdown?: string
3226
+ ready_resources?: string[]
3227
+ deployed_to?: Array<{
3228
+ destination_organization_id?: string
3229
+ destination_manifest_id?: string
3230
+ destination_organization_type?: "sandbox" | "production"
3231
+ last_triggered_at?: string
3232
+ }>
3233
+ }
3234
+ ```