@epilot/sdk 2.2.7 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. package/README.md +3 -2
  2. package/definitions/automation-runtime.json +1 -1
  3. package/definitions/automation.json +209 -0
  4. package/definitions/blueprint-manifest-runtime.json +1 -1
  5. package/definitions/blueprint-manifest.json +1279 -150
  6. package/definitions/data-governance-runtime.json +1 -0
  7. package/definitions/data-governance.json +1126 -0
  8. package/definitions/deduplication-runtime.json +1 -1
  9. package/definitions/deduplication.json +135 -4
  10. package/definitions/design-runtime.json +1 -1
  11. package/definitions/design.json +103 -57
  12. package/definitions/email-settings-runtime.json +1 -1
  13. package/definitions/email-settings.json +29 -0
  14. package/definitions/entity.json +44 -2
  15. package/definitions/{erp-integration-runtime.json → integration-toolkit-runtime.json} +1 -1
  16. package/definitions/{erp-integration.json → integration-toolkit.json} +76 -5
  17. package/definitions/journey.json +9 -0
  18. package/definitions/message-runtime.json +1 -1
  19. package/definitions/message.json +202 -0
  20. package/definitions/sharing-runtime.json +1 -0
  21. package/definitions/sharing.json +956 -0
  22. package/definitions/template-variables.json +12 -4
  23. package/definitions/user.json +52 -0
  24. package/definitions/workflow-definition.json +15 -1
  25. package/definitions/workflow-runtime.json +1 -1
  26. package/definitions/workflow.json +102 -0
  27. package/dist/README-KX4XC2HB.js +7 -0
  28. package/dist/README-PTYV6PQI.cjs +7 -0
  29. package/dist/{_index-NWNYWBIF.js → _index-CLT2KTVS.js} +9 -6
  30. package/dist/{_index-ONGE545F.cjs → _index-O7JDGRSE.cjs} +8 -5
  31. package/dist/apis/access-token.cjs +6 -6
  32. package/dist/apis/access-token.js +1 -1
  33. package/dist/apis/address-suggestions.cjs +6 -6
  34. package/dist/apis/address-suggestions.js +1 -1
  35. package/dist/apis/address.cjs +6 -6
  36. package/dist/apis/address.js +1 -1
  37. package/dist/apis/ai-agents.cjs +6 -6
  38. package/dist/apis/ai-agents.js +1 -1
  39. package/dist/apis/app.cjs +6 -6
  40. package/dist/apis/app.js +1 -1
  41. package/dist/apis/audit-logs.cjs +6 -6
  42. package/dist/apis/audit-logs.js +1 -1
  43. package/dist/apis/automation.cjs +8 -8
  44. package/dist/apis/automation.d.cts +2 -2
  45. package/dist/apis/automation.d.ts +2 -2
  46. package/dist/apis/automation.js +2 -2
  47. package/dist/apis/billing.cjs +6 -6
  48. package/dist/apis/billing.js +1 -1
  49. package/dist/apis/blueprint-manifest.cjs +8 -8
  50. package/dist/apis/blueprint-manifest.d.cts +2 -2
  51. package/dist/apis/blueprint-manifest.d.ts +2 -2
  52. package/dist/apis/blueprint-manifest.js +2 -2
  53. package/dist/apis/consent.cjs +6 -6
  54. package/dist/apis/consent.js +1 -1
  55. package/dist/apis/customer-portal.cjs +6 -6
  56. package/dist/apis/customer-portal.js +1 -1
  57. package/dist/apis/dashboard.cjs +6 -6
  58. package/dist/apis/dashboard.js +1 -1
  59. package/dist/apis/data-governance.cjs +38 -0
  60. package/dist/apis/{data-management.d.cts → data-governance.d.cts} +5 -5
  61. package/dist/apis/{data-management.d.ts → data-governance.d.ts} +5 -5
  62. package/dist/apis/{data-management.js → data-governance.js} +10 -10
  63. package/dist/apis/deduplication.cjs +8 -8
  64. package/dist/apis/deduplication.d.cts +2 -2
  65. package/dist/apis/deduplication.d.ts +2 -2
  66. package/dist/apis/deduplication.js +2 -2
  67. package/dist/apis/design.cjs +8 -8
  68. package/dist/apis/design.d.cts +2 -2
  69. package/dist/apis/design.d.ts +2 -2
  70. package/dist/apis/design.js +2 -2
  71. package/dist/apis/document.cjs +6 -6
  72. package/dist/apis/document.js +1 -1
  73. package/dist/apis/email-settings.cjs +8 -8
  74. package/dist/apis/email-settings.d.cts +2 -2
  75. package/dist/apis/email-settings.d.ts +2 -2
  76. package/dist/apis/email-settings.js +2 -2
  77. package/dist/apis/email-template.cjs +6 -6
  78. package/dist/apis/email-template.js +1 -1
  79. package/dist/apis/entity-mapping.cjs +6 -6
  80. package/dist/apis/entity-mapping.js +1 -1
  81. package/dist/apis/entity.cjs +6 -6
  82. package/dist/apis/entity.d.cts +2 -2
  83. package/dist/apis/entity.d.ts +2 -2
  84. package/dist/apis/entity.js +1 -1
  85. package/dist/apis/environments.cjs +6 -6
  86. package/dist/apis/environments.js +1 -1
  87. package/dist/apis/erp-integration.cjs +6 -6
  88. package/dist/apis/erp-integration.d.cts +5755 -3
  89. package/dist/apis/erp-integration.d.ts +5755 -3
  90. package/dist/apis/erp-integration.js +1 -1
  91. package/dist/apis/event-catalog.cjs +6 -6
  92. package/dist/apis/event-catalog.js +1 -1
  93. package/dist/apis/file.cjs +6 -6
  94. package/dist/apis/file.js +1 -1
  95. package/dist/apis/iban.cjs +6 -6
  96. package/dist/apis/iban.js +1 -1
  97. package/dist/apis/integration-toolkit.cjs +38 -0
  98. package/dist/apis/integration-toolkit.d.cts +18 -0
  99. package/dist/apis/integration-toolkit.d.ts +18 -0
  100. package/dist/apis/integration-toolkit.js +38 -0
  101. package/dist/apis/journey.cjs +6 -6
  102. package/dist/apis/journey.d.cts +2 -2
  103. package/dist/apis/journey.d.ts +2 -2
  104. package/dist/apis/journey.js +1 -1
  105. package/dist/apis/kanban.cjs +6 -6
  106. package/dist/apis/kanban.js +1 -1
  107. package/dist/apis/message.cjs +8 -8
  108. package/dist/apis/message.d.cts +2 -2
  109. package/dist/apis/message.d.ts +2 -2
  110. package/dist/apis/message.js +2 -2
  111. package/dist/apis/metering.cjs +6 -6
  112. package/dist/apis/metering.js +1 -1
  113. package/dist/apis/notes.cjs +6 -6
  114. package/dist/apis/notes.js +1 -1
  115. package/dist/apis/notification.cjs +6 -6
  116. package/dist/apis/notification.js +1 -1
  117. package/dist/apis/organization.cjs +6 -6
  118. package/dist/apis/organization.js +1 -1
  119. package/dist/apis/partner-directory.cjs +6 -6
  120. package/dist/apis/partner-directory.js +1 -1
  121. package/dist/apis/permissions.cjs +6 -6
  122. package/dist/apis/permissions.js +1 -1
  123. package/dist/apis/pricing-tier.cjs +6 -6
  124. package/dist/apis/pricing-tier.js +1 -1
  125. package/dist/apis/pricing.cjs +6 -6
  126. package/dist/apis/pricing.js +1 -1
  127. package/dist/apis/purpose.cjs +6 -6
  128. package/dist/apis/purpose.js +1 -1
  129. package/dist/apis/sandbox.cjs +6 -6
  130. package/dist/apis/sandbox.js +1 -1
  131. package/dist/apis/sharing.cjs +38 -0
  132. package/dist/apis/sharing.d.cts +18 -0
  133. package/dist/apis/sharing.d.ts +18 -0
  134. package/dist/apis/sharing.js +38 -0
  135. package/dist/apis/submission.cjs +6 -6
  136. package/dist/apis/submission.js +1 -1
  137. package/dist/apis/targeting.cjs +6 -6
  138. package/dist/apis/targeting.js +1 -1
  139. package/dist/apis/template-variables.cjs +6 -6
  140. package/dist/apis/template-variables.d.cts +2 -2
  141. package/dist/apis/template-variables.d.ts +2 -2
  142. package/dist/apis/template-variables.js +1 -1
  143. package/dist/apis/user.cjs +6 -6
  144. package/dist/apis/user.d.cts +2 -2
  145. package/dist/apis/user.d.ts +2 -2
  146. package/dist/apis/user.js +1 -1
  147. package/dist/apis/validation-rules.cjs +6 -6
  148. package/dist/apis/validation-rules.js +1 -1
  149. package/dist/apis/webhooks.cjs +6 -6
  150. package/dist/apis/webhooks.js +1 -1
  151. package/dist/apis/workflow-definition.cjs +6 -6
  152. package/dist/apis/workflow-definition.d.cts +2 -2
  153. package/dist/apis/workflow-definition.d.ts +2 -2
  154. package/dist/apis/workflow-definition.js +1 -1
  155. package/dist/apis/workflow.cjs +8 -8
  156. package/dist/apis/workflow.d.cts +2 -2
  157. package/dist/apis/workflow.d.ts +2 -2
  158. package/dist/apis/workflow.js +2 -2
  159. package/dist/automation-GFNNLSIN.js +7 -0
  160. package/dist/automation-IOCVCTKR.cjs +7 -0
  161. package/dist/{automation-runtime-YBGGE5PL.cjs → automation-runtime-DO5QSGJJ.cjs} +2 -2
  162. package/dist/{automation-runtime-L5UKEFLA.js → automation-runtime-VP4M7Z4R.js} +1 -1
  163. package/dist/{automation.d-D7BzN7Gq.d.cts → automation.d-CzhG2m4L.d.cts} +353 -3
  164. package/dist/{automation.d-D7BzN7Gq.d.ts → automation.d-CzhG2m4L.d.ts} +353 -3
  165. package/dist/blueprint-manifest-ELK4SGN7.js +7 -0
  166. package/dist/blueprint-manifest-VBOWPK52.cjs +7 -0
  167. package/dist/{blueprint-manifest-runtime-2RTW5C52.js → blueprint-manifest-runtime-E2FN43TB.js} +1 -1
  168. package/dist/{blueprint-manifest-runtime-AF3FIDVX.cjs → blueprint-manifest-runtime-G4UK5VEX.cjs} +2 -2
  169. package/dist/{blueprint-manifest.d-DECw6HdM.d.cts → blueprint-manifest.d-BGrGU787.d.cts} +712 -22
  170. package/dist/{blueprint-manifest.d-DECw6HdM.d.ts → blueprint-manifest.d-BGrGU787.d.ts} +712 -22
  171. package/dist/chunk-5APJZUIH.cjs +14 -0
  172. package/dist/chunk-5ED7FB3Q.js +14 -0
  173. package/dist/{chunk-UNCVJH6J.cjs → chunk-77JS7NDM.cjs} +1 -1
  174. package/dist/{chunk-6UAS2VVG.js → chunk-DLYPVF4U.js} +1 -1
  175. package/dist/chunk-DVM27A7E.cjs +14 -0
  176. package/dist/{chunk-3NLMZLCD.js → chunk-EFWPEVXI.js} +1 -1
  177. package/dist/chunk-EIIIKDOJ.cjs +14 -0
  178. package/dist/{chunk-HAZ3WP7V.cjs → chunk-IAHSYVYB.cjs} +1 -1
  179. package/dist/chunk-JTFWOEZF.cjs +14 -0
  180. package/dist/{chunk-A67W5WAP.cjs → chunk-KEI3GHDY.cjs} +1 -1
  181. package/dist/chunk-KIWRGUKM.js +14 -0
  182. package/dist/{chunk-PSQMDY3B.js → chunk-KQKBSWGI.js} +1 -1
  183. package/dist/chunk-NPDSA7T2.js +14 -0
  184. package/dist/{chunk-ZI33AJQ5.cjs → chunk-QNZPOA54.cjs} +1 -1
  185. package/dist/{chunk-BN6EJPDC.js → chunk-QSEIJWJW.js} +31 -26
  186. package/dist/{chunk-VUVWHQMP.cjs → chunk-TKTSGA7G.cjs} +31 -26
  187. package/dist/chunk-TZQFJ5GX.cjs +14 -0
  188. package/dist/chunk-U4PUHKZC.js +14 -0
  189. package/dist/chunk-VPDA5SAH.js +14 -0
  190. package/dist/chunk-WT26LFC2.js +14 -0
  191. package/dist/{chunk-3YSEO476.js → chunk-X2SC4GW5.js} +1 -1
  192. package/dist/chunk-ZL6KDJFT.cjs +14 -0
  193. package/dist/data-governance-2U5UU4GM.cjs +7 -0
  194. package/dist/data-governance-36Y33JVG.js +7 -0
  195. package/dist/{data-management-W5JQGGGH.js → data-governance-PLS5TJ7Z.js} +3 -3
  196. package/dist/{data-management-XFSRLFYA.cjs → data-governance-ZJ2K4ZWX.cjs} +3 -3
  197. package/dist/data-governance-runtime-LITKCNSG.js +5 -0
  198. package/dist/{data-management-runtime-J5IS7T47.cjs → data-governance-runtime-TDGFG67G.cjs} +2 -2
  199. package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
  200. package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
  201. package/dist/deduplication-G2ZY4NMX.js +7 -0
  202. package/dist/deduplication-PKKTZAEA.cjs +7 -0
  203. package/dist/{deduplication-runtime-BBHG7MJW.cjs → deduplication-runtime-5QS6I4S7.cjs} +2 -2
  204. package/dist/{deduplication-runtime-DLGBF4RN.js → deduplication-runtime-VL4R2VIG.js} +1 -1
  205. package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
  206. package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
  207. package/dist/design-NISDHPFD.cjs +7 -0
  208. package/dist/design-WL4AZIGX.js +7 -0
  209. package/dist/design-runtime-OXEXKZVG.cjs +5 -0
  210. package/dist/{design-runtime-3SKJA7QH.js → design-runtime-QMJM4FAF.js} +1 -1
  211. package/dist/{design.d-eA-irKEX.d.ts → design.d-DTo29S0F.d.cts} +142 -15
  212. package/dist/{design.d-eA-irKEX.d.cts → design.d-DTo29S0F.d.ts} +142 -15
  213. package/dist/email-settings-CKFJU4WZ.js +7 -0
  214. package/dist/email-settings-NQJJKS2P.cjs +7 -0
  215. package/dist/{email-settings-runtime-Q2HVKJDS.js → email-settings-runtime-EGIJ2AVQ.js} +1 -1
  216. package/dist/{email-settings-runtime-3NJIAWWI.cjs → email-settings-runtime-WGVLI7N6.cjs} +2 -2
  217. package/dist/{email-settings.d-DUvmLZMN.d.ts → email-settings.d-B7Q_xT25.d.cts} +29 -2
  218. package/dist/{email-settings.d-DUvmLZMN.d.cts → email-settings.d-B7Q_xT25.d.ts} +29 -2
  219. package/dist/entity-CK76MXVN.js +7 -0
  220. package/dist/entity-TFMH5VTZ.cjs +7 -0
  221. package/dist/{entity.d-__Tx1Y0J.d.cts → entity.d-ByufVI16.d.cts} +40 -1
  222. package/dist/{entity.d-__Tx1Y0J.d.ts → entity.d-ByufVI16.d.ts} +40 -1
  223. package/dist/erp-integration-PAVHSUDM.cjs +7 -0
  224. package/dist/erp-integration-SBQJ6HEG.js +7 -0
  225. package/dist/index.cjs +67 -40
  226. package/dist/index.d.cts +36 -34
  227. package/dist/index.d.ts +36 -34
  228. package/dist/index.js +54 -27
  229. package/dist/integration-toolkit-FRPFOYT2.js +7 -0
  230. package/dist/integration-toolkit-VNMDI55O.cjs +7 -0
  231. package/dist/integration-toolkit-runtime-5KG3LGXF.cjs +5 -0
  232. package/dist/integration-toolkit-runtime-LYHFVIRW.js +5 -0
  233. package/dist/{erp-integration.d-B4XPU_j-.d.cts → integration-toolkit.d-Ry-KC9ow.d.cts} +69 -3
  234. package/dist/{erp-integration.d-B4XPU_j-.d.ts → integration-toolkit.d-Ry-KC9ow.d.ts} +69 -3
  235. package/dist/journey-KDR5EU3W.js +7 -0
  236. package/dist/journey-REBN4TGQ.cjs +7 -0
  237. package/dist/{journey.d-BguKXj73.d.cts → journey.d-ClXO0xK8.d.cts} +8 -0
  238. package/dist/{journey.d-BguKXj73.d.ts → journey.d-ClXO0xK8.d.ts} +8 -0
  239. package/dist/message-HCA2KSH6.js +7 -0
  240. package/dist/message-J2SFQJNB.cjs +7 -0
  241. package/dist/{message-runtime-ITR7MPKT.cjs → message-runtime-CGFCT6FU.cjs} +2 -2
  242. package/dist/{message-runtime-YMKW2N3R.js → message-runtime-XDCFFLYK.js} +1 -1
  243. package/dist/{message.d-YEv1kmQd.d.cts → message.d-D3QUkBjg.d.cts} +230 -4
  244. package/dist/{message.d-YEv1kmQd.d.ts → message.d-D3QUkBjg.d.ts} +230 -4
  245. package/dist/sharing-KEWK5LNG.js +976 -0
  246. package/dist/sharing-MNDABPL7.js +7 -0
  247. package/dist/sharing-MR7ANOST.cjs +7 -0
  248. package/dist/sharing-WG4L7LH2.cjs +976 -0
  249. package/dist/sharing-runtime-OZGIZWL3.js +5 -0
  250. package/dist/sharing-runtime-VOFLBIFW.cjs +5 -0
  251. package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
  252. package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
  253. package/dist/{template-variables-VKDJJZUT.js → template-variables-6CLOG67C.js} +13 -0
  254. package/dist/{template-variables-OAYS2E3G.cjs → template-variables-I72B5WS6.cjs} +13 -0
  255. package/dist/{template-variables.d-Ch3H3zYf.d.cts → template-variables.d-Ble9TSBa.d.cts} +8 -2
  256. package/dist/{template-variables.d-Ch3H3zYf.d.ts → template-variables.d-Ble9TSBa.d.ts} +8 -2
  257. package/dist/user-7ZN2XO7G.cjs +7 -0
  258. package/dist/user-ZK7BK6VY.js +7 -0
  259. package/dist/{user.d-CXqM751M.d.cts → user.d-D18fe97W.d.cts} +75 -3
  260. package/dist/{user.d-CXqM751M.d.ts → user.d-D18fe97W.d.ts} +75 -3
  261. package/dist/workflow-CQOBZ25C.cjs +7 -0
  262. package/dist/workflow-G7VFCXY7.js +7 -0
  263. package/dist/workflow-definition-CVBYKAUY.cjs +7 -0
  264. package/dist/workflow-definition-GNAKDNG7.js +7 -0
  265. package/dist/{workflow-definition.d-CtmE-ymB.d.cts → workflow-definition.d-ByCJK9_x.d.cts} +16 -0
  266. package/dist/{workflow-definition.d-CtmE-ymB.d.ts → workflow-definition.d-ByCJK9_x.d.ts} +16 -0
  267. package/dist/{workflow-runtime-RLZO2OQB.js → workflow-runtime-DNTQDYPQ.js} +1 -1
  268. package/dist/{workflow-runtime-WCJ7NRTH.cjs → workflow-runtime-VKFESVFX.cjs} +2 -2
  269. package/dist/{workflow.d-DvhTpEtU.d.cts → workflow.d-pD8ISOg-.d.cts} +73 -1
  270. package/dist/{workflow.d-DvhTpEtU.d.ts → workflow.d-pD8ISOg-.d.ts} +73 -1
  271. package/docs/automation.md +141 -15
  272. package/docs/blueprint-manifest.md +854 -55
  273. package/docs/{data-management.md → data-governance.md} +113 -28
  274. package/docs/deduplication.md +122 -0
  275. package/docs/design.md +140 -82
  276. package/docs/email-settings.md +22 -0
  277. package/docs/entity.md +17 -0
  278. package/docs/erp-integration.md +21 -6
  279. package/docs/integration-toolkit.md +6048 -0
  280. package/docs/journey.md +6 -0
  281. package/docs/message.md +110 -1
  282. package/docs/sharing.md +1181 -0
  283. package/docs/template-variables.md +13 -0
  284. package/docs/user.md +62 -8
  285. package/docs/workflow-definition.md +28 -14
  286. package/docs/workflow.md +231 -30
  287. package/package.json +29 -17
  288. package/definitions/data-management-runtime.json +0 -1
  289. package/definitions/data-management.json +0 -978
  290. package/dist/README-6OOYWQYJ.cjs +0 -7
  291. package/dist/README-JUWX7KNV.js +0 -7
  292. package/dist/apis/data-management.cjs +0 -38
  293. package/dist/automation-3HGCK725.cjs +0 -7
  294. package/dist/automation-72VGEJCY.js +0 -7
  295. package/dist/blueprint-manifest-CXSCRQ5X.js +0 -7
  296. package/dist/blueprint-manifest-SHNZPK5O.cjs +0 -7
  297. package/dist/chunk-4BCQGZJB.cjs +0 -14
  298. package/dist/chunk-4G6LO3JY.cjs +0 -14
  299. package/dist/chunk-6GC363VV.js +0 -14
  300. package/dist/chunk-75ZWZM3L.js +0 -14
  301. package/dist/chunk-D32L2HMX.cjs +0 -14
  302. package/dist/chunk-O4JDWMYD.js +0 -14
  303. package/dist/chunk-RXMOHUBP.cjs +0 -14
  304. package/dist/chunk-ZKQ573B7.js +0 -14
  305. package/dist/data-management-3N3A3XBM.js +0 -7
  306. package/dist/data-management-YXFLQWLV.cjs +0 -7
  307. package/dist/data-management-runtime-DN7FGK7G.js +0 -5
  308. package/dist/data-management.d-BXS5jbJY.d.cts +0 -547
  309. package/dist/data-management.d-BXS5jbJY.d.ts +0 -547
  310. package/dist/deduplication-ECVAZVVA.cjs +0 -7
  311. package/dist/deduplication-GYIST22B.js +0 -7
  312. package/dist/deduplication.d-w_2aJD5f.d.cts +0 -113
  313. package/dist/deduplication.d-w_2aJD5f.d.ts +0 -113
  314. package/dist/design-KUVXMFFK.cjs +0 -7
  315. package/dist/design-YKBXRW5C.js +0 -7
  316. package/dist/design-runtime-Y3VGTQLP.cjs +0 -5
  317. package/dist/email-settings-EJ3DCPPN.js +0 -7
  318. package/dist/email-settings-TALOPLBC.cjs +0 -7
  319. package/dist/entity-M5F22DSS.cjs +0 -7
  320. package/dist/entity-RT4YRZDG.js +0 -7
  321. package/dist/erp-integration-76K5HOGL.js +0 -7
  322. package/dist/erp-integration-A33WOGPF.cjs +0 -7
  323. package/dist/journey-HKN7QXCZ.cjs +0 -7
  324. package/dist/journey-UBZCOJNW.js +0 -7
  325. package/dist/message-3XZLJR6R.cjs +0 -7
  326. package/dist/message-ZNMCS5YH.js +0 -7
  327. package/dist/user-EIEOI3OG.js +0 -7
  328. package/dist/user-NJJ7XVKB.cjs +0 -7
  329. package/dist/workflow-3LLURW3H.js +0 -7
  330. package/dist/workflow-RAGQDYXT.cjs +0 -7
  331. package/dist/workflow-definition-MBOMPMCG.js +0 -7
  332. package/dist/workflow-definition-SPAHD3HS.cjs +0 -7
@@ -1,7 +0,0 @@
1
- "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
-
3
- // src/docs/data-management.json
4
- var data_management_default = '# Data Management API\n\n- **Full API Docs:** [https://docs.epilot.io/api/data-management](https://docs.epilot.io/api/data-management)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataManagement.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-management\'\n\nconst dataManagementClient = getClient()\nauthorize(dataManagementClient, () => \'<token>\')\nconst { data } = await dataManagementClient.queryEntities(...)\n```\n\n## Operations\n\n**Data Management**\n- [`queryEntities`](#queryentities)\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`getConfig`](#getconfig)\n- [`createJobForConfig`](#createjobforconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\n- [`listJobs`](#listjobs)\n\n**Schemas**\n- [`ConfigType`](#configtype)\n- [`JobStatus`](#jobstatus)\n- [`JobTrigger`](#jobtrigger)\n- [`JobReportFormat`](#jobreportformat)\n- [`JobReport`](#jobreport)\n- [`CreateJobRequest`](#createjobrequest)\n- [`JobDetails`](#jobdetails)\n- [`UpdateJobRequest`](#updatejobrequest)\n- [`Job`](#job)\n- [`ListJobsResponse`](#listjobsresponse)\n- [`JobReportUrlResponse`](#jobreporturlresponse)\n- [`QueryFilterType`](#queryfiltertype)\n- [`QueryFilter`](#queryfilter)\n- [`QueryConfig`](#queryconfig)\n- [`QueryEntitiesRequest`](#queryentitiesrequest)\n- [`QueryEntitiesResult`](#queryentitiesresult)\n- [`ConfigSchedule`](#configschedule)\n- [`IntervalConfigSchedule`](#intervalconfigschedule)\n- [`UpsertConfigRequest`](#upsertconfigrequest)\n- [`Config`](#config)\n- [`DeletionRelationEntitySchema`](#deletionrelationentityschema)\n- [`ListConfigsResponse`](#listconfigsresponse)\n\n### `queryEntities`\n\nQuery entities using a saved view with additional data filters\n\n`POST /data-management/v1/{entity_schema}/query`\n\n```ts\nconst { data } = await client.queryEntities(\n {\n entity_schema: \'example\',\n },\n {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\'],\n workflow_status: [\'CLOSED\']\n }\n ],\n from: 0,\n size: 0,\n hydrate: true,\n fields: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `createJob`\n\nCreate a new job run\n\n`POST /data-management/v1/{entity_schema}/jobs`\n\n```ts\nconst { data } = await client.createJob(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n config_id: \'string\',\n scheduled_for: \'1970-01-01\',\n status: \'in_progress\',\n started_at: \'1970-01-01T00:00:00.000Z\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateJob`\n\nUpdate an existing job run\n\n`PATCH /data-management/v1/{entity_schema}/jobs/{job_id}`\n\n```ts\nconst { data } = await client.updateJob(\n {\n entity_schema: \'example\',\n job_id: \'example\',\n },\n {\n status: \'in_progress\',\n details: {},\n completed_at: \'1970-01-01T00:00:00.000Z\',\n error: \'string\',\n report: {\n bucket: \'string\',\n key: \'string\',\n format: \'csv\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJob`\n\nGet a job by id\n\n`GET /data-management/v1/jobs/{job_id}`\n\n```ts\nconst { data } = await client.getJob({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJobReportUrl`\n\nGet report download URL for a job\n\n`GET /data-management/v1/jobs/{job_id}/report-url`\n\n```ts\nconst { data } = await client.getJobReportUrl({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "url": "string",\n "expires_in": 0\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet a config by id\n\n`GET /data-management/v1/configs/{config_id}`\n\n```ts\nconst { data } = await client.getConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createJobForConfig`\n\nTrigger a manual job run for a config\n\n`POST /data-management/v1/configs/{config_id}/jobs`\n\n```ts\nconst { data } = await client.createJobForConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `upsertConfig`\n\nUpsert config\n\n`POST /data-management/v1/{entity_schema}/configs`\n\n```ts\nconst { data } = await client.upsertConfig(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n query: {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\'],\n workflow_status: [\'CLOSED\']\n }\n ]\n },\n schedule: {\n frequency: \'interval\',\n interval_days: 1,\n start_date: \'1970-01-01\',\n end_date: \'1970-01-01\'\n },\n relations_for_deletion: [\'contact\'],\n enabled: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listConfigs`\n\nList configs\n\n`GET /data-management/v1/configs`\n\n```ts\nconst { data } = await client.listConfigs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n next_run_at: \'example\',\n enabled: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "configs": [\n {\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `listJobs`\n\nList jobs\n\n`GET /data-management/v1/jobs`\n\n```ts\nconst { data } = await client.listJobs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n status: \'example\',\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "jobs": [\n {\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConfigType`\n\nType of configuration (e.g. deletion)\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\n```ts\ntype JobReport = {\n bucket?: string\n key?: string\n format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\n```ts\ntype CreateJobRequest = {\n type: "deletion"\n config_id: string\n scheduled_for: string // date\n status?: "in_progress" | "success" | "failed"\n started_at?: string // date-time\n}\n```\n\n### `JobDetails`\n\nGeneric, type-specific job details payload (e.g. matched count, deleted count, failed count, etc.).\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\n```ts\ntype UpdateJobRequest = {\n status?: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n}\n```\n\n### `Job`\n\n```ts\ntype Job = {\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n}\n```\n\n### `ListJobsResponse`\n\n```ts\ntype ListJobsResponse = {\n jobs?: Array<{\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: { ... }\n key?: { ... }\n format?: { ... }\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n }>\n cursor?: string\n}\n```\n\n### `JobReportUrlResponse`\n\n```ts\ntype JobReportUrlResponse = {\n url?: string\n expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\n```ts\ntype QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n```\n\n### `QueryFilter`\n\n```ts\ntype QueryFilter = {\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n}\n```\n\n### `QueryConfig`\n\n```ts\ntype QueryConfig = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n }>\n}\n```\n\n### `QueryEntitiesRequest`\n\n```ts\ntype QueryEntitiesRequest = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n }>\n from?: number\n size?: number\n hydrate?: boolean\n fields?: string[]\n}\n```\n\n### `QueryEntitiesResult`\n\n```ts\ntype QueryEntitiesResult = {\n hits?: number\n results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\n```ts\ntype ConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `IntervalConfigSchedule`\n\n```ts\ntype IntervalConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `UpsertConfigRequest`\n\n```ts\ntype UpsertConfigRequest = {\n type: "deletion"\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n workflow_status?: { ... }\n }>\n }\n schedule: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n enabled?: boolean\n}\n```\n\n### `Config`\n\n```ts\ntype Config = {\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n workflow_status?: { ... }\n }>\n }\n schedule?: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n}\n```\n\n### `DeletionRelationEntitySchema`\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\n```ts\ntype ListConfigsResponse = {\n configs?: Array<{\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: { ... }\n include_deleted?: { ... }\n filters?: { ... }\n }\n schedule?: {\n frequency: { ... }\n interval_days: { ... }\n start_date?: { ... }\n end_date?: { ... }\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n }>\n cursor?: string\n}\n```\n';
5
-
6
-
7
- exports.default = data_management_default;
@@ -1,5 +0,0 @@
1
- import {
2
- require_data_management_runtime
3
- } from "./chunk-6GC363VV.js";
4
- import "./chunk-YPSWSI3M.js";
5
- export default require_data_management_runtime();
@@ -1,547 +0,0 @@
1
- import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from data-management-client */
4
-
5
-
6
- declare namespace Components {
7
- namespace Schemas {
8
- export interface Config {
9
- id: string;
10
- /**
11
- * Type of configuration. Currently only 'deletion' is supported.
12
- */
13
- type: /* Type of configuration (e.g. deletion) */ ConfigType;
14
- entity_schema: string;
15
- query: QueryConfig;
16
- schedule?: ConfigSchedule;
17
- enabled?: boolean;
18
- created_at?: string; // date-time
19
- last_updated_at?: string; // date-time
20
- next_run_at?: string; // date
21
- relations_for_deletion?: DeletionRelationEntitySchema[];
22
- last_run_at?: string; // date-time
23
- }
24
- export type ConfigSchedule = IntervalConfigSchedule;
25
- /**
26
- * Type of configuration (e.g. deletion)
27
- */
28
- export type ConfigType = "deletion";
29
- export interface CreateJobRequest {
30
- type: /* Type of configuration (e.g. deletion) */ ConfigType;
31
- config_id: string;
32
- scheduled_for: string; // date
33
- status?: JobStatus;
34
- started_at?: string; // date-time
35
- }
36
- export type DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract";
37
- export interface IntervalConfigSchedule {
38
- frequency: "interval";
39
- /**
40
- * Interval in days between executions
41
- */
42
- interval_days: number;
43
- start_date?: string; // date
44
- end_date?: string; // date
45
- }
46
- export interface Job {
47
- id: string;
48
- type: /* Type of configuration (e.g. deletion) */ ConfigType;
49
- config_id: string;
50
- entity_schema: string;
51
- scheduled_for: string; // date
52
- status: JobStatus;
53
- details?: /* Generic, type-specific job details payload (e.g. matched count, deleted count, failed count, etc.). */ JobDetails;
54
- started_at?: string; // date-time
55
- completed_at?: string; // date-time
56
- error?: string;
57
- report?: JobReport;
58
- created_at: string; // date-time
59
- last_updated_at: string; // date-time
60
- trigger?: JobTrigger;
61
- triggered_by?: string | null;
62
- }
63
- /**
64
- * Generic, type-specific job details payload (e.g. matched count, deleted count, failed count, etc.).
65
- */
66
- export interface JobDetails {
67
- [name: string]: any;
68
- }
69
- export interface JobReport {
70
- bucket?: string;
71
- key?: string;
72
- format?: JobReportFormat;
73
- }
74
- export type JobReportFormat = "csv";
75
- export interface JobReportUrlResponse {
76
- url?: string;
77
- expires_in?: number;
78
- }
79
- export type JobStatus = "in_progress" | "success" | "failed";
80
- export type JobTrigger = "schedule" | "manual";
81
- export interface ListConfigsResponse {
82
- configs?: Config[];
83
- cursor?: string | null;
84
- }
85
- export interface ListJobsResponse {
86
- jobs?: Job[];
87
- cursor?: string | null;
88
- }
89
- export interface QueryConfig {
90
- saved_view_id: string;
91
- include_deleted?: "true" | "false" | "only";
92
- filters?: QueryFilter[];
93
- }
94
- export interface QueryEntitiesRequest {
95
- saved_view_id: string;
96
- include_deleted?: "true" | "false" | "only";
97
- filters?: QueryFilter[];
98
- from?: number;
99
- size?: number;
100
- hydrate?: boolean;
101
- fields?: string[];
102
- }
103
- export interface QueryEntitiesResult {
104
- hits?: number;
105
- results?: {
106
- [name: string]: any;
107
- }[];
108
- }
109
- export interface QueryFilter {
110
- type: QueryFilterType;
111
- related_entity_schemas?: string[];
112
- lookback_period_days?: number;
113
- message_type?: ("SENT" | "RECEIVED")[];
114
- workflow_status?: ("CLOSED" | "DONE")[];
115
- }
116
- export type QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since";
117
- export interface UpdateJobRequest {
118
- status?: JobStatus;
119
- details?: /* Generic, type-specific job details payload (e.g. matched count, deleted count, failed count, etc.). */ JobDetails;
120
- completed_at?: string; // date-time
121
- error?: string;
122
- report?: JobReport;
123
- }
124
- export interface UpsertConfigRequest {
125
- type: /* Type of configuration (e.g. deletion) */ ConfigType;
126
- query: QueryConfig;
127
- schedule: ConfigSchedule;
128
- relations_for_deletion?: DeletionRelationEntitySchema[];
129
- /**
130
- * Whether this configuration is active
131
- */
132
- enabled?: boolean;
133
- }
134
- }
135
- }
136
- declare namespace Paths {
137
- namespace CreateJob {
138
- namespace Parameters {
139
- export type EntitySchema = string;
140
- }
141
- export interface PathParameters {
142
- entity_schema: Parameters.EntitySchema;
143
- }
144
- export type RequestBody = Components.Schemas.CreateJobRequest;
145
- namespace Responses {
146
- export type $201 = Components.Schemas.Job;
147
- }
148
- }
149
- namespace CreateJobForConfig {
150
- namespace Parameters {
151
- export type ConfigId = string;
152
- }
153
- export interface PathParameters {
154
- config_id: Parameters.ConfigId;
155
- }
156
- namespace Responses {
157
- export type $201 = Components.Schemas.Job;
158
- export interface $404 {
159
- }
160
- }
161
- }
162
- namespace GetConfig {
163
- namespace Parameters {
164
- export type ConfigId = string;
165
- }
166
- export interface PathParameters {
167
- config_id: Parameters.ConfigId;
168
- }
169
- namespace Responses {
170
- export type $200 = Components.Schemas.Config;
171
- export interface $404 {
172
- }
173
- }
174
- }
175
- namespace GetJob {
176
- namespace Parameters {
177
- export type JobId = string;
178
- }
179
- export interface PathParameters {
180
- job_id: Parameters.JobId;
181
- }
182
- namespace Responses {
183
- export type $200 = Components.Schemas.Job;
184
- export interface $404 {
185
- }
186
- }
187
- }
188
- namespace GetJobReportUrl {
189
- namespace Parameters {
190
- export type JobId = string;
191
- }
192
- export interface PathParameters {
193
- job_id: Parameters.JobId;
194
- }
195
- namespace Responses {
196
- export type $200 = Components.Schemas.JobReportUrlResponse;
197
- export interface $404 {
198
- }
199
- }
200
- }
201
- namespace ListConfigs {
202
- namespace Parameters {
203
- export type Cursor = string;
204
- export type Enabled = boolean;
205
- export type EntitySchema = string;
206
- export type Limit = number;
207
- export type NextRunAt = string; // date
208
- export type Type = /* Type of configuration (e.g. deletion) */ Components.Schemas.ConfigType;
209
- }
210
- export interface QueryParameters {
211
- limit?: Parameters.Limit;
212
- cursor?: Parameters.Cursor;
213
- entity_schema?: Parameters.EntitySchema;
214
- type?: Parameters.Type;
215
- next_run_at?: Parameters.NextRunAt /* date */;
216
- enabled?: Parameters.Enabled;
217
- }
218
- namespace Responses {
219
- export type $200 = Components.Schemas.ListConfigsResponse;
220
- }
221
- }
222
- namespace ListJobs {
223
- namespace Parameters {
224
- export type ConfigId = string;
225
- export type Cursor = string;
226
- export type EntitySchema = string;
227
- export type Limit = number;
228
- export type Status = Components.Schemas.JobStatus;
229
- export type Type = /* Type of configuration (e.g. deletion) */ Components.Schemas.ConfigType;
230
- }
231
- export interface QueryParameters {
232
- limit?: Parameters.Limit;
233
- cursor?: Parameters.Cursor;
234
- entity_schema?: Parameters.EntitySchema;
235
- type?: Parameters.Type;
236
- status?: Parameters.Status;
237
- config_id?: Parameters.ConfigId;
238
- }
239
- namespace Responses {
240
- export type $200 = Components.Schemas.ListJobsResponse;
241
- }
242
- }
243
- namespace QueryEntities {
244
- namespace Parameters {
245
- export type EntitySchema = string;
246
- }
247
- export interface PathParameters {
248
- entity_schema: Parameters.EntitySchema;
249
- }
250
- export type RequestBody = Components.Schemas.QueryEntitiesRequest;
251
- namespace Responses {
252
- export type $200 = Components.Schemas.QueryEntitiesResult;
253
- }
254
- }
255
- namespace UpdateJob {
256
- namespace Parameters {
257
- export type EntitySchema = string;
258
- export type JobId = string;
259
- }
260
- export interface PathParameters {
261
- entity_schema: Parameters.EntitySchema;
262
- job_id: Parameters.JobId;
263
- }
264
- export type RequestBody = Components.Schemas.UpdateJobRequest;
265
- namespace Responses {
266
- export type $200 = Components.Schemas.Job;
267
- export interface $404 {
268
- }
269
- }
270
- }
271
- namespace UpsertConfig {
272
- namespace Parameters {
273
- export type EntitySchema = string;
274
- }
275
- export interface PathParameters {
276
- entity_schema: Parameters.EntitySchema;
277
- }
278
- export type RequestBody = Components.Schemas.UpsertConfigRequest;
279
- namespace Responses {
280
- export type $200 = Components.Schemas.Config;
281
- export type $201 = Components.Schemas.Config;
282
- }
283
- }
284
- }
285
-
286
-
287
- interface OperationMethods {
288
- /**
289
- * queryEntities - Query entities using a saved view with additional data filters
290
- *
291
- * Executes a query against the specified entity schema using the saved view definition, optionally combined with additional filters. Returns the entities matching the composed query.
292
- *
293
- */
294
- 'queryEntities'(
295
- parameters?: Parameters<Paths.QueryEntities.PathParameters> | null,
296
- data?: Paths.QueryEntities.RequestBody,
297
- config?: AxiosRequestConfig
298
- ): OperationResponse<Paths.QueryEntities.Responses.$200>
299
- /**
300
- * createJob - Create a new job run
301
- */
302
- 'createJob'(
303
- parameters?: Parameters<Paths.CreateJob.PathParameters> | null,
304
- data?: Paths.CreateJob.RequestBody,
305
- config?: AxiosRequestConfig
306
- ): OperationResponse<Paths.CreateJob.Responses.$201>
307
- /**
308
- * updateJob - Update an existing job run
309
- */
310
- 'updateJob'(
311
- parameters?: Parameters<Paths.UpdateJob.PathParameters> | null,
312
- data?: Paths.UpdateJob.RequestBody,
313
- config?: AxiosRequestConfig
314
- ): OperationResponse<Paths.UpdateJob.Responses.$200>
315
- /**
316
- * getJob - Get a job by id
317
- *
318
- * Returns details of a single job run.
319
- *
320
- */
321
- 'getJob'(
322
- parameters?: Parameters<Paths.GetJob.PathParameters> | null,
323
- data?: any,
324
- config?: AxiosRequestConfig
325
- ): OperationResponse<Paths.GetJob.Responses.$200>
326
- /**
327
- * getJobReportUrl - Get report download URL for a job
328
- *
329
- * Returns a short-lived, pre-signed URL to download the report file for the given job.
330
- *
331
- */
332
- 'getJobReportUrl'(
333
- parameters?: Parameters<Paths.GetJobReportUrl.PathParameters> | null,
334
- data?: any,
335
- config?: AxiosRequestConfig
336
- ): OperationResponse<Paths.GetJobReportUrl.Responses.$200>
337
- /**
338
- * getConfig - Get a config by id
339
- *
340
- * Returns a data management config by its id.
341
- *
342
- */
343
- 'getConfig'(
344
- parameters?: Parameters<Paths.GetConfig.PathParameters> | null,
345
- data?: any,
346
- config?: AxiosRequestConfig
347
- ): OperationResponse<Paths.GetConfig.Responses.$200>
348
- /**
349
- * createJobForConfig - Trigger a manual job run for a config
350
- *
351
- * Creates a job run for the given config and triggers asynchronous execution. Returns a job id which can be used to poll job status.
352
- *
353
- */
354
- 'createJobForConfig'(
355
- parameters?: Parameters<Paths.CreateJobForConfig.PathParameters> | null,
356
- data?: any,
357
- config?: AxiosRequestConfig
358
- ): OperationResponse<Paths.CreateJobForConfig.Responses.$201>
359
- /**
360
- * upsertConfig - Upsert config
361
- *
362
- * Creates or updates a config for the given entity schema. The config is later used by a scheduled background process to periodically query and act on matching entities (for example, deletion).
363
- *
364
- */
365
- 'upsertConfig'(
366
- parameters?: Parameters<Paths.UpsertConfig.PathParameters> | null,
367
- data?: Paths.UpsertConfig.RequestBody,
368
- config?: AxiosRequestConfig
369
- ): OperationResponse<Paths.UpsertConfig.Responses.$200 | Paths.UpsertConfig.Responses.$201>
370
- /**
371
- * listConfigs - List configs
372
- *
373
- * Returns a paginated list of configs
374
- *
375
- */
376
- 'listConfigs'(
377
- parameters?: Parameters<Paths.ListConfigs.QueryParameters> | null,
378
- data?: any,
379
- config?: AxiosRequestConfig
380
- ): OperationResponse<Paths.ListConfigs.Responses.$200>
381
- /**
382
- * listJobs - List jobs
383
- *
384
- * Returns a paginated list of jobs
385
- *
386
- */
387
- 'listJobs'(
388
- parameters?: Parameters<Paths.ListJobs.QueryParameters> | null,
389
- data?: any,
390
- config?: AxiosRequestConfig
391
- ): OperationResponse<Paths.ListJobs.Responses.$200>
392
- }
393
-
394
- interface PathsDictionary {
395
- ['/data-management/v1/{entity_schema}/query']: {
396
- /**
397
- * queryEntities - Query entities using a saved view with additional data filters
398
- *
399
- * Executes a query against the specified entity schema using the saved view definition, optionally combined with additional filters. Returns the entities matching the composed query.
400
- *
401
- */
402
- 'post'(
403
- parameters?: Parameters<Paths.QueryEntities.PathParameters> | null,
404
- data?: Paths.QueryEntities.RequestBody,
405
- config?: AxiosRequestConfig
406
- ): OperationResponse<Paths.QueryEntities.Responses.$200>
407
- }
408
- ['/data-management/v1/{entity_schema}/jobs']: {
409
- /**
410
- * createJob - Create a new job run
411
- */
412
- 'post'(
413
- parameters?: Parameters<Paths.CreateJob.PathParameters> | null,
414
- data?: Paths.CreateJob.RequestBody,
415
- config?: AxiosRequestConfig
416
- ): OperationResponse<Paths.CreateJob.Responses.$201>
417
- }
418
- ['/data-management/v1/{entity_schema}/jobs/{job_id}']: {
419
- /**
420
- * updateJob - Update an existing job run
421
- */
422
- 'patch'(
423
- parameters?: Parameters<Paths.UpdateJob.PathParameters> | null,
424
- data?: Paths.UpdateJob.RequestBody,
425
- config?: AxiosRequestConfig
426
- ): OperationResponse<Paths.UpdateJob.Responses.$200>
427
- }
428
- ['/data-management/v1/jobs/{job_id}']: {
429
- /**
430
- * getJob - Get a job by id
431
- *
432
- * Returns details of a single job run.
433
- *
434
- */
435
- 'get'(
436
- parameters?: Parameters<Paths.GetJob.PathParameters> | null,
437
- data?: any,
438
- config?: AxiosRequestConfig
439
- ): OperationResponse<Paths.GetJob.Responses.$200>
440
- }
441
- ['/data-management/v1/jobs/{job_id}/report-url']: {
442
- /**
443
- * getJobReportUrl - Get report download URL for a job
444
- *
445
- * Returns a short-lived, pre-signed URL to download the report file for the given job.
446
- *
447
- */
448
- 'get'(
449
- parameters?: Parameters<Paths.GetJobReportUrl.PathParameters> | null,
450
- data?: any,
451
- config?: AxiosRequestConfig
452
- ): OperationResponse<Paths.GetJobReportUrl.Responses.$200>
453
- }
454
- ['/data-management/v1/configs/{config_id}']: {
455
- /**
456
- * getConfig - Get a config by id
457
- *
458
- * Returns a data management config by its id.
459
- *
460
- */
461
- 'get'(
462
- parameters?: Parameters<Paths.GetConfig.PathParameters> | null,
463
- data?: any,
464
- config?: AxiosRequestConfig
465
- ): OperationResponse<Paths.GetConfig.Responses.$200>
466
- }
467
- ['/data-management/v1/configs/{config_id}/jobs']: {
468
- /**
469
- * createJobForConfig - Trigger a manual job run for a config
470
- *
471
- * Creates a job run for the given config and triggers asynchronous execution. Returns a job id which can be used to poll job status.
472
- *
473
- */
474
- 'post'(
475
- parameters?: Parameters<Paths.CreateJobForConfig.PathParameters> | null,
476
- data?: any,
477
- config?: AxiosRequestConfig
478
- ): OperationResponse<Paths.CreateJobForConfig.Responses.$201>
479
- }
480
- ['/data-management/v1/{entity_schema}/configs']: {
481
- /**
482
- * upsertConfig - Upsert config
483
- *
484
- * Creates or updates a config for the given entity schema. The config is later used by a scheduled background process to periodically query and act on matching entities (for example, deletion).
485
- *
486
- */
487
- 'post'(
488
- parameters?: Parameters<Paths.UpsertConfig.PathParameters> | null,
489
- data?: Paths.UpsertConfig.RequestBody,
490
- config?: AxiosRequestConfig
491
- ): OperationResponse<Paths.UpsertConfig.Responses.$200 | Paths.UpsertConfig.Responses.$201>
492
- }
493
- ['/data-management/v1/configs']: {
494
- /**
495
- * listConfigs - List configs
496
- *
497
- * Returns a paginated list of configs
498
- *
499
- */
500
- 'get'(
501
- parameters?: Parameters<Paths.ListConfigs.QueryParameters> | null,
502
- data?: any,
503
- config?: AxiosRequestConfig
504
- ): OperationResponse<Paths.ListConfigs.Responses.$200>
505
- }
506
- ['/data-management/v1/jobs']: {
507
- /**
508
- * listJobs - List jobs
509
- *
510
- * Returns a paginated list of jobs
511
- *
512
- */
513
- 'get'(
514
- parameters?: Parameters<Paths.ListJobs.QueryParameters> | null,
515
- data?: any,
516
- config?: AxiosRequestConfig
517
- ): OperationResponse<Paths.ListJobs.Responses.$200>
518
- }
519
- }
520
-
521
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
522
-
523
-
524
- type Config = Components.Schemas.Config;
525
- type ConfigSchedule = Components.Schemas.ConfigSchedule;
526
- type ConfigType = Components.Schemas.ConfigType;
527
- type CreateJobRequest = Components.Schemas.CreateJobRequest;
528
- type DeletionRelationEntitySchema = Components.Schemas.DeletionRelationEntitySchema;
529
- type IntervalConfigSchedule = Components.Schemas.IntervalConfigSchedule;
530
- type Job = Components.Schemas.Job;
531
- type JobDetails = Components.Schemas.JobDetails;
532
- type JobReport = Components.Schemas.JobReport;
533
- type JobReportFormat = Components.Schemas.JobReportFormat;
534
- type JobReportUrlResponse = Components.Schemas.JobReportUrlResponse;
535
- type JobStatus = Components.Schemas.JobStatus;
536
- type JobTrigger = Components.Schemas.JobTrigger;
537
- type ListConfigsResponse = Components.Schemas.ListConfigsResponse;
538
- type ListJobsResponse = Components.Schemas.ListJobsResponse;
539
- type QueryConfig = Components.Schemas.QueryConfig;
540
- type QueryEntitiesRequest = Components.Schemas.QueryEntitiesRequest;
541
- type QueryEntitiesResult = Components.Schemas.QueryEntitiesResult;
542
- type QueryFilter = Components.Schemas.QueryFilter;
543
- type QueryFilterType = Components.Schemas.QueryFilterType;
544
- type UpdateJobRequest = Components.Schemas.UpdateJobRequest;
545
- type UpsertConfigRequest = Components.Schemas.UpsertConfigRequest;
546
-
547
- export { type Client as C, type DeletionRelationEntitySchema as D, type IntervalConfigSchedule as I, type Job as J, type ListConfigsResponse as L, type OperationMethods as O, Paths as P, type QueryConfig as Q, type UpdateJobRequest as U, Components as a, type PathsDictionary as b, type Config as c, type ConfigSchedule as d, type ConfigType as e, type CreateJobRequest as f, type JobDetails as g, type JobReport as h, type JobReportFormat as i, type JobReportUrlResponse as j, type JobStatus as k, type JobTrigger as l, type ListJobsResponse as m, type QueryEntitiesRequest as n, type QueryEntitiesResult as o, type QueryFilter as p, type QueryFilterType as q, type UpsertConfigRequest as r };