@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
package/dist/entity-IX5NSHPX.cjs ADDED
@@ -0,0 +1,7 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
+
3
+ // src/docs/entity.json
4
+ var entity_default = '# Entity API\n\n- **Base URL:** `https://entity.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/entity](https://docs.epilot.io/api/entity)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.entity.listSchemas(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/entity\'\n\nconst entityClient = getClient()\nauthorize(entityClient, () => \'<token>\')\nconst { data } = await entityClient.listSchemas(...)\n```\n\n## Operations\n\n**Schemas**\n- [`listSchemas`](#listschemas)\n- [`listSchemasV2`](#listschemasv2)\n- [`getSchema`](#getschema)\n- [`putSchema`](#putschema)\n- [`deleteSchema`](#deleteschema)\n- [`getJsonSchema`](#getjsonschema)\n- [`getSchemaExample`](#getschemaexample)\n- [`getSchemaVersions`](#getschemaversions)\n- [`listAvailableCapabilities`](#listavailablecapabilities)\n- [`listSchemaBlueprints`](#listschemablueprints)\n- [`listTaxonomyClassificationsForSchema`](#listtaxonomyclassificationsforschema)\n- [`createSchemaAttribute`](#createschemaattribute)\n- [`getSchemaAttribute`](#getschemaattribute)\n- [`putSchemaAttribute`](#putschemaattribute)\n- [`deleteSchemaAttribute`](#deleteschemaattribute)\n- [`createSchemaCapability`](#createschemacapability)\n- [`getSchemaCapability`](#getschemacapability)\n- [`putSchemaCapability`](#putschemacapability)\n- [`deleteSchemaCapability`](#deleteschemacapability)\n- [`createSchemaGroup`](#createschemagroup)\n- [`getSchemaGroup`](#getschemagroup)\n- [`putSchemaGroup`](#putschemagroup)\n- [`deleteSchemaGroup`](#deleteschemagroup)\n- [`createSchemaGroupHeadline`](#createschemagroupheadline)\n- [`getSchemaGroupHeadline`](#getschemagroupheadline)\n- [`putSchemaGroupHeadline`](#putschemagroupheadline)\n- [`deleteSchemaGroupHeadline`](#deleteschemagroupheadline)\n\n**Entities**\n- [`searchEntities`](#searchentities)\n- [`listEntities`](#listentities)\n- [`queryEntityGraph`](#queryentitygraph)\n- [`createEntity`](#createentity)\n- [`validateEntity`](#validateentity)\n- [`validateEntityV2`](#validateentityv2)\n- [`upsertEntity`](#upsertentity)\n- [`getEntityV2`](#getentityv2)\n- [`restoreEntity`](#restoreentity)\n- [`reindexEntity`](#reindexentity)\n- [`getEntity`](#getentity)\n- [`updateEntity`](#updateentity)\n- [`patchEntity`](#patchentity)\n- [`deleteEntity`](#deleteentity)\n- [`autocomplete`](#autocomplete)\n- [`wipeAllEntities`](#wipeallentities)\n\n**Activity**\n- [`createActivity`](#createactivity)\n- [`getActivity`](#getactivity)\n- [`attachActivity`](#attachactivity)\n- [`getEntityActivityFeed`](#getentityactivityfeed)\n\n**Relations**\n- [`getRelations`](#getrelations)\n- [`addRelations`](#addrelations)\n- [`removeRelations`](#removerelations)\n- [`getRelationsV2`](#getrelationsv2)\n- [`getRelationsV3`](#getrelationsv3)\n- [`getRelatedEntitiesCount`](#getrelatedentitiescount)\n- [`updateRelation`](#updaterelation)\n- [`deleteRelation`](#deleterelation)\n\n**Import-Export**\n- [`exportEntities`](#exportentities)\n- [`importEntities`](#importentities)\n\n**Saved Views**\n- [`listSavedViews`](#listsavedviews)\n- [`createSavedView`](#createsavedview)\n- [`getSavedView`](#getsavedview)\n- [`updateSavedView`](#updatesavedview)\n- [`patchSavedView`](#patchsavedview)\n- [`deleteSavedView`](#deletesavedview)\n- [`listFavoriteViewsForUser`](#listfavoriteviewsforuser)\n\n**Taxonomy**\n- [`listTaxonomies`](#listtaxonomies)\n- [`createTaxonomy`](#createtaxonomy)\n- [`getTaxonomy`](#gettaxonomy)\n- [`updateTaxonomy`](#updatetaxonomy)\n- [`deleteTaxonomy`](#deletetaxonomy)\n- [`updateClassificationsForTaxonomy`](#updateclassificationsfortaxonomy)\n- [`createTaxonomyClassification`](#createtaxonomyclassification)\n- [`getTaxonomyClassification`](#gettaxonomyclassification)\n- [`updateTaxonomyClassification`](#updatetaxonomyclassification)\n- [`deleteTaxonomyClassification`](#deletetaxonomyclassification)\n- [`taxonomyAutocomplete`](#taxonomyautocomplete)\n- [`taxonomiesClassificationsSearch`](#taxonomiesclassificationssearch)\n- [`getTaxonomyBulkActionJobs`](#gettaxonomybulkactionjobs)\n- [`getTaxonomyBulkActionJobById`](#gettaxonomybulkactionjobbyid)\n- [`cancelBulkAction`](#cancelbulkaction)\n- [`bulkMoveClassifications`](#bulkmoveclassifications)\n- [`bulkMergeClassifications`](#bulkmergeclassifications)\n- [`bulkDeleteClassifications`](#bulkdeleteclassifications)\n\n**Schemas**\n- [`ExportJobId`](#exportjobid)\n- [`Language`](#language)\n- [`IsTemplate`](#istemplate)\n- [`SchemaId`](#schemaid)\n- [`EntitySchema`](#entityschema)\n- [`EntitySchemaItem`](#entityschemaitem)\n- [`GenerateEntityTableAIFiltersRequest`](#generateentitytableaifiltersrequest)\n- [`GenerateEntityTableAIFiltersResponse`](#generateentitytableaifiltersresponse)\n- [`EntityTableFilterSearch`](#entitytablefiltersearch)\n- [`EntityTableFilterOption`](#entitytablefilteroption)\n- [`EntitySchemaGroup`](#entityschemagroup)\n- [`EntitySchemaGroupWithCompositeID`](#entityschemagroupwithcompositeid)\n- [`Attribute`](#attribute)\n- [`AttributeWithCompositeID`](#attributewithcompositeid)\n- [`BaseAttribute`](#baseattribute)\n- [`TextAttribute`](#textattribute)\n- [`LinkAttribute`](#linkattribute)\n- [`InternalAttribute`](#internalattribute)\n- [`BooleanAttribute`](#booleanattribute)\n- [`DateAttribute`](#dateattribute)\n- [`CountryAttribute`](#countryattribute)\n- [`SelectAttribute`](#selectattribute)\n- [`MultiSelectAttribute`](#multiselectattribute)\n- [`StatusAttribute`](#statusattribute)\n- [`SequenceAttribute`](#sequenceattribute)\n- [`FileAttribute`](#fileattribute)\n- [`CurrencyAttribute`](#currencyattribute)\n- [`SummaryField`](#summaryfield)\n- [`EntityAction`](#entityaction)\n- [`RelationAttribute`](#relationattribute)\n- [`UserRelationAttribute`](#userrelationattribute)\n- [`PartnerOrganisationAttribute`](#partnerorganisationattribute)\n- [`PortalAccessAttribute`](#portalaccessattribute)\n- [`DefaultAddressFields`](#defaultaddressfields)\n- [`AddressAttribute`](#addressattribute)\n- [`AddressRelationAttribute`](#addressrelationattribute)\n- [`PaymentMethodRelationAttribute`](#paymentmethodrelationattribute)\n- [`InvitationEmailAttribute`](#invitationemailattribute)\n- [`AutomationAttribute`](#automationattribute)\n- [`InternalUserAttribute`](#internaluserattribute)\n- [`PurposeAttribute`](#purposeattribute)\n- [`RepeatableAttribute`](#repeatableattribute)\n- [`TagsAttribute`](#tagsattribute)\n- [`MessageEmailAddressAttribute`](#messageemailaddressattribute)\n- [`NumberAttribute`](#numberattribute)\n- [`TableAttribute`](#tableattribute)\n- [`ConsentAttribute`](#consentattribute)\n- [`OrderedListAttribute`](#orderedlistattribute)\n- [`EmailAttribute`](#emailattribute)\n- [`PhoneAttribute`](#phoneattribute)\n- [`PaymentAttribute`](#paymentattribute)\n- [`PriceComponentAttribute`](#pricecomponentattribute)\n- [`ComputedAttribute`](#computedattribute)\n- [`PartnerStatusAttribute`](#partnerstatusattribute)\n- [`SummaryAttribute`](#summaryattribute)\n- [`GroupHeadline`](#groupheadline)\n- [`GroupHeadlineWithCompositeID`](#groupheadlinewithcompositeid)\n- [`EntitySlug`](#entityslug)\n- [`EntityCapability`](#entitycapability)\n- [`EntityCapabilityWithCompositeID`](#entitycapabilitywithcompositeid)\n- [`EntityViewDisabled`](#entityviewdisabled)\n- [`EntityDefaultTable`](#entitydefaulttable)\n- [`EntityDefaultCreate`](#entitydefaultcreate)\n- [`EntityDefaultEdit`](#entitydefaultedit)\n- [`RedirectEntityView`](#redirectentityview)\n- [`EntityId`](#entityid)\n- [`BaseEntity`](#baseentity)\n- [`Entity`](#entity)\n- [`NullableEntity`](#nullableentity)\n- [`EntityOwner`](#entityowner)\n- [`EntityAcl`](#entityacl)\n- [`HydratedEntity`](#hydratedentity)\n- [`EntityItem`](#entityitem)\n- [`EntityValidationError`](#entityvalidationerror)\n- [`EntityValidationResultSuccess`](#entityvalidationresultsuccess)\n- [`EntityValidationResultError`](#entityvalidationresulterror)\n- [`EntityValidationResult`](#entityvalidationresult)\n- [`EntityValidationV2Error`](#entityvalidationv2error)\n- [`EntityValidationV2ResultSuccess`](#entityvalidationv2resultsuccess)\n- [`EntityValidationV2ResultError`](#entityvalidationv2resulterror)\n- [`EntityValidationV2Result`](#entityvalidationv2result)\n- [`HydratedEntityItem`](#hydratedentityitem)\n- [`GetRelationsResp`](#getrelationsresp)\n- [`GetRelationsRespWithPagination`](#getrelationsrespwithpagination)\n- [`GetRelatedEntitiesCount`](#getrelatedentitiescount)\n- [`RelationEntity`](#relationentity)\n- [`RelationItem`](#relationitem)\n- [`EntitySearchIncludeDeletedParam`](#entitysearchincludedeletedparam)\n- [`EntitySearchParams`](#entitysearchparams)\n- [`EntityListParams`](#entitylistparams)\n- [`SearchFilter`](#searchfilter)\n- [`SearchFilterValue`](#searchfiltervalue)\n- [`EntitySearchOptions`](#entitysearchoptions)\n- [`FieldsParam`](#fieldsparam)\n- [`EntityImportParams`](#entityimportparams)\n- [`GraphQueryRequest`](#graphqueryrequest)\n- [`GraphSeed`](#graphseed)\n- [`GraphDefinition`](#graphdefinition)\n- [`GraphNode`](#graphnode)\n- [`GraphEdge`](#graphedge)\n- [`GraphQueryResponse`](#graphqueryresponse)\n- [`EntitySearchResults`](#entitysearchresults)\n- [`SearchMappings`](#searchmappings)\n- [`ActivityId`](#activityid)\n- [`ActivityCallerContext`](#activitycallercontext)\n- [`ActivityType`](#activitytype)\n- [`Activity`](#activity)\n- [`EntityOperation`](#entityoperation)\n- [`BaseActivityItem`](#baseactivityitem)\n- [`ActivityItem`](#activityitem)\n- [`BlueprintEntityId`](#blueprintentityid)\n- [`ListSavedViewsResults`](#listsavedviewsresults)\n- [`SavedViewId`](#savedviewid)\n- [`SavedViewItem`](#savedviewitem)\n- [`SavedViewPartial`](#savedviewpartial)\n- [`SavedView`](#savedview)\n- [`Taxonomy`](#taxonomy)\n- [`TaxonomyLocationId`](#taxonomylocationid)\n- [`TaxonomySearchIncludeArchivedParam`](#taxonomysearchincludearchivedparam)\n- [`TaxonomyClassification`](#taxonomyclassification)\n- [`ClassificationId`](#classificationid)\n- [`ClassificationIdOrPattern`](#classificationidorpattern)\n- [`ClassificationSlug`](#classificationslug)\n- [`TaxonomySlug`](#taxonomyslug)\n- [`ClassificationsUpdate`](#classificationsupdate)\n- [`TaxonomyBulkJobTriggerResponse`](#taxonomybulkjobtriggerresponse)\n- [`TaxonomyBulkJobStatus`](#taxonomybulkjobstatus)\n- [`TaxonomyBulkJobActionType`](#taxonomybulkjobactiontype)\n- [`TaxonomyBulkJob`](#taxonomybulkjob)\n- [`ESClusterAssignment`](#esclusterassignment)\n- [`SettingFlag`](#settingflag)\n- [`ErrorObject`](#errorobject)\n\n### `listSchemas`\n\nGet the latest versions of all schemas\n\n`GET /v1/entity/schemas`\n\n```ts\nconst { data } = await client.listSchemas({\n unpublished: true,\n exclude: [\'...\'],\n include: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "comment": "string",\n "source": {},\n "_summary": true,\n "slug": "contact",\n "version": 1,\n "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "enable_setting": ["360_features"],\n "name": "Contact",\n "plural": "Contacts",\n "description": "Example description",\n "docs_url": "https://docs.epilot.io/docs/pricing/entities",\n "category": "customer_relations",\n "published": false,\n "draft": false,\n "icon": "person",\n "title_template": "{{first_name}} {{last_name}}",\n "ui_config": {},\n "capabilities": [],\n "group_settings": [],\n "layout_settings": {},\n "dialog_config": {},\n "attributes": [],\n "_purpose": ["string"],\n "explicit_search_mappings": {},\n "group_headlines": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listSchemasV2`\n\nGet the latest versions of all schemas.\nReturns summary schemas by default (only summary attributes, no capabilities).\nUse ?full=true for complete schemas.\n\n`GET /v2/entity/schemas`\n\n```ts\nconst { data } = await client.listSchemasV2({\n full: true,\n unpublished: true,\n exclude: [\'...\'],\n include: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "comment": "string",\n "source": {},\n "_summary": true,\n "slug": "contact",\n "version": 1,\n "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "enable_setting": ["360_features"],\n "name": "Contact",\n "plural": "Contacts",\n "description": "Example description",\n "docs_url": "https://docs.epilot.io/docs/pricing/entities",\n "category": "customer_relations",\n "published": false,\n "draft": false,\n "icon": "person",\n "title_template": "{{first_name}} {{last_name}}",\n "ui_config": {},\n "capabilities": [],\n "group_settings": [],\n "layout_settings": {},\n "dialog_config": {},\n "attributes": [],\n "_purpose": ["string"],\n "explicit_search_mappings": {},\n "group_headlines": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getSchema`\n\nBy default gets the latest version of the Schema and to get the specific version of schema pass the id.\n\n`GET /v1/entity/schemas/{slug}`\n\n```ts\nconst { data } = await client.getSchema({\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "comment": "string",\n "source": {\n "id": "string",\n "type": "string"\n },\n "_summary": true,\n "slug": "contact",\n "version": 1,\n "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "enable_setting": ["360_features"],\n "name": "Contact",\n "plural": "Contacts",\n "description": "Example description",\n "docs_url": "https://docs.epilot.io/docs/pricing/entities",\n "category": "customer_relations",\n "published": false,\n "draft": false,\n "icon": "person",\n "title_template": "{{first_name}} {{last_name}}",\n "ui_config": {\n "table_view": {\n "view_type": "default",\n "row_actions": ["string"],\n "bulk_actions": ["string"],\n "navbar_actions": [],\n "enable_thumbnails": false\n },\n "create_view": {\n "view_type": "default",\n "search_params": {}\n },\n "edit_view": {\n "view_type": "default",\n "search_params": {},\n "summary_attributes": ["email"]\n },\n "single_view": {\n "view_type": "default",\n "search_params": {},\n "summary_attributes": ["email"]\n },\n "list_item": {\n "summary_attributes": [],\n "quick_actions": [],\n "ui_config": {}\n },\n "sharing": {\n "show_sharing_button": true\n }\n },\n "capabilities": [\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "customer_messaging",\n "title": "Messaging",\n "attributes": [],\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "app_id": "123e4567-e89b-12d3-a456-426614174000",\n "ui_config": {},\n "ui_hooks": [],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "schemas": []\n }\n ],\n "group_settings": [\n {\n "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "label": "Contact Details",\n "expanded": true,\n "order": 1\n },\n {\n "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",\n "label": "Address Details",\n "expanded": false,\n "order": 2,\n "info_tooltip_title": {}\n }\n ],\n "layout_settings": {\n "grid_gap": "string",\n "grid_template_columns": "string"\n },\n "dialog_config": {},\n "attributes": [\n {\n "name": "email",\n "type": "email",\n "label": "Email",\n "required": true\n },\n {\n "name": "first_name",\n "type": "string",\n "label": "First Name"\n }\n ],\n "_purpose": ["string"],\n "explicit_search_mappings": {\n "image": {\n "type": "keyword",\n "index": false\n }\n },\n "group_headlines": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "name": "string",\n "label": "string",\n "layout": "string",\n "group": "string",\n "order": 0,\n "type": "headline",\n "enable_divider": false,\n "divider": "top_divider",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `putSchema`\n\nCreate or update a schema with a new version\n\n`PUT /v1/entity/schemas/{slug}`\n\n```ts\nconst { data } = await client.putSchema(\n {\n slug: \'example\',\n draft: true,\n },\n {\n slug: \'contact\',\n version: 1,\n blueprint: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n enable_setting: [\'360_features\'],\n name: \'Contact\',\n plural: \'Contacts\',\n description: \'Example description\',\n docs_url: \'https://docs.epilot.io/docs/pricing/entities\',\n category: \'customer_relations\',\n published: false,\n draft: false,\n icon: \'person\',\n title_template: \'{{first_name}} {{last_name}}\',\n ui_config: {\n table_view: {\n view_type: \'default\',\n row_actions: [\'string\'],\n bulk_actions: [\'string\'],\n navbar_actions: [ /* ... */ ],\n enable_thumbnails: false\n },\n create_view: {\n view_type: \'default\',\n search_params: {}\n },\n edit_view: {\n view_type: \'default\',\n search_params: {},\n summary_attributes: [\'email\']\n },\n single_view: {\n view_type: \'default\',\n search_params: {},\n summary_attributes: [\'email\']\n },\n list_item: {\n summary_attributes: [ /* ... */ ],\n quick_actions: [ /* ... */ ],\n ui_config: { /* ... */ }\n },\n sharing: {\n show_sharing_button: true\n }\n },\n capabilities: [\n {\n id: \'d5839b94-ba20-4225-a78e-76951d352bd6\',\n name: \'customer_messaging\',\n title: \'Messaging\',\n attributes: [ /* ... */ ],\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n app_id: \'123e4567-e89b-12d3-a456-426614174000\',\n ui_config: { /* ... */ },\n ui_hooks: [ /* ... */ ],\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [ /* ... */ ],\n schemas: [ /* ... */ ]\n }\n ],\n group_settings: [\n {\n id: \'e18a532b-ae79-4d86-a6a5-e5dbfb579d14\',\n label: \'Contact Details\',\n expanded: true,\n order: 1\n },\n {\n id: \'e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e\',\n label: \'Address Details\',\n expanded: false,\n order: 2,\n info_tooltip_title: { /* ... */ }\n }\n ],\n layout_settings: {\n grid_gap: \'string\',\n grid_template_columns: \'string\'\n },\n dialog_config: {},\n attributes: [\n {\n name: \'email\',\n type: \'email\',\n label: \'Email\',\n required: true\n },\n {\n name: \'first_name\',\n type: \'string\',\n label: \'First Name\'\n },\n /* ... 5 more */\n ],\n _purpose: [\'string\'],\n explicit_search_mappings: {\n image: {\n type: \'keyword\',\n index: false\n }\n },\n group_headlines: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n name: \'string\',\n label: \'string\',\n layout: \'string\',\n group: \'string\',\n order: 0,\n type: \'headline\',\n enable_divider: false,\n divider: \'top_divider\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "comment": "string",\n "source": {\n "id": "string",\n "type": "string"\n },\n "_summary": true,\n "slug": "contact",\n "version": 1,\n "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "enable_setting": ["360_features"],\n "name": "Contact",\n "plural": "Contacts",\n "description": "Example description",\n "docs_url": "https://docs.epilot.io/docs/pricing/entities",\n "category": "customer_relations",\n "published": false,\n "draft": false,\n "icon": "person",\n "title_template": "{{first_name}} {{last_name}}",\n "ui_config": {\n "table_view": {\n "view_type": "default",\n "row_actions": ["string"],\n "bulk_actions": ["string"],\n "navbar_actions": [],\n "enable_thumbnails": false\n },\n "create_view": {\n "view_type": "default",\n "search_params": {}\n },\n "edit_view": {\n "view_type": "default",\n "search_params": {},\n "summary_attributes": ["email"]\n },\n "single_view": {\n "view_type": "default",\n "search_params": {},\n "summary_attributes": ["email"]\n },\n "list_item": {\n "summary_attributes": [],\n "quick_actions": [],\n "ui_config": {}\n },\n "sharing": {\n "show_sharing_button": true\n }\n },\n "capabilities": [\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "customer_messaging",\n "title": "Messaging",\n "attributes": [],\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "app_id": "123e4567-e89b-12d3-a456-426614174000",\n "ui_config": {},\n "ui_hooks": [],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "schemas": []\n }\n ],\n "group_settings": [\n {\n "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "label": "Contact Details",\n "expanded": true,\n "order": 1\n },\n {\n "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",\n "label": "Address Details",\n "expanded": false,\n "order": 2,\n "info_tooltip_title": {}\n }\n ],\n "layout_settings": {\n "grid_gap": "string",\n "grid_template_columns": "string"\n },\n "dialog_config": {},\n "attributes": [\n {\n "name": "email",\n "type": "email",\n "label": "Email",\n "required": true\n },\n {\n "name": "first_name",\n "type": "string",\n "label": "First Name"\n }\n ],\n "_purpose": ["string"],\n "explicit_search_mappings": {\n "image": {\n "type": "keyword",\n "index": false\n }\n },\n "group_headlines": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "name": "string",\n "label": "string",\n "layout": "string",\n "group": "string",\n "order": 0,\n "type": "headline",\n "enable_divider": false,\n "divider": "top_divider",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deleteSchema`\n\nDelete a schema, or a specific version of a schema\n\n`DELETE /v1/entity/schemas/{slug}`\n\n```ts\nconst { data } = await client.deleteSchema({\n slug: \'example\',\n})\n```\n\n---\n\n### `getJsonSchema`\n\nGet formal JSON schema definition draft 2020-12 for the given epilot schema\n\n`GET /v1/entity/schemas/{slug}/json/schema`\n\n```ts\nconst { data } = await client.getJsonSchema({\n slug: \'example\',\n dereference: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "$schema": "http://json-schema.org/draft/2020-12/schema",\n "type": "object",\n "properties": {\n "_id": {\n "type": "string",\n "format": "uuid",\n "example": "123e4567-e89b-12d3-a456-426614174000"\n },\n "_org": {\n "type": "string",\n "description": "Organization Id the entity belongs to",\n "readOnly": true\n },\n "_owners": {\n "type": "array",\n "readOnly": true,\n "items": {}\n },\n "_schema": {\n "readOnly": true,\n "type": "string"\n },\n "_title": {\n "readOnly": true,\n "type": "string"\n },\n "_tags": {\n "type": "array",\n "nullable": true,\n "items": {}\n },\n "_manifest": {\n "type": "array",\n "description": "Manifest ID used to create/update the entity",\n "items": {}\n },\n "_created_at": {\n "readOnly": true,\n "type": "string",\n "format": "date-time"\n },\n "_updated_at": {\n "readOnly": true,\n "type": "string",\n "format": "date-time"\n },\n "_acl": {\n "readOnly": true,\n "type": "object",\n "description": "Access control list (ACL) for an entity. Defines sharing access to external orgs or users.",\n "additionalProperties": true,\n "properties": {}\n },\n "title": {\n "type": "string",\n "nullable": true,\n "enum": ["Dr.", "Prof.", "Prof. Dr.", null]\n },\n "salutation": {\n "type": "string",\n "nullable": true,\n "enum": ["Mr.", "Ms. / Mrs.", "Company", "Contact Person", "Company/Contact Person", "Spouse", "Family", "Ownership", "Assembly", "Other", null]\n },\n "first_name": {\n "type": "string"\n },\n "last_name": {\n "type": "string"\n },\n "customer_number": {\n "type": "string",\n "nullable": true\n },\n "birthdate": {\n "type": "string",\n "format": "date",\n "nullable": true\n },\n "account": {\n "type": "object",\n "nullable": true,\n "properties": {},\n "additionalProperties": true\n },\n "address": {\n "type": "array",\n "nullable": true,\n "description": "Addresses as a list of object, the element with index 0 is treated as the primary one.\\n",\n "items": {}\n },\n "email": {\n "type": "array",\n "nullable": true,\n "description": "Email addresses as a list of object, the element with index 0 is treated as the primary one.\\n",\n "items": {}\n },\n "phone": {\n "type": "array",\n "description": "Phone numbers as a list of object, the element with index 0 is treated as the primary one.\\n",\n "items": {}\n }\n },\n "required": ["first_name", "last_name", "_id", "_org", "_owners", "_schema", "_title", "_tags", "_created_at", "_updated_at", "_acl"]\n}\n```\n\n</details>\n\n---\n\n### `getSchemaExample`\n\nGet a full example entity for the given schema\n\n`GET /v1/entity/schemas/{slug}/json/example`\n\n```ts\nconst { data } = await client.getSchemaExample({\n slug: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getSchemaVersions`\n\nGet all versions of this schema ordered by the latest versions including drafts.\n\n`GET /v1/entity/schemas/{slug}/versions`\n\n```ts\nconst { data } = await client.getSchemaVersions({\n slug: \'example\',\n versions_from: 1,\n versions_size: 1,\n drafts_from: 1,\n drafts_size: 1,\n fields: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "versions": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "comment": "string",\n "source": {},\n "_summary": true,\n "slug": "contact",\n "version": 1,\n "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "enable_setting": ["360_features"],\n "name": "Contact",\n "plural": "Contacts",\n "description": "Example description",\n "docs_url": "https://docs.epilot.io/docs/pricing/entities",\n "category": "customer_relations",\n "published": false,\n "draft": false,\n "icon": "person",\n "title_template": "{{first_name}} {{last_name}}",\n "ui_config": {},\n "capabilities": [],\n "group_settings": [],\n "layout_settings": {},\n "dialog_config": {},\n "attributes": [],\n "_purpose": ["string"],\n "explicit_search_mappings": {},\n "group_headlines": []\n }\n ],\n "drafts": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "comment": "string",\n "source": {},\n "_summary": true,\n "slug": "contact",\n "version": 1,\n "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "enable_setting": ["360_features"],\n "name": "Contact",\n "plural": "Contacts",\n "description": "Example description",\n "docs_url": "https://docs.epilot.io/docs/pricing/entities",\n "category": "customer_relations",\n "published": false,\n "draft": false,\n "icon": "person",\n "title_template": "{{first_name}} {{last_name}}",\n "ui_config": {},\n "capabilities": [],\n "group_settings": [],\n "layout_settings": {},\n "dialog_config": {},\n "attributes": [],\n "_purpose": ["string"],\n "explicit_search_mappings": {},\n "group_headlines": []\n }\n ],\n "versions_more": true,\n "drafts_more": true\n}\n```\n\n</details>\n\n---\n\n### `listAvailableCapabilities`\n\nList available capabilities for schema\n\n`GET /v1/entity/schemas/{slug}/capabilities/available`\n\n```ts\nconst { data } = await client.listAvailableCapabilities({\n slug: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "customer_messaging",\n "title": "Messaging",\n "attributes": [],\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "app_id": "123e4567-e89b-12d3-a456-426614174000",\n "ui_config": {},\n "ui_hooks": [],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "schemas": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listSchemaBlueprints`\n\nList canonical versions of all available schemas\n\n`GET /v1/entity/schemas/blueprints`\n\n```ts\nconst { data } = await client.listSchemaBlueprints()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "comment": "string",\n "source": {},\n "_summary": true,\n "slug": "contact",\n "version": 1,\n "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "enable_setting": ["360_features"],\n "name": "Contact",\n "plural": "Contacts",\n "description": "Example description",\n "docs_url": "https://docs.epilot.io/docs/pricing/entities",\n "category": "customer_relations",\n "published": false,\n "draft": false,\n "icon": "person",\n "title_template": "{{first_name}} {{last_name}}",\n "ui_config": {},\n "capabilities": [],\n "group_settings": [],\n "layout_settings": {},\n "dialog_config": {},\n "attributes": [],\n "_purpose": ["string"],\n "explicit_search_mappings": {},\n "group_headlines": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `searchEntities`\n\nSearch for entities. Supports ordering and pagination. [Lucene query syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax) supp\n\n`POST /v1/entity:search`\n\n```ts\nconst { data } = await client.searchEntities(\n null,\n {\n q: \'_schema:contact AND status:active\',\n include_scores: false,\n sort: \'string\',\n from: 0,\n size: 10,\n hydrate: false,\n fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\'],\n aggs: {\n \'contact-count-per-tag\': {\n terms: {\n field: \'_tags.keyword\'\n }\n }\n },\n include_deleted: \'false\',\n highlight: {},\n stable_for: 0,\n stable_query_id: \'string\',\n search_after: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "results": [\n {\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ],\n "aggregations": {\n "contact-count-per-tag": {\n "doc_count_error_upper_bound": 0,\n "sum_other_doc_count": 23,\n "buckets": [\n {\n "key": "automation",\n "doc_count": 108\n },\n {\n "key": "primary",\n "doc_count": 66\n }\n ]\n }\n },\n "stable_query_id": "string",\n "sort_end": [1747905443332, "0.000023312468"]\n}\n```\n\n</details>\n\n---\n\n### `listEntities`\n\nList entities that meet the specified conditions.\n\n`POST /v1/entity:list`\n\n```ts\nconst { data } = await client.listEntities(\n null,\n {\n query: {\n query_string: {\n query: \'status:active\',\n fields: [\'_title\', \'_tags\', \'status\'],\n default_operator: \'OR\',\n lenient: true\n }\n },\n filter: [\n {\n term: {\n _schema: \'contact\'\n }\n },\n {\n terms: {\n status: [\'active\']\n }\n }\n ],\n allow_targeting_all_schemas: false,\n sort: \'string\',\n from: 0,\n size: 10,\n hydrate: false,\n fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\'],\n aggs: {\n \'contact-count-per-tag\': {\n terms: {\n field: \'_tags.keyword\'\n }\n }\n },\n include_deleted: \'false\',\n include_scores: false,\n highlight: {},\n stable_for: 0,\n stable_query_id: \'string\',\n search_after: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "results": [\n {\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ],\n "aggregations": {\n "contact-count-per-tag": {\n "doc_count_error_upper_bound": 0,\n "sum_other_doc_count": 23,\n "buckets": [\n {\n "key": "automation",\n "doc_count": 108\n },\n {\n "key": "primary",\n "doc_count": 66\n }\n ]\n }\n },\n "stable_query_id": "string",\n "sort_end": [1747905443332, "0.000023312468"]\n}\n```\n\n</details>\n\n---\n\n### `queryEntityGraph`\n\nTraverse an entity relationship graph starting from a seed entity.\n\n`POST /v1/entity:graph`\n\n```ts\nconst { data } = await client.queryEntityGraph(\n null,\n {\n seed: {\n entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n node_id: \'contact\'\n },\n graph: {\n nodes: [\n {\n id: \'portal_user\',\n schema: \'portal_user\',\n cardinality: \'one\'\n },\n {\n id: \'contact\',\n schema: \'contact\',\n cardinality: \'one\'\n },\n /* ... 1 more */\n ],\n edges: [\n {\n from: \'portal_user\',\n to: \'contact\'\n },\n {\n from: \'contact\',\n to: \'billing_accounts\'\n }\n ]\n },\n hydrate: false\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "nodes": {\n "portal_user": ["550e8400-e29b-41d4-a716-446655440001"],\n "contact": ["550e8400-e29b-41d4-a716-446655440002"],\n "billing_accounts": ["550e8400-e29b-41d4-a716-446655440003", "550e8400-e29b-41d4-a716-446655440004"]\n },\n "entityNodes": {\n "portal_user": {\n "_id": "550e8400-e29b-41d4-a716-446655440001",\n "_schema": "portal_user"\n },\n "contact": {\n "_id": "550e8400-e29b-41d4-a716-446655440002",\n "_schema": "contact"\n },\n "billing_accounts": [\n {\n "_id": "550e8400-e29b-41d4-a716-446655440003",\n "_schema": "billing_account"\n },\n {\n "_id": "550e8400-e29b-41d4-a716-446655440004",\n "_schema": "billing_account"\n }\n ]\n },\n "edges": [\n {\n "from": "portal_user",\n "to": "contact"\n },\n {\n "from": "contact",\n "to": "billing_accounts"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createEntity`\n\nCreates a new entity using a key.\n\n`POST /v1/entity/{slug}`\n\n```ts\nconst { data } = await client.createEntity(\n {\n slug: \'example\',\n activity_id: \'example\',\n fill_activity: true,\n async: true,\n validate: true,\n },\n {\n _id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n _org: \'123\',\n _owners: [\n {\n org_id: \'123\',\n user_id: \'123\'\n }\n ],\n _schema: \'contact\',\n _tags: [\'example\', \'mock\'],\n _created_at: \'2021-02-09T12:41:43.662Z\',\n _updated_at: \'2021-02-09T12:41:43.662Z\',\n _acl: {\n view: [\'org:456\', \'org:789\'],\n edit: [\'org:456\'],\n delete: [\'org:456\']\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `validateEntity`\n\nValidates an entity against the schema.\n\n`POST /v1/entity/{slug}:validate`\n\n```ts\nconst { data } = await client.validateEntity(\n {\n slug: \'example\',\n },\n {\n _id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n _org: \'123\',\n _owners: [\n {\n org_id: \'123\',\n user_id: \'123\'\n }\n ],\n _schema: \'contact\',\n _tags: [\'example\', \'mock\'],\n _created_at: \'2021-02-09T12:41:43.662Z\',\n _updated_at: \'2021-02-09T12:41:43.662Z\',\n _acl: {\n view: [\'org:456\', \'org:789\'],\n edit: [\'org:456\'],\n delete: [\'org:456\']\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status": "success",\n "errors": [\n {\n "code": "custom",\n "params": {\n "type": "missing_field"\n },\n "path": ["first_name"],\n "message": "Invalid input"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `validateEntityV2`\n\nValidates an entity against the schema.\n\n`POST /v2/entity/{slug}:validate`\n\n```ts\nconst { data } = await client.validateEntityV2(\n {\n slug: \'example\',\n },\n {\n _id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n _org: \'123\',\n _owners: [\n {\n org_id: \'123\',\n user_id: \'123\'\n }\n ],\n _schema: \'contact\',\n _tags: [\'example\', \'mock\'],\n _created_at: \'2021-02-09T12:41:43.662Z\',\n _updated_at: \'2021-02-09T12:41:43.662Z\',\n _acl: {\n view: [\'org:456\', \'org:789\'],\n edit: [\'org:456\'],\n delete: [\'org:456\']\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status": "success",\n "errors": [\n {\n "keyword": "string",\n "instance_path": "string",\n "schema_path": "string",\n "params": {},\n "property_name": "string",\n "message": "string",\n "schema": {},\n "parent_schema": {},\n "data": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `upsertEntity`\n\nCreate or update an entity using `unique_key`\n\n`PATCH /v1/entity/{slug}:upsert`\n\n```ts\nconst { data } = await client.upsertEntity(\n {\n slug: \'example\',\n activity_id: \'example\',\n fill_activity: true,\n dry_run: true,\n async: true,\n validate: true,\n strict: true,\n },\n {\n unique_key: [\'_id\'],\n entity: {\n _id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n _org: \'123\',\n _owners: [\n {\n org_id: \'123\',\n user_id: \'123\'\n }\n ],\n _schema: \'contact\',\n _tags: [\'example\', \'mock\'],\n _created_at: \'2021-02-09T12:41:43.662Z\',\n _updated_at: \'2021-02-09T12:41:43.662Z\',\n _acl: {\n view: [\'org:456\', \'org:789\'],\n edit: [\'org:456\'],\n delete: [\'org:456\']\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `getEntityV2`\n\nGets Entity by id.\n\n`GET /v2/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.getEntityV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n slug: \'example\',\n hydrate: true,\n fields: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `restoreEntity`\n\nRestores an entity by id\n\n`PATCH /v1/entity/{slug}/{id}:restore`\n\n```ts\nconst { data } = await client.restoreEntity(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n slug: \'example\',\n activity_id: \'example\',\n },\n {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `reindexEntity`\n\nTriggers a reindex for the Entity for search.\n\n`POST /v1/entity/{slug}/{id}:reindex`\n\n```ts\nconst { data } = await client.reindexEntity(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n slug: \'example\',\n },\n {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `getEntity`\n\nGets Entity and relations by id.\n\n`GET /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.getEntity({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n slug: \'example\',\n hydrate: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity": {\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n },\n "relations": [\n {\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `updateEntity`\n\nUpdates an Entity\n\n`PUT /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.updateEntity(\n {\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n activity_id: \'example\',\n fill_activity: true,\n async: true,\n validate: true,\n },\n {\n _id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n _org: \'123\',\n _owners: [\n {\n org_id: \'123\',\n user_id: \'123\'\n }\n ],\n _schema: \'contact\',\n _tags: [\'example\', \'mock\'],\n _created_at: \'2021-02-09T12:41:43.662Z\',\n _updated_at: \'2021-02-09T12:41:43.662Z\',\n _acl: {\n view: [\'org:456\', \'org:789\'],\n edit: [\'org:456\'],\n delete: [\'org:456\']\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `patchEntity`\n\nPartially updates an entity with the passed in entity data.\n\n`PATCH /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.patchEntity(\n {\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n activity_id: \'example\',\n fill_activity: true,\n dry_run: true,\n async: true,\n validate: true,\n },\n {\n _id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n _org: \'123\',\n _owners: [\n {\n org_id: \'123\',\n user_id: \'123\'\n }\n ],\n _schema: \'contact\',\n _tags: [\'example\', \'mock\'],\n _created_at: \'2021-02-09T12:41:43.662Z\',\n _updated_at: \'2021-02-09T12:41:43.662Z\',\n _acl: {\n view: [\'org:456\', \'org:789\'],\n edit: [\'org:456\'],\n delete: [\'org:456\']\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `deleteEntity`\n\nDeletes an Entity\n\n`DELETE /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.deleteEntity({\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n activity_id: \'example\',\n purge: true,\n})\n```\n\n---\n\n### `autocomplete`\n\nAutocomplete entity attributes\n\n`GET /v1/entity:autocomplete`\n\n```ts\nconst { data } = await client.autocomplete({\n input: \'example\',\n attribute: \'example\',\n slug: \'example\',\n size: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "results": ["value"]\n}\n```\n\n</details>\n\n---\n\n### `wipeAllEntities`\n\nCreates a request to queue the deletion of all entities in the system. This is a destructive operation and should only be used in sandbox environments.\n\n`POST /v1/entity:wipeAllEntities`\n\n```ts\nconst { data } = await client.wipeAllEntities(\n null,\n {\n schemas: [\'contact\']\n },\n)\n```\n\n---\n\n### `createActivity`\n\nCreate an activity that can be displayed in activity feeds.\n\n`POST /v1/entity/activity`\n\n```ts\nconst { data } = await client.createActivity(\n {\n entities: [\'...\'],\n },\n {\n type: \'string\',\n title: \'My custom activity\',\n message: \'{{caller}} did something with {{entity payload.entity.id}}.\',\n payload: {\n entity: {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n schema: \'contact\'\n }\n },\n pending: false\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",\n "timestamp": "1970-01-01T00:00:00.000Z",\n "type": "string",\n "title": "My custom activity",\n "message": "{{caller}} did something with {{entity payload.entity.id}}.",\n "payload": {\n "entity": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "schema": "contact"\n }\n },\n "pending": false,\n "caller": {\n "EpilotAuth": {\n "token": {\n "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",\n "cognito:groups": ["Administrator"],\n "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",\n "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",\n "custom:ivy_org_id": "739224",\n "cognito:username": "n.ahmad@epilot.cloud",\n "custom:ivy_user_id": "10006129",\n "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],\n "aud": "6e0jbdnger7nmoktaaflarue1l",\n "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",\n "token_use": "id",\n "auth_time": 1614333023,\n "exp": 1614336623,\n "iat": 1614333023,\n "email": "n.ahmad@epilot.cloud"\n }\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getActivity`\n\nGet activity by id\n\n`GET /v1/entity/activity/{id}`\n\n```ts\nconst { data } = await client.getActivity({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n operations_size: 1,\n operations_from: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",\n "timestamp": "1970-01-01T00:00:00.000Z",\n "type": "string",\n "title": "My custom activity",\n "message": "{{caller}} did something with {{entity payload.entity.id}}.",\n "payload": {\n "entity": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "schema": "contact"\n }\n },\n "pending": false,\n "caller": {\n "EpilotAuth": {\n "token": {}\n }\n },\n "operations_total": 1,\n "operations": [\n {\n "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org": "123",\n "activity_id": "01F130Q52Q6MWSNS8N2AVXV4JN",\n "activity_type": "string",\n "operation": "createEntity",\n "params": {},\n "payload": {},\n "diff": {},\n "_workflow_origin": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `attachActivity`\n\nAttach existing activity to entity activity feeds\n\n`POST /v1/entity/activity/{id}:attach`\n\n```ts\nconst { data } = await client.attachActivity({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n entities: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",\n "timestamp": "1970-01-01T00:00:00.000Z",\n "type": "string",\n "title": "My custom activity",\n "message": "{{caller}} did something with {{entity payload.entity.id}}.",\n "payload": {\n "entity": {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "schema": "contact"\n }\n },\n "pending": false,\n "caller": {\n "EpilotAuth": {\n "token": {\n "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",\n "cognito:groups": ["Administrator"],\n "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",\n "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",\n "custom:ivy_org_id": "739224",\n "cognito:username": "n.ahmad@epilot.cloud",\n "custom:ivy_user_id": "10006129",\n "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],\n "aud": "6e0jbdnger7nmoktaaflarue1l",\n "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",\n "token_use": "id",\n "auth_time": 1614333023,\n "exp": 1614336623,\n "iat": 1614333023,\n "email": "n.ahmad@epilot.cloud"\n }\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getEntityActivityFeed`\n\nGet activity feed for an entity\n\n`GET /v1/entity/{slug}/{id}/activity`\n\n```ts\nconst { data } = await client.getEntityActivityFeed({\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n after: \'example\',\n before: \'example\',\n start_date: \'example\',\n end_date: \'example\',\n preset_range: \'example\',\n from: 1,\n size: 1,\n type: [\'...\'],\n include_relations: true,\n exclude_activity_groups: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "total": 1,\n "results": [\n {\n "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",\n "timestamp": "1970-01-01T00:00:00.000Z",\n "type": "string",\n "title": "My custom activity",\n "message": "{{caller}} did something with {{entity payload.entity.id}}.",\n "payload": {},\n "pending": false,\n "caller": {},\n "operations_total": 1,\n "operations": []\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getRelations`\n\nReturns 1st level direct relations for an entity.\n\n`GET /v1/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.getRelations({\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n include_reverse: true,\n from: 1,\n size: 1,\n include_schemas: [\'...\'],\n exclude_schemas: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "_schema": "contact",\n "attribute": "string",\n "_tags": ["string"],\n "reverse": true\n },\n {\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n]\n```\n\n</details>\n\n---\n\n### `addRelations`\n\nRelates one or more entities to parent entity by adding items to a relation attribute\n\n`POST /v1/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.addRelations(\n {\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n async: true,\n activity_id: \'example\',\n },\n [\n {\n entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n org_id: \'string\',\n _schema: \'contact\',\n attribute: \'string\',\n _tags: [\'string\'],\n reverse: true\n }\n ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "_schema": "contact",\n "attribute": "string",\n "_tags": ["string"],\n "reverse": true\n}\n```\n\n</details>\n\n---\n\n### `removeRelations`\n\nDisassociate one or more entities to parent entity by removing items to a relation attribute\n\n`DELETE /v1/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.removeRelations(\n {\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n async: true,\n activity_id: \'example\',\n },\n [\n {\n entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n org_id: \'string\',\n _schema: \'contact\',\n attribute: \'string\',\n _tags: [\'string\'],\n reverse: true\n }\n ],\n)\n```\n\n---\n\n### `getRelationsV2`\n\nReturns 1st level direct relations for an entity with pagination.\n\n`GET /v2/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.getRelationsV2({\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n query: \'example\',\n include_reverse: true,\n from: 1,\n size: 1,\n fields: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "relations": [\n {\n "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "_schema": "contact",\n "attribute": "string",\n "_tags": ["string"],\n "reverse": true\n },\n {\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getRelationsV3`\n\nReturns 1st level direct relations for an entity with pagination.\n\n`GET /v3/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.getRelationsV3({\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: true,\n include_reverse: true,\n from: 1,\n size: 1,\n include_schemas: [\'...\'],\n exclude_schemas: [\'...\'],\n mode: \'example\',\n fields: [\'...\'],\n include_deleted: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "relations": [\n {\n "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "_schema": "contact",\n "attribute": "string",\n "_tags": ["string"],\n "reverse": true\n },\n {\n "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "_org": "123",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "contact",\n "_tags": ["example", "mock"],\n "_created_at": "2021-02-09T12:41:43.662Z",\n "_updated_at": "2021-02-09T12:41:43.662Z",\n "_acl": {\n "view": ["org:456", "org:789"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getRelatedEntitiesCount`\n\nReturns the amount of unique related entities for an entity - includes direct and reverse relations.\n\n`GET /v2/entity/{slug}/{id}/relations/count`\n\n```ts\nconst { data } = await client.getRelatedEntitiesCount({\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n exclude_schemas: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1\n}\n```\n\n</details>\n\n---\n\n### `updateRelation`\n\nUpdates an existing relation between two entities.\n\n`PUT /v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}`\n\n```ts\nconst { data } = await client.updateRelation(\n {\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n attribute: \'example\',\n entity_id: \'example\',\n async: true,\n activity_id: \'example\',\n },\n {\n _tags: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "org_id": "string",\n "_schema": "contact",\n "attribute": "string",\n "_tags": ["string"],\n "reverse": true\n}\n```\n\n</details>\n\n---\n\n### `deleteRelation`\n\nRemoves relation between two entities\n\n`DELETE /v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}`\n\n```ts\nconst { data } = await client.deleteRelation({\n slug: \'example\',\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n attribute: \'example\',\n entity_id: \'example\',\n async: true,\n activity_id: \'example\',\n})\n```\n\n---\n\n### `exportEntities`\n\nExport entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.\nThe values exported as in some cases, transformed to human-readable values.\n\n`POST /v1/entity:export`\n\n```ts\nconst { data } = await client.exportEntities(\n {\n job_id: \'example\',\n is_template: true,\n language: \'example\',\n },\n {\n q: \'_schema:contact AND status:active\',\n include_scores: false,\n sort: \'string\',\n from: 0,\n size: 10,\n hydrate: false,\n fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\'],\n aggs: {\n \'contact-count-per-tag\': {\n terms: {\n field: \'_tags.keyword\'\n }\n }\n },\n include_deleted: \'false\',\n highlight: {},\n stable_for: 0,\n stable_query_id: \'string\',\n search_after: [\'string\']\n },\n)\n```\n\n---\n\n### `importEntities`\n\nImport Entities\n\n`POST /v1/entity:import`\n\n```ts\nconst { data } = await client.importEntities(\n {\n job_id: \'example\',\n },\n {\n S3Reference: {\n bucket: \'my-bucket\',\n key: \'imports/my-import.json\'\n },\n schema: \'contact\'\n },\n)\n```\n\n---\n\n### `listSavedViews`\n\nGet the Saved Views based on the schema\n\n`GET /v1/entity/views`\n\n```ts\nconst { data } = await client.listSavedViews({\n slug: \'example\',\n sort: \'example\',\n from: 1,\n size: 1,\n fields: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "results": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "slug": ["contact"],\n "name": "View listing German",\n "org": "66",\n "shared": true,\n "isFavoritedBy": ["11701"],\n "created_by": {\n "user_id": "10598"\n },\n "ui_config": {\n "filters": {\n "customer_name": "suresh test",\n "_tags": "360"\n },\n "table_layout": {\n "opportunity": {\n "page": 1,\n "sort": "_created_at:desc",\n "pageSize": 25,\n "columnSettings": []\n }\n }\n },\n "shared_with": ["112233"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createSavedView`\n\nCreates a new saved view\n\n`POST /v1/entity/view`\n\n```ts\nconst { data } = await client.createSavedView(\n null,\n {\n slug: [\'contact\'],\n name: \'View listing German\',\n org: \'66\',\n shared: true,\n isFavoritedBy: [\'11701\'],\n created_by: {\n user_id: \'10598\'\n },\n ui_config: {\n filters: {\n customer_name: \'suresh test\',\n _tags: \'360\'\n },\n table_layout: {\n opportunity: {\n page: 1,\n sort: \'_created_at:desc\',\n pageSize: 25,\n columnSettings: []\n }\n }\n },\n shared_with: [\'112233\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "slug": ["contact"],\n "name": "View listing German",\n "org": "66",\n "shared": true,\n "isFavoritedBy": ["11701"],\n "created_by": {\n "user_id": "10598"\n },\n "ui_config": {\n "filters": {\n "customer_name": "suresh test",\n "_tags": "360"\n },\n "table_layout": {\n "opportunity": {\n "page": 1,\n "sort": "_created_at:desc",\n "pageSize": 25,\n "columnSettings": []\n }\n }\n },\n "shared_with": ["112233"]\n}\n```\n\n</details>\n\n---\n\n### `getSavedView`\n\nGets Saved View configuration by id.\n\n`GET /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.getSavedView({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "slug": ["contact"],\n "name": "View listing German",\n "org": "66",\n "shared": true,\n "isFavoritedBy": ["11701"],\n "created_by": {\n "user_id": "10598"\n },\n "ui_config": {\n "filters": {\n "customer_name": "suresh test",\n "_tags": "360"\n },\n "table_layout": {\n "opportunity": {\n "page": 1,\n "sort": "_created_at:desc",\n "pageSize": 25,\n "columnSettings": []\n }\n }\n },\n "shared_with": ["112233"]\n}\n```\n\n</details>\n\n---\n\n### `updateSavedView`\n\nUpdates a saved view\n\n`PUT /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.updateSavedView(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n created_at: \'string\',\n updated_at: \'string\',\n slug: [\'contact\'],\n name: \'View listing German\',\n org: \'66\',\n shared: true,\n isFavoritedBy: [\'11701\'],\n created_by: {\n user_id: \'10598\'\n },\n ui_config: {\n filters: {\n customer_name: \'suresh test\',\n _tags: \'360\'\n },\n table_layout: {\n opportunity: {\n page: 1,\n sort: \'_created_at:desc\',\n pageSize: 25,\n columnSettings: []\n }\n }\n },\n shared_with: [\'112233\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "slug": ["contact"],\n "name": "View listing German",\n "org": "66",\n "shared": true,\n "isFavoritedBy": ["11701"],\n "created_by": {\n "user_id": "10598"\n },\n "ui_config": {\n "filters": {\n "customer_name": "suresh test",\n "_tags": "360"\n },\n "table_layout": {\n "opportunity": {\n "page": 1,\n "sort": "_created_at:desc",\n "pageSize": 25,\n "columnSettings": []\n }\n }\n },\n "shared_with": ["112233"]\n}\n```\n\n</details>\n\n---\n\n### `patchSavedView`\n\nPartially updates a saved view with the provided payload. If an updated_at is passed and the server contains a newer version of the view a `409` error is returned\n\n`PATCH /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.patchSavedView(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n slug: [\'contact\'],\n name: \'View listing German\',\n org: \'66\',\n shared: true,\n isFavoritedBy: [\'11701\'],\n created_by: {\n user_id: \'10598\'\n },\n ui_config: {\n filters: {\n customer_name: \'suresh test\',\n _tags: \'360\'\n },\n table_layout: {\n opportunity: {\n page: 1,\n sort: \'_created_at:desc\',\n pageSize: 25,\n columnSettings: []\n }\n }\n },\n shared_with: [\'112233\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "slug": ["contact"],\n "name": "View listing German",\n "org": "66",\n "shared": true,\n "isFavoritedBy": ["11701"],\n "created_by": {\n "user_id": "10598"\n },\n "ui_config": {\n "filters": {\n "customer_name": "suresh test",\n "_tags": "360"\n },\n "table_layout": {\n "opportunity": {\n "page": 1,\n "sort": "_created_at:desc",\n "pageSize": 25,\n "columnSettings": []\n }\n }\n },\n "shared_with": ["112233"]\n}\n```\n\n</details>\n\n---\n\n### `deleteSavedView`\n\nDeletes a saved view\n\n`DELETE /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.deleteSavedView({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `listFavoriteViewsForUser`\n\nGet the Favorite Saved Views for user based on the schema\n\n`GET /v1/entity/views/favorites`\n\n```ts\nconst { data } = await client.listFavoriteViewsForUser()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created_at": "string",\n "updated_at": "string",\n "slug": ["contact"],\n "name": "View listing German",\n "org": "66",\n "shared": true,\n "isFavoritedBy": ["11701"],\n "created_by": {\n "user_id": "10598"\n },\n "ui_config": {\n "filters": {\n "customer_name": "suresh test",\n "_tags": "360"\n },\n "table_layout": {\n "opportunity": {\n "page": 1,\n "sort": "_created_at:desc",\n "pageSize": 25,\n "columnSettings": []\n }\n }\n },\n "shared_with": ["112233"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listTaxonomies`\n\nList taxonomies in an organization\n\n`GET /v1/entity/taxonomies`\n\n```ts\nconst { data } = await client.listTaxonomies({\n include_disabled: true,\n type: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "slug": "purpose",\n "name": "Purpose",\n "plural": "Purposes",\n "kind": "system",\n "type": "entity",\n "icon": "purpose",\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "deleted_at": "1970-01-01T00:00:00.000Z",\n "created_by": "10598",\n "enabled": true,\n "order": 10,\n "enabled_locations": ["account", "string"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createTaxonomy`\n\nCreate a new taxonomy\n\n`POST /v1/entity/taxonomies`\n\n```ts\nconst { data } = await client.createTaxonomy(\n null,\n {\n slug: \'purpose\',\n name: \'Purpose\',\n plural: \'Purposes\',\n kind: \'system\',\n type: \'entity\',\n icon: \'purpose\',\n color: \'#FF5733\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n deleted_at: \'1970-01-01T00:00:00.000Z\',\n created_by: \'10598\',\n enabled: true,\n order: 10,\n enabled_locations: [\'account\', \'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "slug": "purpose",\n "name": "Purpose",\n "plural": "Purposes",\n "kind": "system",\n "type": "entity",\n "icon": "purpose",\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "deleted_at": "1970-01-01T00:00:00.000Z",\n "created_by": "10598",\n "enabled": true,\n "order": 10,\n "enabled_locations": ["account", "string"]\n}\n```\n\n</details>\n\n---\n\n### `getTaxonomy`\n\nGet taxonomy by slug\n\n`GET /v1/entity/taxonomies/{taxonomySlug}`\n\n```ts\nconst { data } = await client.getTaxonomy({\n taxonomySlug: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "slug": "purpose",\n "name": "Purpose",\n "plural": "Purposes",\n "kind": "system",\n "type": "entity",\n "icon": "purpose",\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "deleted_at": "1970-01-01T00:00:00.000Z",\n "created_by": "10598",\n "enabled": true,\n "order": 10,\n "enabled_locations": ["account", "string"]\n}\n```\n\n</details>\n\n---\n\n### `updateTaxonomy`\n\nUpdate a taxonomy\n\n`PUT /v1/entity/taxonomies/{taxonomySlug}`\n\n```ts\nconst { data } = await client.updateTaxonomy(\n {\n taxonomySlug: \'example\',\n },\n {\n slug: \'purpose\',\n name: \'Purpose\',\n plural: \'Purposes\',\n kind: \'system\',\n type: \'entity\',\n icon: \'purpose\',\n color: \'#FF5733\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n deleted_at: \'1970-01-01T00:00:00.000Z\',\n created_by: \'10598\',\n enabled: true,\n order: 10,\n enabled_locations: [\'account\', \'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "slug": "purpose",\n "name": "Purpose",\n "plural": "Purposes",\n "kind": "system",\n "type": "entity",\n "icon": "purpose",\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "deleted_at": "1970-01-01T00:00:00.000Z",\n "created_by": "10598",\n "enabled": true,\n "order": 10,\n "enabled_locations": ["account", "string"]\n}\n```\n\n</details>\n\n---\n\n### `deleteTaxonomy`\n\nDelete a taxonomy\n\n`DELETE /v1/entity/taxonomies/{taxonomySlug}`\n\n```ts\nconst { data } = await client.deleteTaxonomy({\n taxonomySlug: \'example\',\n permanent: true,\n})\n```\n\n---\n\n### `updateClassificationsForTaxonomy`\n\nUpdate the classifications for a taxonomy\n\n`POST /v1/entity/taxonomies/{taxonomySlug}/classifications`\n\n```ts\nconst { data } = await client.updateClassificationsForTaxonomy(\n {\n taxonomySlug: \'example\',\n },\n {\n create: [\n {\n id: \'taxonomy-slug:classification-slug\',\n slug: \'wallbox-pv\',\n name: \'Wallbox PV\',\n parents: [\'taxonomy-slug:classification-slug\'],\n color: \'#FF5733\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n archived: false,\n starred: false,\n enabled_locations: [\'account\', \'string\'],\n enabled_purposes: [\'string\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n }\n ],\n update: [\n {\n id: \'taxonomy-slug:classification-slug\',\n slug: \'wallbox-pv\',\n name: \'Wallbox PV\',\n parents: [\'taxonomy-slug:classification-slug\'],\n color: \'#FF5733\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n archived: false,\n starred: false,\n enabled_locations: [\'account\', \'string\'],\n enabled_purposes: [\'string\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n }\n ],\n delete: [\'taxonomy-slug:classification-slug\', \'taxonomy-slug:classification-slug\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "created": [\n {\n "id": "taxonomy-slug:classification-slug",\n "slug": "wallbox-pv",\n "name": "Wallbox PV",\n "parents": ["taxonomy-slug:classification-slug"],\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "archived": false,\n "starred": false,\n "enabled_locations": ["account", "string"],\n "enabled_purposes": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ],\n "updated": [\n {\n "id": "taxonomy-slug:classification-slug",\n "slug": "wallbox-pv",\n "name": "Wallbox PV",\n "parents": ["taxonomy-slug:classification-slug"],\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "archived": false,\n "starred": false,\n "enabled_locations": ["account", "string"],\n "enabled_purposes": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ],\n "deleted": ["taxonomy-slug:classification-slug"]\n}\n```\n\n</details>\n\n---\n\n### `createTaxonomyClassification`\n\nCreate a new classification for a taxonomy\n\n`POST /v2/entity/taxonomies/classifications`\n\n```ts\nconst { data } = await client.createTaxonomyClassification(\n null,\n {\n id: \'taxonomy-slug:classification-slug\',\n slug: \'wallbox-pv\',\n name: \'Wallbox PV\',\n parents: [\'taxonomy-slug:classification-slug\'],\n color: \'#FF5733\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n archived: false,\n starred: false,\n enabled_locations: [\'account\', \'string\'],\n enabled_purposes: [\'string\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "taxonomy-slug:classification-slug",\n "slug": "wallbox-pv",\n "name": "Wallbox PV",\n "parents": ["taxonomy-slug:classification-slug"],\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "archived": false,\n "starred": false,\n "enabled_locations": ["account", "string"],\n "enabled_purposes": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `getTaxonomyClassification`\n\nGet a classification for a taxonomy by slug\n\n`GET /v2/entity/taxonomies/classifications/{classificationSlug}`\n\n```ts\nconst { data } = await client.getTaxonomyClassification({\n classificationSlug: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "taxonomy-slug:classification-slug",\n "slug": "wallbox-pv",\n "name": "Wallbox PV",\n "parents": ["taxonomy-slug:classification-slug"],\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "archived": false,\n "starred": false,\n "enabled_locations": ["account", "string"],\n "enabled_purposes": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `updateTaxonomyClassification`\n\nUpdate a classification for a taxonomy\n\n`PUT /v2/entity/taxonomies/classifications/{classificationSlug}`\n\n```ts\nconst { data } = await client.updateTaxonomyClassification(\n {\n classificationSlug: \'example\',\n },\n {\n id: \'taxonomy-slug:classification-slug\',\n slug: \'wallbox-pv\',\n name: \'Wallbox PV\',\n parents: [\'taxonomy-slug:classification-slug\'],\n color: \'#FF5733\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n archived: false,\n starred: false,\n enabled_locations: [\'account\', \'string\'],\n enabled_purposes: [\'string\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "taxonomy-slug:classification-slug",\n "slug": "wallbox-pv",\n "name": "Wallbox PV",\n "parents": ["taxonomy-slug:classification-slug"],\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "archived": false,\n "starred": false,\n "enabled_locations": ["account", "string"],\n "enabled_purposes": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `deleteTaxonomyClassification`\n\nDelete a classification for a taxonomy\n\n`DELETE /v2/entity/taxonomies/classifications/{classificationSlug}`\n\n```ts\nconst { data } = await client.deleteTaxonomyClassification({\n classificationSlug: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "taxonomy-slug:classification-slug",\n "slug": "wallbox-pv",\n "name": "Wallbox PV",\n "parents": ["taxonomy-slug:classification-slug"],\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "archived": false,\n "starred": false,\n "enabled_locations": ["account", "string"],\n "enabled_purposes": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `taxonomyAutocomplete`\n\nTaxonomies autocomplete\n\n`GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete`\n\n```ts\nconst { data } = await client.taxonomyAutocomplete({\n taxonomySlug: \'example\',\n query: \'example\',\n size: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "taxonomy-slug:classification-slug",\n "slug": "wallbox-pv",\n "name": "Wallbox PV",\n "parents": ["taxonomy-slug:classification-slug"],\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "archived": false,\n "starred": false,\n "enabled_locations": ["account", "string"],\n "enabled_purposes": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `taxonomiesClassificationsSearch`\n\nList taxonomy classifications in an organization based on taxonomy slug\n\n`POST /v1/entity/taxonomies/classifications:search`\n\n```ts\nconst { data } = await client.taxonomiesClassificationsSearch(\n {\n taxonomySlug: [\'...\'],\n query: \'example\',\n archived: true,\n include_archived: \'example\',\n },\n {\n classificationIds: [\n \'taxonomy-slug:classification-slug\',\n {\n pattern: \'taxonomy-slug:*\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "taxonomy-slug:classification-slug",\n "slug": "wallbox-pv",\n "name": "Wallbox PV",\n "parents": ["taxonomy-slug:classification-slug"],\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "archived": false,\n "starred": false,\n "enabled_locations": ["account", "string"],\n "enabled_purposes": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ],\n "hits": 10\n}\n```\n\n</details>\n\n---\n\n### `listTaxonomyClassificationsForSchema`\n\nList taxonomy classifications for a given schema\n\n`GET /v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}`\n\n```ts\nconst { data } = await client.listTaxonomyClassificationsForSchema({\n slug: \'example\',\n taxonomySlug: \'example\',\n query: \'example\',\n size: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "taxonomy-slug:classification-slug",\n "slug": "wallbox-pv",\n "name": "Wallbox PV",\n "parents": ["taxonomy-slug:classification-slug"],\n "color": "#FF5733",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "archived": false,\n "starred": false,\n "enabled_locations": ["account", "string"],\n "enabled_purposes": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getTaxonomyBulkActionJobs`\n\nGets bulk actions jobs by job status:\n- ``<undefined>`` = all active jobs\n- PENDING = all active jobs\n- FAILED = all failed jobs\n- COMPLETED = all completed jobs\n\n`GET /v1/entity/taxonomies/bulk-jobs`\n\n```ts\nconst { data } = await client.getTaxonomyBulkActionJobs({\n status: [\'...\'],\n size: 1,\n created_after: \'example\',\n sort_pending_first: true,\n scope: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "job_id": "123e4567-e89b-12d3-a456-426614174000",\n "status": "PENDING",\n "action_type": "MOVE_CLASSIFICATIONS",\n "created_by": "10598",\n "created_at": "2024-01-01T00:00:00.000Z",\n "updated_at": "2024-01-01T00:00:00.000Z",\n "org": "66"\n }\n]\n```\n\n</details>\n\n---\n\n### `getTaxonomyBulkActionJobById`\n\nGets a bulk action job by job id\n\n`GET /v1/entity/taxonomies/bulk-jobs/{job_id}`\n\n```ts\nconst { data } = await client.getTaxonomyBulkActionJobById({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "job_id": "123e4567-e89b-12d3-a456-426614174000",\n "status": "PENDING",\n "action_type": "MOVE_CLASSIFICATIONS",\n "created_by": "10598",\n "created_at": "2024-01-01T00:00:00.000Z",\n "updated_at": "2024-01-01T00:00:00.000Z",\n "org": "66"\n}\n```\n\n</details>\n\n---\n\n### `cancelBulkAction`\n\nCancels a running bulk action job. The job status will be updated to CANCELLED\nand the job will be stopped.\n\n`POST /v1/entity/taxonomies/bulk-jobs/{job_id}/cancel`\n\n```ts\nconst { data } = await client.cancelBulkAction({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "job_id": "123e4567-e89b-12d3-a456-426614174000",\n "status": "PENDING",\n "action_type": "MOVE_CLASSIFICATIONS",\n "created_by": "10598",\n "created_at": "2024-01-01T00:00:00.000Z",\n "updated_at": "2024-01-01T00:00:00.000Z",\n "org": "66"\n}\n```\n\n</details>\n\n---\n\n### `bulkMoveClassifications`\n\nMoves classifications from one taxonomy to another, through a bulk async operation which\nalso updates all references from the old classification to the new one under the target taxonomy.\n\n`POST /v1/entity/taxonomies/classifications:move`\n\n```ts\nconst { data } = await client.bulkMoveClassifications(\n null,\n {\n job_id: \'string\',\n target_taxonomy: \'purpose\',\n classification_ids: [\'taxonomy-slug:classification-slug\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "PENDING"\n}\n```\n\n</details>\n\n---\n\n### `bulkMergeClassifications`\n\nMerges classifications from one taxonomy into one individual classification, through a bulk async operation which\nalso updates all references from the old Classifications to the new one.\n\n`POST /v1/entity/taxonomies/classifications:merge`\n\n```ts\nconst { data } = await client.bulkMergeClassifications(\n null,\n {\n job_id: \'string\',\n target_classification: \'purpose\',\n classification_ids: [\'taxonomy-slug:classification-slug\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "PENDING"\n}\n```\n\n</details>\n\n---\n\n### `bulkDeleteClassifications`\n\nPermanently deletes taxonomy classifications. The classifications are deleted through a bulk\nasync operation which also deletes all references of the deleted classifications from the entities\nreferenc\n\n`POST /v1/entity/taxonomies/classifications:delete`\n\n```ts\nconst { data } = await client.bulkDeleteClassifications(\n null,\n {\n job_id: \'string\',\n classification_ids: [\'taxonomy-slug:classification-slug\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "status": "PENDING"\n}\n```\n\n</details>\n\n---\n\n### `createSchemaAttribute`\n\nCreate a schema attribute\n\n`POST /v1/entity/schemas/attributes`\n\n```ts\nconst { data } = await client.createSchemaAttribute(\n null,\n {\n id: \'d5839b94-ba20-4225-a78e-76951d352bd6\',\n name: \'string\',\n label: \'string\',\n placeholder: \'string\',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n default_value: {},\n group: \'string\',\n order: 0,\n layout: \'full_width\',\n hide_label: true,\n icon: \'string\',\n render_condition: \'string\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n constraints: {\n disablePast: true\n },\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [\n {\n name: \'string\',\n enabled: true\n }\n ],\n value_formatter: \'string\',\n preview_value_formatter: \'string\',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: {\n hint_text: \'string\',\n hint_text_key: \'string\',\n hint_custom_component: \'string\',\n hint_tooltip_placement: \'top\'\n },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n type: \'string\',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {\n "disablePast": true\n },\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {\n "hint_text": "string",\n "hint_text_key": "string",\n "hint_custom_component": "string",\n "hint_tooltip_placement": "top"\n },\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "string",\n "multiline": true,\n "rich_text": true,\n "rows": 3\n}\n```\n\n</details>\n\n---\n\n### `getSchemaAttribute`\n\nGet a schema attribute from given attribute ID\n\n`GET /v1/entity/schemas/attributes/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaAttribute({\n composite_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {\n "disablePast": true\n },\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {\n "hint_text": "string",\n "hint_text_key": "string",\n "hint_custom_component": "string",\n "hint_tooltip_placement": "top"\n },\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "string",\n "multiline": true,\n "rich_text": true,\n "rows": 3\n}\n```\n\n</details>\n\n---\n\n### `putSchemaAttribute`\n\nUpdates an attribute in the schema\n\n`PUT /v1/entity/schemas/attributes/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaAttribute(\n {\n composite_id: \'example\',\n },\n {\n id: \'d5839b94-ba20-4225-a78e-76951d352bd6\',\n name: \'string\',\n label: \'string\',\n placeholder: \'string\',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n default_value: {},\n group: \'string\',\n order: 0,\n layout: \'full_width\',\n hide_label: true,\n icon: \'string\',\n render_condition: \'string\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n constraints: {\n disablePast: true\n },\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [\n {\n name: \'string\',\n enabled: true\n }\n ],\n value_formatter: \'string\',\n preview_value_formatter: \'string\',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: {\n hint_text: \'string\',\n hint_text_key: \'string\',\n hint_custom_component: \'string\',\n hint_tooltip_placement: \'top\'\n },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n type: \'string\',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {\n "disablePast": true\n },\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {\n "hint_text": "string",\n "hint_text_key": "string",\n "hint_custom_component": "string",\n "hint_tooltip_placement": "top"\n },\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "string",\n "multiline": true,\n "rich_text": true,\n "rows": 3\n}\n```\n\n</details>\n\n---\n\n### `deleteSchemaAttribute`\n\nDeletes an attribute from a schema\n\n`DELETE /v1/entity/schemas/attributes/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaAttribute({\n composite_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {\n "disablePast": true\n },\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {\n "hint_text": "string",\n "hint_text_key": "string",\n "hint_custom_component": "string",\n "hint_tooltip_placement": "top"\n },\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "string",\n "multiline": true,\n "rich_text": true,\n "rows": 3\n}\n```\n\n</details>\n\n---\n\n### `createSchemaCapability`\n\nCreate a schema capability\n\n`POST /v1/entity/schemas/capabilities`\n\n```ts\nconst { data } = await client.createSchemaCapability(\n null,\n {\n id: \'d5839b94-ba20-4225-a78e-76951d352bd6\',\n name: \'customer_messaging\',\n title: \'Messaging\',\n attributes: [\n {\n id: \'d5839b94-ba20-4225-a78e-76951d352bd6\',\n name: \'string\',\n label: \'string\',\n placeholder: \'string\',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n default_value: {},\n group: \'string\',\n order: 0,\n layout: \'full_width\',\n hide_label: true,\n icon: \'string\',\n render_condition: \'string\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n constraints: { /* ... */ },\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [ /* ... */ ],\n value_formatter: \'string\',\n preview_value_formatter: \'string\',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n type: \'string\',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n {\n id: \'d5839b94-ba20-4225-a78e-76951d352bd6\',\n name: \'string\',\n label: \'string\',\n placeholder: \'string\',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n default_value: {},\n group: \'string\',\n order: 0,\n layout: \'full_width\',\n hide_label: true,\n icon: \'string\',\n render_condition: \'string\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n constraints: { /* ... */ },\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [ /* ... */ ],\n value_formatter: \'string\',\n preview_value_formatter: \'string\',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n type: \'link\'\n },\n /* ... 33 more */\n ],\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n app_id: \'123e4567-e89b-12d3-a456-426614174000\',\n ui_config: {\n is_filterable: true\n },\n ui_hooks: [\n {\n hook: \'EntityDetailsV2:Tab\',\n render_condition: \'_is_composite_price = "false"\',\n order: 10,\n title: \'Notes\',\n group_expanded: true,\n import: \'@epilot360/notes\',\n component: \'PricingItems\',\n route: \'notes\',\n icon: \'email\',\n disabled: true,\n header: true,\n requiredPermission: { /* ... */ }\n }\n ],\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [\n {\n name: \'string\',\n enabled: true\n }\n ],\n schemas: [\n {\n schema: \'contact\'\n }\n ],\n composite_id: \'contact:97644baa-083f-4e49-9188-fcff2ecaad7d\',\n schema: \'contact\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "customer_messaging",\n "title": "Messaging",\n "attributes": [\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {},\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {},\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "string",\n "multiline": true,\n "rich_text": true,\n "rows": 3\n },\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {},\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {},\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "link"\n }\n ],\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "app_id": "123e4567-e89b-12d3-a456-426614174000",\n "ui_config": {\n "is_filterable": true\n },\n "ui_hooks": [\n {\n "hook": "EntityDetailsV2:Tab",\n "render_condition": "_is_composite_price = \\"false\\"",\n "order": 10,\n "title": "Notes",\n "group_expanded": true,\n "import": "@epilot360/notes",\n "component": "PricingItems",\n "route": "notes",\n "icon": "email",\n "disabled": true,\n "header": true,\n "requiredPermission": {}\n }\n ],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "schemas": [\n {\n "schema": "contact"\n }\n ],\n "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `getSchemaCapability`\n\nGet a schema capability from given capability ID\n\n`GET /v1/entity/schemas/capabilities/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaCapability({\n composite_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "customer_messaging",\n "title": "Messaging",\n "attributes": [\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {},\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {},\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "string",\n "multiline": true,\n "rich_text": true,\n "rows": 3\n },\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {},\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {},\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "link"\n }\n ],\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "app_id": "123e4567-e89b-12d3-a456-426614174000",\n "ui_config": {\n "is_filterable": true\n },\n "ui_hooks": [\n {\n "hook": "EntityDetailsV2:Tab",\n "render_condition": "_is_composite_price = \\"false\\"",\n "order": 10,\n "title": "Notes",\n "group_expanded": true,\n "import": "@epilot360/notes",\n "component": "PricingItems",\n "route": "notes",\n "icon": "email",\n "disabled": true,\n "header": true,\n "requiredPermission": {}\n }\n ],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "schemas": [\n {\n "schema": "contact"\n }\n ],\n "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `putSchemaCapability`\n\nAdds or updates an capability in the schema\n\n`PUT /v1/entity/schemas/capabilities/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaCapability(\n {\n composite_id: \'example\',\n },\n {\n id: \'d5839b94-ba20-4225-a78e-76951d352bd6\',\n name: \'customer_messaging\',\n title: \'Messaging\',\n attributes: [\n {\n id: \'d5839b94-ba20-4225-a78e-76951d352bd6\',\n name: \'string\',\n label: \'string\',\n placeholder: \'string\',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n default_value: {},\n group: \'string\',\n order: 0,\n layout: \'full_width\',\n hide_label: true,\n icon: \'string\',\n render_condition: \'string\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n constraints: { /* ... */ },\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [ /* ... */ ],\n value_formatter: \'string\',\n preview_value_formatter: \'string\',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n type: \'string\',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n {\n id: \'d5839b94-ba20-4225-a78e-76951d352bd6\',\n name: \'string\',\n label: \'string\',\n placeholder: \'string\',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n default_value: {},\n group: \'string\',\n order: 0,\n layout: \'full_width\',\n hide_label: true,\n icon: \'string\',\n render_condition: \'string\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n constraints: { /* ... */ },\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [ /* ... */ ],\n value_formatter: \'string\',\n preview_value_formatter: \'string\',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n type: \'link\'\n },\n /* ... 33 more */\n ],\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n app_id: \'123e4567-e89b-12d3-a456-426614174000\',\n ui_config: {\n is_filterable: true\n },\n ui_hooks: [\n {\n hook: \'EntityDetailsV2:Tab\',\n render_condition: \'_is_composite_price = "false"\',\n order: 10,\n title: \'Notes\',\n group_expanded: true,\n import: \'@epilot360/notes\',\n component: \'PricingItems\',\n route: \'notes\',\n icon: \'email\',\n disabled: true,\n header: true,\n requiredPermission: { /* ... */ }\n }\n ],\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [\n {\n name: \'string\',\n enabled: true\n }\n ],\n schemas: [\n {\n schema: \'contact\'\n }\n ],\n composite_id: \'contact:97644baa-083f-4e49-9188-fcff2ecaad7d\',\n schema: \'contact\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "customer_messaging",\n "title": "Messaging",\n "attributes": [\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {},\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {},\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "string",\n "multiline": true,\n "rich_text": true,\n "rows": 3\n },\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {},\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {},\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "link"\n }\n ],\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "app_id": "123e4567-e89b-12d3-a456-426614174000",\n "ui_config": {\n "is_filterable": true\n },\n "ui_hooks": [\n {\n "hook": "EntityDetailsV2:Tab",\n "render_condition": "_is_composite_price = \\"false\\"",\n "order": 10,\n "title": "Notes",\n "group_expanded": true,\n "import": "@epilot360/notes",\n "component": "PricingItems",\n "route": "notes",\n "icon": "email",\n "disabled": true,\n "header": true,\n "requiredPermission": {}\n }\n ],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "schemas": [\n {\n "schema": "contact"\n }\n ],\n "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `deleteSchemaCapability`\n\nDeletes a Capability from a schema\n\n`DELETE /v1/entity/schemas/capabilities/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaCapability({\n composite_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "customer_messaging",\n "title": "Messaging",\n "attributes": [\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {},\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {},\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "string",\n "multiline": true,\n "rich_text": true,\n "rows": 3\n },\n {\n "id": "d5839b94-ba20-4225-a78e-76951d352bd6",\n "name": "string",\n "label": "string",\n "placeholder": "string",\n "hidden": false,\n "show_in_table": true,\n "sortable": true,\n "required": false,\n "readonly": false,\n "deprecated": false,\n "default_value": {},\n "group": "string",\n "order": 0,\n "layout": "full_width",\n "hide_label": true,\n "icon": "string",\n "render_condition": "string",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "constraints": {},\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [],\n "value_formatter": "string",\n "preview_value_formatter": "string",\n "entity_builder_disable_edit": false,\n "protected": true,\n "info_helpers": {},\n "explicit_searchable": false,\n "exclude_from_search": false,\n "repeatable": true,\n "has_primary": true,\n "type": "link"\n }\n ],\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "app_id": "123e4567-e89b-12d3-a456-426614174000",\n "ui_config": {\n "is_filterable": true\n },\n "ui_hooks": [\n {\n "hook": "EntityDetailsV2:Tab",\n "render_condition": "_is_composite_price = \\"false\\"",\n "order": 10,\n "title": "Notes",\n "group_expanded": true,\n "import": "@epilot360/notes",\n "component": "PricingItems",\n "route": "notes",\n "icon": "email",\n "disabled": true,\n "header": true,\n "requiredPermission": {}\n }\n ],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "schemas": [\n {\n "schema": "contact"\n }\n ],\n "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `createSchemaGroup`\n\nCreate a schema group\n\n`POST /v1/entity/schemas/group`\n\n```ts\nconst { data } = await client.createSchemaGroup(\n null,\n {\n label: \'Contact Details\',\n id: \'e18a532b-ae79-4d86-a6a5-e5dbfb579d14\',\n order: 0,\n expanded: false,\n render_condition: \'_is_composite_price = "false"\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [\n {\n name: \'string\',\n enabled: true\n }\n ],\n info_tooltip_title: {\n key: \'string\',\n default: \'string\'\n },\n composite_id: \'contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\',\n schema: \'contact\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "label": "Contact Details",\n "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "order": 0,\n "expanded": false,\n "render_condition": "_is_composite_price = \\"false\\"",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "info_tooltip_title": {\n "key": "string",\n "default": "string"\n },\n "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `getSchemaGroup`\n\nGet a schema group from given group composite ID\n\n`GET /v1/entity/schemas/group/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaGroup({\n composite_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "label": "Contact Details",\n "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "order": 0,\n "expanded": false,\n "render_condition": "_is_composite_price = \\"false\\"",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "info_tooltip_title": {\n "key": "string",\n "default": "string"\n },\n "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `putSchemaGroup`\n\nAdds or updates an capability in the schema\n\n`PUT /v1/entity/schemas/group/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaGroup(\n {\n composite_id: \'example\',\n },\n {\n label: \'Contact Details\',\n id: \'e18a532b-ae79-4d86-a6a5-e5dbfb579d14\',\n order: 0,\n expanded: false,\n render_condition: \'_is_composite_price = "false"\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n feature_flag: \'FF_MY_FEATURE_FLAG\',\n settings_flag: [\n {\n name: \'string\',\n enabled: true\n }\n ],\n info_tooltip_title: {\n key: \'string\',\n default: \'string\'\n },\n composite_id: \'contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\',\n schema: \'contact\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "label": "Contact Details",\n "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "order": 0,\n "expanded": false,\n "render_condition": "_is_composite_price = \\"false\\"",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "info_tooltip_title": {\n "key": "string",\n "default": "string"\n },\n "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `deleteSchemaGroup`\n\nDeletes a Capability from a schema\n\n`DELETE /v1/entity/schemas/group/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaGroup({\n composite_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "label": "Contact Details",\n "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "order": 0,\n "expanded": false,\n "render_condition": "_is_composite_price = \\"false\\"",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "feature_flag": "FF_MY_FEATURE_FLAG",\n "settings_flag": [\n {\n "name": "string",\n "enabled": true\n }\n ],\n "info_tooltip_title": {\n "key": "string",\n "default": "string"\n },\n "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `createSchemaGroupHeadline`\n\nCreate a headline in a schema group\n\n`POST /v1/entity/schemas/headline`\n\n```ts\nconst { data } = await client.createSchemaGroupHeadline(\n null,\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n name: \'string\',\n label: \'string\',\n layout: \'string\',\n group: \'string\',\n order: 0,\n type: \'headline\',\n enable_divider: false,\n divider: \'top_divider\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n composite_id: \'contact:97644baa-083f-4e49-9188-fcff2ecaad7d\',\n schema: \'contact\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "name": "string",\n "label": "string",\n "layout": "string",\n "group": "string",\n "order": 0,\n "type": "headline",\n "enable_divider": false,\n "divider": "top_divider",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `getSchemaGroupHeadline`\n\nGet a group headline from schema from given headline composite ID\n\n`GET /v1/entity/schemas/headline/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaGroupHeadline({\n composite_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "name": "string",\n "label": "string",\n "layout": "string",\n "group": "string",\n "order": 0,\n "type": "headline",\n "enable_divider": false,\n "divider": "top_divider",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `putSchemaGroupHeadline`\n\nAdds or updates a group headline in the schema\n\n`PUT /v1/entity/schemas/headline/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaGroupHeadline(\n {\n composite_id: \'example\',\n },\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n name: \'string\',\n label: \'string\',\n layout: \'string\',\n group: \'string\',\n order: 0,\n type: \'headline\',\n enable_divider: false,\n divider: \'top_divider\',\n _purpose: [\'taxonomy-slug:classification-slug\'],\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n composite_id: \'contact:97644baa-083f-4e49-9188-fcff2ecaad7d\',\n schema: \'contact\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "name": "string",\n "label": "string",\n "layout": "string",\n "group": "string",\n "order": 0,\n "type": "headline",\n "enable_divider": false,\n "divider": "top_divider",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n### `deleteSchemaGroupHeadline`\n\nDeletes a group headline from a schema\n\n`DELETE /v1/entity/schemas/headline/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaGroupHeadline({\n composite_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "name": "string",\n "label": "string",\n "layout": "string",\n "group": "string",\n "order": 0,\n "type": "headline",\n "enable_divider": false,\n "divider": "top_divider",\n "_purpose": ["taxonomy-slug:classification-slug"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",\n "schema": "contact"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ExportJobId`\n\nThe unique identifier of the import job.\n\n```ts\ntype ExportJobId = string\n```\n\n### `Language`\n\nExport headers translation Language\n\n```ts\ntype Language = string\n```\n\n### `IsTemplate`\n\nPass \'true\' to generate import template\n\n```ts\ntype IsTemplate = boolean\n```\n\n### `SchemaId`\n\nGenerated uuid for schema\n\n```ts\ntype SchemaId = string // uuid\n```\n\n### `EntitySchema`\n\nThe "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.\n\n```ts\ntype EntitySchema = {\n slug: string\n version?: number\n blueprint?: string // uuid\n feature_flag?: string\n enable_setting?: string[]\n name: string\n plural: string\n description?: string\n docs_url?: string // uri\n category?: string\n published?: boolean\n draft?: boolean\n icon?: string\n title_template?: string\n ui_config?: {\n table_view?: {\n view_type?: { ... }\n row_actions?: { ... }\n bulk_actions?: { ... }\n navbar_actions?: { ... }\n enable_thumbnails?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n create_view?: {\n view_type?: { ... }\n search_params?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n edit_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n single_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n list_item?: {\n summary_attributes?: { ... }\n quick_actions?: { ... }\n ui_config?: { ... }\n }\n sharing?: {\n show_sharing_button?: { ... }\n }\n }\n capabilities: Array<{\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: { ... }\n name: { ... }\n label: { ... }\n placeholder?: { ... }\n hidden?: { ... }\n show_in_table?: { ... }\n sortable?: { ... }\n required?: { ... }\n readonly?: { ... }\n deprecated?: { ... }\n default_value?: { ... }\n group?: { ... }\n order?: { ... }\n layout?: { ... }\n hide_label?: { ... }\n icon?: { ... }\n render_condition?: { ... }\n _purpose?: { ... }\n _manifest?: { ... }\n constraints?: { ... }\n feature_flag?: { ... }\n settings_flag?: { ... }\n value_formatter?: { ... }\n preview_value_formatter?: { ... }\n entity_builder_disable_edit?: { ... }\n protected?: { ... }\n info_helpers?: { ... }\n explicit_searchable?: { ... }\n exclude_from_search?: { ... }\n // ...\n}\n```\n\n### `EntitySchemaItem`\n\n```ts\ntype EntitySchemaItem = {\n id?: string // uuid\n created_at?: string\n updated_at?: string\n comment?: string\n source?: {\n id?: string\n type?: string\n }\n _summary?: boolean\n slug: string\n version?: number\n blueprint?: string // uuid\n feature_flag?: string\n enable_setting?: string[]\n name: string\n plural: string\n description?: string\n docs_url?: string // uri\n category?: string\n published?: boolean\n draft?: boolean\n icon?: string\n title_template?: string\n ui_config?: {\n table_view?: {\n view_type?: { ... }\n row_actions?: { ... }\n bulk_actions?: { ... }\n navbar_actions?: { ... }\n enable_thumbnails?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n create_view?: {\n view_type?: { ... }\n search_params?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n edit_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n single_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n list_item?: {\n summary_attributes?: { ... }\n quick_actions?: { ... }\n ui_config?: { ... }\n }\n sharing?: {\n show_sharing_button?: { ... }\n }\n }\n capabilities: Array<{\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: { ... }\n name: { ... }\n label: { ... }\n placeholder?: { ... }\n hidden?: { ... }\n show_in_table?: { ... }\n sortable?: { ... }\n required?: { ... }\n readonly?: { ... }\n deprecated?: { ... }\n default_value?: { ... }\n group?: { ... }\n order?: { ... }\n layout?: { ... }\n hide_label?: { ... }\n icon?: { ... }\n render_condition?: { ... }\n _purpose?: { ... }\n _manifest?: { ... }\n constraints?: { ... }\n // ...\n}\n```\n\n### `GenerateEntityTableAIFiltersRequest`\n\n```ts\ntype GenerateEntityTableAIFiltersRequest = {\n prompt: string\n main_entity_slug: string\n filter_options: Array<{\n type?: "search" | "filter"\n label: string\n label_type?: string\n name?: string\n group?: string\n allowedSchemas?: string[]\n relatedOptions?: Array<{\n type?: { ... }\n label: { ... }\n label_type?: { ... }\n name?: { ... }\n group?: { ... }\n allowedSchemas?: { ... }\n relatedOptions?: { ... }\n }>\n }>\n}\n```\n\n### `GenerateEntityTableAIFiltersResponse`\n\n```ts\ntype GenerateEntityTableAIFiltersResponse = Array<{\n label: string\n type: string\n value: string\n}>\n```\n\n### `EntityTableFilterSearch`\n\n```ts\ntype EntityTableFilterSearch = {\n label: string\n type: string\n value: string\n}\n```\n\n### `EntityTableFilterOption`\n\n```ts\ntype EntityTableFilterOption = {\n type?: "search" | "filter"\n label: string\n label_type?: string\n name?: string\n group?: string\n allowedSchemas?: string[]\n relatedOptions?: Array<{\n type?: "search" | "filter"\n label: string\n label_type?: string\n name?: string\n group?: string\n allowedSchemas?: string[]\n relatedOptions?: Array<{\n type?: { ... }\n label: { ... }\n label_type?: { ... }\n name?: { ... }\n group?: { ... }\n allowedSchemas?: { ... }\n relatedOptions?: { ... }\n }>\n }>\n}\n```\n\n### `EntitySchemaGroup`\n\n```ts\ntype EntitySchemaGroup = {\n label: string\n id?: string\n order?: number\n expanded?: boolean\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n info_tooltip_title?: {\n key?: string\n default?: string\n }\n}\n```\n\n### `EntitySchemaGroupWithCompositeID`\n\n```ts\ntype EntitySchemaGroupWithCompositeID = {\n label: string\n id?: string\n order?: number\n expanded?: boolean\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n info_tooltip_title?: {\n key?: string\n default?: string\n }\n composite_id?: string\n schema?: string\n}\n```\n\n### `Attribute`\n\n```ts\ntype Attribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "string"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n} | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "link"\n} | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n // ...\n}\n```\n\n### `AttributeWithCompositeID`\n\n```ts\ntype AttributeWithCompositeID = {\n composite_id?: string\n schema?: string\n}\n```\n\n### `BaseAttribute`\n\n```ts\ntype BaseAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n}\n```\n\n### `TextAttribute`\n\n```ts\ntype TextAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "string"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n}\n```\n\n### `LinkAttribute`\n\n```ts\ntype LinkAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "link"\n}\n```\n\n### `InternalAttribute`\n\n```ts\ntype InternalAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "internal"\n}\n```\n\n### `BooleanAttribute`\n\n```ts\ntype BooleanAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "boolean"\n display_type?: "switch" | "checkbox"\n}\n```\n\n### `DateAttribute`\n\n```ts\ntype DateAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "date" | "datetime"\n}\n```\n\n### `CountryAttribute`\n\n```ts\ntype CountryAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "country"\n}\n```\n\n### `SelectAttribute`\n\n```ts\ntype SelectAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "select" | "radio"\n options?: Array<{\n value: string\n title?: string\n } | string>\n allow_any?: boolean\n}\n```\n\n### `MultiSelectAttribute`\n\n```ts\ntype MultiSelectAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "multiselect" | "checkbox"\n disable_case_sensitive?: boolean\n allow_extra_options?: boolean\n options?: Array<string | {\n value: string\n title?: string\n }>\n allow_any?: boolean\n}\n```\n\n### `StatusAttribute`\n\n```ts\ntype StatusAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "status"\n options?: Array<string | {\n value: string\n title?: string\n }>\n}\n```\n\n### `SequenceAttribute`\n\n```ts\ntype SequenceAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "sequence"\n prefix?: string\n start_number?: number\n}\n```\n\n### `FileAttribute`\n\n```ts\ntype FileAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "image" | "file"\n multiple?: boolean\n allowed_extensions?: string[]\n display_images_landscaped?: boolean\n enable_description?: boolean\n default_access_control?: "public-read" | "private"\n}\n```\n\n### `CurrencyAttribute`\n\n```ts\ntype CurrencyAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "currency"\n currency_selector_only?: boolean\n currency: Array<{\n code: string\n description: string\n symbol: string\n flag?: string\n }>\n}\n```\n\n### `SummaryField`\n\nSummary Fields are displayed inside list view as a resume of the relation entity.\n\n```ts\ntype SummaryField = {\n field?: string\n display_as?: string\n}\n```\n\n### `EntityAction`\n\nAn entity action configured from the entity schema\n\n```ts\ntype EntityAction = {\n action: string\n label: string\n icon?: string\n permission?: string\n}\n```\n\n### `RelationAttribute`\n\n```ts\ntype RelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "relation"\n relation_type?: "has_many" | "has_one"\n reverse_attributes?: Record<string, string>\n relation_affinity_mode?: "weak" | "strong"\n enable_relation_picker?: boolean\n edit_mode?: "list-view"\n details_view_mode_enabled?: boolean\n relation_picker_filter?: {\n q: string\n }\n actions?: Array<{\n action_type?: "add_existing" | "create_new" | "create_from_existing"\n label?: string\n default?: boolean\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n new_entity_item?: Record<string, unknown>\n }>\n drawer_size?: "small" | "medium" | "large"\n summary_fields?: Array<string | {\n field?: string\n display_as?: string\n }>\n allowedSchemas?: string[]\n enable_relation_tags?: boolean\n add_button_label?: string\n search_placeholder?: string\n}\n```\n\n### `UserRelationAttribute`\n\n```ts\ntype UserRelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "relation_user"\n multiple?: boolean\n}\n```\n\n### `PartnerOrganisationAttribute`\n\n```ts\ntype PartnerOrganisationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "partner_organisation"\n}\n```\n\n### `PortalAccessAttribute`\n\n```ts\ntype PortalAccessAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "portal_access"\n}\n```\n\n### `DefaultAddressFields`\n\nDefault fields visible on addresses\n\nValid values are:\n - postal_code (default)\n - city (default)\n - street (default)\n - street_number (default)\n - plot_area\n - plot_of_land\n - suburb\n - country\n - postbox\n - additional_info\n - coordinates\n - start_date\n - end_date\n - salutation\n - ti\n\n```ts\ntype DefaultAddressFields = string[]\n```\n\n### `AddressAttribute`\n\n```ts\ntype AddressAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "address"\n default_address_fields?: string[]\n}\n```\n\n### `AddressRelationAttribute`\n\n```ts\ntype AddressRelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "relation_address"\n default_address_fields?: string[]\n}\n```\n\n### `PaymentMethodRelationAttribute`\n\n```ts\ntype PaymentMethodRelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "relation_payment_method"\n}\n```\n\n### `InvitationEmailAttribute`\n\n```ts\ntype InvitationEmailAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "invitation_email"\n}\n```\n\n### `AutomationAttribute`\n\n```ts\ntype AutomationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "automation"\n}\n```\n\n### `InternalUserAttribute`\n\n```ts\ntype InternalUserAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "internal_user"\n}\n```\n\n### `PurposeAttribute`\n\n```ts\ntype PurposeAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "purpose"\n}\n```\n\n### `RepeatableAttribute`\n\n```ts\ntype RepeatableAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n}\n```\n\n### `TagsAttribute`\n\n```ts\ntype TagsAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "tags"\n options?: string[]\n suggestions?: string[]\n}\n```\n\n### `MessageEmailAddressAttribute`\n\n```ts\ntype MessageEmailAddressAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "message_email_address"\n address?: string\n send_status?: string\n email_type?: string\n}\n```\n\n### `NumberAttribute`\n\n```ts\ntype NumberAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "number"\n data_type?: "number" | "string"\n format?: string\n show_separator?: boolean\n}\n```\n\n### `TableAttribute`\n\n```ts\ntype TableAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "table"\n columns?: Array<{\n name: string\n label: string\n type?: "string" | "number" | "date" | "boolean"\n width?: string\n required?: boolean\n }>\n min_rows?: number\n max_rows?: number\n}\n```\n\n### `ConsentAttribute`\n\n```ts\ntype ConsentAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "consent"\n topic: string\n identifiers?: string[]\n}\n```\n\n### `OrderedListAttribute`\n\n```ts\ntype OrderedListAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "ordered_list"\n}\n```\n\n### `EmailAttribute`\n\n```ts\ntype EmailAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "email"\n}\n```\n\n### `PhoneAttribute`\n\n```ts\ntype PhoneAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "phone"\n}\n```\n\n### `PaymentAttribute`\n\n```ts\ntype PaymentAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "payment"\n}\n```\n\n### `PriceComponentAttribute`\n\n```ts\ntype PriceComponentAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "price_component"\n}\n```\n\n### `ComputedAttribute`\n\n```ts\ntype ComputedAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "computed"\n computed?: boolean\n amount_field?: string\n currency_field?: string\n}\n```\n\n### `PartnerStatusAttribute`\n\n```ts\ntype PartnerStatusAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "partner_status"\n}\n```\n\n### `SummaryAttribute`\n\nRepresents an expanded version of an attribute to be displayed in the list item summary.\nThis configuration can be used in the following way:\n```js\n{\n "label": "Price components"\n "value": "{{item.prices.length}} price components"\n "show_as_tag": true\n "render_condition": "is_composite_price = "\n\n```ts\ntype SummaryAttribute = {\n label: string\n value: string\n show_as_tag?: boolean\n tag_color?: string\n render_condition?: string\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n display_mode?: "inline" | "block"\n content_line_cap?: number\n content_wrap?: "normal" | "nowrap" | "pre" | "pre-wrap"\n hide_label?: boolean\n highlight_container?: boolean\n}\n```\n\n### `GroupHeadline`\n\n```ts\ntype GroupHeadline = {\n id?: string // uuid\n name: string\n label: string\n layout?: string\n group: string\n order?: number\n type: "headline"\n enable_divider?: boolean\n divider?: "top_divider" | "bottom_divider"\n _purpose?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `GroupHeadlineWithCompositeID`\n\n```ts\ntype GroupHeadlineWithCompositeID = {\n id?: string // uuid\n name: string\n label: string\n layout?: string\n group: string\n order?: number\n type: "headline"\n enable_divider?: boolean\n divider?: "top_divider" | "bottom_divider"\n _purpose?: string[]\n _manifest?: string // uuid[]\n composite_id?: string\n schema?: string\n}\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = string\n```\n\n### `EntityCapability`\n\nCapabilities the Entity has. Turn features on/off for entities.\n\n```ts\ntype EntityCapability = {\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "string"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n } | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "link"\n } | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n // ...\n}\n```\n\n### `EntityCapabilityWithCompositeID`\n\n```ts\ntype EntityCapabilityWithCompositeID = {\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "string"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n } | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n type: "link"\n } | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n // ...\n}\n```\n\n### `EntityViewDisabled`\n\n```ts\ntype EntityViewDisabled = {\n view_type?: "disabled"\n}\n```\n\n### `EntityDefaultTable`\n\n```ts\ntype EntityDefaultTable = {\n view_type?: "default"\n row_actions?: Array<string | {\n action: string\n label: string\n icon?: string\n permission?: string\n }>\n bulk_actions?: Array<string | {\n action: string\n label: string\n icon?: string\n permission?: string\n }>\n navbar_actions?: Array<{\n type: string\n options?: Array<{\n label: { ... }\n params?: { ... }\n }>\n }>\n enable_thumbnails?: boolean\n}\n```\n\n### `EntityDefaultCreate`\n\n```ts\ntype EntityDefaultCreate = {\n view_type?: "default"\n search_params?: Record<string, string>\n}\n```\n\n### `EntityDefaultEdit`\n\n```ts\ntype EntityDefaultEdit = {\n view_type?: "default"\n search_params?: Record<string, string>\n summary_attributes?: string[]\n}\n```\n\n### `RedirectEntityView`\n\n```ts\ntype RedirectEntityView = {\n view_type?: "redirect"\n route?: string\n}\n```\n\n### `EntityId`\n\n```ts\ntype EntityId = string // uuid\n```\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n _id: object\n _org: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema: string\n _title: string\n _tags?: string[]\n _created_at: string // date-time\n _updated_at: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `Entity`\n\n```ts\ntype Entity = {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `NullableEntity`\n\n```ts\ntype NullableEntity = {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `EntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype EntityOwner = {\n org_id: string\n user_id?: string\n}\n```\n\n### `EntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype EntityAcl = {\n view?: string[]\n edit?: string[]\n delete?: string[]\n}\n```\n\n### `HydratedEntity`\n\nEntity with relation data resolved into the attribute values\n\n```ts\ntype HydratedEntity = {\n _relations: Array<{\n entity_id: string // uuid\n }>\n}\n```\n\n### `EntityItem`\n\n```ts\ntype EntityItem = {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `EntityValidationError`\n\nValidation error for an entity attribute\n\n```ts\ntype EntityValidationError = {\n code: string\n params: {\n type?: string\n }\n path: string[]\n message: string\n}\n```\n\n### `EntityValidationResultSuccess`\n\nValidation result for a successful validation\n\n```ts\ntype EntityValidationResultSuccess = {\n status: "success"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n}\n```\n\n### `EntityValidationResultError`\n\nValidation result for a failed validation\n\n```ts\ntype EntityValidationResultError = {\n status: "error"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n}\n```\n\n### `EntityValidationResult`\n\n```ts\ntype EntityValidationResult = {\n status: "success"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n} | {\n status: "error"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n}\n```\n\n### `EntityValidationV2Error`\n\n```ts\ntype EntityValidationV2Error = {\n keyword: string\n instance_path: string\n schema_path: string\n params: Record<string, unknown>\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record<string, unknown>\n data?: Record<string, unknown>\n}\n```\n\n### `EntityValidationV2ResultSuccess`\n\nValidation result for a successful validation\n\n```ts\ntype EntityValidationV2ResultSuccess = {\n status: "success"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record<string, unknown>\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record<string, unknown>\n data?: Record<string, unknown>\n }>\n}\n```\n\n### `EntityValidationV2ResultError`\n\nValidation result for a failed validation\n\n```ts\ntype EntityValidationV2ResultError = {\n status: "error"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record<string, unknown>\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record<string, unknown>\n data?: Record<string, unknown>\n }>\n}\n```\n\n### `EntityValidationV2Result`\n\n```ts\ntype EntityValidationV2Result = {\n status: "success"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record<string, unknown>\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record<string, unknown>\n data?: Record<string, unknown>\n }>\n} | {\n status: "error"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record<string, unknown>\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record<string, unknown>\n data?: Record<string, unknown>\n }>\n}\n```\n\n### `HydratedEntityItem`\n\n```ts\ntype HydratedEntityItem = {\n _relations: Array<{\n entity_id: string // uuid\n }>\n}\n```\n\n### `GetRelationsResp`\n\n```ts\ntype GetRelationsResp = Array<{\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n} | {\n $relation?: {\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n }\n}>\n```\n\n### `GetRelationsRespWithPagination`\n\n```ts\ntype GetRelationsRespWithPagination = {\n hits?: number\n relations?: Array<{\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n } | {\n $relation?: {\n entity_id: { ... }\n org_id?: { ... }\n _schema?: { ... }\n attribute: { ... }\n _tags?: { ... }\n reverse?: { ... }\n }\n }>\n}\n```\n\n### `GetRelatedEntitiesCount`\n\n```ts\ntype GetRelatedEntitiesCount = {\n hits?: number\n}\n```\n\n### `RelationEntity`\n\n```ts\ntype RelationEntity = {\n $relation?: {\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n }\n}\n```\n\n### `RelationItem`\n\n```ts\ntype RelationItem = {\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n}\n```\n\n### `EntitySearchIncludeDeletedParam`\n\nWhether to include deleted entities in the search results\n- `true`: include deleted entities\n- `false`: exclude deleted entities\n- `only`: include only deleted entities\n\nBy default, no deleted entities are included in the search results.\n\n\n```ts\ntype EntitySearchIncludeDeletedParam = "true" | "false" | "only"\n```\n\n### `EntitySearchParams`\n\n```ts\ntype EntitySearchParams = {\n q: string\n include_scores?: boolean\n sort?: string | string[]\n from?: number\n size?: number\n hydrate?: boolean\n fields?: string[]\n aggs?: object\n include_deleted?: "true" | "false" | "only"\n highlight?: unknown\n stable_for?: number\n stable_query_id?: string\n search_after?: string | number[]\n}\n```\n\n### `EntityListParams`\n\n```ts\ntype EntityListParams = {\n query?: {\n query_string: {\n query: { ... }\n fields?: { ... }\n default_operator?: { ... }\n lenient?: { ... }\n }\n }\n filter: Array<{\n term?: Record<string, string | number | boolean>\n terms?: Record<string, string | number | boolean[]>\n ids?: {\n values?: { ... }\n }\n range?: Record<string, {\n gt?: { ... }\n gte?: { ... }\n lt?: { ... }\n lte?: { ... }\n format?: { ... }\n relation?: { ... }\n time_zone?: { ... }\n }>\n exists?: {\n field: { ... }\n }\n $and?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $or?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $not?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n }>\n allow_targeting_all_schemas?: boolean\n sort?: string | string[]\n from?: number\n size?: number\n hydrate?: boolean\n fields?: string[]\n aggs?: object\n include_deleted?: "true" | "false" | "only"\n include_scores?: boolean\n highlight?: unknown\n stable_for?: number\n stable_query_id?: string\n search_after?: string | number[]\n}\n```\n\n### `SearchFilter`\n\nA subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.\n\n```ts\ntype SearchFilter = Array<{\n term?: Record<string, string | number | boolean>\n terms?: Record<string, string | number | boolean[]>\n ids?: {\n values?: string[]\n }\n range?: Record<string, {\n gt?: string | number | boolean\n gte?: string | number | boolean\n lt?: string | number | boolean\n lte?: string | number | boolean\n format?: string\n relation?: "INTERSECTS" | "CONTAINS" | "WITHIN"\n time_zone?: string\n }>\n exists?: {\n field: string\n }\n $and?: Array<{\n term?: Record<string, string | number | boolean>\n terms?: Record<string, string | number | boolean[]>\n ids?: {\n values?: { ... }\n }\n range?: Record<string, {\n gt?: { ... }\n gte?: { ... }\n lt?: { ... }\n lte?: { ... }\n format?: { ... }\n relation?: { ... }\n time_zone?: { ... }\n }>\n exists?: {\n field: { ... }\n }\n $and?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $or?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $not?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n }>\n $or?: Array<{\n term?: Record<string, string | number | boolean>\n terms?: Record<string, string | number | boolean[]>\n ids?: {\n values?: { ... }\n }\n range?: Record<string, {\n gt?: { ... }\n gte?: { ... }\n lt?: { ... }\n lte?: { ... }\n format?: { ... }\n relation?: { ... }\n time_zone?: { ... }\n }>\n exists?: {\n field: { ... }\n }\n $and?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $or?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n // ...\n}\n```\n\n### `SearchFilterValue`\n\nA filter field value.\n\n```ts\ntype SearchFilterValue = string | number | boolean\n```\n\n### `EntitySearchOptions`\n\n```ts\ntype EntitySearchOptions = {\n sort?: string | string[]\n from?: number\n size?: number\n hydrate?: boolean\n fields?: string[]\n aggs?: object\n include_deleted?: "true" | "false" | "only"\n include_scores?: boolean\n stable_for?: number\n stable_query_id?: string\n search_after?: string | number[]\n}\n```\n\n### `FieldsParam`\n\nList of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n\n\n```ts\ntype FieldsParam = string[]\n```\n\n### `EntityImportParams`\n\nThe parameters for importing entities.\n\n```ts\ntype EntityImportParams = {\n S3Reference: {\n bucket: string\n key: string\n }\n schema: string\n}\n```\n\n### `GraphQueryRequest`\n\n```ts\ntype GraphQueryRequest = {\n seed: {\n entity_id: string // uuid\n node_id: string\n }\n graph: {\n nodes: Array<{\n id: { ... }\n schema: { ... }\n cardinality?: { ... }\n fields?: { ... }\n }>\n edges: Array<{\n from: { ... }\n to: { ... }\n }>\n }\n hydrate?: boolean\n}\n```\n\n### `GraphSeed`\n\n```ts\ntype GraphSeed = {\n entity_id: string // uuid\n node_id: string\n}\n```\n\n### `GraphDefinition`\n\n```ts\ntype GraphDefinition = {\n nodes: Array<{\n id: string\n schema: string\n cardinality?: "one" | "many"\n fields?: object\n }>\n edges: Array<{\n from: string\n to: string\n }>\n}\n```\n\n### `GraphNode`\n\n```ts\ntype GraphNode = {\n id: string\n schema: string\n cardinality?: "one" | "many"\n fields?: object\n}\n```\n\n### `GraphEdge`\n\n```ts\ntype GraphEdge = {\n from: string\n to: string\n}\n```\n\n### `GraphQueryResponse`\n\n```ts\ntype GraphQueryResponse = {\n nodes?: Record<string, string // uuid[]>\n entityNodes?: Record<string, {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n } | Array<{\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n }>>\n edges: Array<{\n from: string\n to: string\n }>\n}\n```\n\n### `EntitySearchResults`\n\n```ts\ntype EntitySearchResults = {\n hits?: number\n results?: Array<{\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n }>\n aggregations?: object\n stable_query_id?: string\n sort_end?: string | number[]\n}\n```\n\n### `SearchMappings`\n\nAdvanced: explicit Elasticsearch index mapping definitions for entity data\n\n\n```ts\ntype SearchMappings = Record<string, {\n index?: boolean\n type?: "keyword" | "text" | "boolean" | "integer" | "long" | "float" | "date" | "flattened" | "nested"\n fields?: unknown\n}>\n```\n\n### `ActivityId`\n\nSee https://github.com/ulid/spec\n\n```ts\ntype ActivityId = string // ulid\n```\n\n### `ActivityCallerContext`\n\n```ts\ntype ActivityCallerContext = {\n EpilotAuth?: {\n token?: {\n sub?: { ... }\n email?: { ... }\n cognito:username?: { ... }\n custom:ivy_user_id?: { ... }\n }\n }\n}\n```\n\n### `ActivityType`\n\nA type for the activity. Used to categorize activities in the activity feed and for event subscriptions.\n\nBuilt-in entity activity types (custom activities can be defined as well):\n- EntityCreated\n- EntityUpdated\n- EntityDeleted\n- EntitySoftDeleted\n- EntityRestored\n- RelationsAdded\n- RelationsRemove\n\n```ts\ntype ActivityType = string\n```\n\n### `Activity`\n\n```ts\ntype Activity = {\n type: string\n title: string\n message: string\n payload?: Record<string, unknown>\n pending?: boolean\n}\n```\n\n### `EntityOperation`\n\n```ts\ntype EntityOperation = {\n entity: string // uuid\n org: string\n activity_id?: string // ulid\n activity_type?: string\n operation: "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity" | "relationsAdded" | "relationsRemoved" | "relationsSoftDeleted" | "relationsRestored" | "relationsDeleted"\n params?: {\n id?: string // uuid\n slug?: string\n }\n payload?: {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n }\n diff?: {\n added?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n }\n updated?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n }\n deleted?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n }\n }\n _workflow_origin?: {\n workflow_exec_id?: string\n flow_template_id?: string\n }\n}\n```\n\n### `BaseActivityItem`\n\n```ts\ntype BaseActivityItem = {\n _id?: string // ulid\n timestamp?: string // date-time\n type: string\n title: string\n message: string\n payload?: Record<string, unknown>\n pending?: boolean\n caller?: {\n EpilotAuth?: {\n token?: { ... }\n }\n }\n}\n```\n\n### `ActivityItem`\n\n```ts\ntype ActivityItem = {\n operations_total?: number\n operations?: Array<{\n entity: string // uuid\n org: string\n activity_id?: string // ulid\n activity_type?: string\n operation: "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity" | "relationsAdded" | "relationsRemoved" | "relationsSoftDeleted" | "relationsRestored" | "relationsDeleted"\n params?: {\n id?: { ... }\n slug?: { ... }\n }\n payload?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n }\n diff?: {\n added?: { ... }\n updated?: { ... }\n deleted?: { ... }\n }\n _workflow_origin?: {\n workflow_exec_id?: { ... }\n flow_template_id?: { ... }\n }\n }>\n}\n```\n\n### `BlueprintEntityId`\n\nReference to blueprint\n\n```ts\ntype BlueprintEntityId = string // uuid\n```\n\n### `ListSavedViewsResults`\n\n```ts\ntype ListSavedViewsResults = {\n hits?: number\n results?: Array<{\n id?: string // uuid\n created_at?: string\n updated_at?: string\n }>\n}\n```\n\n### `SavedViewId`\n\nGenerated uuid for a saved view\n\n```ts\ntype SavedViewId = string // uuid\n```\n\n### `SavedViewItem`\n\n```ts\ntype SavedViewItem = {\n id?: string // uuid\n created_at?: string\n updated_at?: string\n}\n```\n\n### `SavedViewPartial`\n\nA saved entity view\n\n```ts\ntype SavedViewPartial = {\n slug?: string[]\n name?: string\n org?: string\n shared?: boolean\n isFavoritedBy?: string[]\n created_by?: {\n user_id?: string\n } | {\n source?: "SYSTEM" | "BLUEPRINT"\n }\n ui_config?: Record<string, unknown>\n shared_with?: string[]\n}\n```\n\n### `SavedView`\n\nA saved entity view\n\n```ts\ntype SavedView = {\n slug: string[]\n name: string\n org?: string\n shared?: boolean\n isFavoritedBy?: string[]\n created_by?: {\n user_id?: string\n } | {\n source?: "SYSTEM" | "BLUEPRINT"\n }\n ui_config: Record<string, unknown>\n shared_with?: string[]\n}\n```\n\n### `Taxonomy`\n\n```ts\ntype Taxonomy = {\n slug?: string\n name?: string\n plural?: string\n kind?: "system" | "user_defined"\n type?: "entity" | "relation" | "system" | "file_collection"\n icon?: string\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n deleted_at?: string // date-time\n created_by?: string\n enabled?: boolean\n order?: number\n enabled_locations?: "account" | "contact" | "contract" | "email_template" | "file" | "journey" | "meter_counter" | "meter" | "opportunity" | "order" | "partner" | "price" | "product" | "submission" | "tax" | "message" | "portal_user" | "request" | "comment" | string[]\n}\n```\n\n### `TaxonomyLocationId`\n\n```ts\ntype TaxonomyLocationId = "account" | "contact" | "contract" | "email_template" | "file" | "journey" | "meter_counter" | "meter" | "opportunity" | "order" | "partner" | "price" | "product" | "submission" | "tax" | "message" | "portal_user" | "request" | "comment"\n```\n\n### `TaxonomySearchIncludeArchivedParam`\n\nWhether to include archived labels in the search results\n- `true`: include archived labels\n- `false`: exclude archived labels\n- `only`: include only archived labels\n\nBy default, no archived labels are included in the search results.\n\n\n```ts\ntype TaxonomySearchIncludeArchivedParam = "true" | "false" | "only"\n```\n\n### `TaxonomyClassification`\n\n```ts\ntype TaxonomyClassification = {\n id?: string\n slug: string\n name: string\n parents?: string[]\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n archived?: boolean\n starred?: boolean\n enabled_locations?: "account" | "contact" | "contract" | "email_template" | "file" | "journey" | "meter_counter" | "meter" | "opportunity" | "order" | "partner" | "price" | "product" | "submission" | "tax" | "message" | "portal_user" | "request" | "comment" | string[]\n enabled_purposes?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `ClassificationId`\n\n```ts\ntype ClassificationId = string\n```\n\n### `ClassificationIdOrPattern`\n\n```ts\ntype ClassificationIdOrPattern = string | {\n pattern: string\n}\n```\n\n### `ClassificationSlug`\n\nURL-friendly identifier for the classification\n\n```ts\ntype ClassificationSlug = string\n```\n\n### `TaxonomySlug`\n\nURL-friendly name for taxonomy\n\n```ts\ntype TaxonomySlug = string\n```\n\n### `ClassificationsUpdate`\n\n```ts\ntype ClassificationsUpdate = {\n create?: Array<{\n id?: string\n slug: string\n name: string\n parents?: string[]\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n archived?: boolean\n starred?: boolean\n enabled_locations?: "account" | "contact" | "contract" | "email_template" | "file" | "journey" | "meter_counter" | "meter" | "opportunity" | "order" | "partner" | "price" | "product" | "submission" | "tax" | "message" | "portal_user" | "request" | "comment" | string[]\n enabled_purposes?: string[]\n _manifest?: string // uuid[]\n }>\n update?: Array<{\n id?: string\n slug: string\n name: string\n parents?: string[]\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n archived?: boolean\n starred?: boolean\n enabled_locations?: "account" | "contact" | "contract" | "email_template" | "file" | "journey" | "meter_counter" | "meter" | "opportunity" | "order" | "partner" | "price" | "product" | "submission" | "tax" | "message" | "portal_user" | "request" | "comment" | string[]\n enabled_purposes?: string[]\n _manifest?: string // uuid[]\n }>\n delete?: string | string[]\n}\n```\n\n### `TaxonomyBulkJobTriggerResponse`\n\n```ts\ntype TaxonomyBulkJobTriggerResponse = {\n job_id?: string // uuid\n status?: "PENDING" | "FAILED" | "COMPLETED" | "CANCELLED"\n}\n```\n\n### `TaxonomyBulkJobStatus`\n\nThe status of the bulk job\n\n```ts\ntype TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED" | "CANCELLED"\n```\n\n### `TaxonomyBulkJobActionType`\n\n```ts\ntype TaxonomyBulkJobActionType = "MOVE_CLASSIFICATIONS" | "MERGE_CLASSIFICATIONS" | "DELETE_CLASSIFICATIONS"\n```\n\n### `TaxonomyBulkJob`\n\n```ts\ntype TaxonomyBulkJob = {\n job_id?: string // uuid\n job_status?: "PENDING" | "FAILED" | "COMPLETED" | "CANCELLED"\n failure_reason?: string\n action_type?: "MOVE_CLASSIFICATIONS" | "MERGE_CLASSIFICATIONS" | "DELETE_CLASSIFICATIONS"\n request?: {\n target_taxonomy?: string\n target_classification?: string\n classification_ids?: string[]\n }\n output?: {\n target_entities_count?: number\n affected_entities_count?: number\n failures_count?: number\n failed_entities?: string // uuid[]\n }\n created_by?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n org?: string\n}\n```\n\n### `ESClusterAssignment`\n\n```ts\ntype ESClusterAssignment = {\n orgId?: string\n cluster?: string\n}\n```\n\n### `SettingFlag`\n\n```ts\ntype SettingFlag = {\n name?: string\n enabled?: boolean\n}\n```\n\n### `ErrorObject`\n\nA generic error returned by the API\n\n```ts\ntype ErrorObject = {\n status?: number\n error?: string\n}\n```\n';
5
+
6
+
7
+ exports.default = entity_default;