@epilot/sdk 2.4.2 → 2.4.4-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (364) hide show
  1. package/README.md +1 -0
  2. package/definitions/app-runtime.json +1 -1
  3. package/definitions/app.json +346 -10
  4. package/definitions/automation.json +42 -0
  5. package/definitions/calendar-runtime.json +1 -0
  6. package/definitions/calendar.json +675 -0
  7. package/definitions/customer-portal.json +29 -0
  8. package/definitions/notes.json +175 -130
  9. package/definitions/pricing-runtime.json +1 -1
  10. package/definitions/pricing.json +163 -84
  11. package/dist/README-46VYEGGW.js +7 -0
  12. package/dist/README-IVBISSWB.cjs +7 -0
  13. package/dist/{_index-HE4B6FOA.js → _index-5FB6F5YY.js} +3 -0
  14. package/dist/{_index-55HAH24D.cjs → _index-DB2VV4PQ.cjs} +4 -1
  15. package/dist/apis/_registry.d.ts +8 -0
  16. package/dist/apis/access-token.cjs +6 -6
  17. package/dist/apis/access-token.d.ts +9 -12
  18. package/dist/apis/access-token.js +1 -1
  19. package/dist/apis/address-suggestions.cjs +6 -6
  20. package/dist/apis/address-suggestions.d.ts +9 -12
  21. package/dist/apis/address-suggestions.js +1 -1
  22. package/dist/apis/address.cjs +6 -6
  23. package/dist/apis/address.d.ts +9 -12
  24. package/dist/apis/address.js +1 -1
  25. package/dist/apis/ai-agents.cjs +6 -6
  26. package/dist/apis/ai-agents.d.ts +9 -12
  27. package/dist/apis/ai-agents.js +1 -1
  28. package/dist/apis/app.cjs +6 -6
  29. package/dist/apis/app.d.ts +9 -12
  30. package/dist/apis/app.js +1 -1
  31. package/dist/apis/audit-logs.cjs +6 -6
  32. package/dist/apis/audit-logs.d.ts +9 -12
  33. package/dist/apis/audit-logs.js +1 -1
  34. package/dist/apis/automation.cjs +6 -6
  35. package/dist/apis/automation.d.ts +9 -12
  36. package/dist/apis/automation.js +1 -1
  37. package/dist/apis/billing.cjs +6 -6
  38. package/dist/apis/billing.d.ts +9 -12
  39. package/dist/apis/billing.js +1 -1
  40. package/dist/apis/blueprint-manifest.cjs +6 -6
  41. package/dist/apis/blueprint-manifest.d.ts +9 -12
  42. package/dist/apis/blueprint-manifest.js +1 -1
  43. package/dist/apis/calendar.cjs +38 -0
  44. package/dist/apis/calendar.d.ts +15 -0
  45. package/dist/apis/calendar.js +38 -0
  46. package/dist/apis/configuration-hub.cjs +6 -6
  47. package/dist/apis/configuration-hub.d.ts +9 -12
  48. package/dist/apis/configuration-hub.js +1 -1
  49. package/dist/apis/consent.cjs +6 -6
  50. package/dist/apis/consent.d.ts +9 -12
  51. package/dist/apis/consent.js +1 -1
  52. package/dist/apis/customer-portal.cjs +6 -6
  53. package/dist/apis/customer-portal.d.ts +9 -12
  54. package/dist/apis/customer-portal.js +1 -1
  55. package/dist/apis/dashboard.cjs +6 -6
  56. package/dist/apis/dashboard.d.ts +9 -12
  57. package/dist/apis/dashboard.js +1 -1
  58. package/dist/apis/data-governance.cjs +6 -6
  59. package/dist/apis/data-governance.d.ts +9 -12
  60. package/dist/apis/data-governance.js +1 -1
  61. package/dist/apis/deduplication.cjs +6 -6
  62. package/dist/apis/deduplication.d.ts +9 -12
  63. package/dist/apis/deduplication.js +1 -1
  64. package/dist/apis/design.cjs +6 -6
  65. package/dist/apis/design.d.ts +9 -12
  66. package/dist/apis/design.js +1 -1
  67. package/dist/apis/document.cjs +6 -6
  68. package/dist/apis/document.d.ts +9 -12
  69. package/dist/apis/document.js +1 -1
  70. package/dist/apis/email-settings.cjs +6 -6
  71. package/dist/apis/email-settings.d.ts +9 -12
  72. package/dist/apis/email-settings.js +1 -1
  73. package/dist/apis/email-template.cjs +6 -6
  74. package/dist/apis/email-template.d.ts +9 -12
  75. package/dist/apis/email-template.js +1 -1
  76. package/dist/apis/entity-mapping.cjs +6 -6
  77. package/dist/apis/entity-mapping.d.ts +9 -12
  78. package/dist/apis/entity-mapping.js +1 -1
  79. package/dist/apis/entity.cjs +6 -6
  80. package/dist/apis/entity.d.ts +9 -12
  81. package/dist/apis/entity.js +1 -1
  82. package/dist/apis/environments.cjs +6 -6
  83. package/dist/apis/environments.d.ts +9 -12
  84. package/dist/apis/environments.js +1 -1
  85. package/dist/apis/event-catalog.cjs +6 -6
  86. package/dist/apis/event-catalog.d.ts +9 -12
  87. package/dist/apis/event-catalog.js +1 -1
  88. package/dist/apis/file.cjs +6 -6
  89. package/dist/apis/file.d.ts +9 -12
  90. package/dist/apis/file.js +1 -1
  91. package/dist/apis/iban.cjs +6 -6
  92. package/dist/apis/iban.d.ts +9 -12
  93. package/dist/apis/iban.js +1 -1
  94. package/dist/apis/integration-toolkit.cjs +6 -6
  95. package/dist/apis/integration-toolkit.d.ts +9 -12
  96. package/dist/apis/integration-toolkit.js +1 -1
  97. package/dist/apis/journey.cjs +6 -6
  98. package/dist/apis/journey.d.ts +9 -12
  99. package/dist/apis/journey.js +1 -1
  100. package/dist/apis/kanban.cjs +6 -6
  101. package/dist/apis/kanban.d.ts +9 -12
  102. package/dist/apis/kanban.js +1 -1
  103. package/dist/apis/message.cjs +6 -6
  104. package/dist/apis/message.d.ts +9 -12
  105. package/dist/apis/message.js +1 -1
  106. package/dist/apis/metering.cjs +6 -6
  107. package/dist/apis/metering.d.ts +9 -12
  108. package/dist/apis/metering.js +1 -1
  109. package/dist/apis/notes.cjs +6 -6
  110. package/dist/apis/notes.d.ts +9 -12
  111. package/dist/apis/notes.js +1 -1
  112. package/dist/apis/notification.cjs +6 -6
  113. package/dist/apis/notification.d.ts +9 -12
  114. package/dist/apis/notification.js +1 -1
  115. package/dist/apis/organization.cjs +6 -6
  116. package/dist/apis/organization.d.ts +9 -12
  117. package/dist/apis/organization.js +1 -1
  118. package/dist/apis/partner-directory.cjs +6 -6
  119. package/dist/apis/partner-directory.d.ts +9 -12
  120. package/dist/apis/partner-directory.js +1 -1
  121. package/dist/apis/permissions.cjs +6 -6
  122. package/dist/apis/permissions.d.ts +9 -12
  123. package/dist/apis/permissions.js +1 -1
  124. package/dist/apis/pricing-tier.cjs +6 -6
  125. package/dist/apis/pricing-tier.d.ts +9 -12
  126. package/dist/apis/pricing-tier.js +1 -1
  127. package/dist/apis/pricing.cjs +8 -8
  128. package/dist/apis/pricing.d.ts +9 -12
  129. package/dist/apis/pricing.js +2 -2
  130. package/dist/apis/purpose.cjs +6 -6
  131. package/dist/apis/purpose.d.ts +9 -12
  132. package/dist/apis/purpose.js +1 -1
  133. package/dist/apis/query.cjs +6 -6
  134. package/dist/apis/query.d.ts +9 -12
  135. package/dist/apis/query.js +1 -1
  136. package/dist/apis/sandbox.cjs +6 -6
  137. package/dist/apis/sandbox.d.ts +9 -12
  138. package/dist/apis/sandbox.js +1 -1
  139. package/dist/apis/sharing.cjs +6 -6
  140. package/dist/apis/sharing.d.ts +9 -12
  141. package/dist/apis/sharing.js +1 -1
  142. package/dist/apis/submission.cjs +6 -6
  143. package/dist/apis/submission.d.ts +9 -12
  144. package/dist/apis/submission.js +1 -1
  145. package/dist/apis/target.cjs +6 -6
  146. package/dist/apis/target.d.ts +9 -591
  147. package/dist/apis/target.js +1 -1
  148. package/dist/apis/targeting.cjs +6 -6
  149. package/dist/apis/targeting.d.ts +9 -12
  150. package/dist/apis/targeting.js +1 -1
  151. package/dist/apis/template-variables.cjs +6 -6
  152. package/dist/apis/template-variables.d.ts +9 -12
  153. package/dist/apis/template-variables.js +1 -1
  154. package/dist/apis/user.cjs +6 -6
  155. package/dist/apis/user.d.ts +9 -12
  156. package/dist/apis/user.js +1 -1
  157. package/dist/apis/validation-rules.cjs +6 -6
  158. package/dist/apis/validation-rules.d.ts +9 -12
  159. package/dist/apis/validation-rules.js +1 -1
  160. package/dist/apis/webhooks.cjs +6 -6
  161. package/dist/apis/webhooks.d.ts +9 -12
  162. package/dist/apis/webhooks.js +1 -1
  163. package/dist/apis/workflow-definition.cjs +6 -6
  164. package/dist/apis/workflow-definition.d.ts +9 -12
  165. package/dist/apis/workflow-definition.js +1 -1
  166. package/dist/apis/workflow.cjs +6 -6
  167. package/dist/apis/workflow.d.ts +9 -12
  168. package/dist/apis/workflow.js +1 -1
  169. package/dist/authorize.d.ts +3 -0
  170. package/dist/automation-BMO7ZFTN.cjs +7 -0
  171. package/dist/automation-MEZTSUR3.js +7 -0
  172. package/dist/bin/cli.d.ts +1 -0
  173. package/dist/bin/cli.js +1 -1
  174. package/dist/calendar-2YDAYG7S.cjs +7 -0
  175. package/dist/calendar-ACFIHQ2N.js +7 -0
  176. package/dist/calendar-runtime-6CMMEQMG.js +5 -0
  177. package/dist/calendar-runtime-G4SN5PDY.cjs +5 -0
  178. package/dist/{chunk-MEUS7LCE.js → chunk-63BFJKWV.js} +1 -1
  179. package/dist/{chunk-YLJD7G7H.cjs → chunk-CD4OX2U6.cjs} +7 -5
  180. package/dist/chunk-CKLEBO4K.cjs +14 -0
  181. package/dist/chunk-JNH37UUH.js +14 -0
  182. package/dist/{chunk-JXJC6WEW.cjs → chunk-KP7H52BF.cjs} +1 -1
  183. package/dist/{chunk-CQ3AKMIJ.js → chunk-TSV242UN.js} +7 -5
  184. package/dist/client-factory.d.ts +9 -0
  185. package/dist/client-map.d.ts +102 -0
  186. package/dist/compact.d.ts +22 -0
  187. package/dist/help.d.ts +12 -0
  188. package/dist/index.cjs +27 -19
  189. package/dist/index.d.ts +12 -180
  190. package/dist/index.js +22 -14
  191. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  192. package/dist/large-response.d.ts +9 -0
  193. package/dist/openapi.d.ts +12 -0
  194. package/dist/overrides.d.ts +9 -0
  195. package/dist/pricing-G67CH3XH.js +7 -0
  196. package/dist/pricing-XAET4G7T.cjs +7 -0
  197. package/dist/{pricing-runtime-JRR4FWFI.js → pricing-runtime-2YKEJJMZ.js} +1 -1
  198. package/dist/{pricing-runtime-6XNS4EOF.cjs → pricing-runtime-XDCOKL47.cjs} +2 -2
  199. package/dist/proxy.d.ts +14 -0
  200. package/dist/registry.d.ts +19 -0
  201. package/dist/retry.d.ts +11 -0
  202. package/dist/sdk.d.ts +29 -0
  203. package/dist/types.d.ts +53 -0
  204. package/docs/automation.md +42 -5
  205. package/docs/calendar.md +441 -0
  206. package/docs/pricing.md +39 -15
  207. package/package.json +10 -1
  208. package/dist/README-6MG272KM.cjs +0 -7
  209. package/dist/README-7N542PBL.js +0 -7
  210. package/dist/access-token.d-CnmUTOlq.d.cts +0 -552
  211. package/dist/access-token.d-CnmUTOlq.d.ts +0 -552
  212. package/dist/address-suggestions.d-_YwTOR-9.d.cts +0 -339
  213. package/dist/address-suggestions.d-_YwTOR-9.d.ts +0 -339
  214. package/dist/address.d-CwAPOVxa.d.cts +0 -437
  215. package/dist/address.d-CwAPOVxa.d.ts +0 -437
  216. package/dist/ai-agents.d-OkXfr2bz.d.cts +0 -1339
  217. package/dist/ai-agents.d-OkXfr2bz.d.ts +0 -1339
  218. package/dist/apis/access-token.d.cts +0 -18
  219. package/dist/apis/address-suggestions.d.cts +0 -18
  220. package/dist/apis/address.d.cts +0 -18
  221. package/dist/apis/ai-agents.d.cts +0 -18
  222. package/dist/apis/app.d.cts +0 -18
  223. package/dist/apis/audit-logs.d.cts +0 -18
  224. package/dist/apis/automation.d.cts +0 -18
  225. package/dist/apis/billing.d.cts +0 -18
  226. package/dist/apis/blueprint-manifest.d.cts +0 -18
  227. package/dist/apis/configuration-hub.d.cts +0 -18
  228. package/dist/apis/consent.d.cts +0 -18
  229. package/dist/apis/customer-portal.d.cts +0 -18
  230. package/dist/apis/dashboard.d.cts +0 -18
  231. package/dist/apis/data-governance.d.cts +0 -18
  232. package/dist/apis/deduplication.d.cts +0 -18
  233. package/dist/apis/design.d.cts +0 -18
  234. package/dist/apis/document.d.cts +0 -18
  235. package/dist/apis/email-settings.d.cts +0 -18
  236. package/dist/apis/email-template.d.cts +0 -18
  237. package/dist/apis/entity-mapping.d.cts +0 -18
  238. package/dist/apis/entity.d.cts +0 -18
  239. package/dist/apis/environments.d.cts +0 -18
  240. package/dist/apis/event-catalog.d.cts +0 -18
  241. package/dist/apis/file.d.cts +0 -18
  242. package/dist/apis/iban.d.cts +0 -18
  243. package/dist/apis/integration-toolkit.d.cts +0 -18
  244. package/dist/apis/journey.d.cts +0 -18
  245. package/dist/apis/kanban.d.cts +0 -18
  246. package/dist/apis/message.d.cts +0 -18
  247. package/dist/apis/metering.d.cts +0 -18
  248. package/dist/apis/notes.d.cts +0 -18
  249. package/dist/apis/notification.d.cts +0 -18
  250. package/dist/apis/organization.d.cts +0 -18
  251. package/dist/apis/partner-directory.d.cts +0 -18
  252. package/dist/apis/permissions.d.cts +0 -18
  253. package/dist/apis/pricing-tier.d.cts +0 -18
  254. package/dist/apis/pricing.d.cts +0 -18
  255. package/dist/apis/purpose.d.cts +0 -18
  256. package/dist/apis/query.d.cts +0 -18
  257. package/dist/apis/sandbox.d.cts +0 -18
  258. package/dist/apis/sharing.d.cts +0 -18
  259. package/dist/apis/submission.d.cts +0 -18
  260. package/dist/apis/target.d.cts +0 -597
  261. package/dist/apis/targeting.d.cts +0 -18
  262. package/dist/apis/template-variables.d.cts +0 -18
  263. package/dist/apis/user.d.cts +0 -18
  264. package/dist/apis/validation-rules.d.cts +0 -18
  265. package/dist/apis/webhooks.d.cts +0 -18
  266. package/dist/apis/workflow-definition.d.cts +0 -18
  267. package/dist/apis/workflow.d.cts +0 -18
  268. package/dist/app.d-u7Dq42kU.d.cts +0 -3391
  269. package/dist/app.d-u7Dq42kU.d.ts +0 -3391
  270. package/dist/audit-logs.d-BRToFqeX.d.cts +0 -287
  271. package/dist/audit-logs.d-BRToFqeX.d.ts +0 -287
  272. package/dist/automation-GFNNLSIN.js +0 -7
  273. package/dist/automation-IOCVCTKR.cjs +0 -7
  274. package/dist/automation.d-CzhG2m4L.d.cts +0 -5252
  275. package/dist/automation.d-CzhG2m4L.d.ts +0 -5252
  276. package/dist/billing.d-Bs8Ku9qE.d.cts +0 -993
  277. package/dist/billing.d-Bs8Ku9qE.d.ts +0 -993
  278. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +0 -4343
  279. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +0 -4343
  280. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  281. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  282. package/dist/consent.d-C2PROHhX.d.cts +0 -265
  283. package/dist/consent.d-C2PROHhX.d.ts +0 -265
  284. package/dist/customer-portal.d-DyZ2n2dW.d.cts +0 -16728
  285. package/dist/customer-portal.d-DyZ2n2dW.d.ts +0 -16728
  286. package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
  287. package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
  288. package/dist/data-governance.d-BbZ466j5.d.cts +0 -1178
  289. package/dist/data-governance.d-BbZ466j5.d.ts +0 -1178
  290. package/dist/deduplication.d-D5GYddVu.d.cts +0 -218
  291. package/dist/deduplication.d-D5GYddVu.d.ts +0 -218
  292. package/dist/design.d-BRre8iLg.d.cts +0 -2346
  293. package/dist/design.d-BRre8iLg.d.ts +0 -2346
  294. package/dist/document.d-DN37pjdx.d.cts +0 -648
  295. package/dist/document.d-DN37pjdx.d.ts +0 -648
  296. package/dist/email-settings.d-B7Q_xT25.d.cts +0 -2417
  297. package/dist/email-settings.d-B7Q_xT25.d.ts +0 -2417
  298. package/dist/email-template.d-gtQkdaXM.d.cts +0 -1188
  299. package/dist/email-template.d-gtQkdaXM.d.ts +0 -1188
  300. package/dist/entity-mapping.d-DKSW3sfy.d.cts +0 -1092
  301. package/dist/entity-mapping.d-DKSW3sfy.d.ts +0 -1092
  302. package/dist/entity.d-BHR9dEon.d.cts +0 -18479
  303. package/dist/entity.d-BHR9dEon.d.ts +0 -18479
  304. package/dist/environments.d-BvqvN-PD.d.cts +0 -382
  305. package/dist/environments.d-BvqvN-PD.d.ts +0 -382
  306. package/dist/event-catalog.d-ENw6HO-w.d.cts +0 -1511
  307. package/dist/event-catalog.d-ENw6HO-w.d.ts +0 -1511
  308. package/dist/file.d-DcTJxjp7.d.cts +0 -2992
  309. package/dist/file.d-DcTJxjp7.d.ts +0 -2992
  310. package/dist/iban.d-BwdiGbxi.d.cts +0 -70
  311. package/dist/iban.d-BwdiGbxi.d.ts +0 -70
  312. package/dist/index.d.cts +0 -180
  313. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +0 -5796
  314. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +0 -5796
  315. package/dist/journey.d-ClXO0xK8.d.cts +0 -1931
  316. package/dist/journey.d-ClXO0xK8.d.ts +0 -1931
  317. package/dist/kanban.d-BHnSRCYW.d.cts +0 -760
  318. package/dist/kanban.d-BHnSRCYW.d.ts +0 -760
  319. package/dist/message.d-B5UuSqgw.d.cts +0 -3811
  320. package/dist/message.d-B5UuSqgw.d.ts +0 -3811
  321. package/dist/metering.d-DvtPv7wk.d.cts +0 -1841
  322. package/dist/metering.d-DvtPv7wk.d.ts +0 -1841
  323. package/dist/notes.d-BC-scR42.d.cts +0 -1046
  324. package/dist/notes.d-BC-scR42.d.ts +0 -1046
  325. package/dist/notification.d-BfBL3lga.d.cts +0 -1147
  326. package/dist/notification.d-BfBL3lga.d.ts +0 -1147
  327. package/dist/organization.d-DqwnNxMg.d.cts +0 -1271
  328. package/dist/organization.d-DqwnNxMg.d.ts +0 -1271
  329. package/dist/partner-directory.d-BCIjHoGs.d.cts +0 -2337
  330. package/dist/partner-directory.d-BCIjHoGs.d.ts +0 -2337
  331. package/dist/permissions.d-l6AT8SYP.d.cts +0 -1279
  332. package/dist/permissions.d-l6AT8SYP.d.ts +0 -1279
  333. package/dist/pricing-4Z4TOETA.cjs +0 -7
  334. package/dist/pricing-C65DTZSX.js +0 -7
  335. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +0 -81
  336. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +0 -81
  337. package/dist/pricing.d-Cv39plGm.d.cts +0 -12200
  338. package/dist/pricing.d-Cv39plGm.d.ts +0 -12200
  339. package/dist/purpose.d-CbIYfTua.d.cts +0 -372
  340. package/dist/purpose.d-CbIYfTua.d.ts +0 -372
  341. package/dist/query.d-Cmp78IhZ.d.cts +0 -2375
  342. package/dist/query.d-Cmp78IhZ.d.ts +0 -2375
  343. package/dist/sandbox.d-BdbOFzDu.d.cts +0 -465
  344. package/dist/sandbox.d-BdbOFzDu.d.ts +0 -465
  345. package/dist/sharing.d-sOXq-gtz.d.cts +0 -571
  346. package/dist/sharing.d-sOXq-gtz.d.ts +0 -571
  347. package/dist/submission.d-BamwfhXw.d.cts +0 -469
  348. package/dist/submission.d-BamwfhXw.d.ts +0 -469
  349. package/dist/targeting.d-BNmcVsNS.d.cts +0 -2057
  350. package/dist/targeting.d-BNmcVsNS.d.ts +0 -2057
  351. package/dist/template-variables.d-Ble9TSBa.d.cts +0 -1320
  352. package/dist/template-variables.d-Ble9TSBa.d.ts +0 -1320
  353. package/dist/types-ChU9Acbv.d.cts +0 -37
  354. package/dist/types-ChU9Acbv.d.ts +0 -37
  355. package/dist/user.d-D18fe97W.d.cts +0 -2270
  356. package/dist/user.d-D18fe97W.d.ts +0 -2270
  357. package/dist/validation-rules.d-Db5c5zTf.d.cts +0 -807
  358. package/dist/validation-rules.d-Db5c5zTf.d.ts +0 -807
  359. package/dist/webhooks.d-pLHIL_io.d.cts +0 -1256
  360. package/dist/webhooks.d-pLHIL_io.d.ts +0 -1256
  361. package/dist/workflow-definition.d-DOeb0KVV.d.cts +0 -1922
  362. package/dist/workflow-definition.d-DOeb0KVV.d.ts +0 -1922
  363. package/dist/workflow.d-CMSKt8oN.d.cts +0 -3151
  364. package/dist/workflow.d-CMSKt8oN.d.ts +0 -3151
@@ -1,3811 +0,0 @@
1
- import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from message-client */
4
-
5
-
6
- declare namespace Components {
7
- namespace Responses {
8
- export type BadRequest = Schemas.ErrorResponse;
9
- export type Conflict = Schemas.ErrorResponse;
10
- export type Forbidden = Schemas.ErrorResponse;
11
- export type InternalServerError = Schemas.ErrorResponse;
12
- export type NotFound = Schemas.ErrorResponse;
13
- }
14
- namespace Schemas {
15
- export interface Address {
16
- /**
17
- * Email address alias
18
- * example:
19
- * epilot
20
- */
21
- name?: string;
22
- /**
23
- * Email address
24
- * example:
25
- * messaging@epilot.cloud
26
- */
27
- address: string;
28
- /**
29
- * Type of the email, Internal (360 Agents), Partners, External users(Customers)
30
- *
31
- */
32
- email_type?: "INTERNAL" | "EXTERNAL" | "PARTNER";
33
- /**
34
- * Sent message status regarding to this recipient. Reference at <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html>
35
- *
36
- */
37
- send_status?: "SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR";
38
- /**
39
- * 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>
40
- *
41
- */
42
- send_error?: {
43
- [key: string]: any;
44
- };
45
- }
46
- /**
47
- * Message attachments
48
- */
49
- export interface AttachmentsRelation {
50
- /**
51
- * It's normal entity relation with some additional properties for sending message attachment.
52
- */
53
- $relation?: File[];
54
- }
55
- export interface BaseEntity {
56
- /**
57
- * Entity ID
58
- * example:
59
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
60
- */
61
- _id: string;
62
- /**
63
- * Entity title
64
- */
65
- _title: string;
66
- /**
67
- * Organization ID the entity belongs to
68
- * example:
69
- * 206801
70
- */
71
- _org: string;
72
- /**
73
- * URL-friendly identifier for the entity schema
74
- * example:
75
- * message
76
- */
77
- _schema: string;
78
- /**
79
- * Entity tags
80
- * example:
81
- * [
82
- * "pricing",
83
- * "INBOX"
84
- * ]
85
- */
86
- _tags?: string[];
87
- /**
88
- * Created date
89
- * example:
90
- * 2021-02-09T12:41:43.662Z
91
- */
92
- _created_at: string; // date-time
93
- /**
94
- * Updated date
95
- * example:
96
- * 2021-02-10T09:14:31.990Z
97
- */
98
- _updated_at: string; // date-time
99
- }
100
- export interface BulkActionsPayload {
101
- /**
102
- * Array of threads you wish to perform bulk actions on
103
- * example:
104
- * [
105
- * "6b299eda-4018-4554-8965-c4b5598e6531"
106
- * ]
107
- */
108
- ids: string[];
109
- }
110
- export interface BulkActionsPayloadWithScopes {
111
- /**
112
- * Array of threads you wish to perform bulk actions on
113
- * example:
114
- * [
115
- * "6b299eda-4018-4554-8965-c4b5598e6531"
116
- * ]
117
- */
118
- ids: string[];
119
- /**
120
- * Assignable IDs to assign the threads to
121
- */
122
- assign_to?: string[];
123
- /**
124
- * Inbox ID to move the threads to
125
- * example:
126
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
127
- */
128
- inbox_id?: string;
129
- /**
130
- * The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.
131
- * example:
132
- * [
133
- * "organization",
134
- * "user"
135
- * ]
136
- */
137
- scopes?: /* Who is marking an item as read or unread. */ ReadingScope[];
138
- }
139
- export interface ErrorResponse {
140
- /**
141
- * Error message
142
- * example:
143
- * Thread not found
144
- */
145
- error?: string;
146
- }
147
- /**
148
- * List of entity fields to include or exclude in the response
149
- *
150
- * Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
151
- *
152
- * Globbing and globstart (**) is supported for nested fields.
153
- *
154
- * example:
155
- * [
156
- * "_id",
157
- * "_title",
158
- * "first_name",
159
- * "account",
160
- * "!account.*._files",
161
- * "**._product"
162
- * ]
163
- */
164
- export type FieldsParam = string[];
165
- export interface File {
166
- /**
167
- * File entity ID
168
- * example:
169
- * f820ce3b-07b0-45ae-bcc6-babb2f53f79f
170
- */
171
- entity_id: string;
172
- /**
173
- * File name
174
- * example:
175
- * Produktinformationen_epilot360_Double_Opt_in.pdf
176
- */
177
- filename?: string;
178
- /**
179
- * To indicate this file relation is message attachment. If false then this file will not be sent and simply kept as a file relation.
180
- */
181
- is_message_attachment?: boolean;
182
- /**
183
- * 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.
184
- */
185
- may_be_signature_attachment?: boolean;
186
- /**
187
- * Content ID (for inline)
188
- * example:
189
- * fb222496-a1a5-4639-94f2-07b5e35e4068
190
- */
191
- cid?: string;
192
- /**
193
- * 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).
194
- *
195
- */
196
- inline?: boolean;
197
- /**
198
- * 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.
199
- *
200
- */
201
- send_as_link?: boolean;
202
- }
203
- export interface Message {
204
- /**
205
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
206
- * example:
207
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
208
- */
209
- message_id?: string;
210
- /**
211
- * User ID of user sends the message.
212
- * example:
213
- * 206801
214
- */
215
- sender?: string;
216
- /**
217
- * Subject
218
- * example:
219
- * Request for solar panel price
220
- */
221
- subject: string;
222
- /**
223
- * HTML body
224
- * example:
225
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
226
- */
227
- html?: string;
228
- /**
229
- * Text body
230
- * example:
231
- * We at ABC GmbH would like to request a price quote for the solar panel.
232
- */
233
- text?: string;
234
- from: Address;
235
- reply_to?: Address;
236
- /**
237
- * To email addresses
238
- */
239
- to?: Address[];
240
- /**
241
- * Cc email addresses
242
- */
243
- cc?: Address[];
244
- /**
245
- * Bcc email addresses
246
- */
247
- bcc?: Address[];
248
- file?: /* Message attachments */ AttachmentsRelation;
249
- /**
250
- * 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.
251
- *
252
- * example:
253
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
254
- */
255
- references?: string;
256
- /**
257
- * In-Reply-To header. Value is the `message_id` of parent message.
258
- *
259
- * example:
260
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
261
- */
262
- in_reply_to?: string;
263
- /**
264
- * User ID of user read the message.
265
- * example:
266
- * [
267
- * "206801",
268
- * "200109"
269
- * ]
270
- */
271
- user_read_message?: string[];
272
- /**
273
- * Organization ID of organization read the message.
274
- * example:
275
- * [
276
- * "789372",
277
- * "210291"
278
- * ]
279
- */
280
- org_read_message?: string[];
281
- /**
282
- * 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>
283
- *
284
- */
285
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
286
- /**
287
- * Message type
288
- */
289
- type?: "SENT" | "RECEIVED";
290
- /**
291
- * Template ID used for sending message.
292
- * example:
293
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
294
- */
295
- template_id?: string;
296
- }
297
- export interface MessageRequestParams {
298
- [name: string]: any;
299
- /**
300
- * Whether the thread is marked as Done immediately after sending the message
301
- */
302
- complete_thread?: boolean;
303
- /**
304
- * 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.
305
- *
306
- * example:
307
- * {
308
- * "topic": "CUSTOMER_MESSAGE",
309
- * "assigned_to": [
310
- * "206801",
311
- * "200109"
312
- * ],
313
- * "opportunity_id": 829072
314
- * }
315
- */
316
- thread?: {
317
- /**
318
- * Message topic (e.g. which service sends the message or message category)
319
- */
320
- topic: string;
321
- /**
322
- * User ID of who the message is assigned to. Default is the user who sends message.
323
- */
324
- assigned_to?: string[];
325
- };
326
- /**
327
- * Entity ID of parent message which this message replies to or forwards from. If both `parent_id` and `thread` are provided, `thread` is discarded.
328
- *
329
- * example:
330
- * 44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2
331
- */
332
- parent_id?: string;
333
- /**
334
- * Subject
335
- * example:
336
- * Request for solar panel price
337
- */
338
- subject: string;
339
- /**
340
- * HTML body
341
- * example:
342
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
343
- */
344
- html?: string;
345
- /**
346
- * Text body. If not provided, text body is converted from HTML body using [html-to-text](https://www.npmjs.com/package/html-to-text)
347
- * example:
348
- * We at ABC GmbH would like to request a price quote for the solar panel.
349
- */
350
- text?: string;
351
- from: Address;
352
- reply_to?: Address;
353
- /**
354
- * To email addresses
355
- */
356
- to?: Address[];
357
- /**
358
- * Cc email addresses
359
- */
360
- cc?: Address[];
361
- /**
362
- * Bcc email addresses
363
- */
364
- bcc?: Address[];
365
- file?: /* Message attachments */ AttachmentsRelation;
366
- /**
367
- * Template ID used for sending message.
368
- * example:
369
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
370
- */
371
- template_id?: string;
372
- }
373
- export interface MessageV2 {
374
- /**
375
- * Entity ID
376
- * example:
377
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
378
- */
379
- _id: string;
380
- /**
381
- * Entity title
382
- */
383
- _title: string;
384
- /**
385
- * Organization ID the entity belongs to
386
- * example:
387
- * 206801
388
- */
389
- _org: string;
390
- /**
391
- * URL-friendly identifier for the entity schema
392
- * example:
393
- * message
394
- */
395
- _schema: string;
396
- /**
397
- * Entity tags
398
- * example:
399
- * [
400
- * "pricing",
401
- * "INBOX"
402
- * ]
403
- */
404
- _tags?: string[];
405
- /**
406
- * Created date
407
- * example:
408
- * 2021-02-09T12:41:43.662Z
409
- */
410
- _created_at: string; // date-time
411
- /**
412
- * Updated date
413
- * example:
414
- * 2021-02-10T09:14:31.990Z
415
- */
416
- _updated_at: string; // date-time
417
- /**
418
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
419
- * example:
420
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
421
- */
422
- message_id?: string;
423
- /**
424
- * User ID of user sends the message.
425
- * example:
426
- * 206801
427
- */
428
- sender?: string;
429
- /**
430
- * Subject
431
- * example:
432
- * Request for solar panel price
433
- */
434
- subject: string;
435
- /**
436
- * HTML body
437
- * example:
438
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
439
- */
440
- html?: string;
441
- /**
442
- * Text body
443
- * example:
444
- * We at ABC GmbH would like to request a price quote for the solar panel.
445
- */
446
- text?: string;
447
- from: Address;
448
- reply_to?: Address;
449
- /**
450
- * To email addresses
451
- */
452
- to?: Address[];
453
- /**
454
- * Cc email addresses
455
- */
456
- cc?: Address[];
457
- /**
458
- * Bcc email addresses
459
- */
460
- bcc?: Address[];
461
- file?: /* Message attachments */ AttachmentsRelation;
462
- /**
463
- * 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.
464
- *
465
- * example:
466
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
467
- */
468
- references?: string;
469
- /**
470
- * In-Reply-To header. Value is the `message_id` of parent message.
471
- *
472
- * example:
473
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
474
- */
475
- in_reply_to?: string;
476
- /**
477
- * User ID of user read the message.
478
- * example:
479
- * [
480
- * "206801",
481
- * "200109"
482
- * ]
483
- */
484
- user_read_message?: string[];
485
- /**
486
- * Organization ID of organization read the message.
487
- * example:
488
- * [
489
- * "789372",
490
- * "210291"
491
- * ]
492
- */
493
- org_read_message?: string[];
494
- /**
495
- * 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>
496
- *
497
- */
498
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
499
- /**
500
- * Message type
501
- */
502
- type?: "SENT" | "RECEIVED";
503
- /**
504
- * Template ID used for sending message.
505
- * example:
506
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
507
- */
508
- template_id?: string;
509
- /**
510
- * If true then html is not provided and must be downloaded using the html_download_url
511
- */
512
- html_omitted?: boolean;
513
- /**
514
- * HTML body download URL
515
- * example:
516
- * https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html
517
- */
518
- html_download_url?: string;
519
- }
520
- export interface MoveThreadPayload {
521
- /**
522
- * Inbox ID
523
- * example:
524
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
525
- */
526
- inbox_id: string;
527
- }
528
- export interface ReadMessagePayload {
529
- /**
530
- * The scopes to be used when marking an item as read or unread. The read status will be synced for all provided scopes.
531
- * example:
532
- * [
533
- * "organization",
534
- * "user"
535
- * ]
536
- */
537
- scopes: /* Who is marking an item as read or unread. */ ReadingScope[];
538
- }
539
- /**
540
- * Who is marking an item as read or unread.
541
- */
542
- export type ReadingScope = "organization" | "user";
543
- export interface SearchIDParams {
544
- /**
545
- * Lucene query syntax supported with ElasticSearch
546
- * example:
547
- * subject:"Request for solar panel price" AND _tags:INBOX
548
- */
549
- q?: string;
550
- }
551
- export interface SearchParams {
552
- /**
553
- * Lucene query syntax supported with ElasticSearch
554
- * example:
555
- * subject:"Request for solar panel price" AND _tags:INBOX
556
- */
557
- q: string;
558
- from?: number;
559
- size?: number;
560
- hydrate?: boolean;
561
- }
562
- export interface SearchParamsV2 {
563
- inbox_id?: string | string[];
564
- /**
565
- * Lucene query syntax supported with ElasticSearch
566
- * example:
567
- * subject:"Request for solar panel price" AND _tags:INBOX
568
- */
569
- q: string;
570
- fields?: /**
571
- * List of entity fields to include or exclude in the response
572
- *
573
- * Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
574
- *
575
- * Globbing and globstart (**) is supported for nested fields.
576
- *
577
- * example:
578
- * [
579
- * "_id",
580
- * "_title",
581
- * "first_name",
582
- * "account",
583
- * "!account.*._files",
584
- * "**._product"
585
- * ]
586
- */
587
- FieldsParam;
588
- from?: number;
589
- size?: number;
590
- hydrate?: boolean;
591
- include_scores?: boolean;
592
- sort?: string;
593
- highlight?: any;
594
- }
595
- /**
596
- * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
597
- */
598
- export interface Thread {
599
- /**
600
- * Message topic (e.g. which service sends the message or message category)
601
- * example:
602
- * CUSTOMER_MESSAGE
603
- */
604
- topic: string;
605
- /**
606
- * User ID of who the message is assigned to. Default is the user who sends message.
607
- * example:
608
- * [
609
- * "206801",
610
- * "200109"
611
- * ]
612
- */
613
- assigned_to?: string[];
614
- /**
615
- * Organization ID of organization read the message.
616
- * example:
617
- * [
618
- * "789372",
619
- * "210291"
620
- * ]
621
- */
622
- org_read_message?: string[];
623
- /**
624
- * Whether the thread is marked as Done
625
- * example:
626
- * false
627
- */
628
- done?: boolean;
629
- latest_message?: Message;
630
- latest_trash_message?: Message;
631
- /**
632
- * The date of the latest message time in the thread
633
- * example:
634
- * 2024-02-10T09:14:31.990Z
635
- */
636
- latest_message_at?: string;
637
- }
638
- export interface ThreadDoneEvent {
639
- type: "THREAD_DONE";
640
- /**
641
- * User ID of the user who marked the thread as done
642
- * example:
643
- * 123
644
- */
645
- user_id: string;
646
- /**
647
- * Organization ID of the organization who marked the thread as done
648
- * example:
649
- * 456
650
- */
651
- organization_id: string;
652
- }
653
- export interface ThreadOpenEvent {
654
- type: "THREAD_OPEN";
655
- /**
656
- * User ID of the user who marked the thread as open
657
- * example:
658
- * 123
659
- */
660
- user_id: string;
661
- /**
662
- * Organization ID of the organization who marked the thread as open
663
- * example:
664
- * 456
665
- */
666
- organization_id: string;
667
- }
668
- export interface ThreadTimeline {
669
- events: TimelineEvent[];
670
- }
671
- export interface TimelineEvent {
672
- data: TimelineEventData;
673
- /**
674
- * Timestamp of the event
675
- * example:
676
- * 2024-01-01T00:00:00Z
677
- */
678
- timestamp: string;
679
- }
680
- export type TimelineEventData = ThreadDoneEvent | ThreadOpenEvent;
681
- }
682
- }
683
- declare namespace Paths {
684
- namespace AssignThread {
685
- namespace Parameters {
686
- export type Id = string;
687
- }
688
- export interface PathParameters {
689
- id: Parameters.Id;
690
- }
691
- /**
692
- * Entities which thread is assigned to
693
- */
694
- export type RequestBody = {
695
- /**
696
- * Entity slug
697
- * example:
698
- * contact
699
- */
700
- slug?: string;
701
- /**
702
- * Entity ID
703
- * example:
704
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
705
- */
706
- entity_id?: string;
707
- /**
708
- * Organization ID
709
- * example:
710
- * 206801
711
- */
712
- org_id?: string;
713
- /**
714
- * To indicate this is main entity
715
- * example:
716
- * true
717
- */
718
- is_main_entity?: boolean;
719
- }[];
720
- namespace Responses {
721
- export interface $204 {
722
- }
723
- export interface $403 {
724
- }
725
- }
726
- }
727
- namespace AssignUsers {
728
- namespace Parameters {
729
- export type Id = string;
730
- }
731
- export interface PathParameters {
732
- id: Parameters.Id;
733
- }
734
- /**
735
- * User IDs of users assigned to thread
736
- */
737
- export interface RequestBody {
738
- /**
739
- * IDs of users assigned to thread
740
- */
741
- assigned_to?: string[];
742
- }
743
- namespace Responses {
744
- export interface $204 {
745
- }
746
- export interface $403 {
747
- }
748
- }
749
- }
750
- namespace AssignUsersV2 {
751
- namespace Parameters {
752
- export type Id = string;
753
- }
754
- export interface PathParameters {
755
- id: Parameters.Id;
756
- }
757
- export interface RequestBody {
758
- /**
759
- * User IDs of users to add to thread
760
- */
761
- add: string[];
762
- /**
763
- * User IDs of users to remove from thread
764
- */
765
- remove: string[];
766
- }
767
- namespace Responses {
768
- export interface $204 {
769
- }
770
- export interface $403 {
771
- }
772
- }
773
- }
774
- namespace BulkAssignThreads {
775
- export type RequestBody = Components.Schemas.BulkActionsPayloadWithScopes;
776
- namespace Responses {
777
- export interface $200 {
778
- }
779
- export interface $403 {
780
- }
781
- }
782
- }
783
- namespace BulkMoveThreads {
784
- export type RequestBody = Components.Schemas.BulkActionsPayloadWithScopes;
785
- namespace Responses {
786
- export interface $200 {
787
- }
788
- export interface $403 {
789
- }
790
- }
791
- }
792
- namespace CreateDraft {
793
- export type RequestBody = Components.Schemas.MessageRequestParams;
794
- namespace Responses {
795
- export interface $201 {
796
- /**
797
- * Entity ID
798
- * example:
799
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
800
- */
801
- _id: string;
802
- /**
803
- * Entity title
804
- */
805
- _title: string;
806
- /**
807
- * Organization ID the entity belongs to
808
- * example:
809
- * 206801
810
- */
811
- _org: string;
812
- /**
813
- * URL-friendly identifier for the entity schema
814
- * example:
815
- * message
816
- */
817
- _schema: string;
818
- /**
819
- * Entity tags
820
- * example:
821
- * [
822
- * "pricing",
823
- * "INBOX"
824
- * ]
825
- */
826
- _tags?: string[];
827
- /**
828
- * Created date
829
- * example:
830
- * 2021-02-09T12:41:43.662Z
831
- */
832
- _created_at: string; // date-time
833
- /**
834
- * Updated date
835
- * example:
836
- * 2021-02-10T09:14:31.990Z
837
- */
838
- _updated_at: string; // date-time
839
- /**
840
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
841
- * example:
842
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
843
- */
844
- message_id?: string;
845
- /**
846
- * User ID of user sends the message.
847
- * example:
848
- * 206801
849
- */
850
- sender?: string;
851
- /**
852
- * Subject
853
- * example:
854
- * Request for solar panel price
855
- */
856
- subject: string;
857
- /**
858
- * HTML body
859
- * example:
860
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
861
- */
862
- html?: string;
863
- /**
864
- * Text body
865
- * example:
866
- * We at ABC GmbH would like to request a price quote for the solar panel.
867
- */
868
- text?: string;
869
- from: Components.Schemas.Address;
870
- reply_to?: Components.Schemas.Address;
871
- /**
872
- * To email addresses
873
- */
874
- to?: Components.Schemas.Address[];
875
- /**
876
- * Cc email addresses
877
- */
878
- cc?: Components.Schemas.Address[];
879
- /**
880
- * Bcc email addresses
881
- */
882
- bcc?: Components.Schemas.Address[];
883
- file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
884
- /**
885
- * 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.
886
- *
887
- * example:
888
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
889
- */
890
- references?: string;
891
- /**
892
- * In-Reply-To header. Value is the `message_id` of parent message.
893
- *
894
- * example:
895
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
896
- */
897
- in_reply_to?: string;
898
- /**
899
- * User ID of user read the message.
900
- * example:
901
- * [
902
- * "206801",
903
- * "200109"
904
- * ]
905
- */
906
- user_read_message?: string[];
907
- /**
908
- * Organization ID of organization read the message.
909
- * example:
910
- * [
911
- * "789372",
912
- * "210291"
913
- * ]
914
- */
915
- org_read_message?: string[];
916
- /**
917
- * 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>
918
- *
919
- */
920
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
921
- /**
922
- * Message type
923
- */
924
- type?: "SENT" | "RECEIVED";
925
- /**
926
- * Template ID used for sending message.
927
- * example:
928
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
929
- */
930
- template_id?: string;
931
- }
932
- export interface $403 {
933
- }
934
- }
935
- }
936
- namespace DeleteMessage {
937
- namespace Parameters {
938
- export type Id = string;
939
- }
940
- export interface PathParameters {
941
- id: Parameters.Id;
942
- }
943
- namespace Responses {
944
- export interface $204 {
945
- }
946
- export interface $403 {
947
- }
948
- }
949
- }
950
- namespace DeleteThread {
951
- namespace Parameters {
952
- export type Id = string;
953
- }
954
- export interface PathParameters {
955
- id: Parameters.Id;
956
- }
957
- namespace Responses {
958
- export interface $204 {
959
- }
960
- export interface $403 {
961
- }
962
- }
963
- }
964
- namespace GetMessage {
965
- namespace Parameters {
966
- /**
967
- * example:
968
- * 4d74976d-fb64-47fd-85e2-65eea140f5eb
969
- */
970
- export type Id = string;
971
- }
972
- export interface PathParameters {
973
- id: /**
974
- * example:
975
- * 4d74976d-fb64-47fd-85e2-65eea140f5eb
976
- */
977
- Parameters.Id;
978
- }
979
- namespace Responses {
980
- export interface $200 {
981
- /**
982
- * Entity ID
983
- * example:
984
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
985
- */
986
- _id: string;
987
- /**
988
- * Entity title
989
- */
990
- _title: string;
991
- /**
992
- * Organization ID the entity belongs to
993
- * example:
994
- * 206801
995
- */
996
- _org: string;
997
- /**
998
- * URL-friendly identifier for the entity schema
999
- * example:
1000
- * message
1001
- */
1002
- _schema: string;
1003
- /**
1004
- * Entity tags
1005
- * example:
1006
- * [
1007
- * "pricing",
1008
- * "INBOX"
1009
- * ]
1010
- */
1011
- _tags?: string[];
1012
- /**
1013
- * Created date
1014
- * example:
1015
- * 2021-02-09T12:41:43.662Z
1016
- */
1017
- _created_at: string; // date-time
1018
- /**
1019
- * Updated date
1020
- * example:
1021
- * 2021-02-10T09:14:31.990Z
1022
- */
1023
- _updated_at: string; // date-time
1024
- /**
1025
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
1026
- * example:
1027
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
1028
- */
1029
- message_id?: string;
1030
- /**
1031
- * User ID of user sends the message.
1032
- * example:
1033
- * 206801
1034
- */
1035
- sender?: string;
1036
- /**
1037
- * Subject
1038
- * example:
1039
- * Request for solar panel price
1040
- */
1041
- subject: string;
1042
- /**
1043
- * HTML body
1044
- * example:
1045
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
1046
- */
1047
- html?: string;
1048
- /**
1049
- * Text body
1050
- * example:
1051
- * We at ABC GmbH would like to request a price quote for the solar panel.
1052
- */
1053
- text?: string;
1054
- from: Components.Schemas.Address;
1055
- reply_to?: Components.Schemas.Address;
1056
- /**
1057
- * To email addresses
1058
- */
1059
- to?: Components.Schemas.Address[];
1060
- /**
1061
- * Cc email addresses
1062
- */
1063
- cc?: Components.Schemas.Address[];
1064
- /**
1065
- * Bcc email addresses
1066
- */
1067
- bcc?: Components.Schemas.Address[];
1068
- file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
1069
- /**
1070
- * 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.
1071
- *
1072
- * example:
1073
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1074
- */
1075
- references?: string;
1076
- /**
1077
- * In-Reply-To header. Value is the `message_id` of parent message.
1078
- *
1079
- * example:
1080
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1081
- */
1082
- in_reply_to?: string;
1083
- /**
1084
- * User ID of user read the message.
1085
- * example:
1086
- * [
1087
- * "206801",
1088
- * "200109"
1089
- * ]
1090
- */
1091
- user_read_message?: string[];
1092
- /**
1093
- * Organization ID of organization read the message.
1094
- * example:
1095
- * [
1096
- * "789372",
1097
- * "210291"
1098
- * ]
1099
- */
1100
- org_read_message?: string[];
1101
- /**
1102
- * 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>
1103
- *
1104
- */
1105
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
1106
- /**
1107
- * Message type
1108
- */
1109
- type?: "SENT" | "RECEIVED";
1110
- /**
1111
- * Template ID used for sending message.
1112
- * example:
1113
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
1114
- */
1115
- template_id?: string;
1116
- }
1117
- export interface $302 {
1118
- }
1119
- export interface $403 {
1120
- }
1121
- }
1122
- }
1123
- namespace GetMessageEml {
1124
- namespace Parameters {
1125
- /**
1126
- * example:
1127
- * 4d74976d-fb64-47fd-85e2-65eea140f5eb
1128
- */
1129
- export type Id = string;
1130
- }
1131
- export interface PathParameters {
1132
- id: /**
1133
- * example:
1134
- * 4d74976d-fb64-47fd-85e2-65eea140f5eb
1135
- */
1136
- Parameters.Id;
1137
- }
1138
- namespace Responses {
1139
- export interface $302 {
1140
- }
1141
- export interface $403 {
1142
- }
1143
- export interface $404 {
1144
- }
1145
- }
1146
- }
1147
- namespace GetMessageV2 {
1148
- namespace Parameters {
1149
- /**
1150
- * example:
1151
- * 4d74976d-fb64-47fd-85e2-65eea140f5eb
1152
- */
1153
- export type Id = string;
1154
- }
1155
- export interface PathParameters {
1156
- id: /**
1157
- * example:
1158
- * 4d74976d-fb64-47fd-85e2-65eea140f5eb
1159
- */
1160
- Parameters.Id;
1161
- }
1162
- namespace Responses {
1163
- export interface $200 {
1164
- /**
1165
- * Entity ID
1166
- * example:
1167
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1168
- */
1169
- _id: string;
1170
- /**
1171
- * Entity title
1172
- */
1173
- _title: string;
1174
- /**
1175
- * Organization ID the entity belongs to
1176
- * example:
1177
- * 206801
1178
- */
1179
- _org: string;
1180
- /**
1181
- * URL-friendly identifier for the entity schema
1182
- * example:
1183
- * message
1184
- */
1185
- _schema: string;
1186
- /**
1187
- * Entity tags
1188
- * example:
1189
- * [
1190
- * "pricing",
1191
- * "INBOX"
1192
- * ]
1193
- */
1194
- _tags?: string[];
1195
- /**
1196
- * Created date
1197
- * example:
1198
- * 2021-02-09T12:41:43.662Z
1199
- */
1200
- _created_at: string; // date-time
1201
- /**
1202
- * Updated date
1203
- * example:
1204
- * 2021-02-10T09:14:31.990Z
1205
- */
1206
- _updated_at: string; // date-time
1207
- /**
1208
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
1209
- * example:
1210
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
1211
- */
1212
- message_id?: string;
1213
- /**
1214
- * User ID of user sends the message.
1215
- * example:
1216
- * 206801
1217
- */
1218
- sender?: string;
1219
- /**
1220
- * Subject
1221
- * example:
1222
- * Request for solar panel price
1223
- */
1224
- subject: string;
1225
- /**
1226
- * HTML body
1227
- * example:
1228
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
1229
- */
1230
- html?: string;
1231
- /**
1232
- * Text body
1233
- * example:
1234
- * We at ABC GmbH would like to request a price quote for the solar panel.
1235
- */
1236
- text?: string;
1237
- from: Components.Schemas.Address;
1238
- reply_to?: Components.Schemas.Address;
1239
- /**
1240
- * To email addresses
1241
- */
1242
- to?: Components.Schemas.Address[];
1243
- /**
1244
- * Cc email addresses
1245
- */
1246
- cc?: Components.Schemas.Address[];
1247
- /**
1248
- * Bcc email addresses
1249
- */
1250
- bcc?: Components.Schemas.Address[];
1251
- file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
1252
- /**
1253
- * 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.
1254
- *
1255
- * example:
1256
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1257
- */
1258
- references?: string;
1259
- /**
1260
- * In-Reply-To header. Value is the `message_id` of parent message.
1261
- *
1262
- * example:
1263
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1264
- */
1265
- in_reply_to?: string;
1266
- /**
1267
- * User ID of user read the message.
1268
- * example:
1269
- * [
1270
- * "206801",
1271
- * "200109"
1272
- * ]
1273
- */
1274
- user_read_message?: string[];
1275
- /**
1276
- * Organization ID of organization read the message.
1277
- * example:
1278
- * [
1279
- * "789372",
1280
- * "210291"
1281
- * ]
1282
- */
1283
- org_read_message?: string[];
1284
- /**
1285
- * 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>
1286
- *
1287
- */
1288
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
1289
- /**
1290
- * Message type
1291
- */
1292
- type?: "SENT" | "RECEIVED";
1293
- /**
1294
- * Template ID used for sending message.
1295
- * example:
1296
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
1297
- */
1298
- template_id?: string;
1299
- /**
1300
- * If true then html is not provided and must be downloaded using the html_download_url
1301
- */
1302
- html_omitted?: boolean;
1303
- /**
1304
- * HTML body download URL
1305
- * example:
1306
- * https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html
1307
- */
1308
- html_download_url?: string;
1309
- }
1310
- export interface $403 {
1311
- }
1312
- }
1313
- }
1314
- namespace GetThreadTimeline {
1315
- namespace Parameters {
1316
- export type Id = string;
1317
- }
1318
- export interface PathParameters {
1319
- id: Parameters.Id;
1320
- }
1321
- namespace Responses {
1322
- export type $200 = Components.Schemas.ThreadTimeline;
1323
- export interface $403 {
1324
- }
1325
- }
1326
- }
1327
- namespace GetUnread {
1328
- namespace Parameters {
1329
- export type Actor = "organization" | "user";
1330
- export type EmailFilter = string[] | string;
1331
- }
1332
- export interface PathParameters {
1333
- actor: Parameters.Actor;
1334
- }
1335
- export interface QueryParameters {
1336
- email_filter?: Parameters.EmailFilter;
1337
- }
1338
- namespace Responses {
1339
- export interface $200 {
1340
- /**
1341
- * Total of unread messages
1342
- * example:
1343
- * 14
1344
- */
1345
- count: number;
1346
- /**
1347
- * Total of unread messages
1348
- * example:
1349
- * 0
1350
- */
1351
- unread?: number;
1352
- /**
1353
- * Total of drafts messages
1354
- * example:
1355
- * 12
1356
- */
1357
- drafts?: number;
1358
- /**
1359
- * Total of unassigned messages
1360
- * example:
1361
- * 1
1362
- */
1363
- unassigned?: number;
1364
- /**
1365
- * Total of spam messages
1366
- * example:
1367
- * 3
1368
- */
1369
- spam?: number;
1370
- }
1371
- export interface $403 {
1372
- }
1373
- }
1374
- }
1375
- namespace MarkReadMessage {
1376
- namespace Parameters {
1377
- export type Id = string;
1378
- }
1379
- export interface PathParameters {
1380
- id: Parameters.Id;
1381
- }
1382
- namespace Responses {
1383
- export interface $204 {
1384
- }
1385
- export interface $403 {
1386
- }
1387
- }
1388
- }
1389
- namespace MarkReadMessageV2 {
1390
- namespace Parameters {
1391
- export type Id = string;
1392
- }
1393
- export interface PathParameters {
1394
- id: Parameters.Id;
1395
- }
1396
- export type RequestBody = Components.Schemas.ReadMessagePayload;
1397
- namespace Responses {
1398
- export interface $204 {
1399
- }
1400
- export interface $403 {
1401
- }
1402
- }
1403
- }
1404
- namespace MarkReadThread {
1405
- namespace Parameters {
1406
- export type Id = string;
1407
- }
1408
- export interface PathParameters {
1409
- id: Parameters.Id;
1410
- }
1411
- namespace Responses {
1412
- export interface $200 {
1413
- }
1414
- export interface $403 {
1415
- }
1416
- }
1417
- }
1418
- namespace MarkReadThreadV2 {
1419
- namespace Parameters {
1420
- export type Id = string;
1421
- }
1422
- export interface PathParameters {
1423
- id: Parameters.Id;
1424
- }
1425
- export type RequestBody = Components.Schemas.ReadMessagePayload;
1426
- namespace Responses {
1427
- export interface $200 {
1428
- }
1429
- export interface $403 {
1430
- }
1431
- }
1432
- }
1433
- namespace MarkThreadAsDone {
1434
- namespace Parameters {
1435
- export type Id = string;
1436
- }
1437
- export interface PathParameters {
1438
- id: Parameters.Id;
1439
- }
1440
- namespace Responses {
1441
- export interface $204 {
1442
- }
1443
- export interface $400 {
1444
- }
1445
- }
1446
- }
1447
- namespace MarkThreadAsOpen {
1448
- namespace Parameters {
1449
- export type Id = string;
1450
- }
1451
- export interface PathParameters {
1452
- id: Parameters.Id;
1453
- }
1454
- namespace Responses {
1455
- export interface $204 {
1456
- }
1457
- export interface $400 {
1458
- }
1459
- }
1460
- }
1461
- namespace MarkUnreadMessage {
1462
- namespace Parameters {
1463
- export type Id = string;
1464
- }
1465
- export interface PathParameters {
1466
- id: Parameters.Id;
1467
- }
1468
- namespace Responses {
1469
- export interface $204 {
1470
- }
1471
- export interface $403 {
1472
- }
1473
- }
1474
- }
1475
- namespace MarkUnreadMessageV2 {
1476
- namespace Parameters {
1477
- export type Id = string;
1478
- }
1479
- export interface PathParameters {
1480
- id: Parameters.Id;
1481
- }
1482
- export type RequestBody = Components.Schemas.ReadMessagePayload;
1483
- namespace Responses {
1484
- export interface $204 {
1485
- }
1486
- export interface $403 {
1487
- }
1488
- }
1489
- }
1490
- namespace MarkUnreadThread {
1491
- namespace Parameters {
1492
- export type Id = string;
1493
- }
1494
- export interface PathParameters {
1495
- id: Parameters.Id;
1496
- }
1497
- namespace Responses {
1498
- export interface $200 {
1499
- }
1500
- export interface $403 {
1501
- }
1502
- }
1503
- }
1504
- namespace MarkUnreadThreadV2 {
1505
- namespace Parameters {
1506
- export type Id = string;
1507
- }
1508
- export interface PathParameters {
1509
- id: Parameters.Id;
1510
- }
1511
- export type RequestBody = Components.Schemas.ReadMessagePayload;
1512
- namespace Responses {
1513
- export interface $200 {
1514
- }
1515
- export interface $403 {
1516
- }
1517
- }
1518
- }
1519
- namespace MoveThread {
1520
- namespace Parameters {
1521
- export type Id = string;
1522
- }
1523
- export interface PathParameters {
1524
- id: Parameters.Id;
1525
- }
1526
- export type RequestBody = Components.Schemas.MoveThreadPayload;
1527
- namespace Responses {
1528
- export interface $204 {
1529
- }
1530
- export type $400 = Components.Responses.BadRequest;
1531
- export type $403 = Components.Responses.Forbidden;
1532
- export type $404 = Components.Responses.NotFound;
1533
- export type $409 = Components.Responses.Conflict;
1534
- export type $500 = Components.Responses.InternalServerError;
1535
- }
1536
- }
1537
- namespace PinThread {
1538
- namespace Parameters {
1539
- export type Id = string;
1540
- }
1541
- export interface PathParameters {
1542
- id: Parameters.Id;
1543
- }
1544
- namespace Responses {
1545
- export interface $204 {
1546
- }
1547
- export interface $400 {
1548
- }
1549
- export interface $404 {
1550
- }
1551
- export interface $409 {
1552
- }
1553
- export interface $500 {
1554
- }
1555
- }
1556
- }
1557
- namespace SearchIds {
1558
- export type RequestBody = Components.Schemas.SearchIDParams;
1559
- namespace Responses {
1560
- export interface $200 {
1561
- /**
1562
- * Total of matched threads
1563
- * example:
1564
- * 14
1565
- */
1566
- hits: number;
1567
- /**
1568
- * Matched threads ids
1569
- */
1570
- results: string[];
1571
- }
1572
- export interface $403 {
1573
- }
1574
- }
1575
- }
1576
- namespace SearchMessages {
1577
- export type RequestBody = Components.Schemas.SearchParamsV2;
1578
- namespace Responses {
1579
- export interface $200 {
1580
- /**
1581
- * Total of matched messages
1582
- * example:
1583
- * 14
1584
- */
1585
- hits: number;
1586
- /**
1587
- * Matched messages
1588
- */
1589
- results: {
1590
- /**
1591
- * Entity ID
1592
- * example:
1593
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1594
- */
1595
- _id: string;
1596
- /**
1597
- * Entity title
1598
- */
1599
- _title: string;
1600
- /**
1601
- * Organization ID the entity belongs to
1602
- * example:
1603
- * 206801
1604
- */
1605
- _org: string;
1606
- /**
1607
- * URL-friendly identifier for the entity schema
1608
- * example:
1609
- * message
1610
- */
1611
- _schema: string;
1612
- /**
1613
- * Entity tags
1614
- * example:
1615
- * [
1616
- * "pricing",
1617
- * "INBOX"
1618
- * ]
1619
- */
1620
- _tags?: string[];
1621
- /**
1622
- * Created date
1623
- * example:
1624
- * 2021-02-09T12:41:43.662Z
1625
- */
1626
- _created_at: string; // date-time
1627
- /**
1628
- * Updated date
1629
- * example:
1630
- * 2021-02-10T09:14:31.990Z
1631
- */
1632
- _updated_at: string; // date-time
1633
- /**
1634
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
1635
- * example:
1636
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
1637
- */
1638
- message_id?: string;
1639
- /**
1640
- * User ID of user sends the message.
1641
- * example:
1642
- * 206801
1643
- */
1644
- sender?: string;
1645
- /**
1646
- * Subject
1647
- * example:
1648
- * Request for solar panel price
1649
- */
1650
- subject: string;
1651
- /**
1652
- * HTML body
1653
- * example:
1654
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
1655
- */
1656
- html?: string;
1657
- /**
1658
- * Text body
1659
- * example:
1660
- * We at ABC GmbH would like to request a price quote for the solar panel.
1661
- */
1662
- text?: string;
1663
- from: Components.Schemas.Address;
1664
- reply_to?: Components.Schemas.Address;
1665
- /**
1666
- * To email addresses
1667
- */
1668
- to?: Components.Schemas.Address[];
1669
- /**
1670
- * Cc email addresses
1671
- */
1672
- cc?: Components.Schemas.Address[];
1673
- /**
1674
- * Bcc email addresses
1675
- */
1676
- bcc?: Components.Schemas.Address[];
1677
- file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
1678
- /**
1679
- * 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.
1680
- *
1681
- * example:
1682
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1683
- */
1684
- references?: string;
1685
- /**
1686
- * In-Reply-To header. Value is the `message_id` of parent message.
1687
- *
1688
- * example:
1689
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
1690
- */
1691
- in_reply_to?: string;
1692
- /**
1693
- * User ID of user read the message.
1694
- * example:
1695
- * [
1696
- * "206801",
1697
- * "200109"
1698
- * ]
1699
- */
1700
- user_read_message?: string[];
1701
- /**
1702
- * Organization ID of organization read the message.
1703
- * example:
1704
- * [
1705
- * "789372",
1706
- * "210291"
1707
- * ]
1708
- */
1709
- org_read_message?: string[];
1710
- /**
1711
- * 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>
1712
- *
1713
- */
1714
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
1715
- /**
1716
- * Message type
1717
- */
1718
- type?: "SENT" | "RECEIVED";
1719
- /**
1720
- * Template ID used for sending message.
1721
- * example:
1722
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
1723
- */
1724
- template_id?: string;
1725
- }[];
1726
- }
1727
- export interface $403 {
1728
- }
1729
- }
1730
- }
1731
- namespace SearchThreads {
1732
- export type RequestBody = Components.Schemas.SearchParams;
1733
- namespace Responses {
1734
- export interface $200 {
1735
- /**
1736
- * Total of matched threads
1737
- * example:
1738
- * 14
1739
- */
1740
- hits: number;
1741
- /**
1742
- * Matched threads
1743
- */
1744
- results: {
1745
- /**
1746
- * Entity ID
1747
- * example:
1748
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1749
- */
1750
- _id: string;
1751
- /**
1752
- * Entity title
1753
- */
1754
- _title: string;
1755
- /**
1756
- * Organization ID the entity belongs to
1757
- * example:
1758
- * 206801
1759
- */
1760
- _org: string;
1761
- /**
1762
- * URL-friendly identifier for the entity schema
1763
- * example:
1764
- * message
1765
- */
1766
- _schema: string;
1767
- /**
1768
- * Entity tags
1769
- * example:
1770
- * [
1771
- * "pricing",
1772
- * "INBOX"
1773
- * ]
1774
- */
1775
- _tags?: string[];
1776
- /**
1777
- * Created date
1778
- * example:
1779
- * 2021-02-09T12:41:43.662Z
1780
- */
1781
- _created_at: string; // date-time
1782
- /**
1783
- * Updated date
1784
- * example:
1785
- * 2021-02-10T09:14:31.990Z
1786
- */
1787
- _updated_at: string; // date-time
1788
- /**
1789
- * Message topic (e.g. which service sends the message or message category)
1790
- * example:
1791
- * CUSTOMER_MESSAGE
1792
- */
1793
- topic: string;
1794
- /**
1795
- * User ID of who the message is assigned to. Default is the user who sends message.
1796
- * example:
1797
- * [
1798
- * "206801",
1799
- * "200109"
1800
- * ]
1801
- */
1802
- assigned_to?: string[];
1803
- /**
1804
- * Organization ID of organization read the message.
1805
- * example:
1806
- * [
1807
- * "789372",
1808
- * "210291"
1809
- * ]
1810
- */
1811
- org_read_message?: string[];
1812
- /**
1813
- * Whether the thread is marked as Done
1814
- * example:
1815
- * false
1816
- */
1817
- done?: boolean;
1818
- latest_message?: Components.Schemas.Message;
1819
- latest_trash_message?: Components.Schemas.Message;
1820
- /**
1821
- * The date of the latest message time in the thread
1822
- * example:
1823
- * 2024-02-10T09:14:31.990Z
1824
- */
1825
- latest_message_at?: string;
1826
- }[];
1827
- }
1828
- export interface $403 {
1829
- }
1830
- }
1831
- }
1832
- namespace SearchThreadsV2 {
1833
- export type RequestBody = Components.Schemas.SearchParamsV2;
1834
- namespace Responses {
1835
- export interface $200 {
1836
- /**
1837
- * Total of matched threads
1838
- * example:
1839
- * 14
1840
- */
1841
- hits: number;
1842
- /**
1843
- * Matched threads
1844
- */
1845
- results: {
1846
- /**
1847
- * Entity ID
1848
- * example:
1849
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1850
- */
1851
- _id: string;
1852
- /**
1853
- * Entity title
1854
- */
1855
- _title: string;
1856
- /**
1857
- * Organization ID the entity belongs to
1858
- * example:
1859
- * 206801
1860
- */
1861
- _org: string;
1862
- /**
1863
- * URL-friendly identifier for the entity schema
1864
- * example:
1865
- * message
1866
- */
1867
- _schema: string;
1868
- /**
1869
- * Entity tags
1870
- * example:
1871
- * [
1872
- * "pricing",
1873
- * "INBOX"
1874
- * ]
1875
- */
1876
- _tags?: string[];
1877
- /**
1878
- * Created date
1879
- * example:
1880
- * 2021-02-09T12:41:43.662Z
1881
- */
1882
- _created_at: string; // date-time
1883
- /**
1884
- * Updated date
1885
- * example:
1886
- * 2021-02-10T09:14:31.990Z
1887
- */
1888
- _updated_at: string; // date-time
1889
- /**
1890
- * Message topic (e.g. which service sends the message or message category)
1891
- * example:
1892
- * CUSTOMER_MESSAGE
1893
- */
1894
- topic: string;
1895
- /**
1896
- * User ID of who the message is assigned to. Default is the user who sends message.
1897
- * example:
1898
- * [
1899
- * "206801",
1900
- * "200109"
1901
- * ]
1902
- */
1903
- assigned_to?: string[];
1904
- /**
1905
- * Organization ID of organization read the message.
1906
- * example:
1907
- * [
1908
- * "789372",
1909
- * "210291"
1910
- * ]
1911
- */
1912
- org_read_message?: string[];
1913
- /**
1914
- * Whether the thread is marked as Done
1915
- * example:
1916
- * false
1917
- */
1918
- done?: boolean;
1919
- latest_message?: Components.Schemas.Message;
1920
- latest_trash_message?: Components.Schemas.Message;
1921
- /**
1922
- * The date of the latest message time in the thread
1923
- * example:
1924
- * 2024-02-10T09:14:31.990Z
1925
- */
1926
- latest_message_at?: string;
1927
- }[];
1928
- }
1929
- export interface $403 {
1930
- }
1931
- }
1932
- }
1933
- namespace SendDraft {
1934
- namespace Responses {
1935
- export interface $201 {
1936
- /**
1937
- * Entity ID
1938
- * example:
1939
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
1940
- */
1941
- _id: string;
1942
- /**
1943
- * Entity title
1944
- */
1945
- _title: string;
1946
- /**
1947
- * Organization ID the entity belongs to
1948
- * example:
1949
- * 206801
1950
- */
1951
- _org: string;
1952
- /**
1953
- * URL-friendly identifier for the entity schema
1954
- * example:
1955
- * message
1956
- */
1957
- _schema: string;
1958
- /**
1959
- * Entity tags
1960
- * example:
1961
- * [
1962
- * "pricing",
1963
- * "INBOX"
1964
- * ]
1965
- */
1966
- _tags?: string[];
1967
- /**
1968
- * Created date
1969
- * example:
1970
- * 2021-02-09T12:41:43.662Z
1971
- */
1972
- _created_at: string; // date-time
1973
- /**
1974
- * Updated date
1975
- * example:
1976
- * 2021-02-10T09:14:31.990Z
1977
- */
1978
- _updated_at: string; // date-time
1979
- /**
1980
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
1981
- * example:
1982
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
1983
- */
1984
- message_id?: string;
1985
- /**
1986
- * User ID of user sends the message.
1987
- * example:
1988
- * 206801
1989
- */
1990
- sender?: string;
1991
- /**
1992
- * Subject
1993
- * example:
1994
- * Request for solar panel price
1995
- */
1996
- subject: string;
1997
- /**
1998
- * HTML body
1999
- * example:
2000
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
2001
- */
2002
- html?: string;
2003
- /**
2004
- * Text body
2005
- * example:
2006
- * We at ABC GmbH would like to request a price quote for the solar panel.
2007
- */
2008
- text?: string;
2009
- from: Components.Schemas.Address;
2010
- reply_to?: Components.Schemas.Address;
2011
- /**
2012
- * To email addresses
2013
- */
2014
- to?: Components.Schemas.Address[];
2015
- /**
2016
- * Cc email addresses
2017
- */
2018
- cc?: Components.Schemas.Address[];
2019
- /**
2020
- * Bcc email addresses
2021
- */
2022
- bcc?: Components.Schemas.Address[];
2023
- file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
2024
- /**
2025
- * 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.
2026
- *
2027
- * example:
2028
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
2029
- */
2030
- references?: string;
2031
- /**
2032
- * In-Reply-To header. Value is the `message_id` of parent message.
2033
- *
2034
- * example:
2035
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
2036
- */
2037
- in_reply_to?: string;
2038
- /**
2039
- * User ID of user read the message.
2040
- * example:
2041
- * [
2042
- * "206801",
2043
- * "200109"
2044
- * ]
2045
- */
2046
- user_read_message?: string[];
2047
- /**
2048
- * Organization ID of organization read the message.
2049
- * example:
2050
- * [
2051
- * "789372",
2052
- * "210291"
2053
- * ]
2054
- */
2055
- org_read_message?: string[];
2056
- /**
2057
- * 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>
2058
- *
2059
- */
2060
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
2061
- /**
2062
- * Message type
2063
- */
2064
- type?: "SENT" | "RECEIVED";
2065
- /**
2066
- * Template ID used for sending message.
2067
- * example:
2068
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
2069
- */
2070
- template_id?: string;
2071
- }
2072
- export interface $403 {
2073
- }
2074
- }
2075
- }
2076
- namespace SendMessage {
2077
- namespace Parameters {
2078
- export type DoNotCreateEntities = boolean;
2079
- }
2080
- export interface QueryParameters {
2081
- do_not_create_entities?: Parameters.DoNotCreateEntities;
2082
- }
2083
- export type RequestBody = Components.Schemas.MessageRequestParams;
2084
- namespace Responses {
2085
- export type $201 = Components.Schemas.MessageRequestParams;
2086
- export interface $403 {
2087
- }
2088
- }
2089
- }
2090
- namespace SpamMessage {
2091
- namespace Parameters {
2092
- export type Id = string;
2093
- }
2094
- export interface PathParameters {
2095
- id: Parameters.Id;
2096
- }
2097
- namespace Responses {
2098
- export interface $204 {
2099
- }
2100
- export interface $403 {
2101
- }
2102
- export interface $404 {
2103
- }
2104
- }
2105
- }
2106
- namespace SpamThread {
2107
- namespace Parameters {
2108
- export type Id = string;
2109
- }
2110
- export interface PathParameters {
2111
- id: Parameters.Id;
2112
- }
2113
- namespace Responses {
2114
- export interface $200 {
2115
- }
2116
- export interface $403 {
2117
- }
2118
- export interface $404 {
2119
- }
2120
- }
2121
- }
2122
- namespace ThreadBulkActionsDelete {
2123
- export type RequestBody = Components.Schemas.BulkActionsPayload;
2124
- namespace Responses {
2125
- export interface $200 {
2126
- }
2127
- export interface $403 {
2128
- }
2129
- }
2130
- }
2131
- namespace ThreadBulkActionsDone {
2132
- export type RequestBody = Components.Schemas.BulkActionsPayload;
2133
- namespace Responses {
2134
- export interface $200 {
2135
- }
2136
- export interface $403 {
2137
- }
2138
- }
2139
- }
2140
- namespace ThreadBulkActionsFavorite {
2141
- export type RequestBody = Components.Schemas.BulkActionsPayload;
2142
- namespace Responses {
2143
- export interface $200 {
2144
- }
2145
- export interface $403 {
2146
- }
2147
- }
2148
- }
2149
- namespace ThreadBulkActionsOpen {
2150
- export type RequestBody = Components.Schemas.BulkActionsPayload;
2151
- namespace Responses {
2152
- export interface $200 {
2153
- }
2154
- export interface $403 {
2155
- }
2156
- }
2157
- }
2158
- namespace ThreadBulkActionsRead {
2159
- export type RequestBody = Components.Schemas.BulkActionsPayloadWithScopes;
2160
- namespace Responses {
2161
- export interface $200 {
2162
- }
2163
- export interface $403 {
2164
- }
2165
- }
2166
- }
2167
- namespace ThreadBulkActionsTrash {
2168
- export type RequestBody = Components.Schemas.BulkActionsPayload;
2169
- namespace Responses {
2170
- export interface $200 {
2171
- }
2172
- export interface $403 {
2173
- }
2174
- }
2175
- }
2176
- namespace ThreadBulkActionsUnfavorite {
2177
- export type RequestBody = Components.Schemas.BulkActionsPayload;
2178
- namespace Responses {
2179
- export interface $200 {
2180
- }
2181
- export interface $403 {
2182
- }
2183
- }
2184
- }
2185
- namespace ThreadBulkActionsUnread {
2186
- export type RequestBody = Components.Schemas.BulkActionsPayloadWithScopes;
2187
- namespace Responses {
2188
- export interface $200 {
2189
- }
2190
- export interface $403 {
2191
- }
2192
- }
2193
- }
2194
- namespace ThreadBulkActionsUntrash {
2195
- export type RequestBody = Components.Schemas.BulkActionsPayload;
2196
- namespace Responses {
2197
- export interface $200 {
2198
- }
2199
- export interface $403 {
2200
- }
2201
- }
2202
- }
2203
- namespace TrashMessage {
2204
- namespace Parameters {
2205
- export type Id = string;
2206
- }
2207
- export interface PathParameters {
2208
- id: Parameters.Id;
2209
- }
2210
- namespace Responses {
2211
- export interface $204 {
2212
- }
2213
- export interface $403 {
2214
- }
2215
- }
2216
- }
2217
- namespace TrashThread {
2218
- namespace Parameters {
2219
- export type Id = string;
2220
- }
2221
- export interface PathParameters {
2222
- id: Parameters.Id;
2223
- }
2224
- namespace Responses {
2225
- export interface $200 {
2226
- }
2227
- export interface $403 {
2228
- }
2229
- }
2230
- }
2231
- namespace UnassignThread {
2232
- namespace Parameters {
2233
- export type Id = string;
2234
- export type UnlinkMappedEntities = boolean;
2235
- }
2236
- export interface PathParameters {
2237
- id: Parameters.Id;
2238
- }
2239
- export interface QueryParameters {
2240
- unlink_mapped_entities?: Parameters.UnlinkMappedEntities;
2241
- }
2242
- /**
2243
- * Entities which thread is unassigned from
2244
- */
2245
- export type RequestBody = {
2246
- /**
2247
- * Entity slug
2248
- * example:
2249
- * contact
2250
- */
2251
- slug?: string;
2252
- /**
2253
- * Entity ID
2254
- * example:
2255
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
2256
- */
2257
- entity_id?: string;
2258
- }[];
2259
- namespace Responses {
2260
- export interface $204 {
2261
- }
2262
- export interface $403 {
2263
- }
2264
- }
2265
- }
2266
- namespace UnpinThread {
2267
- namespace Parameters {
2268
- export type Id = string;
2269
- }
2270
- export interface PathParameters {
2271
- id: Parameters.Id;
2272
- }
2273
- namespace Responses {
2274
- export interface $204 {
2275
- }
2276
- export interface $400 {
2277
- }
2278
- export interface $404 {
2279
- }
2280
- export interface $409 {
2281
- }
2282
- export interface $500 {
2283
- }
2284
- }
2285
- }
2286
- namespace UnspamMessage {
2287
- namespace Parameters {
2288
- export type Id = string;
2289
- }
2290
- export interface PathParameters {
2291
- id: Parameters.Id;
2292
- }
2293
- namespace Responses {
2294
- export interface $204 {
2295
- }
2296
- export interface $403 {
2297
- }
2298
- export interface $404 {
2299
- }
2300
- }
2301
- }
2302
- namespace UnspamThread {
2303
- namespace Parameters {
2304
- export type Id = string;
2305
- }
2306
- export interface PathParameters {
2307
- id: Parameters.Id;
2308
- }
2309
- namespace Responses {
2310
- export interface $200 {
2311
- }
2312
- export interface $403 {
2313
- }
2314
- export interface $404 {
2315
- }
2316
- }
2317
- }
2318
- namespace UntrashMessage {
2319
- namespace Parameters {
2320
- export type Id = string;
2321
- }
2322
- export interface PathParameters {
2323
- id: Parameters.Id;
2324
- }
2325
- namespace Responses {
2326
- export interface $204 {
2327
- }
2328
- export interface $403 {
2329
- }
2330
- }
2331
- }
2332
- namespace UntrashThread {
2333
- namespace Parameters {
2334
- export type Id = string;
2335
- }
2336
- export interface PathParameters {
2337
- id: Parameters.Id;
2338
- }
2339
- namespace Responses {
2340
- export interface $200 {
2341
- }
2342
- export interface $403 {
2343
- }
2344
- }
2345
- }
2346
- namespace UpdateMessage {
2347
- namespace Responses {
2348
- export interface $201 {
2349
- /**
2350
- * Entity ID
2351
- * example:
2352
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
2353
- */
2354
- _id: string;
2355
- /**
2356
- * Entity title
2357
- */
2358
- _title: string;
2359
- /**
2360
- * Organization ID the entity belongs to
2361
- * example:
2362
- * 206801
2363
- */
2364
- _org: string;
2365
- /**
2366
- * URL-friendly identifier for the entity schema
2367
- * example:
2368
- * message
2369
- */
2370
- _schema: string;
2371
- /**
2372
- * Entity tags
2373
- * example:
2374
- * [
2375
- * "pricing",
2376
- * "INBOX"
2377
- * ]
2378
- */
2379
- _tags?: string[];
2380
- /**
2381
- * Created date
2382
- * example:
2383
- * 2021-02-09T12:41:43.662Z
2384
- */
2385
- _created_at: string; // date-time
2386
- /**
2387
- * Updated date
2388
- * example:
2389
- * 2021-02-10T09:14:31.990Z
2390
- */
2391
- _updated_at: string; // date-time
2392
- /**
2393
- * Message ID which is from email provider. If you provide `message-id`, API overrides by its own value.
2394
- * example:
2395
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com>
2396
- */
2397
- message_id?: string;
2398
- /**
2399
- * User ID of user sends the message.
2400
- * example:
2401
- * 206801
2402
- */
2403
- sender?: string;
2404
- /**
2405
- * Subject
2406
- * example:
2407
- * Request for solar panel price
2408
- */
2409
- subject: string;
2410
- /**
2411
- * HTML body
2412
- * example:
2413
- * <div>We at ABC GmbH would like to request a price quote for the solar panel.</div>
2414
- */
2415
- html?: string;
2416
- /**
2417
- * Text body
2418
- * example:
2419
- * We at ABC GmbH would like to request a price quote for the solar panel.
2420
- */
2421
- text?: string;
2422
- from: Components.Schemas.Address;
2423
- reply_to?: Components.Schemas.Address;
2424
- /**
2425
- * To email addresses
2426
- */
2427
- to?: Components.Schemas.Address[];
2428
- /**
2429
- * Cc email addresses
2430
- */
2431
- cc?: Components.Schemas.Address[];
2432
- /**
2433
- * Bcc email addresses
2434
- */
2435
- bcc?: Components.Schemas.Address[];
2436
- file?: /* Message attachments */ Components.Schemas.AttachmentsRelation;
2437
- /**
2438
- * 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.
2439
- *
2440
- * example:
2441
- * <0102017b97a502f8-a67f01c2-68cc-4928-b91b-45853f34e259-000000@eu-west-1.amazonses.com> <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
2442
- */
2443
- references?: string;
2444
- /**
2445
- * In-Reply-To header. Value is the `message_id` of parent message.
2446
- *
2447
- * example:
2448
- * <CALHgQpziyxW9NaFUs+nRMykzr6Ljq6vjq4WO9SaihAuMasuDyg@mail.gmail.com>
2449
- */
2450
- in_reply_to?: string;
2451
- /**
2452
- * User ID of user read the message.
2453
- * example:
2454
- * [
2455
- * "206801",
2456
- * "200109"
2457
- * ]
2458
- */
2459
- user_read_message?: string[];
2460
- /**
2461
- * Organization ID of organization read the message.
2462
- * example:
2463
- * [
2464
- * "789372",
2465
- * "210291"
2466
- * ]
2467
- */
2468
- org_read_message?: string[];
2469
- /**
2470
- * 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>
2471
- *
2472
- */
2473
- send_status?: ("SEND" | "DELIVERY" | "REJECT" | "COMPLAINT" | "BOUNCE" | "ERROR")[];
2474
- /**
2475
- * Message type
2476
- */
2477
- type?: "SENT" | "RECEIVED";
2478
- /**
2479
- * Template ID used for sending message.
2480
- * example:
2481
- * 3f34ce73-089c-4d45-a5ee-c161234e41c3
2482
- */
2483
- template_id?: string;
2484
- }
2485
- export interface $403 {
2486
- }
2487
- }
2488
- }
2489
- namespace UpdateThread {
2490
- namespace Responses {
2491
- /**
2492
- * Thread properties depend on API caller as it's not pre-defined. We do recommend having at least `topic` property for categorizing.
2493
- */
2494
- export interface $201 {
2495
- /**
2496
- * Entity ID
2497
- * example:
2498
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
2499
- */
2500
- _id: string;
2501
- /**
2502
- * Entity title
2503
- */
2504
- _title: string;
2505
- /**
2506
- * Organization ID the entity belongs to
2507
- * example:
2508
- * 206801
2509
- */
2510
- _org: string;
2511
- /**
2512
- * URL-friendly identifier for the entity schema
2513
- * example:
2514
- * message
2515
- */
2516
- _schema: string;
2517
- /**
2518
- * Entity tags
2519
- * example:
2520
- * [
2521
- * "pricing",
2522
- * "INBOX"
2523
- * ]
2524
- */
2525
- _tags?: string[];
2526
- /**
2527
- * Created date
2528
- * example:
2529
- * 2021-02-09T12:41:43.662Z
2530
- */
2531
- _created_at: string; // date-time
2532
- /**
2533
- * Updated date
2534
- * example:
2535
- * 2021-02-10T09:14:31.990Z
2536
- */
2537
- _updated_at: string; // date-time
2538
- /**
2539
- * Message topic (e.g. which service sends the message or message category)
2540
- * example:
2541
- * CUSTOMER_MESSAGE
2542
- */
2543
- topic: string;
2544
- /**
2545
- * User ID of who the message is assigned to. Default is the user who sends message.
2546
- * example:
2547
- * [
2548
- * "206801",
2549
- * "200109"
2550
- * ]
2551
- */
2552
- assigned_to?: string[];
2553
- /**
2554
- * Organization ID of organization read the message.
2555
- * example:
2556
- * [
2557
- * "789372",
2558
- * "210291"
2559
- * ]
2560
- */
2561
- org_read_message?: string[];
2562
- /**
2563
- * Whether the thread is marked as Done
2564
- * example:
2565
- * false
2566
- */
2567
- done?: boolean;
2568
- latest_message?: Components.Schemas.Message;
2569
- latest_trash_message?: Components.Schemas.Message;
2570
- /**
2571
- * The date of the latest message time in the thread
2572
- * example:
2573
- * 2024-02-10T09:14:31.990Z
2574
- */
2575
- latest_message_at?: string;
2576
- }
2577
- export interface $403 {
2578
- }
2579
- }
2580
- }
2581
- }
2582
-
2583
-
2584
- interface OperationMethods {
2585
- /**
2586
- * updateMessage - updateMessage
2587
- *
2588
- * Update message metadata
2589
- */
2590
- 'updateMessage'(
2591
- parameters?: Parameters<UnknownParamsObject> | null,
2592
- data?: any,
2593
- config?: AxiosRequestConfig
2594
- ): OperationResponse<Paths.UpdateMessage.Responses.$201>
2595
- /**
2596
- * sendMessage - sendMessage
2597
- *
2598
- * Send an email message
2599
- */
2600
- 'sendMessage'(
2601
- parameters?: Parameters<Paths.SendMessage.QueryParameters> | null,
2602
- data?: Paths.SendMessage.RequestBody,
2603
- config?: AxiosRequestConfig
2604
- ): OperationResponse<Paths.SendMessage.Responses.$201>
2605
- /**
2606
- * getMessage - getMessage
2607
- *
2608
- * Get an email message by id
2609
- */
2610
- 'getMessage'(
2611
- parameters?: Parameters<Paths.GetMessage.PathParameters> | null,
2612
- data?: any,
2613
- config?: AxiosRequestConfig
2614
- ): OperationResponse<Paths.GetMessage.Responses.$200>
2615
- /**
2616
- * deleteMessage - deleteMessage
2617
- *
2618
- * Immediately and permanently delete a message. This operation cannot be undone.
2619
- */
2620
- 'deleteMessage'(
2621
- parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
2622
- data?: any,
2623
- config?: AxiosRequestConfig
2624
- ): OperationResponse<Paths.DeleteMessage.Responses.$204>
2625
- /**
2626
- * getMessageEml - getMessageEml
2627
- *
2628
- * Download a message as an EML file.
2629
- * Returns a 302 redirect to a pre-signed S3 URL where the EML file can be downloaded.
2630
- *
2631
- */
2632
- 'getMessageEml'(
2633
- parameters?: Parameters<Paths.GetMessageEml.PathParameters> | null,
2634
- data?: any,
2635
- config?: AxiosRequestConfig
2636
- ): OperationResponse<any>
2637
- /**
2638
- * searchMessages - searchMessages
2639
- *
2640
- * Search Messages
2641
- */
2642
- 'searchMessages'(
2643
- parameters?: Parameters<UnknownParamsObject> | null,
2644
- data?: Paths.SearchMessages.RequestBody,
2645
- config?: AxiosRequestConfig
2646
- ): OperationResponse<Paths.SearchMessages.Responses.$200>
2647
- /**
2648
- * trashMessage - trashMessage
2649
- *
2650
- * Move a message to the trash
2651
- */
2652
- 'trashMessage'(
2653
- parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
2654
- data?: any,
2655
- config?: AxiosRequestConfig
2656
- ): OperationResponse<Paths.TrashMessage.Responses.$204>
2657
- /**
2658
- * untrashMessage - untrashMessage
2659
- *
2660
- * Restore a trashed message
2661
- */
2662
- 'untrashMessage'(
2663
- parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
2664
- data?: any,
2665
- config?: AxiosRequestConfig
2666
- ): OperationResponse<Paths.UntrashMessage.Responses.$204>
2667
- /**
2668
- * markReadMessage - markReadMessage
2669
- *
2670
- * Mark message as read
2671
- */
2672
- 'markReadMessage'(
2673
- parameters?: Parameters<Paths.MarkReadMessage.PathParameters> | null,
2674
- data?: any,
2675
- config?: AxiosRequestConfig
2676
- ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
2677
- /**
2678
- * markReadMessageV2 - markReadMessageV2
2679
- *
2680
- * Mark message as read within a scope
2681
- */
2682
- 'markReadMessageV2'(
2683
- parameters?: Parameters<Paths.MarkReadMessageV2.PathParameters> | null,
2684
- data?: Paths.MarkReadMessageV2.RequestBody,
2685
- config?: AxiosRequestConfig
2686
- ): OperationResponse<Paths.MarkReadMessageV2.Responses.$204>
2687
- /**
2688
- * markUnreadMessage - markUnreadMessage
2689
- *
2690
- * Mark message as unread
2691
- */
2692
- 'markUnreadMessage'(
2693
- parameters?: Parameters<Paths.MarkUnreadMessage.PathParameters> | null,
2694
- data?: any,
2695
- config?: AxiosRequestConfig
2696
- ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
2697
- /**
2698
- * getUnread - getUnread
2699
- *
2700
- * Get all unread messages by actor
2701
- */
2702
- 'getUnread'(
2703
- parameters?: Parameters<Paths.GetUnread.QueryParameters & Paths.GetUnread.PathParameters> | null,
2704
- data?: any,
2705
- config?: AxiosRequestConfig
2706
- ): OperationResponse<Paths.GetUnread.Responses.$200>
2707
- /**
2708
- * markUnreadMessageV2 - markUnreadMessageV2
2709
- *
2710
- * Mark message as unread within a scope
2711
- */
2712
- 'markUnreadMessageV2'(
2713
- parameters?: Parameters<Paths.MarkUnreadMessageV2.PathParameters> | null,
2714
- data?: Paths.MarkUnreadMessageV2.RequestBody,
2715
- config?: AxiosRequestConfig
2716
- ): OperationResponse<Paths.MarkUnreadMessageV2.Responses.$204>
2717
- /**
2718
- * searchThreads - searchThreads
2719
- *
2720
- * Search for threads of email messages.
2721
- *
2722
- * Messages with no replies yet are treated as threads with single message.
2723
- *
2724
- * Lucene syntax supported.
2725
- *
2726
- */
2727
- 'searchThreads'(
2728
- parameters?: Parameters<UnknownParamsObject> | null,
2729
- data?: Paths.SearchThreads.RequestBody,
2730
- config?: AxiosRequestConfig
2731
- ): OperationResponse<Paths.SearchThreads.Responses.$200>
2732
- /**
2733
- * searchThreadsV2 - searchThreadsV2
2734
- *
2735
- * Search for threads of email messages.
2736
- *
2737
- * Messages with no replies yet are treated as threads with single message.
2738
- *
2739
- * Lucene syntax supported.
2740
- *
2741
- */
2742
- 'searchThreadsV2'(
2743
- parameters?: Parameters<UnknownParamsObject> | null,
2744
- data?: Paths.SearchThreadsV2.RequestBody,
2745
- config?: AxiosRequestConfig
2746
- ): OperationResponse<Paths.SearchThreadsV2.Responses.$200>
2747
- /**
2748
- * searchIds - Search threads and return all id's
2749
- *
2750
- * Return all thread id's that match a criteria
2751
- *
2752
- * Lucene syntax supported.
2753
- *
2754
- */
2755
- 'searchIds'(
2756
- parameters?: Parameters<UnknownParamsObject> | null,
2757
- data?: Paths.SearchIds.RequestBody,
2758
- config?: AxiosRequestConfig
2759
- ): OperationResponse<Paths.SearchIds.Responses.$200>
2760
- /**
2761
- * updateThread - updateThread
2762
- *
2763
- * Modify thread metadata
2764
- */
2765
- 'updateThread'(
2766
- parameters?: Parameters<UnknownParamsObject> | null,
2767
- data?: any,
2768
- config?: AxiosRequestConfig
2769
- ): OperationResponse<Paths.UpdateThread.Responses.$201>
2770
- /**
2771
- * deleteThread - deleteThread
2772
- *
2773
- * Immediately and permanently delete a thread. This operation cannot be undone.
2774
- */
2775
- 'deleteThread'(
2776
- parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
2777
- data?: any,
2778
- config?: AxiosRequestConfig
2779
- ): OperationResponse<Paths.DeleteThread.Responses.$204>
2780
- /**
2781
- * moveThread - moveThread
2782
- *
2783
- * Move thread to a different Inbox
2784
- */
2785
- 'moveThread'(
2786
- parameters?: Parameters<Paths.MoveThread.PathParameters> | null,
2787
- data?: Paths.MoveThread.RequestBody,
2788
- config?: AxiosRequestConfig
2789
- ): OperationResponse<Paths.MoveThread.Responses.$204>
2790
- /**
2791
- * markThreadAsDone - markThreadAsDone
2792
- *
2793
- * Mark thread as done
2794
- */
2795
- 'markThreadAsDone'(
2796
- parameters?: Parameters<Paths.MarkThreadAsDone.PathParameters> | null,
2797
- data?: any,
2798
- config?: AxiosRequestConfig
2799
- ): OperationResponse<Paths.MarkThreadAsDone.Responses.$204>
2800
- /**
2801
- * markThreadAsOpen - markThreadAsOpen
2802
- *
2803
- * Mark thread as open
2804
- */
2805
- 'markThreadAsOpen'(
2806
- parameters?: Parameters<Paths.MarkThreadAsOpen.PathParameters> | null,
2807
- data?: any,
2808
- config?: AxiosRequestConfig
2809
- ): OperationResponse<Paths.MarkThreadAsOpen.Responses.$204>
2810
- /**
2811
- * getThreadTimeline - getThreadTimeline
2812
- *
2813
- * Get thread timeline
2814
- */
2815
- 'getThreadTimeline'(
2816
- parameters?: Parameters<Paths.GetThreadTimeline.PathParameters> | null,
2817
- data?: any,
2818
- config?: AxiosRequestConfig
2819
- ): OperationResponse<Paths.GetThreadTimeline.Responses.$200>
2820
- /**
2821
- * trashThread - trashThread
2822
- *
2823
- * Move a thread to trash
2824
- */
2825
- 'trashThread'(
2826
- parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
2827
- data?: any,
2828
- config?: AxiosRequestConfig
2829
- ): OperationResponse<Paths.TrashThread.Responses.$200>
2830
- /**
2831
- * untrashThread - untrashThread
2832
- *
2833
- * Restore a trashed thread
2834
- */
2835
- 'untrashThread'(
2836
- parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
2837
- data?: any,
2838
- config?: AxiosRequestConfig
2839
- ): OperationResponse<Paths.UntrashThread.Responses.$200>
2840
- /**
2841
- * spamThread - spamThread
2842
- *
2843
- * Mark a thread as spam
2844
- */
2845
- 'spamThread'(
2846
- parameters?: Parameters<Paths.SpamThread.PathParameters> | null,
2847
- data?: any,
2848
- config?: AxiosRequestConfig
2849
- ): OperationResponse<Paths.SpamThread.Responses.$200>
2850
- /**
2851
- * unspamThread - unspamThread
2852
- *
2853
- * Remove spam marking from a thread
2854
- */
2855
- 'unspamThread'(
2856
- parameters?: Parameters<Paths.UnspamThread.PathParameters> | null,
2857
- data?: any,
2858
- config?: AxiosRequestConfig
2859
- ): OperationResponse<Paths.UnspamThread.Responses.$200>
2860
- /**
2861
- * spamMessage - spamMessage
2862
- *
2863
- * Mark a single message as spam. Also marks the parent thread as spam if all messages in the thread are spam.
2864
- */
2865
- 'spamMessage'(
2866
- parameters?: Parameters<Paths.SpamMessage.PathParameters> | null,
2867
- data?: any,
2868
- config?: AxiosRequestConfig
2869
- ): OperationResponse<Paths.SpamMessage.Responses.$204>
2870
- /**
2871
- * unspamMessage - unspamMessage
2872
- *
2873
- * Remove spam marking from a single message. Also removes spam from the parent thread if no other messages are spam.
2874
- */
2875
- 'unspamMessage'(
2876
- parameters?: Parameters<Paths.UnspamMessage.PathParameters> | null,
2877
- data?: any,
2878
- config?: AxiosRequestConfig
2879
- ): OperationResponse<Paths.UnspamMessage.Responses.$204>
2880
- /**
2881
- * bulkMoveThreads - bulkMoveThreads
2882
- *
2883
- * Move many threads to a different inbox
2884
- */
2885
- 'bulkMoveThreads'(
2886
- parameters?: Parameters<UnknownParamsObject> | null,
2887
- data?: Paths.BulkMoveThreads.RequestBody,
2888
- config?: AxiosRequestConfig
2889
- ): OperationResponse<Paths.BulkMoveThreads.Responses.$200>
2890
- /**
2891
- * bulkAssignThreads - bulkAssignThreads
2892
- *
2893
- * Assign many threads
2894
- */
2895
- 'bulkAssignThreads'(
2896
- parameters?: Parameters<UnknownParamsObject> | null,
2897
- data?: Paths.BulkAssignThreads.RequestBody,
2898
- config?: AxiosRequestConfig
2899
- ): OperationResponse<Paths.BulkAssignThreads.Responses.$200>
2900
- /**
2901
- * threadBulkActionsRead - threadBulkActionsRead
2902
- *
2903
- * Perform a bulk action of marking an array of thread ids as read
2904
- */
2905
- 'threadBulkActionsRead'(
2906
- parameters?: Parameters<UnknownParamsObject> | null,
2907
- data?: Paths.ThreadBulkActionsRead.RequestBody,
2908
- config?: AxiosRequestConfig
2909
- ): OperationResponse<Paths.ThreadBulkActionsRead.Responses.$200>
2910
- /**
2911
- * threadBulkActionsUnread - threadBulkActionsUnread
2912
- *
2913
- * Perform a bulk action of marking an array of thread ids as unread
2914
- */
2915
- 'threadBulkActionsUnread'(
2916
- parameters?: Parameters<UnknownParamsObject> | null,
2917
- data?: Paths.ThreadBulkActionsUnread.RequestBody,
2918
- config?: AxiosRequestConfig
2919
- ): OperationResponse<Paths.ThreadBulkActionsUnread.Responses.$200>
2920
- /**
2921
- * threadBulkActionsFavorite - threadBulkActionsFavorite
2922
- *
2923
- * Perform a bulk action of marking an array of thread ids favorite
2924
- */
2925
- 'threadBulkActionsFavorite'(
2926
- parameters?: Parameters<UnknownParamsObject> | null,
2927
- data?: Paths.ThreadBulkActionsFavorite.RequestBody,
2928
- config?: AxiosRequestConfig
2929
- ): OperationResponse<Paths.ThreadBulkActionsFavorite.Responses.$200>
2930
- /**
2931
- * threadBulkActionsUnfavorite - threadBulkActionsUnfavorite
2932
- *
2933
- * Perform a bulk action of marking an array of thread ids unfavorited
2934
- */
2935
- 'threadBulkActionsUnfavorite'(
2936
- parameters?: Parameters<UnknownParamsObject> | null,
2937
- data?: Paths.ThreadBulkActionsUnfavorite.RequestBody,
2938
- config?: AxiosRequestConfig
2939
- ): OperationResponse<Paths.ThreadBulkActionsUnfavorite.Responses.$200>
2940
- /**
2941
- * threadBulkActionsTrash - threadBulkActionsTrash
2942
- *
2943
- * Perform a bulk action of trashing an array of threads
2944
- */
2945
- 'threadBulkActionsTrash'(
2946
- parameters?: Parameters<UnknownParamsObject> | null,
2947
- data?: Paths.ThreadBulkActionsTrash.RequestBody,
2948
- config?: AxiosRequestConfig
2949
- ): OperationResponse<Paths.ThreadBulkActionsTrash.Responses.$200>
2950
- /**
2951
- * threadBulkActionsUntrash - threadBulkActionsUntrash
2952
- *
2953
- * Perform a bulk action of untrashing an array of threads
2954
- */
2955
- 'threadBulkActionsUntrash'(
2956
- parameters?: Parameters<UnknownParamsObject> | null,
2957
- data?: Paths.ThreadBulkActionsUntrash.RequestBody,
2958
- config?: AxiosRequestConfig
2959
- ): OperationResponse<Paths.ThreadBulkActionsUntrash.Responses.$200>
2960
- /**
2961
- * threadBulkActionsDelete - threadBulkActionsDelete
2962
- *
2963
- * Performs a bulk permanent delete for all threads
2964
- */
2965
- 'threadBulkActionsDelete'(
2966
- parameters?: Parameters<UnknownParamsObject> | null,
2967
- data?: Paths.ThreadBulkActionsDelete.RequestBody,
2968
- config?: AxiosRequestConfig
2969
- ): OperationResponse<Paths.ThreadBulkActionsDelete.Responses.$200>
2970
- /**
2971
- * threadBulkActionsDone - threadBulkActionsDone
2972
- *
2973
- * Perform a bulk action of marking an array of threads as done
2974
- */
2975
- 'threadBulkActionsDone'(
2976
- parameters?: Parameters<UnknownParamsObject> | null,
2977
- data?: Paths.ThreadBulkActionsDone.RequestBody,
2978
- config?: AxiosRequestConfig
2979
- ): OperationResponse<Paths.ThreadBulkActionsDone.Responses.$200>
2980
- /**
2981
- * threadBulkActionsOpen - threadBulkActionsOpen
2982
- *
2983
- * Perform a bulk action of marking an array of threads as open
2984
- */
2985
- 'threadBulkActionsOpen'(
2986
- parameters?: Parameters<UnknownParamsObject> | null,
2987
- data?: Paths.ThreadBulkActionsOpen.RequestBody,
2988
- config?: AxiosRequestConfig
2989
- ): OperationResponse<Paths.ThreadBulkActionsOpen.Responses.$200>
2990
- /**
2991
- * markReadThread - markReadThread
2992
- *
2993
- * Mark thread as read
2994
- */
2995
- 'markReadThread'(
2996
- parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
2997
- data?: any,
2998
- config?: AxiosRequestConfig
2999
- ): OperationResponse<Paths.MarkReadThread.Responses.$200>
3000
- /**
3001
- * markReadThreadV2 - markReadThreadV2
3002
- *
3003
- * Mark thread as read within a scope
3004
- */
3005
- 'markReadThreadV2'(
3006
- parameters?: Parameters<Paths.MarkReadThreadV2.PathParameters> | null,
3007
- data?: Paths.MarkReadThreadV2.RequestBody,
3008
- config?: AxiosRequestConfig
3009
- ): OperationResponse<Paths.MarkReadThreadV2.Responses.$200>
3010
- /**
3011
- * markUnreadThread - markUnreadThread
3012
- *
3013
- * Mark thread as unread
3014
- */
3015
- 'markUnreadThread'(
3016
- parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
3017
- data?: any,
3018
- config?: AxiosRequestConfig
3019
- ): OperationResponse<Paths.MarkUnreadThread.Responses.$200>
3020
- /**
3021
- * markUnreadThreadV2 - markUnreadThreadV2
3022
- *
3023
- * Mark thread as unread within a scope
3024
- */
3025
- 'markUnreadThreadV2'(
3026
- parameters?: Parameters<Paths.MarkUnreadThreadV2.PathParameters> | null,
3027
- data?: Paths.MarkUnreadThreadV2.RequestBody,
3028
- config?: AxiosRequestConfig
3029
- ): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$200>
3030
- /**
3031
- * assignThread - assignThread
3032
- *
3033
- * Assign thread to entities
3034
- */
3035
- 'assignThread'(
3036
- parameters?: Parameters<Paths.AssignThread.PathParameters> | null,
3037
- data?: Paths.AssignThread.RequestBody,
3038
- config?: AxiosRequestConfig
3039
- ): OperationResponse<Paths.AssignThread.Responses.$204>
3040
- /**
3041
- * unassignThread - unassignThread
3042
- *
3043
- * Unassign thread from entities
3044
- */
3045
- 'unassignThread'(
3046
- parameters?: Parameters<Paths.UnassignThread.QueryParameters & Paths.UnassignThread.PathParameters> | null,
3047
- data?: Paths.UnassignThread.RequestBody,
3048
- config?: AxiosRequestConfig
3049
- ): OperationResponse<Paths.UnassignThread.Responses.$204>
3050
- /**
3051
- * assignUsers - assignUsers
3052
- *
3053
- * Assign users to thread for receiving notifications.
3054
- * The operation replaces all existing assigned users in thread.
3055
- *
3056
- */
3057
- 'assignUsers'(
3058
- parameters?: Parameters<Paths.AssignUsers.PathParameters> | null,
3059
- data?: Paths.AssignUsers.RequestBody,
3060
- config?: AxiosRequestConfig
3061
- ): OperationResponse<Paths.AssignUsers.Responses.$204>
3062
- /**
3063
- * assignUsersV2 - assignUsersV2
3064
- *
3065
- * Assign users to thread.
3066
- *
3067
- */
3068
- 'assignUsersV2'(
3069
- parameters?: Parameters<Paths.AssignUsersV2.PathParameters> | null,
3070
- data?: Paths.AssignUsersV2.RequestBody,
3071
- config?: AxiosRequestConfig
3072
- ): OperationResponse<Paths.AssignUsersV2.Responses.$204>
3073
- /**
3074
- * pinThread - Pin a single thread
3075
- *
3076
- * Pin a single thread
3077
- */
3078
- 'pinThread'(
3079
- parameters?: Parameters<Paths.PinThread.PathParameters> | null,
3080
- data?: any,
3081
- config?: AxiosRequestConfig
3082
- ): OperationResponse<Paths.PinThread.Responses.$204>
3083
- /**
3084
- * unpinThread - Unpin a single thread
3085
- *
3086
- * Unpin a single thread
3087
- */
3088
- 'unpinThread'(
3089
- parameters?: Parameters<Paths.UnpinThread.PathParameters> | null,
3090
- data?: any,
3091
- config?: AxiosRequestConfig
3092
- ): OperationResponse<Paths.UnpinThread.Responses.$204>
3093
- /**
3094
- * createDraft - createDraft
3095
- *
3096
- * Create a new draft
3097
- */
3098
- 'createDraft'(
3099
- parameters?: Parameters<UnknownParamsObject> | null,
3100
- data?: Paths.CreateDraft.RequestBody,
3101
- config?: AxiosRequestConfig
3102
- ): OperationResponse<Paths.CreateDraft.Responses.$201>
3103
- /**
3104
- * sendDraft - sendDraft
3105
- *
3106
- * Send the existing draft to the recipients
3107
- */
3108
- 'sendDraft'(
3109
- parameters?: Parameters<UnknownParamsObject> | null,
3110
- data?: any,
3111
- config?: AxiosRequestConfig
3112
- ): OperationResponse<Paths.SendDraft.Responses.$201>
3113
- /**
3114
- * getMessageV2 - getMessageV2
3115
- *
3116
- * - Fetches message by ID
3117
- * - If the message html is omitted on the entity, then it keeps the content on the message as a signed url
3118
- * {
3119
- * ...
3120
- * _id: "4d74976d-fb64-47fd-85e2-65eea140f5eb",
3121
- * _schema: "message",
3122
- * _org: "org-123",
3123
- * html_omitted: true,
3124
- * html_download_url: "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html"
3125
- * }
3126
- *
3127
- */
3128
- 'getMessageV2'(
3129
- parameters?: Parameters<Paths.GetMessageV2.PathParameters> | null,
3130
- data?: any,
3131
- config?: AxiosRequestConfig
3132
- ): OperationResponse<Paths.GetMessageV2.Responses.$200>
3133
- }
3134
-
3135
- interface PathsDictionary {
3136
- ['/v1/message/messages']: {
3137
- /**
3138
- * sendMessage - sendMessage
3139
- *
3140
- * Send an email message
3141
- */
3142
- 'post'(
3143
- parameters?: Parameters<Paths.SendMessage.QueryParameters> | null,
3144
- data?: Paths.SendMessage.RequestBody,
3145
- config?: AxiosRequestConfig
3146
- ): OperationResponse<Paths.SendMessage.Responses.$201>
3147
- /**
3148
- * updateMessage - updateMessage
3149
- *
3150
- * Update message metadata
3151
- */
3152
- 'put'(
3153
- parameters?: Parameters<UnknownParamsObject> | null,
3154
- data?: any,
3155
- config?: AxiosRequestConfig
3156
- ): OperationResponse<Paths.UpdateMessage.Responses.$201>
3157
- }
3158
- ['/v1/message/messages/{id}']: {
3159
- /**
3160
- * getMessage - getMessage
3161
- *
3162
- * Get an email message by id
3163
- */
3164
- 'get'(
3165
- parameters?: Parameters<Paths.GetMessage.PathParameters> | null,
3166
- data?: any,
3167
- config?: AxiosRequestConfig
3168
- ): OperationResponse<Paths.GetMessage.Responses.$200>
3169
- /**
3170
- * deleteMessage - deleteMessage
3171
- *
3172
- * Immediately and permanently delete a message. This operation cannot be undone.
3173
- */
3174
- 'delete'(
3175
- parameters?: Parameters<Paths.DeleteMessage.PathParameters> | null,
3176
- data?: any,
3177
- config?: AxiosRequestConfig
3178
- ): OperationResponse<Paths.DeleteMessage.Responses.$204>
3179
- }
3180
- ['/v1/message/messages/{id}/eml']: {
3181
- /**
3182
- * getMessageEml - getMessageEml
3183
- *
3184
- * Download a message as an EML file.
3185
- * Returns a 302 redirect to a pre-signed S3 URL where the EML file can be downloaded.
3186
- *
3187
- */
3188
- 'get'(
3189
- parameters?: Parameters<Paths.GetMessageEml.PathParameters> | null,
3190
- data?: any,
3191
- config?: AxiosRequestConfig
3192
- ): OperationResponse<any>
3193
- }
3194
- ['/v1/message/messages:search']: {
3195
- /**
3196
- * searchMessages - searchMessages
3197
- *
3198
- * Search Messages
3199
- */
3200
- 'post'(
3201
- parameters?: Parameters<UnknownParamsObject> | null,
3202
- data?: Paths.SearchMessages.RequestBody,
3203
- config?: AxiosRequestConfig
3204
- ): OperationResponse<Paths.SearchMessages.Responses.$200>
3205
- }
3206
- ['/v1/message/messages/{id}/trash']: {
3207
- /**
3208
- * trashMessage - trashMessage
3209
- *
3210
- * Move a message to the trash
3211
- */
3212
- 'post'(
3213
- parameters?: Parameters<Paths.TrashMessage.PathParameters> | null,
3214
- data?: any,
3215
- config?: AxiosRequestConfig
3216
- ): OperationResponse<Paths.TrashMessage.Responses.$204>
3217
- }
3218
- ['/v1/message/messages/{id}/untrash']: {
3219
- /**
3220
- * untrashMessage - untrashMessage
3221
- *
3222
- * Restore a trashed message
3223
- */
3224
- 'post'(
3225
- parameters?: Parameters<Paths.UntrashMessage.PathParameters> | null,
3226
- data?: any,
3227
- config?: AxiosRequestConfig
3228
- ): OperationResponse<Paths.UntrashMessage.Responses.$204>
3229
- }
3230
- ['/v1/message/messages/{id}/read']: {
3231
- /**
3232
- * markReadMessage - markReadMessage
3233
- *
3234
- * Mark message as read
3235
- */
3236
- 'post'(
3237
- parameters?: Parameters<Paths.MarkReadMessage.PathParameters> | null,
3238
- data?: any,
3239
- config?: AxiosRequestConfig
3240
- ): OperationResponse<Paths.MarkReadMessage.Responses.$204>
3241
- }
3242
- ['/v2/message/messages/{id}/read']: {
3243
- /**
3244
- * markReadMessageV2 - markReadMessageV2
3245
- *
3246
- * Mark message as read within a scope
3247
- */
3248
- 'post'(
3249
- parameters?: Parameters<Paths.MarkReadMessageV2.PathParameters> | null,
3250
- data?: Paths.MarkReadMessageV2.RequestBody,
3251
- config?: AxiosRequestConfig
3252
- ): OperationResponse<Paths.MarkReadMessageV2.Responses.$204>
3253
- }
3254
- ['/v1/message/messages/{id}/unread']: {
3255
- /**
3256
- * markUnreadMessage - markUnreadMessage
3257
- *
3258
- * Mark message as unread
3259
- */
3260
- 'post'(
3261
- parameters?: Parameters<Paths.MarkUnreadMessage.PathParameters> | null,
3262
- data?: any,
3263
- config?: AxiosRequestConfig
3264
- ): OperationResponse<Paths.MarkUnreadMessage.Responses.$204>
3265
- }
3266
- ['/v1/message/messages/unread/{actor}']: {
3267
- /**
3268
- * getUnread - getUnread
3269
- *
3270
- * Get all unread messages by actor
3271
- */
3272
- 'get'(
3273
- parameters?: Parameters<Paths.GetUnread.QueryParameters & Paths.GetUnread.PathParameters> | null,
3274
- data?: any,
3275
- config?: AxiosRequestConfig
3276
- ): OperationResponse<Paths.GetUnread.Responses.$200>
3277
- }
3278
- ['/v2/message/messages/{id}/unread']: {
3279
- /**
3280
- * markUnreadMessageV2 - markUnreadMessageV2
3281
- *
3282
- * Mark message as unread within a scope
3283
- */
3284
- 'post'(
3285
- parameters?: Parameters<Paths.MarkUnreadMessageV2.PathParameters> | null,
3286
- data?: Paths.MarkUnreadMessageV2.RequestBody,
3287
- config?: AxiosRequestConfig
3288
- ): OperationResponse<Paths.MarkUnreadMessageV2.Responses.$204>
3289
- }
3290
- ['/v1/message/threads:search']: {
3291
- /**
3292
- * searchThreads - searchThreads
3293
- *
3294
- * Search for threads of email messages.
3295
- *
3296
- * Messages with no replies yet are treated as threads with single message.
3297
- *
3298
- * Lucene syntax supported.
3299
- *
3300
- */
3301
- 'post'(
3302
- parameters?: Parameters<UnknownParamsObject> | null,
3303
- data?: Paths.SearchThreads.RequestBody,
3304
- config?: AxiosRequestConfig
3305
- ): OperationResponse<Paths.SearchThreads.Responses.$200>
3306
- }
3307
- ['/v2/message/threads:search']: {
3308
- /**
3309
- * searchThreadsV2 - searchThreadsV2
3310
- *
3311
- * Search for threads of email messages.
3312
- *
3313
- * Messages with no replies yet are treated as threads with single message.
3314
- *
3315
- * Lucene syntax supported.
3316
- *
3317
- */
3318
- 'post'(
3319
- parameters?: Parameters<UnknownParamsObject> | null,
3320
- data?: Paths.SearchThreadsV2.RequestBody,
3321
- config?: AxiosRequestConfig
3322
- ): OperationResponse<Paths.SearchThreadsV2.Responses.$200>
3323
- }
3324
- ['/v1/message/threads:searchIds']: {
3325
- /**
3326
- * searchIds - Search threads and return all id's
3327
- *
3328
- * Return all thread id's that match a criteria
3329
- *
3330
- * Lucene syntax supported.
3331
- *
3332
- */
3333
- 'post'(
3334
- parameters?: Parameters<UnknownParamsObject> | null,
3335
- data?: Paths.SearchIds.RequestBody,
3336
- config?: AxiosRequestConfig
3337
- ): OperationResponse<Paths.SearchIds.Responses.$200>
3338
- }
3339
- ['/v1/message/threads']: {
3340
- /**
3341
- * updateThread - updateThread
3342
- *
3343
- * Modify thread metadata
3344
- */
3345
- 'put'(
3346
- parameters?: Parameters<UnknownParamsObject> | null,
3347
- data?: any,
3348
- config?: AxiosRequestConfig
3349
- ): OperationResponse<Paths.UpdateThread.Responses.$201>
3350
- }
3351
- ['/v1/message/threads/{id}']: {
3352
- /**
3353
- * deleteThread - deleteThread
3354
- *
3355
- * Immediately and permanently delete a thread. This operation cannot be undone.
3356
- */
3357
- 'delete'(
3358
- parameters?: Parameters<Paths.DeleteThread.PathParameters> | null,
3359
- data?: any,
3360
- config?: AxiosRequestConfig
3361
- ): OperationResponse<Paths.DeleteThread.Responses.$204>
3362
- }
3363
- ['/v1/message/threads/{id}:move']: {
3364
- /**
3365
- * moveThread - moveThread
3366
- *
3367
- * Move thread to a different Inbox
3368
- */
3369
- 'post'(
3370
- parameters?: Parameters<Paths.MoveThread.PathParameters> | null,
3371
- data?: Paths.MoveThread.RequestBody,
3372
- config?: AxiosRequestConfig
3373
- ): OperationResponse<Paths.MoveThread.Responses.$204>
3374
- }
3375
- ['/v1/message/threads/{id}:markAsDone']: {
3376
- /**
3377
- * markThreadAsDone - markThreadAsDone
3378
- *
3379
- * Mark thread as done
3380
- */
3381
- 'post'(
3382
- parameters?: Parameters<Paths.MarkThreadAsDone.PathParameters> | null,
3383
- data?: any,
3384
- config?: AxiosRequestConfig
3385
- ): OperationResponse<Paths.MarkThreadAsDone.Responses.$204>
3386
- }
3387
- ['/v1/message/threads/{id}:markAsOpen']: {
3388
- /**
3389
- * markThreadAsOpen - markThreadAsOpen
3390
- *
3391
- * Mark thread as open
3392
- */
3393
- 'post'(
3394
- parameters?: Parameters<Paths.MarkThreadAsOpen.PathParameters> | null,
3395
- data?: any,
3396
- config?: AxiosRequestConfig
3397
- ): OperationResponse<Paths.MarkThreadAsOpen.Responses.$204>
3398
- }
3399
- ['/v1/message/threads/{id}/timeline']: {
3400
- /**
3401
- * getThreadTimeline - getThreadTimeline
3402
- *
3403
- * Get thread timeline
3404
- */
3405
- 'get'(
3406
- parameters?: Parameters<Paths.GetThreadTimeline.PathParameters> | null,
3407
- data?: any,
3408
- config?: AxiosRequestConfig
3409
- ): OperationResponse<Paths.GetThreadTimeline.Responses.$200>
3410
- }
3411
- ['/v1/message/threads/{id}/trash']: {
3412
- /**
3413
- * trashThread - trashThread
3414
- *
3415
- * Move a thread to trash
3416
- */
3417
- 'post'(
3418
- parameters?: Parameters<Paths.TrashThread.PathParameters> | null,
3419
- data?: any,
3420
- config?: AxiosRequestConfig
3421
- ): OperationResponse<Paths.TrashThread.Responses.$200>
3422
- }
3423
- ['/v1/message/threads/{id}/untrash']: {
3424
- /**
3425
- * untrashThread - untrashThread
3426
- *
3427
- * Restore a trashed thread
3428
- */
3429
- 'post'(
3430
- parameters?: Parameters<Paths.UntrashThread.PathParameters> | null,
3431
- data?: any,
3432
- config?: AxiosRequestConfig
3433
- ): OperationResponse<Paths.UntrashThread.Responses.$200>
3434
- }
3435
- ['/v1/message/threads/{id}/spam']: {
3436
- /**
3437
- * spamThread - spamThread
3438
- *
3439
- * Mark a thread as spam
3440
- */
3441
- 'post'(
3442
- parameters?: Parameters<Paths.SpamThread.PathParameters> | null,
3443
- data?: any,
3444
- config?: AxiosRequestConfig
3445
- ): OperationResponse<Paths.SpamThread.Responses.$200>
3446
- }
3447
- ['/v1/message/threads/{id}/unspam']: {
3448
- /**
3449
- * unspamThread - unspamThread
3450
- *
3451
- * Remove spam marking from a thread
3452
- */
3453
- 'post'(
3454
- parameters?: Parameters<Paths.UnspamThread.PathParameters> | null,
3455
- data?: any,
3456
- config?: AxiosRequestConfig
3457
- ): OperationResponse<Paths.UnspamThread.Responses.$200>
3458
- }
3459
- ['/v1/message/messages/{id}/spam']: {
3460
- /**
3461
- * spamMessage - spamMessage
3462
- *
3463
- * Mark a single message as spam. Also marks the parent thread as spam if all messages in the thread are spam.
3464
- */
3465
- 'post'(
3466
- parameters?: Parameters<Paths.SpamMessage.PathParameters> | null,
3467
- data?: any,
3468
- config?: AxiosRequestConfig
3469
- ): OperationResponse<Paths.SpamMessage.Responses.$204>
3470
- }
3471
- ['/v1/message/messages/{id}/unspam']: {
3472
- /**
3473
- * unspamMessage - unspamMessage
3474
- *
3475
- * Remove spam marking from a single message. Also removes spam from the parent thread if no other messages are spam.
3476
- */
3477
- 'post'(
3478
- parameters?: Parameters<Paths.UnspamMessage.PathParameters> | null,
3479
- data?: any,
3480
- config?: AxiosRequestConfig
3481
- ): OperationResponse<Paths.UnspamMessage.Responses.$204>
3482
- }
3483
- ['/v1/message/threads/bulk:move']: {
3484
- /**
3485
- * bulkMoveThreads - bulkMoveThreads
3486
- *
3487
- * Move many threads to a different inbox
3488
- */
3489
- 'post'(
3490
- parameters?: Parameters<UnknownParamsObject> | null,
3491
- data?: Paths.BulkMoveThreads.RequestBody,
3492
- config?: AxiosRequestConfig
3493
- ): OperationResponse<Paths.BulkMoveThreads.Responses.$200>
3494
- }
3495
- ['/v1/message/threads/bulk:assign']: {
3496
- /**
3497
- * bulkAssignThreads - bulkAssignThreads
3498
- *
3499
- * Assign many threads
3500
- */
3501
- 'post'(
3502
- parameters?: Parameters<UnknownParamsObject> | null,
3503
- data?: Paths.BulkAssignThreads.RequestBody,
3504
- config?: AxiosRequestConfig
3505
- ): OperationResponse<Paths.BulkAssignThreads.Responses.$200>
3506
- }
3507
- ['/v1/message/threads/bulk:read']: {
3508
- /**
3509
- * threadBulkActionsRead - threadBulkActionsRead
3510
- *
3511
- * Perform a bulk action of marking an array of thread ids as read
3512
- */
3513
- 'post'(
3514
- parameters?: Parameters<UnknownParamsObject> | null,
3515
- data?: Paths.ThreadBulkActionsRead.RequestBody,
3516
- config?: AxiosRequestConfig
3517
- ): OperationResponse<Paths.ThreadBulkActionsRead.Responses.$200>
3518
- }
3519
- ['/v1/message/threads/bulk:unread']: {
3520
- /**
3521
- * threadBulkActionsUnread - threadBulkActionsUnread
3522
- *
3523
- * Perform a bulk action of marking an array of thread ids as unread
3524
- */
3525
- 'post'(
3526
- parameters?: Parameters<UnknownParamsObject> | null,
3527
- data?: Paths.ThreadBulkActionsUnread.RequestBody,
3528
- config?: AxiosRequestConfig
3529
- ): OperationResponse<Paths.ThreadBulkActionsUnread.Responses.$200>
3530
- }
3531
- ['/v1/message/threads/bulk:favorite']: {
3532
- /**
3533
- * threadBulkActionsFavorite - threadBulkActionsFavorite
3534
- *
3535
- * Perform a bulk action of marking an array of thread ids favorite
3536
- */
3537
- 'post'(
3538
- parameters?: Parameters<UnknownParamsObject> | null,
3539
- data?: Paths.ThreadBulkActionsFavorite.RequestBody,
3540
- config?: AxiosRequestConfig
3541
- ): OperationResponse<Paths.ThreadBulkActionsFavorite.Responses.$200>
3542
- }
3543
- ['/v1/message/threads/bulk:unfavorite']: {
3544
- /**
3545
- * threadBulkActionsUnfavorite - threadBulkActionsUnfavorite
3546
- *
3547
- * Perform a bulk action of marking an array of thread ids unfavorited
3548
- */
3549
- 'post'(
3550
- parameters?: Parameters<UnknownParamsObject> | null,
3551
- data?: Paths.ThreadBulkActionsUnfavorite.RequestBody,
3552
- config?: AxiosRequestConfig
3553
- ): OperationResponse<Paths.ThreadBulkActionsUnfavorite.Responses.$200>
3554
- }
3555
- ['/v1/message/threads/bulk:trash']: {
3556
- /**
3557
- * threadBulkActionsTrash - threadBulkActionsTrash
3558
- *
3559
- * Perform a bulk action of trashing an array of threads
3560
- */
3561
- 'post'(
3562
- parameters?: Parameters<UnknownParamsObject> | null,
3563
- data?: Paths.ThreadBulkActionsTrash.RequestBody,
3564
- config?: AxiosRequestConfig
3565
- ): OperationResponse<Paths.ThreadBulkActionsTrash.Responses.$200>
3566
- }
3567
- ['/v1/message/threads/bulk:untrash']: {
3568
- /**
3569
- * threadBulkActionsUntrash - threadBulkActionsUntrash
3570
- *
3571
- * Perform a bulk action of untrashing an array of threads
3572
- */
3573
- 'post'(
3574
- parameters?: Parameters<UnknownParamsObject> | null,
3575
- data?: Paths.ThreadBulkActionsUntrash.RequestBody,
3576
- config?: AxiosRequestConfig
3577
- ): OperationResponse<Paths.ThreadBulkActionsUntrash.Responses.$200>
3578
- }
3579
- ['/v1/message/threads/bulk:delete']: {
3580
- /**
3581
- * threadBulkActionsDelete - threadBulkActionsDelete
3582
- *
3583
- * Performs a bulk permanent delete for all threads
3584
- */
3585
- 'post'(
3586
- parameters?: Parameters<UnknownParamsObject> | null,
3587
- data?: Paths.ThreadBulkActionsDelete.RequestBody,
3588
- config?: AxiosRequestConfig
3589
- ): OperationResponse<Paths.ThreadBulkActionsDelete.Responses.$200>
3590
- }
3591
- ['/v1/message/threads/bulk:done']: {
3592
- /**
3593
- * threadBulkActionsDone - threadBulkActionsDone
3594
- *
3595
- * Perform a bulk action of marking an array of threads as done
3596
- */
3597
- 'post'(
3598
- parameters?: Parameters<UnknownParamsObject> | null,
3599
- data?: Paths.ThreadBulkActionsDone.RequestBody,
3600
- config?: AxiosRequestConfig
3601
- ): OperationResponse<Paths.ThreadBulkActionsDone.Responses.$200>
3602
- }
3603
- ['/v1/message/threads/bulk:open']: {
3604
- /**
3605
- * threadBulkActionsOpen - threadBulkActionsOpen
3606
- *
3607
- * Perform a bulk action of marking an array of threads as open
3608
- */
3609
- 'post'(
3610
- parameters?: Parameters<UnknownParamsObject> | null,
3611
- data?: Paths.ThreadBulkActionsOpen.RequestBody,
3612
- config?: AxiosRequestConfig
3613
- ): OperationResponse<Paths.ThreadBulkActionsOpen.Responses.$200>
3614
- }
3615
- ['/v1/message/threads/{id}/read']: {
3616
- /**
3617
- * markReadThread - markReadThread
3618
- *
3619
- * Mark thread as read
3620
- */
3621
- 'post'(
3622
- parameters?: Parameters<Paths.MarkReadThread.PathParameters> | null,
3623
- data?: any,
3624
- config?: AxiosRequestConfig
3625
- ): OperationResponse<Paths.MarkReadThread.Responses.$200>
3626
- }
3627
- ['/v2/message/threads/{id}/read']: {
3628
- /**
3629
- * markReadThreadV2 - markReadThreadV2
3630
- *
3631
- * Mark thread as read within a scope
3632
- */
3633
- 'post'(
3634
- parameters?: Parameters<Paths.MarkReadThreadV2.PathParameters> | null,
3635
- data?: Paths.MarkReadThreadV2.RequestBody,
3636
- config?: AxiosRequestConfig
3637
- ): OperationResponse<Paths.MarkReadThreadV2.Responses.$200>
3638
- }
3639
- ['/v1/message/threads/{id}/unread']: {
3640
- /**
3641
- * markUnreadThread - markUnreadThread
3642
- *
3643
- * Mark thread as unread
3644
- */
3645
- 'post'(
3646
- parameters?: Parameters<Paths.MarkUnreadThread.PathParameters> | null,
3647
- data?: any,
3648
- config?: AxiosRequestConfig
3649
- ): OperationResponse<Paths.MarkUnreadThread.Responses.$200>
3650
- }
3651
- ['/v2/message/threads/{id}/unread']: {
3652
- /**
3653
- * markUnreadThreadV2 - markUnreadThreadV2
3654
- *
3655
- * Mark thread as unread within a scope
3656
- */
3657
- 'post'(
3658
- parameters?: Parameters<Paths.MarkUnreadThreadV2.PathParameters> | null,
3659
- data?: Paths.MarkUnreadThreadV2.RequestBody,
3660
- config?: AxiosRequestConfig
3661
- ): OperationResponse<Paths.MarkUnreadThreadV2.Responses.$200>
3662
- }
3663
- ['/v1/message/threads/{id}/assign']: {
3664
- /**
3665
- * assignThread - assignThread
3666
- *
3667
- * Assign thread to entities
3668
- */
3669
- 'post'(
3670
- parameters?: Parameters<Paths.AssignThread.PathParameters> | null,
3671
- data?: Paths.AssignThread.RequestBody,
3672
- config?: AxiosRequestConfig
3673
- ): OperationResponse<Paths.AssignThread.Responses.$204>
3674
- }
3675
- ['/v1/message/threads/{id}/unassign']: {
3676
- /**
3677
- * unassignThread - unassignThread
3678
- *
3679
- * Unassign thread from entities
3680
- */
3681
- 'post'(
3682
- parameters?: Parameters<Paths.UnassignThread.QueryParameters & Paths.UnassignThread.PathParameters> | null,
3683
- data?: Paths.UnassignThread.RequestBody,
3684
- config?: AxiosRequestConfig
3685
- ): OperationResponse<Paths.UnassignThread.Responses.$204>
3686
- }
3687
- ['/v1/message/threads/{id}/assign:users']: {
3688
- /**
3689
- * assignUsers - assignUsers
3690
- *
3691
- * Assign users to thread for receiving notifications.
3692
- * The operation replaces all existing assigned users in thread.
3693
- *
3694
- */
3695
- 'post'(
3696
- parameters?: Parameters<Paths.AssignUsers.PathParameters> | null,
3697
- data?: Paths.AssignUsers.RequestBody,
3698
- config?: AxiosRequestConfig
3699
- ): OperationResponse<Paths.AssignUsers.Responses.$204>
3700
- }
3701
- ['/v2/message/threads/{id}/assign:users']: {
3702
- /**
3703
- * assignUsersV2 - assignUsersV2
3704
- *
3705
- * Assign users to thread.
3706
- *
3707
- */
3708
- 'post'(
3709
- parameters?: Parameters<Paths.AssignUsersV2.PathParameters> | null,
3710
- data?: Paths.AssignUsersV2.RequestBody,
3711
- config?: AxiosRequestConfig
3712
- ): OperationResponse<Paths.AssignUsersV2.Responses.$204>
3713
- }
3714
- ['/v1/message/threads/{id}:pin']: {
3715
- /**
3716
- * pinThread - Pin a single thread
3717
- *
3718
- * Pin a single thread
3719
- */
3720
- 'post'(
3721
- parameters?: Parameters<Paths.PinThread.PathParameters> | null,
3722
- data?: any,
3723
- config?: AxiosRequestConfig
3724
- ): OperationResponse<Paths.PinThread.Responses.$204>
3725
- /**
3726
- * unpinThread - Unpin a single thread
3727
- *
3728
- * Unpin a single thread
3729
- */
3730
- 'delete'(
3731
- parameters?: Parameters<Paths.UnpinThread.PathParameters> | null,
3732
- data?: any,
3733
- config?: AxiosRequestConfig
3734
- ): OperationResponse<Paths.UnpinThread.Responses.$204>
3735
- }
3736
- ['/v1/message/drafts']: {
3737
- /**
3738
- * createDraft - createDraft
3739
- *
3740
- * Create a new draft
3741
- */
3742
- 'post'(
3743
- parameters?: Parameters<UnknownParamsObject> | null,
3744
- data?: Paths.CreateDraft.RequestBody,
3745
- config?: AxiosRequestConfig
3746
- ): OperationResponse<Paths.CreateDraft.Responses.$201>
3747
- }
3748
- ['/v1/message/drafts:send']: {
3749
- /**
3750
- * sendDraft - sendDraft
3751
- *
3752
- * Send the existing draft to the recipients
3753
- */
3754
- 'post'(
3755
- parameters?: Parameters<UnknownParamsObject> | null,
3756
- data?: any,
3757
- config?: AxiosRequestConfig
3758
- ): OperationResponse<Paths.SendDraft.Responses.$201>
3759
- }
3760
- ['/v2/message/messages/{id}']: {
3761
- /**
3762
- * getMessageV2 - getMessageV2
3763
- *
3764
- * - Fetches message by ID
3765
- * - If the message html is omitted on the entity, then it keeps the content on the message as a signed url
3766
- * {
3767
- * ...
3768
- * _id: "4d74976d-fb64-47fd-85e2-65eea140f5eb",
3769
- * _schema: "message",
3770
- * _org: "org-123",
3771
- * html_omitted: true,
3772
- * html_download_url: "https://s3.eu-central-1.amazonaws.com/epilot-attachments/3f34ce73-089c-4d45-a5ee-c161234e41c3/3f34ce73-089c-4d45-a5ee-c161234e41c3.html"
3773
- * }
3774
- *
3775
- */
3776
- 'get'(
3777
- parameters?: Parameters<Paths.GetMessageV2.PathParameters> | null,
3778
- data?: any,
3779
- config?: AxiosRequestConfig
3780
- ): OperationResponse<Paths.GetMessageV2.Responses.$200>
3781
- }
3782
- }
3783
-
3784
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
3785
-
3786
-
3787
- type Address = Components.Schemas.Address;
3788
- type AttachmentsRelation = Components.Schemas.AttachmentsRelation;
3789
- type BaseEntity = Components.Schemas.BaseEntity;
3790
- type BulkActionsPayload = Components.Schemas.BulkActionsPayload;
3791
- type BulkActionsPayloadWithScopes = Components.Schemas.BulkActionsPayloadWithScopes;
3792
- type ErrorResponse = Components.Schemas.ErrorResponse;
3793
- type FieldsParam = Components.Schemas.FieldsParam;
3794
- type File = Components.Schemas.File;
3795
- type Message = Components.Schemas.Message;
3796
- type MessageRequestParams = Components.Schemas.MessageRequestParams;
3797
- type MessageV2 = Components.Schemas.MessageV2;
3798
- type MoveThreadPayload = Components.Schemas.MoveThreadPayload;
3799
- type ReadMessagePayload = Components.Schemas.ReadMessagePayload;
3800
- type ReadingScope = Components.Schemas.ReadingScope;
3801
- type SearchIDParams = Components.Schemas.SearchIDParams;
3802
- type SearchParams = Components.Schemas.SearchParams;
3803
- type SearchParamsV2 = Components.Schemas.SearchParamsV2;
3804
- type Thread = Components.Schemas.Thread;
3805
- type ThreadDoneEvent = Components.Schemas.ThreadDoneEvent;
3806
- type ThreadOpenEvent = Components.Schemas.ThreadOpenEvent;
3807
- type ThreadTimeline = Components.Schemas.ThreadTimeline;
3808
- type TimelineEvent = Components.Schemas.TimelineEvent;
3809
- type TimelineEventData = Components.Schemas.TimelineEventData;
3810
-
3811
- export { type Address as A, type BaseEntity as B, type Client as C, type ErrorResponse as E, type FieldsParam as F, type Message as M, type OperationMethods as O, Paths as P, type ReadMessagePayload as R, type SearchIDParams as S, type Thread as T, Components as a, type PathsDictionary as b, type AttachmentsRelation as c, type BulkActionsPayload as d, type BulkActionsPayloadWithScopes as e, type File as f, type MessageRequestParams as g, type MessageV2 as h, type MoveThreadPayload as i, type ReadingScope as j, type SearchParams as k, type SearchParamsV2 as l, type ThreadDoneEvent as m, type ThreadOpenEvent as n, type ThreadTimeline as o, type TimelineEvent as p, type TimelineEventData as q };