@epilot/sdk 2.1.0-rc.1 → 2.1.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 (637) hide show
  1. package/README.md +24 -0
  2. package/definitions/app.json +38 -0
  3. package/definitions/automation.json +2 -37
  4. package/definitions/blueprint-manifest-runtime.json +1 -1
  5. package/definitions/blueprint-manifest.json +115 -1
  6. package/definitions/customer-portal-runtime.json +1 -1
  7. package/definitions/customer-portal.json +279 -42
  8. package/definitions/data-management.json +10 -0
  9. package/definitions/email-template.json +25 -3
  10. package/definitions/entity.json +205 -3
  11. package/definitions/environments-runtime.json +1 -1
  12. package/definitions/erp-integration-runtime.json +1 -1
  13. package/definitions/erp-integration.json +472 -13
  14. package/definitions/journey.json +257 -12
  15. package/definitions/kanban.json +630 -78
  16. package/definitions/organization-runtime.json +1 -1
  17. package/definitions/organization.json +614 -51
  18. package/definitions/workflow.json +40 -0
  19. package/dist/README-6OOYWQYJ.cjs +7 -0
  20. package/dist/README-JUWX7KNV.js +7 -0
  21. package/dist/_index-NWNYWBIF.js +146 -0
  22. package/dist/_index-ONGE545F.cjs +146 -0
  23. package/dist/access-token-2O6ULCCN.js +633 -0
  24. package/dist/access-token-6BJDZSFE.cjs +7 -0
  25. package/dist/access-token-GSQZLDXR.js +7 -0
  26. package/dist/access-token-RKP2A2F7.cjs +633 -0
  27. package/dist/access-token-runtime-KCKGT4O7.js +5 -0
  28. package/dist/access-token-runtime-NZWZJPWV.cjs +5 -0
  29. package/dist/address-HA4RMRNQ.cjs +7 -0
  30. package/dist/address-HLBX47SQ.cjs +567 -0
  31. package/dist/address-IJF4N2UV.js +567 -0
  32. package/dist/address-QVJUGMOG.js +7 -0
  33. package/dist/address-runtime-2MNO2YRD.cjs +5 -0
  34. package/dist/address-runtime-YFCNBJBW.js +5 -0
  35. package/dist/address-suggestions-74244BAJ.js +7 -0
  36. package/dist/address-suggestions-BYUTV7OU.js +574 -0
  37. package/dist/address-suggestions-ERVGGO6Z.cjs +574 -0
  38. package/dist/address-suggestions-IUQMYF27.cjs +7 -0
  39. package/dist/address-suggestions-runtime-NIMC2J32.js +5 -0
  40. package/dist/address-suggestions-runtime-ZNGLDADE.cjs +5 -0
  41. package/dist/ai-agents-6VHVYRCC.cjs +1612 -0
  42. package/dist/ai-agents-IZWFEUSH.js +7 -0
  43. package/dist/ai-agents-PKCHKKJS.js +1612 -0
  44. package/dist/ai-agents-PWHKNRCX.cjs +7 -0
  45. package/dist/ai-agents-runtime-25YRUJHI.js +5 -0
  46. package/dist/ai-agents-runtime-TILIO3UM.cjs +5 -0
  47. package/dist/apis/access-token.cjs +10 -8
  48. package/dist/apis/access-token.d.cts +2 -2
  49. package/dist/apis/access-token.d.ts +2 -2
  50. package/dist/apis/access-token.js +6 -4
  51. package/dist/apis/address-suggestions.cjs +10 -8
  52. package/dist/apis/address-suggestions.d.cts +2 -2
  53. package/dist/apis/address-suggestions.d.ts +2 -2
  54. package/dist/apis/address-suggestions.js +6 -4
  55. package/dist/apis/address.cjs +10 -8
  56. package/dist/apis/address.d.cts +2 -2
  57. package/dist/apis/address.d.ts +2 -2
  58. package/dist/apis/address.js +6 -4
  59. package/dist/apis/ai-agents.cjs +10 -8
  60. package/dist/apis/ai-agents.d.cts +2 -2
  61. package/dist/apis/ai-agents.d.ts +2 -2
  62. package/dist/apis/ai-agents.js +6 -4
  63. package/dist/apis/app.cjs +10 -8
  64. package/dist/apis/app.d.cts +2 -2
  65. package/dist/apis/app.d.ts +2 -2
  66. package/dist/apis/app.js +6 -4
  67. package/dist/apis/audit-logs.cjs +10 -8
  68. package/dist/apis/audit-logs.d.cts +2 -2
  69. package/dist/apis/audit-logs.d.ts +2 -2
  70. package/dist/apis/audit-logs.js +6 -4
  71. package/dist/apis/automation.cjs +10 -8
  72. package/dist/apis/automation.d.cts +2 -2
  73. package/dist/apis/automation.d.ts +2 -2
  74. package/dist/apis/automation.js +6 -4
  75. package/dist/apis/billing.cjs +10 -8
  76. package/dist/apis/billing.d.cts +2 -2
  77. package/dist/apis/billing.d.ts +2 -2
  78. package/dist/apis/billing.js +6 -4
  79. package/dist/apis/blueprint-manifest.cjs +10 -8
  80. package/dist/apis/blueprint-manifest.d.cts +2 -2
  81. package/dist/apis/blueprint-manifest.d.ts +2 -2
  82. package/dist/apis/blueprint-manifest.js +6 -4
  83. package/dist/apis/consent.cjs +10 -8
  84. package/dist/apis/consent.d.cts +2 -2
  85. package/dist/apis/consent.d.ts +2 -2
  86. package/dist/apis/consent.js +6 -4
  87. package/dist/apis/customer-portal.cjs +10 -8
  88. package/dist/apis/customer-portal.d.cts +2 -2
  89. package/dist/apis/customer-portal.d.ts +2 -2
  90. package/dist/apis/customer-portal.js +6 -4
  91. package/dist/apis/dashboard.cjs +10 -8
  92. package/dist/apis/dashboard.d.cts +2 -2
  93. package/dist/apis/dashboard.d.ts +2 -2
  94. package/dist/apis/dashboard.js +6 -4
  95. package/dist/apis/data-management.cjs +10 -8
  96. package/dist/apis/data-management.d.cts +2 -2
  97. package/dist/apis/data-management.d.ts +2 -2
  98. package/dist/apis/data-management.js +6 -4
  99. package/dist/apis/deduplication.cjs +10 -8
  100. package/dist/apis/deduplication.d.cts +2 -2
  101. package/dist/apis/deduplication.d.ts +2 -2
  102. package/dist/apis/deduplication.js +6 -4
  103. package/dist/apis/design.cjs +10 -8
  104. package/dist/apis/design.d.cts +2 -2
  105. package/dist/apis/design.d.ts +2 -2
  106. package/dist/apis/design.js +6 -4
  107. package/dist/apis/document.cjs +10 -8
  108. package/dist/apis/document.d.cts +2 -2
  109. package/dist/apis/document.d.ts +2 -2
  110. package/dist/apis/document.js +6 -4
  111. package/dist/apis/email-settings.cjs +10 -8
  112. package/dist/apis/email-settings.d.cts +2 -2
  113. package/dist/apis/email-settings.d.ts +2 -2
  114. package/dist/apis/email-settings.js +6 -4
  115. package/dist/apis/email-template.cjs +10 -8
  116. package/dist/apis/email-template.d.cts +2 -2
  117. package/dist/apis/email-template.d.ts +2 -2
  118. package/dist/apis/email-template.js +6 -4
  119. package/dist/apis/entity-mapping.cjs +10 -8
  120. package/dist/apis/entity-mapping.d.cts +2 -2
  121. package/dist/apis/entity-mapping.d.ts +2 -2
  122. package/dist/apis/entity-mapping.js +6 -4
  123. package/dist/apis/entity.cjs +10 -8
  124. package/dist/apis/entity.d.cts +2 -2
  125. package/dist/apis/entity.d.ts +2 -2
  126. package/dist/apis/entity.js +6 -4
  127. package/dist/apis/environments.cjs +10 -8
  128. package/dist/apis/environments.d.cts +2 -2
  129. package/dist/apis/environments.d.ts +2 -2
  130. package/dist/apis/environments.js +6 -4
  131. package/dist/apis/erp-integration.cjs +10 -8
  132. package/dist/apis/erp-integration.d.cts +2 -2
  133. package/dist/apis/erp-integration.d.ts +2 -2
  134. package/dist/apis/erp-integration.js +6 -4
  135. package/dist/apis/event-catalog.cjs +10 -8
  136. package/dist/apis/event-catalog.d.cts +2 -2
  137. package/dist/apis/event-catalog.d.ts +2 -2
  138. package/dist/apis/event-catalog.js +6 -4
  139. package/dist/apis/file.cjs +10 -8
  140. package/dist/apis/file.d.cts +2 -2
  141. package/dist/apis/file.d.ts +2 -2
  142. package/dist/apis/file.js +6 -4
  143. package/dist/apis/iban.cjs +10 -8
  144. package/dist/apis/iban.d.cts +2 -2
  145. package/dist/apis/iban.d.ts +2 -2
  146. package/dist/apis/iban.js +6 -4
  147. package/dist/apis/journey.cjs +10 -8
  148. package/dist/apis/journey.d.cts +2 -2
  149. package/dist/apis/journey.d.ts +2 -2
  150. package/dist/apis/journey.js +6 -4
  151. package/dist/apis/kanban.cjs +10 -8
  152. package/dist/apis/kanban.d.cts +2 -2
  153. package/dist/apis/kanban.d.ts +2 -2
  154. package/dist/apis/kanban.js +6 -4
  155. package/dist/apis/message.cjs +10 -8
  156. package/dist/apis/message.d.cts +2 -2
  157. package/dist/apis/message.d.ts +2 -2
  158. package/dist/apis/message.js +6 -4
  159. package/dist/apis/metering.cjs +10 -8
  160. package/dist/apis/metering.d.cts +2 -2
  161. package/dist/apis/metering.d.ts +2 -2
  162. package/dist/apis/metering.js +6 -4
  163. package/dist/apis/notes.cjs +10 -8
  164. package/dist/apis/notes.d.cts +2 -2
  165. package/dist/apis/notes.d.ts +2 -2
  166. package/dist/apis/notes.js +6 -4
  167. package/dist/apis/notification.cjs +10 -8
  168. package/dist/apis/notification.d.cts +2 -2
  169. package/dist/apis/notification.d.ts +2 -2
  170. package/dist/apis/notification.js +6 -4
  171. package/dist/apis/organization.cjs +10 -8
  172. package/dist/apis/organization.d.cts +4 -4
  173. package/dist/apis/organization.d.ts +4 -4
  174. package/dist/apis/organization.js +6 -4
  175. package/dist/apis/partner-directory.cjs +10 -8
  176. package/dist/apis/partner-directory.d.cts +2 -2
  177. package/dist/apis/partner-directory.d.ts +2 -2
  178. package/dist/apis/partner-directory.js +6 -4
  179. package/dist/apis/permissions.cjs +10 -8
  180. package/dist/apis/permissions.d.cts +2 -2
  181. package/dist/apis/permissions.d.ts +2 -2
  182. package/dist/apis/permissions.js +6 -4
  183. package/dist/apis/pricing-tier.cjs +10 -8
  184. package/dist/apis/pricing-tier.d.cts +2 -2
  185. package/dist/apis/pricing-tier.d.ts +2 -2
  186. package/dist/apis/pricing-tier.js +6 -4
  187. package/dist/apis/pricing.cjs +10 -8
  188. package/dist/apis/pricing.d.cts +2 -2
  189. package/dist/apis/pricing.d.ts +2 -2
  190. package/dist/apis/pricing.js +6 -4
  191. package/dist/apis/purpose.cjs +10 -8
  192. package/dist/apis/purpose.d.cts +2 -2
  193. package/dist/apis/purpose.d.ts +2 -2
  194. package/dist/apis/purpose.js +6 -4
  195. package/dist/apis/sandbox.cjs +10 -8
  196. package/dist/apis/sandbox.d.cts +2 -2
  197. package/dist/apis/sandbox.d.ts +2 -2
  198. package/dist/apis/sandbox.js +6 -4
  199. package/dist/apis/submission.cjs +10 -8
  200. package/dist/apis/submission.d.cts +2 -2
  201. package/dist/apis/submission.d.ts +2 -2
  202. package/dist/apis/submission.js +6 -4
  203. package/dist/apis/targeting.cjs +10 -8
  204. package/dist/apis/targeting.d.cts +2 -2
  205. package/dist/apis/targeting.d.ts +2 -2
  206. package/dist/apis/targeting.js +6 -4
  207. package/dist/apis/template-variables.cjs +10 -8
  208. package/dist/apis/template-variables.d.cts +2 -2
  209. package/dist/apis/template-variables.d.ts +2 -2
  210. package/dist/apis/template-variables.js +6 -4
  211. package/dist/apis/user.cjs +10 -8
  212. package/dist/apis/user.d.cts +2 -2
  213. package/dist/apis/user.d.ts +2 -2
  214. package/dist/apis/user.js +6 -4
  215. package/dist/apis/validation-rules.cjs +10 -8
  216. package/dist/apis/validation-rules.d.cts +2 -2
  217. package/dist/apis/validation-rules.d.ts +2 -2
  218. package/dist/apis/validation-rules.js +6 -4
  219. package/dist/apis/webhooks.cjs +10 -8
  220. package/dist/apis/webhooks.d.cts +2 -2
  221. package/dist/apis/webhooks.d.ts +2 -2
  222. package/dist/apis/webhooks.js +6 -4
  223. package/dist/apis/workflow-definition.cjs +10 -8
  224. package/dist/apis/workflow-definition.d.cts +2 -2
  225. package/dist/apis/workflow-definition.d.ts +2 -2
  226. package/dist/apis/workflow-definition.js +6 -4
  227. package/dist/apis/workflow.cjs +10 -8
  228. package/dist/apis/workflow.d.cts +2 -2
  229. package/dist/apis/workflow.d.ts +2 -2
  230. package/dist/apis/workflow.js +6 -4
  231. package/dist/app-5VPBDFW2.cjs +4047 -0
  232. package/dist/app-IKHWU222.cjs +7 -0
  233. package/dist/app-VJW2KKWE.js +4047 -0
  234. package/dist/app-VLM3SWKA.js +7 -0
  235. package/dist/app-runtime-SSNHSBR7.cjs +5 -0
  236. package/dist/app-runtime-U7RGV7KT.js +5 -0
  237. package/dist/audit-logs-5VXHOQ7S.js +7 -0
  238. package/dist/audit-logs-D2LFUA2R.cjs +7 -0
  239. package/dist/audit-logs-F2NHDISQ.js +312 -0
  240. package/dist/audit-logs-RFEMBILB.cjs +312 -0
  241. package/dist/audit-logs-runtime-4WMHPWNX.cjs +5 -0
  242. package/dist/audit-logs-runtime-76R6WRAB.js +5 -0
  243. package/dist/automation-3HGCK725.cjs +7 -0
  244. package/dist/automation-72VGEJCY.js +7 -0
  245. package/dist/automation-HZASSUCS.cjs +4460 -0
  246. package/dist/automation-WEVRW77F.js +4460 -0
  247. package/dist/automation-runtime-L5UKEFLA.js +5 -0
  248. package/dist/automation-runtime-YBGGE5PL.cjs +5 -0
  249. package/dist/billing-3VZPNG6M.cjs +796 -0
  250. package/dist/billing-ASWY7HC3.js +796 -0
  251. package/dist/billing-DUWDISHP.cjs +7 -0
  252. package/dist/billing-IPALEAG2.js +7 -0
  253. package/dist/billing-runtime-C6BMGWCX.js +5 -0
  254. package/dist/billing-runtime-L4Y7MLM3.cjs +5 -0
  255. package/dist/blueprint-manifest-5TNVSDKC.cjs +3169 -0
  256. package/dist/blueprint-manifest-CXSCRQ5X.js +7 -0
  257. package/dist/blueprint-manifest-SHNZPK5O.cjs +7 -0
  258. package/dist/blueprint-manifest-UGGYWGRZ.js +3169 -0
  259. package/dist/blueprint-manifest-runtime-2RTW5C52.js +5 -0
  260. package/dist/blueprint-manifest-runtime-AF3FIDVX.cjs +5 -0
  261. package/dist/{chunk-ZPCMZO2O.js → chunk-24T6CJTG.js} +1 -1
  262. package/dist/{chunk-4JPVFLVU.js → chunk-265TE2OV.js} +1 -1
  263. package/dist/{chunk-NSOHW3R6.js → chunk-2BPBDRRO.js} +1 -1
  264. package/dist/{chunk-ZAPA4RPI.js → chunk-3XKBB5AE.js} +1 -1
  265. package/dist/{chunk-CFGXI3FX.js → chunk-3YSEO476.js} +1 -1
  266. package/dist/{chunk-WOOKHE7Y.cjs → chunk-46HU6232.cjs} +2 -2
  267. package/dist/{chunk-KU2XF4TS.cjs → chunk-4G6LO3JY.cjs} +2 -2
  268. package/dist/{chunk-GGBSLAVO.cjs → chunk-4QCVVDTA.cjs} +2 -2
  269. package/dist/{chunk-TUAAE3UC.cjs → chunk-4W22EIRF.cjs} +2 -2
  270. package/dist/{chunk-BDIJHJOG.js → chunk-4ZGZDE6D.js} +1 -1
  271. package/dist/{chunk-VD5TBK2T.cjs → chunk-4ZMLRFDX.cjs} +2 -2
  272. package/dist/{chunk-YNPRF4BX.js → chunk-5JPM6YUD.js} +1 -1
  273. package/dist/{chunk-FCLW3FLF.js → chunk-5MFHAXBT.js} +1 -1
  274. package/dist/{chunk-OBQIS3KU.js → chunk-5NKXJA43.js} +1 -1
  275. package/dist/{chunk-UXVV3BSC.cjs → chunk-5WNEYQII.cjs} +2 -2
  276. package/dist/chunk-6OYECNL2.js +14 -0
  277. package/dist/{chunk-D5FJ26GG.js → chunk-6UAS2VVG.js} +1 -1
  278. package/dist/{chunk-UE4XPL43.js → chunk-6VWCUZ5M.js} +1 -1
  279. package/dist/{chunk-HSGQSTVK.js → chunk-75EI2Q64.js} +1 -1
  280. package/dist/{chunk-6J7CIOKR.js → chunk-75ZWZM3L.js} +1 -1
  281. package/dist/{chunk-LXAJ722U.js → chunk-7IKQIVUS.js} +1 -1
  282. package/dist/{chunk-5YVVQBA2.js → chunk-A7AAVJGM.js} +1 -1
  283. package/dist/{chunk-ZDJ3J6Z6.cjs → chunk-ANN2QTMY.cjs} +2 -2
  284. package/dist/{chunk-MKZGM4A6.js → chunk-AUH6NP6Y.js} +1 -1
  285. package/dist/{chunk-BB7WFIE2.cjs → chunk-BLNXQAMX.cjs} +2 -2
  286. package/dist/{chunk-PLBIQ2Y7.cjs → chunk-BM6NCHPL.cjs} +2 -2
  287. package/dist/{chunk-5Y2KLUU6.cjs → chunk-BPHOGIQM.cjs} +2 -2
  288. package/dist/{chunk-Y4YQEDR3.js → chunk-BTTPWE2P.js} +1 -1
  289. package/dist/{chunk-Z5LLUUFD.cjs → chunk-COQMJFAB.cjs} +2 -2
  290. package/dist/{chunk-YFHQYQII.js → chunk-CSK5ZUTS.js} +1 -1
  291. package/dist/{chunk-7KFKA3AH.cjs → chunk-D32L2HMX.cjs} +2 -2
  292. package/dist/{chunk-Y4ZMNMYI.js → chunk-D7Q4JGN7.js} +1 -1
  293. package/dist/{chunk-UTQY2DSM.js → chunk-DZ3P537S.js} +1 -1
  294. package/dist/{chunk-CLMZ2EXW.js → chunk-E2WMGOM5.js} +1 -1
  295. package/dist/{chunk-R6WNZVTA.cjs → chunk-F5JVW2D5.cjs} +2 -2
  296. package/dist/{chunk-WAKSLH7V.cjs → chunk-FARDEGPH.cjs} +2 -2
  297. package/dist/{chunk-XIB2G42L.cjs → chunk-G3VDRMOH.cjs} +2 -2
  298. package/dist/{chunk-ZAXYMQ2B.cjs → chunk-G5FKTWUC.cjs} +2 -2
  299. package/dist/{chunk-URRL33D5.cjs → chunk-GWKHOJGD.cjs} +2 -2
  300. package/dist/{chunk-XLOXC52O.js → chunk-H45V55VT.js} +1 -1
  301. package/dist/{chunk-TBBLLEB2.cjs → chunk-HAZ3WP7V.cjs} +2 -2
  302. package/dist/{chunk-KEJRWMXR.cjs → chunk-HHMXS5NC.cjs} +2 -2
  303. package/dist/{chunk-YXPUCBVK.cjs → chunk-IGVVJMX7.cjs} +2 -2
  304. package/dist/{chunk-IXRDP4VP.js → chunk-IJR3GZKC.js} +1 -1
  305. package/dist/{chunk-OI2M6FSB.js → chunk-IQOCHPWU.js} +1 -1
  306. package/dist/{chunk-6ADJEPMJ.js → chunk-JENQHXFI.js} +1 -1
  307. package/dist/{chunk-E4IFBCNM.cjs → chunk-JICWF5VI.cjs} +2 -2
  308. package/dist/{chunk-Q5TESEDZ.cjs → chunk-JIUTCNTB.cjs} +2 -2
  309. package/dist/{chunk-RNKZDJOY.js → chunk-JJWJLY42.js} +1 -1
  310. package/dist/{chunk-CX3KG7D2.cjs → chunk-JXJC6WEW.cjs} +2 -2
  311. package/dist/{chunk-RQKN4WTW.cjs → chunk-K2UZPY6U.cjs} +2 -2
  312. package/dist/{chunk-UDO4JYVU.cjs → chunk-L66IX6GX.cjs} +2 -2
  313. package/dist/{chunk-HBPCJRZX.cjs → chunk-LKRBFBFN.cjs} +2 -2
  314. package/dist/{chunk-EIILOQ6X.js → chunk-LLZYRINH.js} +1 -1
  315. package/dist/{chunk-CVSQT5PV.cjs → chunk-M2SSGV7K.cjs} +2 -2
  316. package/dist/{chunk-MK4ZGXVE.cjs → chunk-M2UDF7PY.cjs} +2 -2
  317. package/dist/{chunk-SPZSDRM6.cjs → chunk-M56QQHVA.cjs} +2 -2
  318. package/dist/{chunk-IPFHV2FV.cjs → chunk-MB6NKETA.cjs} +2 -2
  319. package/dist/{chunk-PBNPZ7UX.js → chunk-MEUS7LCE.js} +1 -1
  320. package/dist/{chunk-S2QF6HG2.cjs → chunk-N5NFJW7Y.cjs} +2 -2
  321. package/dist/chunk-NBYH536J.js +291 -0
  322. package/dist/{chunk-W3MM2BSK.cjs → chunk-NEVFKRDU.cjs} +2 -2
  323. package/dist/chunk-NJK5F5TF.cjs +21 -0
  324. package/dist/{chunk-CK36RZXR.js → chunk-O4JDWMYD.js} +1 -1
  325. package/dist/{chunk-5RXE7X63.js → chunk-OEBV2PMV.js} +2 -2
  326. package/dist/{chunk-HKZQ56AS.cjs → chunk-OXJOO2YF.cjs} +2 -2
  327. package/dist/{chunk-U4BMKRG6.js → chunk-PSQMDY3B.js} +1 -1
  328. package/dist/{chunk-SHPXCOTN.cjs → chunk-QOAWSFXA.cjs} +3 -3
  329. package/dist/{chunk-RNBO3DEN.js → chunk-QT44OHHL.js} +1 -1
  330. package/dist/{chunk-7BPPP4M2.js → chunk-QTR3RH4N.js} +1 -1
  331. package/dist/{chunk-ID6BXIOZ.js → chunk-RELUU5QZ.js} +1 -1
  332. package/dist/{chunk-4K3MX2J6.js → chunk-RJ3DWFSK.js} +1 -1
  333. package/dist/{chunk-DBNEZWK2.cjs → chunk-RUZRPIHW.cjs} +2 -2
  334. package/dist/{chunk-O3R6C3WW.js → chunk-RW5JOHG7.js} +1 -1
  335. package/dist/{chunk-4MO4WLKA.cjs → chunk-RXMOHUBP.cjs} +2 -2
  336. package/dist/{chunk-YGULLD73.js → chunk-SBSIGQDU.js} +1 -1
  337. package/dist/{chunk-JX45ME2Z.js → chunk-SITPUXIR.js} +1 -1
  338. package/dist/{chunk-TIJGLQKO.js → chunk-SZMCMLOQ.js} +1 -1
  339. package/dist/{chunk-IPDIEZBN.cjs → chunk-T67ZXTVG.cjs} +2 -2
  340. package/dist/{chunk-33TQRYMY.js → chunk-TME4YJNP.js} +1 -1
  341. package/dist/{chunk-N2P26AAD.js → chunk-TPA4HEAO.js} +1 -1
  342. package/dist/{chunk-U52A2DMK.cjs → chunk-TTNPMFXL.cjs} +2 -2
  343. package/dist/chunk-TXDVGTQD.cjs +14 -0
  344. package/dist/{chunk-XD6XML3Z.cjs → chunk-UNCVJH6J.cjs} +2 -2
  345. package/dist/{chunk-CBRWUULQ.js → chunk-UUVJYJHD.js} +1 -1
  346. package/dist/{chunk-V56ZCL54.js → chunk-VSZEOCIE.js} +1 -1
  347. package/dist/{chunk-UX2IZQNM.cjs → chunk-WQBBB6BN.cjs} +2 -2
  348. package/dist/chunk-WSZWUQDD.cjs +291 -0
  349. package/dist/{chunk-5WN2YXNU.cjs → chunk-WTMV77T2.cjs} +2 -2
  350. package/dist/{chunk-JM6HKPSC.cjs → chunk-WWOAKRNG.cjs} +2 -2
  351. package/dist/{chunk-UNHWLNE4.js → chunk-XSE4CFSM.js} +1 -1
  352. package/dist/{chunk-HO7KACZZ.cjs → chunk-YO4M3BZL.cjs} +2 -2
  353. package/dist/chunk-YPSWSI3M.js +21 -0
  354. package/dist/{chunk-6BERHKDQ.cjs → chunk-Z5TVWG3I.cjs} +2 -2
  355. package/dist/{chunk-ONN5COYQ.cjs → chunk-ZI33AJQ5.cjs} +2 -2
  356. package/dist/{chunk-DIP442PL.js → chunk-ZKQ573B7.js} +1 -1
  357. package/dist/consent-6SIH4NQS.cjs +342 -0
  358. package/dist/consent-7MNRAINV.js +342 -0
  359. package/dist/consent-CS2ZBZX4.cjs +7 -0
  360. package/dist/consent-NNYHF2N4.js +7 -0
  361. package/dist/consent-runtime-KZ5D4XZU.cjs +5 -0
  362. package/dist/consent-runtime-OAPXBJH2.js +5 -0
  363. package/dist/customer-portal-D3SLPAHZ.js +7 -0
  364. package/dist/customer-portal-L5DEQEGC.js +14142 -0
  365. package/dist/customer-portal-MXILX4KH.cjs +14142 -0
  366. package/dist/customer-portal-UR3GN4VU.cjs +7 -0
  367. package/dist/customer-portal-runtime-MRVZ7JR4.js +5 -0
  368. package/dist/customer-portal-runtime-VGK7RMLC.cjs +5 -0
  369. package/dist/dashboard-RKUQLIME.cjs +483 -0
  370. package/dist/dashboard-UDL26RGG.js +483 -0
  371. package/dist/dashboard-UHYR5RTY.cjs +7 -0
  372. package/dist/dashboard-UTPGXFW5.js +7 -0
  373. package/dist/dashboard-runtime-EXP2AM44.cjs +5 -0
  374. package/dist/dashboard-runtime-PSKSGLCF.js +5 -0
  375. package/dist/data-management-QH2IJ5QV.js +7 -0
  376. package/dist/data-management-TEFRLGSU.cjs +7 -0
  377. package/dist/data-management-W5JQGGGH.js +925 -0
  378. package/dist/data-management-XFSRLFYA.cjs +925 -0
  379. package/dist/data-management-runtime-PAC7UFGT.cjs +5 -0
  380. package/dist/data-management-runtime-XZ347IUB.js +5 -0
  381. package/dist/deduplication-7RTGTLN5.cjs +193 -0
  382. package/dist/deduplication-ECVAZVVA.cjs +7 -0
  383. package/dist/deduplication-GYIST22B.js +7 -0
  384. package/dist/deduplication-RKLRTNZU.js +193 -0
  385. package/dist/deduplication-runtime-BBHG7MJW.cjs +5 -0
  386. package/dist/deduplication-runtime-DLGBF4RN.js +5 -0
  387. package/dist/design-AO6EGLHD.cjs +1352 -0
  388. package/dist/design-KUVXMFFK.cjs +7 -0
  389. package/dist/design-VLRA2WGV.js +1352 -0
  390. package/dist/design-YKBXRW5C.js +7 -0
  391. package/dist/design-runtime-3SKJA7QH.js +5 -0
  392. package/dist/design-runtime-Y3VGTQLP.cjs +5 -0
  393. package/dist/document-CY2A2OE7.js +7 -0
  394. package/dist/document-OVTR7RVH.cjs +744 -0
  395. package/dist/document-RYQ7MF6U.cjs +7 -0
  396. package/dist/document-SEZ45XAO.js +744 -0
  397. package/dist/document-runtime-GFEBGNMS.js +5 -0
  398. package/dist/document-runtime-RG3F4R6O.cjs +5 -0
  399. package/dist/email-settings-QGCIUWLC.js +2427 -0
  400. package/dist/email-settings-SEGEKVMF.cjs +2427 -0
  401. package/dist/email-settings-TQ5GGDYG.js +7 -0
  402. package/dist/email-settings-TQC34GST.cjs +7 -0
  403. package/dist/email-settings-runtime-NS7MU3RB.cjs +5 -0
  404. package/dist/email-settings-runtime-X7F3EPAB.js +5 -0
  405. package/dist/email-template-26SANLRD.cjs +1308 -0
  406. package/dist/email-template-346NDG4D.js +1308 -0
  407. package/dist/email-template-M2VVL4TI.cjs +7 -0
  408. package/dist/email-template-WYROV3UG.js +7 -0
  409. package/dist/email-template-runtime-QBB64BJQ.js +5 -0
  410. package/dist/email-template-runtime-UI2FS4H5.cjs +5 -0
  411. package/dist/entity-FA6PZX6S.js +7 -0
  412. package/dist/entity-HSCBRIOS.js +9411 -0
  413. package/dist/entity-IX5NSHPX.cjs +7 -0
  414. package/dist/entity-UKAWTND4.cjs +9411 -0
  415. package/dist/entity-mapping-7J3IAGKQ.js +7 -0
  416. package/dist/entity-mapping-PK2XAARN.cjs +1506 -0
  417. package/dist/entity-mapping-UOGYYCZH.js +1506 -0
  418. package/dist/entity-mapping-ZNMFCUKK.cjs +7 -0
  419. package/dist/entity-mapping-runtime-734TTUA2.cjs +5 -0
  420. package/dist/entity-mapping-runtime-HCOJM6DV.js +5 -0
  421. package/dist/entity-runtime-QSFVEFJ6.js +5 -0
  422. package/dist/entity-runtime-XSAICIVR.cjs +5 -0
  423. package/dist/environments-5IS2ZJYQ.cjs +352 -0
  424. package/dist/environments-E3X6NYGX.js +7 -0
  425. package/dist/environments-P2JS4F5N.cjs +7 -0
  426. package/dist/environments-VCREW73K.js +352 -0
  427. package/dist/environments-runtime-BPR47PW7.js +5 -0
  428. package/dist/environments-runtime-L6TJCVW6.cjs +5 -0
  429. package/dist/erp-integration-735KQ73W.js +5295 -0
  430. package/dist/erp-integration-EP2XFEH5.js +7 -0
  431. package/dist/erp-integration-NNV72VFI.cjs +7 -0
  432. package/dist/erp-integration-W7FZDJOB.cjs +5295 -0
  433. package/dist/erp-integration-runtime-FNJXDO75.js +5 -0
  434. package/dist/erp-integration-runtime-WXZIQCLJ.cjs +5 -0
  435. package/dist/event-catalog-C45ISVMP.cjs +7 -0
  436. package/dist/event-catalog-D7VJ7WRS.js +7 -0
  437. package/dist/event-catalog-MZYFJ23V.cjs +965 -0
  438. package/dist/event-catalog-ZUFXLY7B.js +965 -0
  439. package/dist/event-catalog-runtime-5HQSAJVX.cjs +5 -0
  440. package/dist/event-catalog-runtime-6FA3SCRI.js +5 -0
  441. package/dist/file-637CTR4Y.cjs +2744 -0
  442. package/dist/file-EJJBQEQI.js +2744 -0
  443. package/dist/file-UOWBTDIU.cjs +7 -0
  444. package/dist/file-XSN3NAVZ.js +7 -0
  445. package/dist/file-runtime-B6AAGZQF.js +5 -0
  446. package/dist/file-runtime-SFZIKODF.cjs +5 -0
  447. package/dist/iban-24GHLFDB.cjs +7 -0
  448. package/dist/iban-ETTCKOHK.cjs +148 -0
  449. package/dist/iban-HXFDAF4I.js +148 -0
  450. package/dist/iban-LDKYDVQV.js +7 -0
  451. package/dist/iban-runtime-EVXLFPPP.js +5 -0
  452. package/dist/iban-runtime-TUM5LVHO.cjs +5 -0
  453. package/dist/index.cjs +113 -101
  454. package/dist/index.d.cts +36 -5
  455. package/dist/index.d.ts +36 -5
  456. package/dist/index.js +64 -52
  457. package/dist/journey-7CKX67M7.js +7 -0
  458. package/dist/journey-EUZ6MVHG.cjs +7 -0
  459. package/dist/journey-KW3ZFQAL.js +2194 -0
  460. package/dist/journey-XIMSLSZC.cjs +2194 -0
  461. package/dist/journey-runtime-SPBL3F32.cjs +5 -0
  462. package/dist/journey-runtime-YXIAOTMD.js +5 -0
  463. package/dist/kanban-CHTH2ZSY.cjs +7 -0
  464. package/dist/kanban-HI6LL5WY.js +7 -0
  465. package/dist/kanban-M4P7R5TM.cjs +890 -0
  466. package/dist/kanban-QXQEQIF4.js +890 -0
  467. package/dist/kanban-runtime-NHEUWTCG.cjs +5 -0
  468. package/dist/kanban-runtime-R6EWHBFS.js +5 -0
  469. package/dist/message-2VOVRXBB.cjs +2447 -0
  470. package/dist/message-3XZLJR6R.cjs +7 -0
  471. package/dist/message-M62W3KP2.js +2447 -0
  472. package/dist/message-ZNMCS5YH.js +7 -0
  473. package/dist/message-runtime-ITR7MPKT.cjs +5 -0
  474. package/dist/message-runtime-YMKW2N3R.js +5 -0
  475. package/dist/metering-DZNZPPY6.cjs +7 -0
  476. package/dist/metering-KEMILE75.cjs +2198 -0
  477. package/dist/metering-KOSCPPKB.js +7 -0
  478. package/dist/metering-W3TA6ZUQ.js +2198 -0
  479. package/dist/metering-runtime-HAIWXZXJ.cjs +5 -0
  480. package/dist/metering-runtime-NJ6NEUMB.js +5 -0
  481. package/dist/notes-3AO5GXIT.js +7 -0
  482. package/dist/notes-4LVCGLBE.js +1427 -0
  483. package/dist/notes-MPWOQC5J.cjs +7 -0
  484. package/dist/notes-OBM5POWI.cjs +1427 -0
  485. package/dist/notes-runtime-CVNAVKPP.js +5 -0
  486. package/dist/notes-runtime-E3YYF74V.cjs +5 -0
  487. package/dist/notification-EEYPLPUV.cjs +1381 -0
  488. package/dist/notification-MJQGIBM7.js +1381 -0
  489. package/dist/notification-PZOCUYD5.cjs +7 -0
  490. package/dist/notification-VWDZRSFZ.js +7 -0
  491. package/dist/notification-runtime-7QLZTPHG.cjs +5 -0
  492. package/dist/notification-runtime-KREP32YP.js +5 -0
  493. package/dist/organization-2UK7QZLQ.cjs +615 -0
  494. package/dist/organization-RARYYG2E.cjs +7 -0
  495. package/dist/organization-U5HPX627.js +615 -0
  496. package/dist/organization-ZERPH2IH.js +7 -0
  497. package/dist/organization-runtime-LBCVCZ3W.cjs +5 -0
  498. package/dist/organization-runtime-P3WZ2BBU.js +5 -0
  499. package/dist/{organization.d-Bd2Hmk8v.d.cts → organization.d-DqwnNxMg.d.cts} +34 -7
  500. package/dist/{organization.d-Bd2Hmk8v.d.ts → organization.d-DqwnNxMg.d.ts} +34 -7
  501. package/dist/partner-directory-2XMPQWWX.js +7 -0
  502. package/dist/partner-directory-CG5CYJGB.cjs +1600 -0
  503. package/dist/partner-directory-WHNTKQ5E.cjs +7 -0
  504. package/dist/partner-directory-XJ7KI7EX.js +1600 -0
  505. package/dist/partner-directory-runtime-QURDOO4Z.js +5 -0
  506. package/dist/partner-directory-runtime-RSONSDNJ.cjs +5 -0
  507. package/dist/permissions-4T3GFNB4.js +7 -0
  508. package/dist/permissions-FGBIJNN7.cjs +7 -0
  509. package/dist/permissions-SGPGANEP.js +1415 -0
  510. package/dist/permissions-WCOABHKQ.cjs +1415 -0
  511. package/dist/permissions-runtime-D74HOCVO.js +5 -0
  512. package/dist/permissions-runtime-O5LH7WOU.cjs +5 -0
  513. package/dist/pricing-3RNPCUR6.js +9362 -0
  514. package/dist/pricing-4Z4TOETA.cjs +7 -0
  515. package/dist/pricing-C65DTZSX.js +7 -0
  516. package/dist/pricing-VYHPSVKM.cjs +9362 -0
  517. package/dist/pricing-runtime-6XNS4EOF.cjs +5 -0
  518. package/dist/pricing-runtime-JRR4FWFI.js +5 -0
  519. package/dist/pricing-tier-36WV4P4X.js +121 -0
  520. package/dist/pricing-tier-FKQPW2ND.cjs +121 -0
  521. package/dist/pricing-tier-NI35WOUP.cjs +7 -0
  522. package/dist/pricing-tier-VUOFK5Q7.js +7 -0
  523. package/dist/pricing-tier-runtime-32BCKJ7Y.cjs +5 -0
  524. package/dist/pricing-tier-runtime-LEGBNNLA.js +5 -0
  525. package/dist/purpose-AKOEUHZ4.cjs +7 -0
  526. package/dist/purpose-JC2E7W3M.cjs +523 -0
  527. package/dist/purpose-QFQ4W255.js +523 -0
  528. package/dist/purpose-RBRV3AQZ.js +7 -0
  529. package/dist/purpose-runtime-C6IGTUA6.cjs +5 -0
  530. package/dist/purpose-runtime-V5X5ESZV.js +5 -0
  531. package/dist/sandbox-2KN4X66E.cjs +7 -0
  532. package/dist/sandbox-CLZTN7IW.cjs +445 -0
  533. package/dist/sandbox-L2SOOGGR.js +7 -0
  534. package/dist/sandbox-O2NWMZGJ.js +445 -0
  535. package/dist/sandbox-runtime-4MLOMFPK.js +5 -0
  536. package/dist/sandbox-runtime-GKEK3GQB.cjs +5 -0
  537. package/dist/submission-6FD67HIE.cjs +308 -0
  538. package/dist/submission-7BISSPO6.js +7 -0
  539. package/dist/submission-MWJU4L32.js +308 -0
  540. package/dist/submission-Q24BU4GS.cjs +7 -0
  541. package/dist/submission-runtime-5FD4AQSD.cjs +5 -0
  542. package/dist/submission-runtime-JPHKPQ77.js +5 -0
  543. package/dist/targeting-4CQDSEKL.cjs +1369 -0
  544. package/dist/targeting-EYGYZD6M.cjs +7 -0
  545. package/dist/targeting-GEJTJN5Z.js +7 -0
  546. package/dist/targeting-RB7LBQMX.js +1369 -0
  547. package/dist/targeting-runtime-6JFMP262.cjs +5 -0
  548. package/dist/targeting-runtime-M2VSTKFT.js +5 -0
  549. package/dist/template-variables-JYHE2VCH.cjs +1447 -0
  550. package/dist/template-variables-OAYS2E3G.cjs +1148 -0
  551. package/dist/template-variables-VKDJJZUT.js +1148 -0
  552. package/dist/template-variables-XLIW4GY6.js +1447 -0
  553. package/dist/template-variables-runtime-62U3ZY5P.js +5 -0
  554. package/dist/template-variables-runtime-LFOA32UM.cjs +5 -0
  555. package/dist/{types-BwBvJkY_.d.ts → types-ChU9Acbv.d.cts} +3 -0
  556. package/dist/{types-BwBvJkY_.d.cts → types-ChU9Acbv.d.ts} +3 -0
  557. package/dist/user-DKA6DDPX.cjs +2265 -0
  558. package/dist/user-EIEOI3OG.js +7 -0
  559. package/dist/user-NJJ7XVKB.cjs +7 -0
  560. package/dist/user-O4JDAIRO.js +2265 -0
  561. package/dist/user-runtime-7O2HLFVQ.cjs +5 -0
  562. package/dist/user-runtime-U4HYUWJU.js +5 -0
  563. package/dist/validation-rules-AYCAOVDZ.cjs +1344 -0
  564. package/dist/validation-rules-GCI64B57.js +1344 -0
  565. package/dist/validation-rules-P6F5P73P.js +7 -0
  566. package/dist/validation-rules-VDU3CIZV.cjs +7 -0
  567. package/dist/validation-rules-runtime-6MRCS5X2.js +5 -0
  568. package/dist/validation-rules-runtime-X7M3QE5I.cjs +5 -0
  569. package/dist/webhooks-I7JWU34X.cjs +7 -0
  570. package/dist/webhooks-L3FXPRKT.cjs +1431 -0
  571. package/dist/webhooks-WPLEHVPX.js +7 -0
  572. package/dist/webhooks-XXLU2KWP.js +1431 -0
  573. package/dist/webhooks-runtime-EBM4M3SU.cjs +5 -0
  574. package/dist/webhooks-runtime-XCQYIGQK.js +5 -0
  575. package/dist/workflow-3LLURW3H.js +7 -0
  576. package/dist/workflow-RAGQDYXT.cjs +7 -0
  577. package/dist/workflow-VLNZNE3S.js +3834 -0
  578. package/dist/workflow-YJHUCGVK.cjs +3834 -0
  579. package/dist/workflow-definition-7BA4H6W3.cjs +3100 -0
  580. package/dist/workflow-definition-B6ELOZUR.cjs +7 -0
  581. package/dist/workflow-definition-D24CRCK2.js +7 -0
  582. package/dist/workflow-definition-VFYWBQQ3.js +3100 -0
  583. package/dist/workflow-definition-runtime-S7AZHOU7.js +5 -0
  584. package/dist/workflow-definition-runtime-VRND6VQR.cjs +5 -0
  585. package/dist/workflow-runtime-RLZO2OQB.js +5 -0
  586. package/dist/workflow-runtime-WCJ7NRTH.cjs +5 -0
  587. package/docs/access-token.md +440 -0
  588. package/docs/address-suggestions.md +256 -0
  589. package/docs/address.md +284 -0
  590. package/docs/ai-agents.md +1891 -0
  591. package/docs/app.md +3388 -0
  592. package/docs/audit-logs.md +242 -0
  593. package/docs/automation.md +4044 -0
  594. package/docs/billing.md +783 -0
  595. package/docs/blueprint-manifest.md +3234 -0
  596. package/docs/consent.md +213 -0
  597. package/docs/customer-portal.md +11399 -0
  598. package/docs/dashboard.md +640 -0
  599. package/docs/data-management.md +883 -0
  600. package/docs/deduplication.md +135 -0
  601. package/docs/design.md +1273 -0
  602. package/docs/document.md +590 -0
  603. package/docs/email-settings.md +1544 -0
  604. package/docs/email-template.md +1197 -0
  605. package/docs/entity-mapping.md +2864 -0
  606. package/docs/entity.md +9595 -0
  607. package/docs/environments.md +259 -0
  608. package/docs/erp-integration.md +4572 -0
  609. package/docs/event-catalog.md +835 -0
  610. package/docs/file.md +1453 -0
  611. package/docs/iban.md +61 -0
  612. package/docs/journey.md +2268 -0
  613. package/docs/kanban.md +882 -0
  614. package/docs/message.md +2122 -0
  615. package/docs/metering.md +1431 -0
  616. package/docs/notes.md +670 -0
  617. package/docs/notification.md +1207 -0
  618. package/docs/organization.md +733 -0
  619. package/docs/partner-directory.md +1197 -0
  620. package/docs/permissions.md +1047 -0
  621. package/docs/pricing-tier.md +81 -0
  622. package/docs/pricing.md +5923 -0
  623. package/docs/purpose.md +283 -0
  624. package/docs/sandbox.md +389 -0
  625. package/docs/submission.md +195 -0
  626. package/docs/targeting.md +959 -0
  627. package/docs/template-variables.md +1141 -0
  628. package/docs/user.md +2555 -0
  629. package/docs/validation-rules.md +1597 -0
  630. package/docs/webhooks.md +996 -0
  631. package/docs/workflow-definition.md +3842 -0
  632. package/docs/workflow.md +4465 -0
  633. package/package.json +5 -3
  634. package/dist/chunk-GMBRXWMD.cjs +0 -14
  635. package/dist/chunk-L43U5IO3.js +0 -14
  636. package/dist/chunk-XE25WERA.js +0 -125
  637. package/dist/chunk-XEQMAKGA.cjs +0 -125
@@ -0,0 +1,2447 @@
1
+ import "./chunk-YPSWSI3M.js";
2
+
3
+ // src/definitions/message.json
4
+ var openapi = "3.0.2";
5
+ var info = {
6
+ title: "Message API",
7
+ version: "1.4.0",
8
+ description: "Send and receive email messages via your epilot organization\n"
9
+ };
10
+ var security = [
11
+ {
12
+ EpilotAuth: []
13
+ },
14
+ {
15
+ EpilotOrg: []
16
+ }
17
+ ];
18
+ var tags = [
19
+ {
20
+ name: "Messages"
21
+ },
22
+ {
23
+ name: "Threads"
24
+ },
25
+ {
26
+ name: "Drafts"
27
+ },
28
+ {
29
+ name: "message_schema",
30
+ "x-displayName": "Message",
31
+ description: '<SchemaDefinition schemaRef="#/components/schemas/Message" />\n'
32
+ },
33
+ {
34
+ name: "thread_schema",
35
+ "x-displayName": "Thread",
36
+ description: '<SchemaDefinition schemaRef="#/components/schemas/Thread" />\n'
37
+ }
38
+ ];
39
+ var paths = {
40
+ "/v1/message/messages": {
41
+ post: {
42
+ operationId: "sendMessage",
43
+ summary: "sendMessage",
44
+ description: "Send an email message",
45
+ tags: ["Messages"],
46
+ parameters: [
47
+ {
48
+ in: "query",
49
+ name: "do_not_create_entities",
50
+ description: "When true, this flag lets the caller to send only the message and by-pass creating the thread & message entities.",
51
+ schema: {
52
+ type: "boolean",
53
+ default: false
54
+ }
55
+ }
56
+ ],
57
+ requestBody: {
58
+ content: {
59
+ "application/json": {
60
+ schema: {
61
+ $ref: "#/components/schemas/MessageRequestParams"
62
+ }
63
+ }
64
+ }
65
+ },
66
+ responses: {
67
+ "201": {
68
+ description: "Success",
69
+ content: {
70
+ "application/json": {
71
+ schema: {
72
+ $ref: "#/components/schemas/MessageRequestParams"
73
+ }
74
+ }
75
+ }
76
+ },
77
+ "403": {
78
+ description: "Forbidden"
79
+ }
80
+ }
81
+ },
82
+ put: {
83
+ operationId: "updateMessage",
84
+ summary: "updateMessage",
85
+ description: "Update message metadata",
86
+ tags: ["Messages"],
87
+ responses: {
88
+ "201": {
89
+ description: "Success",
90
+ content: {
91
+ "application/json": {
92
+ schema: {
93
+ allOf: [
94
+ {
95
+ $ref: "#/components/schemas/BaseEntity"
96
+ },
97
+ {
98
+ $ref: "#/components/schemas/Message"
99
+ }
100
+ ]
101
+ }
102
+ }
103
+ }
104
+ },
105
+ "403": {
106
+ description: "Forbidden"
107
+ }
108
+ }
109
+ }
110
+ },
111
+ "/v1/message/messages/{id}": {
112
+ get: {
113
+ operationId: "getMessage",
114
+ summary: "getMessage",
115
+ description: "Get an email message by id",
116
+ tags: ["Messages"],
117
+ parameters: [
118
+ {
119
+ name: "id",
120
+ description: "Message ID",
121
+ in: "path",
122
+ required: true,
123
+ schema: {
124
+ type: "string",
125
+ example: "4d74976d-fb64-47fd-85e2-65eea140f5eb"
126
+ }
127
+ }
128
+ ],
129
+ responses: {
130
+ "200": {
131
+ description: "Success",
132
+ content: {
133
+ "application/json": {
134
+ schema: {
135
+ allOf: [
136
+ {
137
+ $ref: "#/components/schemas/BaseEntity"
138
+ },
139
+ {
140
+ $ref: "#/components/schemas/Message"
141
+ }
142
+ ]
143
+ }
144
+ }
145
+ }
146
+ },
147
+ "302": {
148
+ description: "Redirect to V2 API to fetch the download URL",
149
+ headers: {
150
+ Location: {
151
+ description: "V2 API",
152
+ schema: {
153
+ type: "string",
154
+ example: "https://message.sls.epilot.io/v2/messages/4d74976d-fb64-47fd-85e2-65eea140f5eb"
155
+ }
156
+ }
157
+ }
158
+ },
159
+ "403": {
160
+ description: "Forbidden"
161
+ }
162
+ }
163
+ },
164
+ delete: {
165
+ operationId: "deleteMessage",
166
+ summary: "deleteMessage",
167
+ description: "Immediately and permanently delete a message. This operation cannot be undone.",
168
+ tags: ["Messages"],
169
+ parameters: [
170
+ {
171
+ name: "id",
172
+ description: "Message ID",
173
+ in: "path",
174
+ required: true,
175
+ schema: {
176
+ type: "string"
177
+ }
178
+ }
179
+ ],
180
+ responses: {
181
+ "204": {
182
+ description: "Success"
183
+ },
184
+ "403": {
185
+ description: "Forbidden"
186
+ }
187
+ }
188
+ }
189
+ },
190
+ "/v1/message/messages/{id}/eml": {
191
+ get: {
192
+ operationId: "getMessageEml",
193
+ summary: "getMessageEml",
194
+ description: "Download a message as an EML file.\nReturns a 302 redirect to a pre-signed S3 URL where the EML file can be downloaded.\n",
195
+ tags: ["Messages"],
196
+ parameters: [
197
+ {
198
+ name: "id",
199
+ description: "Message entity ID",
200
+ in: "path",
201
+ required: true,
202
+ schema: {
203
+ type: "string",
204
+ example: "4d74976d-fb64-47fd-85e2-65eea140f5eb"
205
+ }
206
+ }
207
+ ],
208
+ responses: {
209
+ "302": {
210
+ description: "Redirect to EML file download URL",
211
+ headers: {
212
+ Location: {
213
+ description: "Pre-signed S3 URL to download the EML file (expires in 15 minutes)",
214
+ schema: {
215
+ type: "string"
216
+ }
217
+ }
218
+ }
219
+ },
220
+ "403": {
221
+ description: "Forbidden"
222
+ },
223
+ "404": {
224
+ description: "Message not found"
225
+ }
226
+ }
227
+ }
228
+ },
229
+ "/v1/message/messages:search": {
230
+ post: {
231
+ operationId: "searchMessages",
232
+ summary: "searchMessages",
233
+ description: "Search Messages",
234
+ tags: ["Messages"],
235
+ requestBody: {
236
+ content: {
237
+ "application/json": {
238
+ schema: {
239
+ $ref: "#/components/schemas/SearchParamsV2"
240
+ }
241
+ }
242
+ }
243
+ },
244
+ responses: {
245
+ "200": {
246
+ description: "Success",
247
+ content: {
248
+ "application/json": {
249
+ schema: {
250
+ type: "object",
251
+ required: ["hits", "results"],
252
+ properties: {
253
+ hits: {
254
+ type: "number",
255
+ description: "Total of matched messages",
256
+ example: 14
257
+ },
258
+ results: {
259
+ type: "array",
260
+ description: "Matched messages",
261
+ items: {
262
+ allOf: [
263
+ {
264
+ $ref: "#/components/schemas/BaseEntity"
265
+ },
266
+ {
267
+ $ref: "#/components/schemas/Message"
268
+ }
269
+ ]
270
+ }
271
+ }
272
+ }
273
+ }
274
+ }
275
+ }
276
+ },
277
+ "403": {
278
+ description: "Forbidden"
279
+ }
280
+ }
281
+ }
282
+ },
283
+ "/v1/message/messages/{id}/trash": {
284
+ post: {
285
+ operationId: "trashMessage",
286
+ summary: "trashMessage",
287
+ description: "Move a message to the trash",
288
+ tags: ["Messages"],
289
+ parameters: [
290
+ {
291
+ name: "id",
292
+ description: "Message ID",
293
+ in: "path",
294
+ required: true,
295
+ schema: {
296
+ type: "string"
297
+ }
298
+ }
299
+ ],
300
+ responses: {
301
+ "204": {
302
+ description: "Success"
303
+ },
304
+ "403": {
305
+ description: "Forbidden"
306
+ }
307
+ }
308
+ }
309
+ },
310
+ "/v1/message/messages/{id}/untrash": {
311
+ post: {
312
+ operationId: "untrashMessage",
313
+ summary: "untrashMessage",
314
+ description: "Restore a trashed message",
315
+ tags: ["Messages"],
316
+ parameters: [
317
+ {
318
+ name: "id",
319
+ description: "Message ID",
320
+ in: "path",
321
+ required: true,
322
+ schema: {
323
+ type: "string"
324
+ }
325
+ }
326
+ ],
327
+ responses: {
328
+ "204": {
329
+ description: "Success"
330
+ },
331
+ "403": {
332
+ description: "Forbidden"
333
+ }
334
+ }
335
+ }
336
+ },
337
+ "/v1/message/messages/{id}/read": {
338
+ post: {
339
+ operationId: "markReadMessage",
340
+ summary: "markReadMessage",
341
+ description: "Mark message as read",
342
+ tags: ["Messages"],
343
+ parameters: [
344
+ {
345
+ name: "id",
346
+ description: "Message ID",
347
+ in: "path",
348
+ required: true,
349
+ schema: {
350
+ type: "string"
351
+ }
352
+ }
353
+ ],
354
+ responses: {
355
+ "204": {
356
+ description: "Success"
357
+ },
358
+ "403": {
359
+ description: "Forbidden"
360
+ }
361
+ }
362
+ }
363
+ },
364
+ "/v2/message/messages/{id}/read": {
365
+ post: {
366
+ operationId: "markReadMessageV2",
367
+ summary: "markReadMessageV2",
368
+ description: "Mark message as read within a scope",
369
+ tags: ["Messages"],
370
+ parameters: [
371
+ {
372
+ name: "id",
373
+ description: "Message ID",
374
+ in: "path",
375
+ required: true,
376
+ schema: {
377
+ type: "string"
378
+ }
379
+ }
380
+ ],
381
+ requestBody: {
382
+ required: true,
383
+ content: {
384
+ "application/json": {
385
+ schema: {
386
+ $ref: "#/components/schemas/ReadMessagePayload"
387
+ }
388
+ }
389
+ }
390
+ },
391
+ responses: {
392
+ "204": {
393
+ description: "Success"
394
+ },
395
+ "403": {
396
+ description: "Forbidden"
397
+ }
398
+ }
399
+ }
400
+ },
401
+ "/v1/message/messages/{id}/unread": {
402
+ post: {
403
+ operationId: "markUnreadMessage",
404
+ summary: "markUnreadMessage",
405
+ description: "Mark message as unread",
406
+ tags: ["Messages"],
407
+ parameters: [
408
+ {
409
+ name: "id",
410
+ description: "Message ID",
411
+ in: "path",
412
+ required: true,
413
+ schema: {
414
+ type: "string"
415
+ }
416
+ }
417
+ ],
418
+ responses: {
419
+ "204": {
420
+ description: "Success"
421
+ },
422
+ "403": {
423
+ description: "Forbidden"
424
+ }
425
+ }
426
+ }
427
+ },
428
+ "/v1/message/messages/unread/{actor}": {
429
+ get: {
430
+ operationId: "getUnread",
431
+ summary: "getUnread",
432
+ description: "Get all unread messages by actor",
433
+ tags: ["Messages"],
434
+ parameters: [
435
+ {
436
+ name: "actor",
437
+ description: "Actor performing call, can be user or organization",
438
+ in: "path",
439
+ required: true,
440
+ schema: {
441
+ type: "string",
442
+ enum: ["organization", "user"]
443
+ }
444
+ },
445
+ {
446
+ in: "query",
447
+ name: "email_filter",
448
+ description: "emails to filter by",
449
+ schema: {
450
+ oneOf: [
451
+ {
452
+ type: "array",
453
+ items: {
454
+ type: "string"
455
+ }
456
+ },
457
+ {
458
+ type: "string"
459
+ }
460
+ ]
461
+ }
462
+ }
463
+ ],
464
+ responses: {
465
+ "200": {
466
+ description: "Success",
467
+ content: {
468
+ "application/json": {
469
+ schema: {
470
+ type: "object",
471
+ required: ["count"],
472
+ properties: {
473
+ count: {
474
+ type: "number",
475
+ description: "Total of unread messages",
476
+ example: 14
477
+ },
478
+ unread: {
479
+ type: "number",
480
+ description: "Total of unread messages",
481
+ example: 0
482
+ },
483
+ drafts: {
484
+ type: "number",
485
+ description: "Total of drafts messages",
486
+ example: 12
487
+ },
488
+ unassigned: {
489
+ type: "number",
490
+ description: "Total of unassigned messages",
491
+ example: 1
492
+ }
493
+ }
494
+ }
495
+ }
496
+ }
497
+ },
498
+ "403": {
499
+ description: "Forbidden"
500
+ }
501
+ }
502
+ }
503
+ },
504
+ "/v2/message/messages/{id}/unread": {
505
+ post: {
506
+ operationId: "markUnreadMessageV2",
507
+ summary: "markUnreadMessageV2",
508
+ description: "Mark message as unread within a scope",
509
+ tags: ["Messages"],
510
+ parameters: [
511
+ {
512
+ name: "id",
513
+ description: "Message ID",
514
+ in: "path",
515
+ required: true,
516
+ schema: {
517
+ type: "string"
518
+ }
519
+ }
520
+ ],
521
+ requestBody: {
522
+ required: true,
523
+ content: {
524
+ "application/json": {
525
+ schema: {
526
+ $ref: "#/components/schemas/ReadMessagePayload"
527
+ }
528
+ }
529
+ }
530
+ },
531
+ responses: {
532
+ "204": {
533
+ description: "Success"
534
+ },
535
+ "403": {
536
+ description: "Forbidden"
537
+ }
538
+ }
539
+ }
540
+ },
541
+ "/v1/message/threads:search": {
542
+ post: {
543
+ operationId: "searchThreads",
544
+ summary: "searchThreads",
545
+ description: "Search for threads of email messages.\n\nMessages with no replies yet are treated as threads with single message.\n\nLucene syntax supported.\n",
546
+ tags: ["Threads"],
547
+ requestBody: {
548
+ content: {
549
+ "application/json": {
550
+ schema: {
551
+ $ref: "#/components/schemas/SearchParams"
552
+ }
553
+ }
554
+ }
555
+ },
556
+ responses: {
557
+ "200": {
558
+ description: "Success",
559
+ content: {
560
+ "application/json": {
561
+ schema: {
562
+ type: "object",
563
+ required: ["hits", "results"],
564
+ properties: {
565
+ hits: {
566
+ type: "number",
567
+ description: "Total of matched threads",
568
+ example: 14
569
+ },
570
+ results: {
571
+ type: "array",
572
+ description: "Matched threads",
573
+ items: {
574
+ allOf: [
575
+ {
576
+ $ref: "#/components/schemas/BaseEntity"
577
+ },
578
+ {
579
+ $ref: "#/components/schemas/Thread"
580
+ }
581
+ ]
582
+ }
583
+ }
584
+ }
585
+ }
586
+ }
587
+ }
588
+ },
589
+ "403": {
590
+ description: "Forbidden"
591
+ }
592
+ }
593
+ }
594
+ },
595
+ "/v2/message/threads:search": {
596
+ post: {
597
+ operationId: "searchThreadsV2",
598
+ summary: "searchThreadsV2",
599
+ description: "Search for threads of email messages.\n\nMessages with no replies yet are treated as threads with single message.\n\nLucene syntax supported.\n",
600
+ tags: ["Threads"],
601
+ requestBody: {
602
+ content: {
603
+ "application/json": {
604
+ schema: {
605
+ $ref: "#/components/schemas/SearchParamsV2"
606
+ }
607
+ }
608
+ }
609
+ },
610
+ responses: {
611
+ "200": {
612
+ description: "Success",
613
+ content: {
614
+ "application/json": {
615
+ schema: {
616
+ type: "object",
617
+ required: ["hits", "results"],
618
+ properties: {
619
+ hits: {
620
+ type: "number",
621
+ description: "Total of matched threads",
622
+ example: 14
623
+ },
624
+ results: {
625
+ type: "array",
626
+ description: "Matched threads",
627
+ items: {
628
+ allOf: [
629
+ {
630
+ $ref: "#/components/schemas/BaseEntity"
631
+ },
632
+ {
633
+ $ref: "#/components/schemas/Thread"
634
+ }
635
+ ]
636
+ }
637
+ }
638
+ }
639
+ }
640
+ }
641
+ }
642
+ },
643
+ "403": {
644
+ description: "Forbidden"
645
+ }
646
+ }
647
+ }
648
+ },
649
+ "/v1/message/threads:searchIds": {
650
+ post: {
651
+ operationId: "searchIds",
652
+ summary: "Search threads and return all id's",
653
+ description: "Return all thread id's that match a criteria\n\nLucene syntax supported.\n",
654
+ tags: ["Threads"],
655
+ requestBody: {
656
+ content: {
657
+ "application/json": {
658
+ schema: {
659
+ $ref: "#/components/schemas/SearchIDParams"
660
+ }
661
+ }
662
+ }
663
+ },
664
+ responses: {
665
+ "200": {
666
+ description: "Success",
667
+ content: {
668
+ "application/json": {
669
+ schema: {
670
+ type: "object",
671
+ required: ["hits", "results"],
672
+ properties: {
673
+ hits: {
674
+ type: "number",
675
+ description: "Total of matched threads",
676
+ example: 14
677
+ },
678
+ results: {
679
+ type: "array",
680
+ description: "Matched threads ids",
681
+ items: {
682
+ type: "string"
683
+ }
684
+ }
685
+ }
686
+ }
687
+ }
688
+ }
689
+ },
690
+ "403": {
691
+ description: "Forbidden"
692
+ }
693
+ }
694
+ }
695
+ },
696
+ "/v1/message/threads": {
697
+ put: {
698
+ operationId: "updateThread",
699
+ summary: "updateThread",
700
+ description: "Modify thread metadata",
701
+ tags: ["Threads"],
702
+ responses: {
703
+ "201": {
704
+ description: "Success",
705
+ content: {
706
+ "application/json": {
707
+ schema: {
708
+ allOf: [
709
+ {
710
+ $ref: "#/components/schemas/BaseEntity"
711
+ },
712
+ {
713
+ $ref: "#/components/schemas/Thread"
714
+ }
715
+ ]
716
+ }
717
+ }
718
+ }
719
+ },
720
+ "403": {
721
+ description: "Forbidden"
722
+ }
723
+ }
724
+ }
725
+ },
726
+ "/v1/message/threads/{id}": {
727
+ delete: {
728
+ operationId: "deleteThread",
729
+ summary: "deleteThread",
730
+ description: "Immediately and permanently delete a thread. This operation cannot be undone.",
731
+ tags: ["Threads"],
732
+ parameters: [
733
+ {
734
+ name: "id",
735
+ description: "Thread ID",
736
+ in: "path",
737
+ required: true,
738
+ schema: {
739
+ type: "string"
740
+ }
741
+ }
742
+ ],
743
+ responses: {
744
+ "204": {
745
+ description: "Success"
746
+ },
747
+ "403": {
748
+ description: "Forbidden"
749
+ }
750
+ }
751
+ }
752
+ },
753
+ "/v1/message/threads/{id}:move": {
754
+ post: {
755
+ operationId: "moveThread",
756
+ summary: "moveThread",
757
+ description: "Move thread to a different Inbox",
758
+ tags: ["Threads"],
759
+ parameters: [
760
+ {
761
+ name: "id",
762
+ description: "Thread ID",
763
+ in: "path",
764
+ required: true,
765
+ schema: {
766
+ type: "string"
767
+ }
768
+ }
769
+ ],
770
+ requestBody: {
771
+ required: true,
772
+ content: {
773
+ "application/json": {
774
+ schema: {
775
+ $ref: "#/components/schemas/MoveThreadPayload"
776
+ }
777
+ }
778
+ }
779
+ },
780
+ responses: {
781
+ "204": {
782
+ description: "Success"
783
+ },
784
+ "400": {
785
+ $ref: "#/components/responses/BadRequest"
786
+ },
787
+ "403": {
788
+ $ref: "#/components/responses/Forbidden"
789
+ },
790
+ "404": {
791
+ $ref: "#/components/responses/NotFound"
792
+ },
793
+ "409": {
794
+ $ref: "#/components/responses/Conflict"
795
+ },
796
+ "500": {
797
+ $ref: "#/components/responses/InternalServerError"
798
+ }
799
+ }
800
+ }
801
+ },
802
+ "/v1/message/threads/{id}:markAsDone": {
803
+ post: {
804
+ operationId: "markThreadAsDone",
805
+ summary: "markThreadAsDone",
806
+ description: "Mark thread as done",
807
+ tags: ["Threads"],
808
+ parameters: [
809
+ {
810
+ name: "id",
811
+ description: "Thread ID",
812
+ in: "path",
813
+ required: true,
814
+ schema: {
815
+ type: "string"
816
+ }
817
+ }
818
+ ],
819
+ responses: {
820
+ "204": {
821
+ description: "Success"
822
+ },
823
+ "400": {
824
+ description: "Bad Request"
825
+ }
826
+ }
827
+ }
828
+ },
829
+ "/v1/message/threads/{id}:markAsOpen": {
830
+ post: {
831
+ operationId: "markThreadAsOpen",
832
+ summary: "markThreadAsOpen",
833
+ description: "Mark thread as open",
834
+ tags: ["Threads"],
835
+ parameters: [
836
+ {
837
+ name: "id",
838
+ description: "Thread ID",
839
+ in: "path",
840
+ required: true,
841
+ schema: {
842
+ type: "string"
843
+ }
844
+ }
845
+ ],
846
+ responses: {
847
+ "204": {
848
+ description: "Success"
849
+ },
850
+ "400": {
851
+ description: "Bad Request"
852
+ }
853
+ }
854
+ }
855
+ },
856
+ "/v1/message/threads/{id}/timeline": {
857
+ get: {
858
+ operationId: "getThreadTimeline",
859
+ summary: "getThreadTimeline",
860
+ description: "Get thread timeline",
861
+ tags: ["Threads"],
862
+ parameters: [
863
+ {
864
+ name: "id",
865
+ description: "Thread ID",
866
+ in: "path",
867
+ required: true,
868
+ schema: {
869
+ type: "string"
870
+ }
871
+ }
872
+ ],
873
+ responses: {
874
+ "200": {
875
+ description: "Success",
876
+ content: {
877
+ "application/json": {
878
+ schema: {
879
+ $ref: "#/components/schemas/ThreadTimeline"
880
+ }
881
+ }
882
+ }
883
+ },
884
+ "403": {
885
+ description: "Forbidden"
886
+ }
887
+ }
888
+ }
889
+ },
890
+ "/v1/message/threads/{id}/trash": {
891
+ post: {
892
+ operationId: "trashThread",
893
+ summary: "trashThread",
894
+ description: "Move a thread to trash",
895
+ tags: ["Threads"],
896
+ parameters: [
897
+ {
898
+ name: "id",
899
+ description: "Thread ID",
900
+ in: "path",
901
+ required: true,
902
+ schema: {
903
+ type: "string"
904
+ }
905
+ }
906
+ ],
907
+ responses: {
908
+ "200": {
909
+ description: "Success"
910
+ },
911
+ "403": {
912
+ description: "Forbidden"
913
+ }
914
+ }
915
+ }
916
+ },
917
+ "/v1/message/threads/{id}/untrash": {
918
+ post: {
919
+ operationId: "untrashThread",
920
+ summary: "untrashThread",
921
+ description: "Restore a trashed thread",
922
+ tags: ["Threads"],
923
+ parameters: [
924
+ {
925
+ name: "id",
926
+ description: "Thread ID",
927
+ in: "path",
928
+ required: true,
929
+ schema: {
930
+ type: "string"
931
+ }
932
+ }
933
+ ],
934
+ responses: {
935
+ "200": {
936
+ description: "Success"
937
+ },
938
+ "403": {
939
+ description: "Forbidden"
940
+ }
941
+ }
942
+ }
943
+ },
944
+ "/v1/message/threads/bulk:read": {
945
+ post: {
946
+ operationId: "threadBulkActionsRead",
947
+ summary: "threadBulkActionsRead",
948
+ description: "Perform a bulk action of marking an array of thread ids as read",
949
+ tags: ["Threads"],
950
+ requestBody: {
951
+ required: true,
952
+ content: {
953
+ "application/json": {
954
+ schema: {
955
+ $ref: "#/components/schemas/BulkActionsPayloadWithScopes"
956
+ }
957
+ }
958
+ }
959
+ },
960
+ responses: {
961
+ "200": {
962
+ description: "Success"
963
+ },
964
+ "403": {
965
+ description: "Forbidden"
966
+ }
967
+ }
968
+ }
969
+ },
970
+ "/v1/message/threads/bulk:unread": {
971
+ post: {
972
+ operationId: "threadBulkActionsUnread",
973
+ summary: "threadBulkActionsUnread",
974
+ description: "Perform a bulk action of marking an array of thread ids as unread",
975
+ tags: ["Threads"],
976
+ requestBody: {
977
+ required: true,
978
+ content: {
979
+ "application/json": {
980
+ schema: {
981
+ $ref: "#/components/schemas/BulkActionsPayloadWithScopes"
982
+ }
983
+ }
984
+ }
985
+ },
986
+ responses: {
987
+ "200": {
988
+ description: "Success"
989
+ },
990
+ "403": {
991
+ description: "Forbidden"
992
+ }
993
+ }
994
+ }
995
+ },
996
+ "/v1/message/threads/bulk:favorite": {
997
+ post: {
998
+ operationId: "threadBulkActionsFavorite",
999
+ summary: "threadBulkActionsFavorite",
1000
+ description: "Perform a bulk action of marking an array of thread ids favorite",
1001
+ tags: ["Threads"],
1002
+ requestBody: {
1003
+ required: true,
1004
+ content: {
1005
+ "application/json": {
1006
+ schema: {
1007
+ $ref: "#/components/schemas/BulkActionsPayload"
1008
+ }
1009
+ }
1010
+ }
1011
+ },
1012
+ responses: {
1013
+ "200": {
1014
+ description: "Success"
1015
+ },
1016
+ "403": {
1017
+ description: "Forbidden"
1018
+ }
1019
+ }
1020
+ }
1021
+ },
1022
+ "/v1/message/threads/bulk:unfavorite": {
1023
+ post: {
1024
+ operationId: "threadBulkActionsUnfavorite",
1025
+ summary: "threadBulkActionsUnfavorite",
1026
+ description: "Perform a bulk action of marking an array of thread ids unfavorited",
1027
+ tags: ["Threads"],
1028
+ requestBody: {
1029
+ required: true,
1030
+ content: {
1031
+ "application/json": {
1032
+ schema: {
1033
+ $ref: "#/components/schemas/BulkActionsPayload"
1034
+ }
1035
+ }
1036
+ }
1037
+ },
1038
+ responses: {
1039
+ "200": {
1040
+ description: "Success"
1041
+ },
1042
+ "403": {
1043
+ description: "Forbidden"
1044
+ }
1045
+ }
1046
+ }
1047
+ },
1048
+ "/v1/message/threads/bulk:trash": {
1049
+ post: {
1050
+ operationId: "threadBulkActionsTrash",
1051
+ summary: "threadBulkActionsTrash",
1052
+ description: "Perform a bulk action of trashing an array of threads",
1053
+ tags: ["Threads"],
1054
+ requestBody: {
1055
+ required: true,
1056
+ content: {
1057
+ "application/json": {
1058
+ schema: {
1059
+ $ref: "#/components/schemas/BulkActionsPayload"
1060
+ }
1061
+ }
1062
+ }
1063
+ },
1064
+ responses: {
1065
+ "200": {
1066
+ description: "Success"
1067
+ },
1068
+ "403": {
1069
+ description: "Forbidden"
1070
+ }
1071
+ }
1072
+ }
1073
+ },
1074
+ "/v1/message/threads/bulk:untrash": {
1075
+ post: {
1076
+ operationId: "threadBulkActionsUntrash",
1077
+ summary: "threadBulkActionsUntrash",
1078
+ description: "Perform a bulk action of untrashing an array of threads",
1079
+ tags: ["Threads"],
1080
+ requestBody: {
1081
+ required: true,
1082
+ content: {
1083
+ "application/json": {
1084
+ schema: {
1085
+ $ref: "#/components/schemas/BulkActionsPayload"
1086
+ }
1087
+ }
1088
+ }
1089
+ },
1090
+ responses: {
1091
+ "200": {
1092
+ description: "Success"
1093
+ },
1094
+ "403": {
1095
+ description: "Forbidden"
1096
+ }
1097
+ }
1098
+ }
1099
+ },
1100
+ "/v1/message/threads/bulk:delete": {
1101
+ post: {
1102
+ operationId: "threadBulkActionsDelete",
1103
+ summary: "threadBulkActionsDelete",
1104
+ description: "Performs a bulk permanent delete for all threads",
1105
+ tags: ["Threads"],
1106
+ requestBody: {
1107
+ required: true,
1108
+ content: {
1109
+ "application/json": {
1110
+ schema: {
1111
+ $ref: "#/components/schemas/BulkActionsPayload"
1112
+ }
1113
+ }
1114
+ }
1115
+ },
1116
+ responses: {
1117
+ "200": {
1118
+ description: "Success"
1119
+ },
1120
+ "403": {
1121
+ description: "Forbidden"
1122
+ }
1123
+ }
1124
+ }
1125
+ },
1126
+ "/v1/message/threads/bulk:done": {
1127
+ post: {
1128
+ operationId: "threadBulkActionsDone",
1129
+ summary: "threadBulkActionsDone",
1130
+ description: "Perform a bulk action of marking an array of threads as done",
1131
+ tags: ["Threads"],
1132
+ requestBody: {
1133
+ required: true,
1134
+ content: {
1135
+ "application/json": {
1136
+ schema: {
1137
+ $ref: "#/components/schemas/BulkActionsPayload"
1138
+ }
1139
+ }
1140
+ }
1141
+ },
1142
+ responses: {
1143
+ "200": {
1144
+ description: "Success"
1145
+ },
1146
+ "403": {
1147
+ description: "Forbidden"
1148
+ }
1149
+ }
1150
+ }
1151
+ },
1152
+ "/v1/message/threads/bulk:open": {
1153
+ post: {
1154
+ operationId: "threadBulkActionsOpen",
1155
+ summary: "threadBulkActionsOpen",
1156
+ description: "Perform a bulk action of marking an array of threads as open",
1157
+ tags: ["Threads"],
1158
+ requestBody: {
1159
+ required: true,
1160
+ content: {
1161
+ "application/json": {
1162
+ schema: {
1163
+ $ref: "#/components/schemas/BulkActionsPayload"
1164
+ }
1165
+ }
1166
+ }
1167
+ },
1168
+ responses: {
1169
+ "200": {
1170
+ description: "Success"
1171
+ },
1172
+ "403": {
1173
+ description: "Forbidden"
1174
+ }
1175
+ }
1176
+ }
1177
+ },
1178
+ "/v1/message/threads/{id}/read": {
1179
+ post: {
1180
+ operationId: "markReadThread",
1181
+ summary: "markReadThread",
1182
+ description: "Mark thread as read",
1183
+ tags: ["Threads"],
1184
+ parameters: [
1185
+ {
1186
+ name: "id",
1187
+ description: "Thread ID",
1188
+ in: "path",
1189
+ required: true,
1190
+ schema: {
1191
+ type: "string"
1192
+ }
1193
+ }
1194
+ ],
1195
+ responses: {
1196
+ "200": {
1197
+ description: "Success"
1198
+ },
1199
+ "403": {
1200
+ description: "Forbidden"
1201
+ }
1202
+ }
1203
+ }
1204
+ },
1205
+ "/v2/message/threads/{id}/read": {
1206
+ post: {
1207
+ operationId: "markReadThreadV2",
1208
+ summary: "markReadThreadV2",
1209
+ description: "Mark thread as read within a scope",
1210
+ tags: ["Threads"],
1211
+ parameters: [
1212
+ {
1213
+ name: "id",
1214
+ description: "Thread ID",
1215
+ in: "path",
1216
+ required: true,
1217
+ schema: {
1218
+ type: "string"
1219
+ }
1220
+ }
1221
+ ],
1222
+ requestBody: {
1223
+ required: true,
1224
+ content: {
1225
+ "application/json": {
1226
+ schema: {
1227
+ $ref: "#/components/schemas/ReadMessagePayload"
1228
+ }
1229
+ }
1230
+ }
1231
+ },
1232
+ responses: {
1233
+ "200": {
1234
+ description: "Success"
1235
+ },
1236
+ "403": {
1237
+ description: "Forbidden"
1238
+ }
1239
+ }
1240
+ }
1241
+ },
1242
+ "/v1/message/threads/{id}/unread": {
1243
+ post: {
1244
+ operationId: "markUnreadThread",
1245
+ summary: "markUnreadThread",
1246
+ description: "Mark thread as unread",
1247
+ tags: ["Threads"],
1248
+ parameters: [
1249
+ {
1250
+ name: "id",
1251
+ description: "Thread ID",
1252
+ in: "path",
1253
+ required: true,
1254
+ schema: {
1255
+ type: "string"
1256
+ }
1257
+ }
1258
+ ],
1259
+ responses: {
1260
+ "200": {
1261
+ description: "Success"
1262
+ },
1263
+ "403": {
1264
+ description: "Forbidden"
1265
+ }
1266
+ }
1267
+ }
1268
+ },
1269
+ "/v2/message/threads/{id}/unread": {
1270
+ post: {
1271
+ operationId: "markUnreadThreadV2",
1272
+ summary: "markUnreadThreadV2",
1273
+ description: "Mark thread as unread within a scope",
1274
+ tags: ["Threads"],
1275
+ parameters: [
1276
+ {
1277
+ name: "id",
1278
+ description: "Thread ID",
1279
+ in: "path",
1280
+ required: true,
1281
+ schema: {
1282
+ type: "string"
1283
+ }
1284
+ }
1285
+ ],
1286
+ requestBody: {
1287
+ required: true,
1288
+ content: {
1289
+ "application/json": {
1290
+ schema: {
1291
+ $ref: "#/components/schemas/ReadMessagePayload"
1292
+ }
1293
+ }
1294
+ }
1295
+ },
1296
+ responses: {
1297
+ "200": {
1298
+ description: "Success"
1299
+ },
1300
+ "403": {
1301
+ description: "Forbidden"
1302
+ }
1303
+ }
1304
+ }
1305
+ },
1306
+ "/v1/message/threads/{id}/assign": {
1307
+ post: {
1308
+ operationId: "assignThread",
1309
+ summary: "assignThread",
1310
+ description: "Assign thread to entities",
1311
+ tags: ["Threads"],
1312
+ parameters: [
1313
+ {
1314
+ name: "id",
1315
+ description: "Thread ID",
1316
+ in: "path",
1317
+ required: true,
1318
+ schema: {
1319
+ type: "string"
1320
+ }
1321
+ }
1322
+ ],
1323
+ requestBody: {
1324
+ required: true,
1325
+ content: {
1326
+ "application/json": {
1327
+ schema: {
1328
+ description: "Entities which thread is assigned to",
1329
+ type: "array",
1330
+ items: {
1331
+ type: "object",
1332
+ properties: {
1333
+ slug: {
1334
+ description: "Entity slug",
1335
+ type: "string",
1336
+ example: "contact"
1337
+ },
1338
+ entity_id: {
1339
+ description: "Entity ID",
1340
+ type: "string",
1341
+ example: "3f34ce73-089c-4d45-a5ee-c161234e41c3"
1342
+ },
1343
+ org_id: {
1344
+ description: "Organization ID",
1345
+ type: "string",
1346
+ example: "206801"
1347
+ },
1348
+ is_main_entity: {
1349
+ description: "To indicate this is main entity",
1350
+ type: "boolean",
1351
+ example: true
1352
+ }
1353
+ }
1354
+ }
1355
+ }
1356
+ }
1357
+ }
1358
+ },
1359
+ responses: {
1360
+ "204": {
1361
+ description: "Success"
1362
+ },
1363
+ "403": {
1364
+ description: "Forbidden"
1365
+ }
1366
+ }
1367
+ }
1368
+ },
1369
+ "/v1/message/threads/{id}/unassign": {
1370
+ post: {
1371
+ operationId: "unassignThread",
1372
+ summary: "unassignThread",
1373
+ description: "Unassign thread from entities",
1374
+ tags: ["Threads"],
1375
+ parameters: [
1376
+ {
1377
+ name: "id",
1378
+ description: "Thread ID",
1379
+ in: "path",
1380
+ required: true,
1381
+ schema: {
1382
+ type: "string"
1383
+ }
1384
+ }
1385
+ ],
1386
+ requestBody: {
1387
+ required: true,
1388
+ content: {
1389
+ "application/json": {
1390
+ schema: {
1391
+ description: "Entities which thread is unassigned from",
1392
+ type: "array",
1393
+ items: {
1394
+ type: "object",
1395
+ properties: {
1396
+ slug: {
1397
+ description: "Entity slug",
1398
+ type: "string",
1399
+ example: "contact"
1400
+ },
1401
+ entity_id: {
1402
+ description: "Entity ID",
1403
+ type: "string",
1404
+ example: "3f34ce73-089c-4d45-a5ee-c161234e41c3"
1405
+ }
1406
+ }
1407
+ }
1408
+ }
1409
+ }
1410
+ }
1411
+ },
1412
+ responses: {
1413
+ "204": {
1414
+ description: "Success"
1415
+ },
1416
+ "403": {
1417
+ description: "Forbidden"
1418
+ }
1419
+ }
1420
+ }
1421
+ },
1422
+ "/v1/message/threads/{id}/assign:users": {
1423
+ post: {
1424
+ operationId: "assignUsers",
1425
+ summary: "assignUsers",
1426
+ description: "Assign users to thread for receiving notifications.\nThe operation replaces all existing assigned users in thread.\n",
1427
+ tags: ["Threads"],
1428
+ parameters: [
1429
+ {
1430
+ name: "id",
1431
+ description: "Thread ID",
1432
+ in: "path",
1433
+ required: true,
1434
+ schema: {
1435
+ type: "string"
1436
+ }
1437
+ }
1438
+ ],
1439
+ requestBody: {
1440
+ required: true,
1441
+ content: {
1442
+ "application/json": {
1443
+ schema: {
1444
+ description: "User IDs of users assigned to thread",
1445
+ type: "object",
1446
+ properties: {
1447
+ assigned_to: {
1448
+ type: "array",
1449
+ description: "IDs of users assigned to thread",
1450
+ items: {
1451
+ type: "string",
1452
+ example: "206801"
1453
+ }
1454
+ }
1455
+ }
1456
+ }
1457
+ }
1458
+ }
1459
+ },
1460
+ responses: {
1461
+ "204": {
1462
+ description: "Success"
1463
+ },
1464
+ "403": {
1465
+ description: "Forbidden"
1466
+ }
1467
+ }
1468
+ }
1469
+ },
1470
+ "/v2/message/threads/{id}/assign:users": {
1471
+ post: {
1472
+ operationId: "assignUsersV2",
1473
+ summary: "assignUsersV2",
1474
+ description: "Assign users to thread.\n",
1475
+ tags: ["Threads"],
1476
+ parameters: [
1477
+ {
1478
+ name: "id",
1479
+ description: "Thread ID",
1480
+ in: "path",
1481
+ required: true,
1482
+ schema: {
1483
+ type: "string"
1484
+ }
1485
+ }
1486
+ ],
1487
+ requestBody: {
1488
+ required: true,
1489
+ content: {
1490
+ "application/json": {
1491
+ schema: {
1492
+ type: "object",
1493
+ required: ["add", "remove"],
1494
+ properties: {
1495
+ add: {
1496
+ type: "array",
1497
+ description: "User IDs of users to add to thread",
1498
+ items: {
1499
+ type: "string",
1500
+ example: "206801"
1501
+ }
1502
+ },
1503
+ remove: {
1504
+ type: "array",
1505
+ description: "User IDs of users to remove from thread",
1506
+ items: {
1507
+ type: "string",
1508
+ example: "206801"
1509
+ }
1510
+ }
1511
+ }
1512
+ }
1513
+ }
1514
+ }
1515
+ },
1516
+ responses: {
1517
+ "204": {
1518
+ description: "Success"
1519
+ },
1520
+ "403": {
1521
+ description: "Forbidden"
1522
+ }
1523
+ }
1524
+ }
1525
+ },
1526
+ "/v1/message/threads/{id}:pin": {
1527
+ post: {
1528
+ operationId: "pinThread",
1529
+ summary: "Pin a single thread",
1530
+ description: "Pin a single thread",
1531
+ tags: ["Threads"],
1532
+ parameters: [
1533
+ {
1534
+ name: "id",
1535
+ description: "Thread ID",
1536
+ in: "path",
1537
+ required: true,
1538
+ schema: {
1539
+ type: "string"
1540
+ }
1541
+ }
1542
+ ],
1543
+ responses: {
1544
+ "204": {
1545
+ description: "Success"
1546
+ },
1547
+ "400": {
1548
+ description: "Bad request"
1549
+ },
1550
+ "404": {
1551
+ description: "Thread not found"
1552
+ },
1553
+ "409": {
1554
+ description: "Concurrent update error"
1555
+ },
1556
+ "500": {
1557
+ description: "Internal server error"
1558
+ }
1559
+ }
1560
+ },
1561
+ delete: {
1562
+ operationId: "unpinThread",
1563
+ summary: "Unpin a single thread",
1564
+ description: "Unpin a single thread",
1565
+ tags: ["Threads"],
1566
+ parameters: [
1567
+ {
1568
+ name: "id",
1569
+ description: "Thread ID",
1570
+ in: "path",
1571
+ required: true,
1572
+ schema: {
1573
+ type: "string"
1574
+ }
1575
+ }
1576
+ ],
1577
+ responses: {
1578
+ "204": {
1579
+ description: "Success"
1580
+ },
1581
+ "400": {
1582
+ description: "Bad request"
1583
+ },
1584
+ "404": {
1585
+ description: "Thread not found"
1586
+ },
1587
+ "409": {
1588
+ description: "Concurrent update error"
1589
+ },
1590
+ "500": {
1591
+ description: "Internal server error"
1592
+ }
1593
+ }
1594
+ }
1595
+ },
1596
+ "/v1/message/drafts": {
1597
+ post: {
1598
+ operationId: "createDraft",
1599
+ summary: "createDraft",
1600
+ description: "Create a new draft",
1601
+ tags: ["Drafts"],
1602
+ requestBody: {
1603
+ content: {
1604
+ "application/json": {
1605
+ schema: {
1606
+ $ref: "#/components/schemas/MessageRequestParams"
1607
+ }
1608
+ }
1609
+ }
1610
+ },
1611
+ responses: {
1612
+ "201": {
1613
+ description: "Success",
1614
+ content: {
1615
+ "application/json": {
1616
+ schema: {
1617
+ allOf: [
1618
+ {
1619
+ $ref: "#/components/schemas/BaseEntity"
1620
+ },
1621
+ {
1622
+ $ref: "#/components/schemas/Message"
1623
+ }
1624
+ ]
1625
+ }
1626
+ }
1627
+ }
1628
+ },
1629
+ "403": {
1630
+ description: "Forbidden"
1631
+ }
1632
+ }
1633
+ }
1634
+ },
1635
+ "/v1/message/drafts:send": {
1636
+ post: {
1637
+ operationId: "sendDraft",
1638
+ summary: "sendDraft",
1639
+ description: "Send the existing draft to the recipients",
1640
+ tags: ["Drafts"],
1641
+ responses: {
1642
+ "201": {
1643
+ description: "Success",
1644
+ content: {
1645
+ "application/json": {
1646
+ schema: {
1647
+ allOf: [
1648
+ {
1649
+ $ref: "#/components/schemas/BaseEntity"
1650
+ },
1651
+ {
1652
+ $ref: "#/components/schemas/Message"
1653
+ }
1654
+ ]
1655
+ }
1656
+ }
1657
+ }
1658
+ },
1659
+ "403": {
1660
+ description: "Forbidden"
1661
+ }
1662
+ }
1663
+ }
1664
+ },
1665
+ "/v2/message/messages/{id}": {
1666
+ get: {
1667
+ operationId: "getMessageV2",
1668
+ summary: "getMessageV2",
1669
+ description: '- Fetches message by ID\n- If the message html is omitted on the entity, then it keeps the content on the message as a signed url\n {\n ...\n _id: "4d74976d-fb64-47fd-85e2-65eea140f5eb",\n _schema: "message",\n _org: "org-123",\n html_omitted: true,\n html_download_url: "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html"\n }\n',
1670
+ tags: ["Messages"],
1671
+ parameters: [
1672
+ {
1673
+ name: "id",
1674
+ description: "Message ID",
1675
+ in: "path",
1676
+ required: true,
1677
+ schema: {
1678
+ type: "string",
1679
+ example: "4d74976d-fb64-47fd-85e2-65eea140f5eb"
1680
+ }
1681
+ }
1682
+ ],
1683
+ responses: {
1684
+ "200": {
1685
+ description: "Success",
1686
+ content: {
1687
+ "application/json": {
1688
+ schema: {
1689
+ allOf: [
1690
+ {
1691
+ $ref: "#/components/schemas/MessageV2"
1692
+ }
1693
+ ]
1694
+ }
1695
+ }
1696
+ }
1697
+ },
1698
+ "403": {
1699
+ description: "Forbidden"
1700
+ }
1701
+ }
1702
+ }
1703
+ }
1704
+ };
1705
+ var components = {
1706
+ responses: {
1707
+ NotFound: {
1708
+ description: "Not found",
1709
+ content: {
1710
+ "application/json": {
1711
+ schema: {
1712
+ $ref: "#/components/schemas/ErrorResponse"
1713
+ }
1714
+ }
1715
+ }
1716
+ },
1717
+ Conflict: {
1718
+ description: "Conflict",
1719
+ content: {
1720
+ "application/json": {
1721
+ schema: {
1722
+ $ref: "#/components/schemas/ErrorResponse"
1723
+ }
1724
+ }
1725
+ }
1726
+ },
1727
+ InternalServerError: {
1728
+ description: "Internal server error",
1729
+ content: {
1730
+ "application/json": {
1731
+ schema: {
1732
+ $ref: "#/components/schemas/ErrorResponse"
1733
+ }
1734
+ }
1735
+ }
1736
+ },
1737
+ BadRequest: {
1738
+ description: "Bad request",
1739
+ content: {
1740
+ "application/json": {
1741
+ schema: {
1742
+ $ref: "#/components/schemas/ErrorResponse"
1743
+ }
1744
+ }
1745
+ }
1746
+ },
1747
+ Forbidden: {
1748
+ description: "Forbidden",
1749
+ content: {
1750
+ "application/json": {
1751
+ schema: {
1752
+ $ref: "#/components/schemas/ErrorResponse"
1753
+ }
1754
+ }
1755
+ }
1756
+ }
1757
+ },
1758
+ securitySchemes: {
1759
+ EpilotAuth: {
1760
+ type: "http",
1761
+ scheme: "bearer",
1762
+ description: "Authorization header with epilot OAuth2 bearer token",
1763
+ bearerFormat: "JWT"
1764
+ },
1765
+ EpilotOrg: {
1766
+ description: "Overrides the target organization to allow shared tenant access",
1767
+ name: "x-epilot-org-id",
1768
+ in: "header",
1769
+ type: "apiKey"
1770
+ }
1771
+ },
1772
+ schemas: {
1773
+ ErrorResponse: {
1774
+ type: "object",
1775
+ properties: {
1776
+ error: {
1777
+ type: "string",
1778
+ description: "Error message",
1779
+ example: "Thread not found"
1780
+ }
1781
+ }
1782
+ },
1783
+ MoveThreadPayload: {
1784
+ type: "object",
1785
+ required: ["inbox_id"],
1786
+ properties: {
1787
+ inbox_id: {
1788
+ type: "string",
1789
+ description: "Inbox ID",
1790
+ example: "3f34ce73-089c-4d45-a5ee-c161234e41c3"
1791
+ }
1792
+ }
1793
+ },
1794
+ BaseEntity: {
1795
+ type: "object",
1796
+ required: ["_id", "_title", "_org", "_schema", "_created_at", "_updated_at"],
1797
+ properties: {
1798
+ _id: {
1799
+ type: "string",
1800
+ description: "Entity ID",
1801
+ example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
1802
+ },
1803
+ _title: {
1804
+ type: "string",
1805
+ description: "Entity title"
1806
+ },
1807
+ _org: {
1808
+ type: "string",
1809
+ description: "Organization ID the entity belongs to",
1810
+ example: "206801"
1811
+ },
1812
+ _schema: {
1813
+ type: "string",
1814
+ description: "URL-friendly identifier for the entity schema",
1815
+ example: "message"
1816
+ },
1817
+ _tags: {
1818
+ type: "array",
1819
+ description: "Entity tags",
1820
+ items: {
1821
+ type: "string"
1822
+ },
1823
+ example: ["pricing", "INBOX"]
1824
+ },
1825
+ _created_at: {
1826
+ type: "string",
1827
+ description: "Created date",
1828
+ format: "date-time",
1829
+ example: "2021-02-09T12:41:43.662Z"
1830
+ },
1831
+ _updated_at: {
1832
+ type: "string",
1833
+ description: "Updated date",
1834
+ format: "date-time",
1835
+ example: "2021-02-10T09:14:31.990Z"
1836
+ }
1837
+ }
1838
+ },
1839
+ Thread: {
1840
+ description: "Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.",
1841
+ required: ["topic"],
1842
+ properties: {
1843
+ topic: {
1844
+ type: "string",
1845
+ description: "Message topic (e.g. which service sends the message or message category)",
1846
+ example: "CUSTOMER_MESSAGE"
1847
+ },
1848
+ assigned_to: {
1849
+ type: "array",
1850
+ description: "User ID of who the message is assigned to. Default is the user who sends message.",
1851
+ items: {
1852
+ type: "string"
1853
+ },
1854
+ example: ["206801", "200109"]
1855
+ },
1856
+ org_read_message: {
1857
+ type: "array",
1858
+ description: "Organization ID of organization read the message.",
1859
+ items: {
1860
+ type: "string"
1861
+ },
1862
+ example: ["789372", "210291"]
1863
+ },
1864
+ done: {
1865
+ type: "boolean",
1866
+ description: "Whether the thread is marked as Done",
1867
+ example: false
1868
+ },
1869
+ latest_message: {
1870
+ $ref: "#/components/schemas/Message"
1871
+ },
1872
+ latest_trash_message: {
1873
+ $ref: "#/components/schemas/Message"
1874
+ },
1875
+ latest_message_at: {
1876
+ type: "string",
1877
+ description: "The date of the latest message time in the thread",
1878
+ example: "2024-02-10T09:14:31.990Z"
1879
+ }
1880
+ }
1881
+ },
1882
+ Message: {
1883
+ type: "object",
1884
+ required: ["subject", "from"],
1885
+ properties: {
1886
+ message_id: {
1887
+ type: "string",
1888
+ description: "Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.",
1889
+ example: "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>"
1890
+ },
1891
+ sender: {
1892
+ type: "string",
1893
+ description: "User ID of user sends the message.",
1894
+ example: "206801"
1895
+ },
1896
+ subject: {
1897
+ type: "string",
1898
+ description: "Subject",
1899
+ example: "Request for solar panel price"
1900
+ },
1901
+ html: {
1902
+ type: "string",
1903
+ description: "HTML body",
1904
+ example: "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
1905
+ },
1906
+ text: {
1907
+ type: "string",
1908
+ description: "Text body",
1909
+ example: "We at ABC GmbH would like to request a price quote for the solar panel."
1910
+ },
1911
+ from: {
1912
+ $ref: "#/components/schemas/Address"
1913
+ },
1914
+ reply_to: {
1915
+ $ref: "#/components/schemas/Address"
1916
+ },
1917
+ to: {
1918
+ type: "array",
1919
+ description: "To email addresses",
1920
+ items: {
1921
+ $ref: "#/components/schemas/Address"
1922
+ }
1923
+ },
1924
+ cc: {
1925
+ type: "array",
1926
+ description: "Cc email addresses",
1927
+ items: {
1928
+ $ref: "#/components/schemas/Address"
1929
+ }
1930
+ },
1931
+ bcc: {
1932
+ type: "array",
1933
+ description: "Bcc email addresses",
1934
+ items: {
1935
+ $ref: "#/components/schemas/Address"
1936
+ }
1937
+ },
1938
+ file: {
1939
+ $ref: "#/components/schemas/AttachmentsRelation"
1940
+ },
1941
+ references: {
1942
+ type: "string",
1943
+ description: "References header. Value is the series of `message_id` which is reparated by space to indicate that message has parent. The last message ID in references identifies the parent. The first message ID in references identifies the first message in the thread. The basic idea is that sender should copy `references` from the parent and append the parent's `message_id` when replying.\n",
1944
+ example: "<0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
1945
+ },
1946
+ in_reply_to: {
1947
+ type: "string",
1948
+ description: "In-Reply-To header. Value is the `message_id` of parent message.\n",
1949
+ example: "<CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>"
1950
+ },
1951
+ user_read_message: {
1952
+ type: "array",
1953
+ description: "User ID of user read the message.",
1954
+ items: {
1955
+ type: "string"
1956
+ },
1957
+ example: ["206801", "200109"]
1958
+ },
1959
+ org_read_message: {
1960
+ type: "array",
1961
+ description: "Organization ID of organization read the message.",
1962
+ items: {
1963
+ type: "string"
1964
+ },
1965
+ example: ["789372", "210291"]
1966
+ },
1967
+ send_status: {
1968
+ type: "array",
1969
+ description: "Sent message status. The array contains sending message status corresponding to all recipients. For more detail, check `send_status` of each recipient in `to`, `cc`, `bcc` Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
1970
+ items: {
1971
+ type: "string",
1972
+ enum: ["SEND", "DELIVERY", "REJECT", "COMPLAINT", "BOUNCE", "ERROR"]
1973
+ }
1974
+ },
1975
+ type: {
1976
+ type: "string",
1977
+ description: "Message type",
1978
+ enum: ["SENT", "RECEIVED"]
1979
+ },
1980
+ template_id: {
1981
+ type: "string",
1982
+ description: "Template ID used for sending message.",
1983
+ example: "3f34ce73-089c-4d45-a5ee-c161234e41c3"
1984
+ }
1985
+ }
1986
+ },
1987
+ MessageV2: {
1988
+ allOf: [
1989
+ {
1990
+ $ref: "#/components/schemas/BaseEntity"
1991
+ },
1992
+ {
1993
+ $ref: "#/components/schemas/Message"
1994
+ }
1995
+ ],
1996
+ properties: {
1997
+ html_omitted: {
1998
+ type: "boolean",
1999
+ description: "If true then html is not provided and must be downloaded using the html_download_url",
2000
+ default: false
2001
+ },
2002
+ html_download_url: {
2003
+ type: "string",
2004
+ description: "HTML body download URL",
2005
+ example: "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html"
2006
+ }
2007
+ }
2008
+ },
2009
+ Address: {
2010
+ type: "object",
2011
+ required: ["address"],
2012
+ properties: {
2013
+ name: {
2014
+ type: "string",
2015
+ description: "Email address alias",
2016
+ example: "epilot"
2017
+ },
2018
+ address: {
2019
+ type: "string",
2020
+ description: "Email address",
2021
+ example: "messaging@epilot.cloud"
2022
+ },
2023
+ email_type: {
2024
+ type: "string",
2025
+ description: "Type of the email, Internal (360 Agents), Partners, External users(Customers)\n",
2026
+ nullable: true,
2027
+ enum: ["INTERNAL", "EXTERNAL", "PARTNER"]
2028
+ },
2029
+ send_status: {
2030
+ type: "string",
2031
+ description: "Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>\n",
2032
+ enum: ["SEND", "DELIVERY", "REJECT", "COMPLAINT", "BOUNCE", "ERROR"]
2033
+ },
2034
+ send_error: {
2035
+ type: "object",
2036
+ description: "Information about reject, complaint or bounce event. Only available if `send_status` is REJECT, COMPLAINT, BOUNCE or ERROR. JSON object is defined by AWS SES. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/notification-contents.html>\n"
2037
+ }
2038
+ }
2039
+ },
2040
+ AttachmentsRelation: {
2041
+ type: "object",
2042
+ description: "Message attachments",
2043
+ properties: {
2044
+ $relation: {
2045
+ type: "array",
2046
+ description: "It's normal entity relation with some additional properties for sending message attachment.",
2047
+ items: {
2048
+ $ref: "#/components/schemas/File"
2049
+ }
2050
+ }
2051
+ }
2052
+ },
2053
+ File: {
2054
+ type: "object",
2055
+ required: ["entity_id"],
2056
+ properties: {
2057
+ entity_id: {
2058
+ type: "string",
2059
+ description: "File entity ID",
2060
+ example: "f820ce3b-07b0-45ae-bcc6-babb2f53f79f"
2061
+ },
2062
+ filename: {
2063
+ type: "string",
2064
+ description: "File name",
2065
+ example: "Produktinformationen_epilot360_Double_Opt_in.pdf"
2066
+ },
2067
+ is_message_attachment: {
2068
+ type: "boolean",
2069
+ description: "To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation."
2070
+ },
2071
+ may_be_signature_attachment: {
2072
+ type: "boolean",
2073
+ description: "To indicate this file relation may be signature attachment. If true then this file will be sent as signature attachment and not related to any entity."
2074
+ },
2075
+ cid: {
2076
+ type: "string",
2077
+ description: "Content ID (for inline)",
2078
+ example: "fb222496-a1a5-4639-94f2-07b5e35e4068"
2079
+ },
2080
+ inline: {
2081
+ type: "boolean",
2082
+ description: "If true then this attachment should not be offered for download (at least not in the main attachments list). The usecase is CID embedded image (aka inline image).\n",
2083
+ default: false
2084
+ },
2085
+ send_as_link: {
2086
+ type: "boolean",
2087
+ description: "If true then this attachment is sent via link. The link have to be inserted to email body by API caller. In this case, service doesn't process this attachment.\n",
2088
+ default: false
2089
+ }
2090
+ }
2091
+ },
2092
+ MessageRequestParams: {
2093
+ required: ["subject", "from"],
2094
+ additionalProperties: true,
2095
+ properties: {
2096
+ complete_thread: {
2097
+ type: "boolean",
2098
+ description: "Whether the thread is marked as Done immediately after sending the message",
2099
+ default: false
2100
+ },
2101
+ thread: {
2102
+ type: "object",
2103
+ required: ["topic"],
2104
+ description: "Open new thread when sending the very first message in conversation. Thread should contains context related to all messages in it (eg. topic, brand_id, opportunity_id, assigned_to,...). Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing. `thread` or `parent_id` must be provided either.\n",
2105
+ properties: {
2106
+ topic: {
2107
+ type: "string",
2108
+ description: "Message topic (e.g. which service sends the message or message category)"
2109
+ },
2110
+ assigned_to: {
2111
+ type: "array",
2112
+ description: "User ID of who the message is assigned to. Default is the user who sends message.",
2113
+ items: {
2114
+ type: "string"
2115
+ }
2116
+ }
2117
+ },
2118
+ example: {
2119
+ topic: "CUSTOMER_MESSAGE",
2120
+ assigned_to: ["206801", "200109"],
2121
+ opportunity_id: 829072
2122
+ }
2123
+ },
2124
+ parent_id: {
2125
+ type: "string",
2126
+ description: "Entity ID of parent message which this message replies to or forwards from. If both `parent_id` and `thread` are provided, `thread` is discarded.\n",
2127
+ example: "44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2"
2128
+ },
2129
+ subject: {
2130
+ type: "string",
2131
+ description: "Subject",
2132
+ example: "Request for solar panel price"
2133
+ },
2134
+ html: {
2135
+ type: "string",
2136
+ description: "HTML body",
2137
+ example: "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>"
2138
+ },
2139
+ text: {
2140
+ type: "string",
2141
+ description: "Text body. If not provided, text body is converted from HTML body using [html-to-text](https://www.npmjs.com/package/html-to-text)",
2142
+ example: "We at ABC GmbH would like to request a price quote for the solar panel."
2143
+ },
2144
+ from: {
2145
+ $ref: "#/components/schemas/Address"
2146
+ },
2147
+ reply_to: {
2148
+ $ref: "#/components/schemas/Address"
2149
+ },
2150
+ to: {
2151
+ type: "array",
2152
+ description: "To email addresses",
2153
+ items: {
2154
+ $ref: "#/components/schemas/Address"
2155
+ }
2156
+ },
2157
+ cc: {
2158
+ type: "array",
2159
+ description: "Cc email addresses",
2160
+ items: {
2161
+ $ref: "#/components/schemas/Address"
2162
+ }
2163
+ },
2164
+ bcc: {
2165
+ type: "array",
2166
+ description: "Bcc email addresses",
2167
+ items: {
2168
+ $ref: "#/components/schemas/Address"
2169
+ }
2170
+ },
2171
+ file: {
2172
+ $ref: "#/components/schemas/AttachmentsRelation"
2173
+ },
2174
+ template_id: {
2175
+ type: "string",
2176
+ description: "Template ID used for sending message.",
2177
+ example: "3f34ce73-089c-4d45-a5ee-c161234e41c3"
2178
+ }
2179
+ }
2180
+ },
2181
+ SearchParamsV2: {
2182
+ type: "object",
2183
+ required: ["q"],
2184
+ properties: {
2185
+ inbox_id: {
2186
+ oneOf: [
2187
+ {
2188
+ type: "string",
2189
+ description: "Inbox ID",
2190
+ example: "3f34ce73-089c-4d45-a5ee-c161234e41c3"
2191
+ },
2192
+ {
2193
+ type: "array",
2194
+ items: {
2195
+ type: "string"
2196
+ },
2197
+ description: "Inbox IDs",
2198
+ example: ["3f34ce73-089c-4d45-a5ee-c161234e41c3", "3f34ce73-089c-4d45-a5ee-c161234e41c4"]
2199
+ }
2200
+ ]
2201
+ },
2202
+ q: {
2203
+ description: "Lucene query syntax supported with ElasticSearch",
2204
+ type: "string",
2205
+ example: 'subject:"Request for solar panel price" AND _tags:INBOX'
2206
+ },
2207
+ fields: {
2208
+ $ref: "#/components/schemas/FieldsParam"
2209
+ },
2210
+ from: {
2211
+ type: "integer",
2212
+ minimum: 0,
2213
+ default: 0
2214
+ },
2215
+ size: {
2216
+ type: "integer",
2217
+ minimum: 1,
2218
+ default: 10
2219
+ },
2220
+ hydrate: {
2221
+ type: "boolean",
2222
+ default: false
2223
+ },
2224
+ include_scores: {
2225
+ type: "boolean",
2226
+ default: false
2227
+ },
2228
+ sort: {
2229
+ type: "string"
2230
+ },
2231
+ highlight: {}
2232
+ }
2233
+ },
2234
+ SearchParams: {
2235
+ type: "object",
2236
+ required: ["q"],
2237
+ properties: {
2238
+ q: {
2239
+ description: "Lucene query syntax supported with ElasticSearch",
2240
+ type: "string",
2241
+ example: 'subject:"Request for solar panel price" AND _tags:INBOX'
2242
+ },
2243
+ from: {
2244
+ type: "integer",
2245
+ minimum: 0,
2246
+ default: 0
2247
+ },
2248
+ size: {
2249
+ type: "integer",
2250
+ minimum: 1,
2251
+ default: 10
2252
+ },
2253
+ hydrate: {
2254
+ type: "boolean",
2255
+ default: false
2256
+ }
2257
+ }
2258
+ },
2259
+ SearchIDParams: {
2260
+ type: "object",
2261
+ properties: {
2262
+ q: {
2263
+ description: "Lucene query syntax supported with ElasticSearch",
2264
+ type: "string",
2265
+ example: 'subject:"Request for solar panel price" AND _tags:INBOX'
2266
+ }
2267
+ }
2268
+ },
2269
+ ReadMessagePayload: {
2270
+ type: "object",
2271
+ required: ["scopes"],
2272
+ properties: {
2273
+ scopes: {
2274
+ description: "The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.",
2275
+ example: ["organization", "user"],
2276
+ type: "array",
2277
+ default: ["organization", "user"],
2278
+ items: {
2279
+ $ref: "#/components/schemas/ReadingScope"
2280
+ }
2281
+ }
2282
+ }
2283
+ },
2284
+ ReadingScope: {
2285
+ description: "Who is marking an item as read or unread.",
2286
+ type: "string",
2287
+ enum: ["organization", "user"]
2288
+ },
2289
+ ThreadTimeline: {
2290
+ type: "object",
2291
+ required: ["events"],
2292
+ properties: {
2293
+ events: {
2294
+ type: "array",
2295
+ items: {
2296
+ $ref: "#/components/schemas/TimelineEvent"
2297
+ }
2298
+ }
2299
+ }
2300
+ },
2301
+ ThreadDoneEvent: {
2302
+ type: "object",
2303
+ required: ["type", "user_id", "organization_id"],
2304
+ properties: {
2305
+ type: {
2306
+ type: "string",
2307
+ enum: ["THREAD_DONE"]
2308
+ },
2309
+ user_id: {
2310
+ type: "string",
2311
+ description: "User ID of the user who marked the thread as done",
2312
+ example: "123"
2313
+ },
2314
+ organization_id: {
2315
+ type: "string",
2316
+ description: "Organization ID of the organization who marked the thread as done",
2317
+ example: "456"
2318
+ }
2319
+ }
2320
+ },
2321
+ ThreadOpenEvent: {
2322
+ type: "object",
2323
+ required: ["type", "user_id", "organization_id"],
2324
+ properties: {
2325
+ type: {
2326
+ type: "string",
2327
+ enum: ["THREAD_OPEN"]
2328
+ },
2329
+ user_id: {
2330
+ type: "string",
2331
+ description: "User ID of the user who marked the thread as open",
2332
+ example: "123"
2333
+ },
2334
+ organization_id: {
2335
+ type: "string",
2336
+ description: "Organization ID of the organization who marked the thread as open",
2337
+ example: "456"
2338
+ }
2339
+ }
2340
+ },
2341
+ TimelineEventData: {
2342
+ type: "object",
2343
+ discriminator: {
2344
+ propertyName: "type"
2345
+ },
2346
+ oneOf: [
2347
+ {
2348
+ $ref: "#/components/schemas/ThreadDoneEvent"
2349
+ },
2350
+ {
2351
+ $ref: "#/components/schemas/ThreadOpenEvent"
2352
+ }
2353
+ ]
2354
+ },
2355
+ TimelineEvent: {
2356
+ type: "object",
2357
+ required: ["timestamp", "data"],
2358
+ properties: {
2359
+ data: {
2360
+ $ref: "#/components/schemas/TimelineEventData"
2361
+ },
2362
+ timestamp: {
2363
+ type: "string",
2364
+ description: "Timestamp of the event",
2365
+ example: "2024-01-01T00:00:00.000Z"
2366
+ }
2367
+ }
2368
+ },
2369
+ BulkActionsPayloadWithScopes: {
2370
+ allOf: [
2371
+ {
2372
+ $ref: "#/components/schemas/BulkActionsPayload"
2373
+ },
2374
+ {
2375
+ type: "object",
2376
+ properties: {
2377
+ scopes: {
2378
+ description: "The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.",
2379
+ example: ["organization", "user"],
2380
+ type: "array",
2381
+ default: ["organization", "user"],
2382
+ items: {
2383
+ $ref: "#/components/schemas/ReadingScope"
2384
+ }
2385
+ }
2386
+ }
2387
+ }
2388
+ ]
2389
+ },
2390
+ BulkActionsPayload: {
2391
+ type: "object",
2392
+ required: ["ids"],
2393
+ properties: {
2394
+ ids: {
2395
+ description: "Array of threads you wish to perform bulk actions on",
2396
+ example: ["6b299eda-4018-4554-8965-c4b5598e6531"],
2397
+ type: "array",
2398
+ items: {
2399
+ type: "string"
2400
+ }
2401
+ }
2402
+ }
2403
+ },
2404
+ FieldsParam: {
2405
+ type: "array",
2406
+ description: "List 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",
2407
+ items: {
2408
+ type: "string"
2409
+ },
2410
+ example: ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]
2411
+ }
2412
+ }
2413
+ };
2414
+ var servers = [
2415
+ {
2416
+ url: "https://message.sls.epilot.io"
2417
+ }
2418
+ ];
2419
+ var message_default = {
2420
+ openapi,
2421
+ info,
2422
+ security,
2423
+ tags,
2424
+ "x-tagGroups": [
2425
+ {
2426
+ name: "APIs",
2427
+ tags: ["Messages", "Threads", "Drafts"]
2428
+ },
2429
+ {
2430
+ name: "Schemas",
2431
+ tags: ["message_schema", "thread_schema"]
2432
+ }
2433
+ ],
2434
+ paths,
2435
+ components,
2436
+ servers
2437
+ };
2438
+ export {
2439
+ components,
2440
+ message_default as default,
2441
+ info,
2442
+ openapi,
2443
+ paths,
2444
+ security,
2445
+ servers,
2446
+ tags
2447
+ };