telnyx 7.12.0 → 7.13.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 (502) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/client.d.mts +56 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +56 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js +54 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +54 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/ai/ai.d.mts +6 -0
  12. package/resources/ai/ai.d.mts.map +1 -1
  13. package/resources/ai/ai.d.ts +6 -0
  14. package/resources/ai/ai.d.ts.map +1 -1
  15. package/resources/ai/ai.js.map +1 -1
  16. package/resources/ai/ai.mjs.map +1 -1
  17. package/resources/ai/anthropic/v1.d.mts +3 -1
  18. package/resources/ai/anthropic/v1.d.mts.map +1 -1
  19. package/resources/ai/anthropic/v1.d.ts +3 -1
  20. package/resources/ai/anthropic/v1.d.ts.map +1 -1
  21. package/resources/ai/assistants/assistants.d.mts +6 -2
  22. package/resources/ai/assistants/assistants.d.mts.map +1 -1
  23. package/resources/ai/assistants/assistants.d.ts +6 -2
  24. package/resources/ai/assistants/assistants.d.ts.map +1 -1
  25. package/resources/ai/assistants/assistants.js.map +1 -1
  26. package/resources/ai/assistants/assistants.mjs.map +1 -1
  27. package/resources/ai/chat.d.mts +6 -0
  28. package/resources/ai/chat.d.mts.map +1 -1
  29. package/resources/ai/chat.d.ts +6 -0
  30. package/resources/ai/chat.d.ts.map +1 -1
  31. package/resources/ai/openai/chat.d.mts +6 -0
  32. package/resources/ai/openai/chat.d.mts.map +1 -1
  33. package/resources/ai/openai/chat.d.ts +6 -0
  34. package/resources/ai/openai/chat.d.ts.map +1 -1
  35. package/resources/ai/openai/openai.d.mts +6 -0
  36. package/resources/ai/openai/openai.d.mts.map +1 -1
  37. package/resources/ai/openai/openai.d.ts +6 -0
  38. package/resources/ai/openai/openai.d.ts.map +1 -1
  39. package/resources/ai/openai/openai.js.map +1 -1
  40. package/resources/ai/openai/openai.mjs.map +1 -1
  41. package/resources/calls/actions.d.mts +223 -48
  42. package/resources/calls/actions.d.mts.map +1 -1
  43. package/resources/calls/actions.d.ts +223 -48
  44. package/resources/calls/actions.d.ts.map +1 -1
  45. package/resources/calls/actions.js +31 -0
  46. package/resources/calls/actions.js.map +1 -1
  47. package/resources/calls/actions.mjs +31 -0
  48. package/resources/calls/actions.mjs.map +1 -1
  49. package/resources/calls/calls.d.mts +3 -2
  50. package/resources/calls/calls.d.mts.map +1 -1
  51. package/resources/calls/calls.d.ts +3 -2
  52. package/resources/calls/calls.d.ts.map +1 -1
  53. package/resources/calls/calls.js.map +1 -1
  54. package/resources/calls/calls.mjs.map +1 -1
  55. package/resources/calls/index.d.mts +1 -1
  56. package/resources/calls/index.d.mts.map +1 -1
  57. package/resources/calls/index.d.ts +1 -1
  58. package/resources/calls/index.d.ts.map +1 -1
  59. package/resources/calls/index.js.map +1 -1
  60. package/resources/calls/index.mjs.map +1 -1
  61. package/resources/custom-storage-credentials.d.mts +110 -14
  62. package/resources/custom-storage-credentials.d.mts.map +1 -1
  63. package/resources/custom-storage-credentials.d.ts +110 -14
  64. package/resources/custom-storage-credentials.d.ts.map +1 -1
  65. package/resources/dir/dir.d.mts +3 -2
  66. package/resources/dir/dir.d.mts.map +1 -1
  67. package/resources/dir/dir.d.ts +3 -2
  68. package/resources/dir/dir.d.ts.map +1 -1
  69. package/resources/dir/dir.js +3 -2
  70. package/resources/dir/dir.js.map +1 -1
  71. package/resources/dir/dir.mjs +3 -2
  72. package/resources/dir/dir.mjs.map +1 -1
  73. package/resources/dir/references.d.mts +41 -11
  74. package/resources/dir/references.d.mts.map +1 -1
  75. package/resources/dir/references.d.ts +41 -11
  76. package/resources/dir/references.d.ts.map +1 -1
  77. package/resources/dir/references.js +30 -8
  78. package/resources/dir/references.js.map +1 -1
  79. package/resources/dir/references.mjs +30 -8
  80. package/resources/dir/references.mjs.map +1 -1
  81. package/resources/dir/verify-email.d.mts +10 -0
  82. package/resources/dir/verify-email.d.mts.map +1 -1
  83. package/resources/dir/verify-email.d.ts +10 -0
  84. package/resources/dir/verify-email.d.ts.map +1 -1
  85. package/resources/email-blocks/email-blocks.d.mts +255 -0
  86. package/resources/email-blocks/email-blocks.d.mts.map +1 -0
  87. package/resources/email-blocks/email-blocks.d.ts +255 -0
  88. package/resources/email-blocks/email-blocks.d.ts.map +1 -0
  89. package/resources/email-blocks/email-blocks.js +99 -0
  90. package/resources/email-blocks/email-blocks.js.map +1 -0
  91. package/resources/email-blocks/email-blocks.mjs +94 -0
  92. package/resources/email-blocks/email-blocks.mjs.map +1 -0
  93. package/resources/email-blocks/import.d.mts +111 -0
  94. package/resources/email-blocks/import.d.mts.map +1 -0
  95. package/resources/email-blocks/import.d.ts +111 -0
  96. package/resources/email-blocks/import.d.ts.map +1 -0
  97. package/resources/email-blocks/import.js +40 -0
  98. package/resources/email-blocks/import.js.map +1 -0
  99. package/resources/email-blocks/import.mjs +36 -0
  100. package/resources/email-blocks/import.mjs.map +1 -0
  101. package/resources/email-blocks/index.d.mts +3 -0
  102. package/resources/email-blocks/index.d.mts.map +1 -0
  103. package/resources/email-blocks/index.d.ts +3 -0
  104. package/resources/email-blocks/index.d.ts.map +1 -0
  105. package/resources/email-blocks/index.js +9 -0
  106. package/resources/email-blocks/index.js.map +1 -0
  107. package/resources/email-blocks/index.mjs +4 -0
  108. package/resources/email-blocks/index.mjs.map +1 -0
  109. package/resources/email-blocks.d.mts +2 -0
  110. package/resources/email-blocks.d.mts.map +1 -0
  111. package/resources/email-blocks.d.ts +2 -0
  112. package/resources/email-blocks.d.ts.map +1 -0
  113. package/resources/email-blocks.js +6 -0
  114. package/resources/email-blocks.js.map +1 -0
  115. package/resources/email-blocks.mjs +3 -0
  116. package/resources/email-blocks.mjs.map +1 -0
  117. package/resources/email-domains/email-domains.d.mts +344 -0
  118. package/resources/email-domains/email-domains.d.mts.map +1 -0
  119. package/resources/email-domains/email-domains.d.ts +344 -0
  120. package/resources/email-domains/email-domains.d.ts.map +1 -0
  121. package/resources/email-domains/email-domains.js +146 -0
  122. package/resources/email-domains/email-domains.js.map +1 -0
  123. package/resources/email-domains/email-domains.mjs +141 -0
  124. package/resources/email-domains/email-domains.mjs.map +1 -0
  125. package/resources/email-domains/index.d.mts +3 -0
  126. package/resources/email-domains/index.d.mts.map +1 -0
  127. package/resources/email-domains/index.d.ts +3 -0
  128. package/resources/email-domains/index.d.ts.map +1 -0
  129. package/resources/email-domains/index.js +9 -0
  130. package/resources/email-domains/index.js.map +1 -0
  131. package/resources/email-domains/index.mjs +4 -0
  132. package/resources/email-domains/index.mjs.map +1 -0
  133. package/resources/email-domains/webhooks.d.mts +170 -0
  134. package/resources/email-domains/webhooks.d.mts.map +1 -0
  135. package/resources/email-domains/webhooks.d.ts +170 -0
  136. package/resources/email-domains/webhooks.d.ts.map +1 -0
  137. package/resources/email-domains/webhooks.js +110 -0
  138. package/resources/email-domains/webhooks.js.map +1 -0
  139. package/resources/email-domains/webhooks.mjs +106 -0
  140. package/resources/email-domains/webhooks.mjs.map +1 -0
  141. package/resources/email-domains.d.mts +2 -0
  142. package/resources/email-domains.d.mts.map +1 -0
  143. package/resources/email-domains.d.ts +2 -0
  144. package/resources/email-domains.d.ts.map +1 -0
  145. package/resources/email-domains.js +6 -0
  146. package/resources/email-domains.js.map +1 -0
  147. package/resources/email-domains.mjs +3 -0
  148. package/resources/email-domains.mjs.map +1 -0
  149. package/resources/email-events.d.mts +186 -0
  150. package/resources/email-events.d.mts.map +1 -0
  151. package/resources/email-events.d.ts +186 -0
  152. package/resources/email-events.d.ts.map +1 -0
  153. package/resources/email-events.js +26 -0
  154. package/resources/email-events.js.map +1 -0
  155. package/resources/email-events.mjs +22 -0
  156. package/resources/email-events.mjs.map +1 -0
  157. package/resources/email-inboxes/drafts.d.mts +549 -0
  158. package/resources/email-inboxes/drafts.d.mts.map +1 -0
  159. package/resources/email-inboxes/drafts.d.ts +549 -0
  160. package/resources/email-inboxes/drafts.d.ts.map +1 -0
  161. package/resources/email-inboxes/drafts.js +161 -0
  162. package/resources/email-inboxes/drafts.js.map +1 -0
  163. package/resources/email-inboxes/drafts.mjs +157 -0
  164. package/resources/email-inboxes/drafts.mjs.map +1 -0
  165. package/resources/email-inboxes/email-inboxes.d.mts +131 -0
  166. package/resources/email-inboxes/email-inboxes.d.mts.map +1 -0
  167. package/resources/email-inboxes/email-inboxes.d.ts +131 -0
  168. package/resources/email-inboxes/email-inboxes.d.ts.map +1 -0
  169. package/resources/email-inboxes/email-inboxes.js +93 -0
  170. package/resources/email-inboxes/email-inboxes.js.map +1 -0
  171. package/resources/email-inboxes/email-inboxes.mjs +88 -0
  172. package/resources/email-inboxes/email-inboxes.mjs.map +1 -0
  173. package/resources/email-inboxes/filters.d.mts +137 -0
  174. package/resources/email-inboxes/filters.d.mts.map +1 -0
  175. package/resources/email-inboxes/filters.d.ts +137 -0
  176. package/resources/email-inboxes/filters.d.ts.map +1 -0
  177. package/resources/email-inboxes/filters.js +81 -0
  178. package/resources/email-inboxes/filters.js.map +1 -0
  179. package/resources/email-inboxes/filters.mjs +77 -0
  180. package/resources/email-inboxes/filters.mjs.map +1 -0
  181. package/resources/email-inboxes/index.d.mts +6 -0
  182. package/resources/email-inboxes/index.d.mts.map +1 -0
  183. package/resources/email-inboxes/index.d.ts +6 -0
  184. package/resources/email-inboxes/index.d.ts.map +1 -0
  185. package/resources/email-inboxes/index.js +15 -0
  186. package/resources/email-inboxes/index.js.map +1 -0
  187. package/resources/email-inboxes/index.mjs +7 -0
  188. package/resources/email-inboxes/index.mjs.map +1 -0
  189. package/resources/email-inboxes/messages/actions.d.mts +190 -0
  190. package/resources/email-inboxes/messages/actions.d.mts.map +1 -0
  191. package/resources/email-inboxes/messages/actions.d.ts +190 -0
  192. package/resources/email-inboxes/messages/actions.d.ts.map +1 -0
  193. package/resources/email-inboxes/messages/actions.js +106 -0
  194. package/resources/email-inboxes/messages/actions.js.map +1 -0
  195. package/resources/email-inboxes/messages/actions.mjs +102 -0
  196. package/resources/email-inboxes/messages/actions.mjs.map +1 -0
  197. package/resources/email-inboxes/messages/index.d.mts +4 -0
  198. package/resources/email-inboxes/messages/index.d.mts.map +1 -0
  199. package/resources/email-inboxes/messages/index.d.ts +4 -0
  200. package/resources/email-inboxes/messages/index.d.ts.map +1 -0
  201. package/resources/email-inboxes/messages/index.js +11 -0
  202. package/resources/email-inboxes/messages/index.js.map +1 -0
  203. package/resources/email-inboxes/messages/index.mjs +5 -0
  204. package/resources/email-inboxes/messages/index.mjs.map +1 -0
  205. package/resources/email-inboxes/messages/labels.d.mts +101 -0
  206. package/resources/email-inboxes/messages/labels.d.mts.map +1 -0
  207. package/resources/email-inboxes/messages/labels.d.ts +101 -0
  208. package/resources/email-inboxes/messages/labels.d.ts.map +1 -0
  209. package/resources/email-inboxes/messages/labels.js +69 -0
  210. package/resources/email-inboxes/messages/labels.js.map +1 -0
  211. package/resources/email-inboxes/messages/labels.mjs +65 -0
  212. package/resources/email-inboxes/messages/labels.mjs.map +1 -0
  213. package/resources/email-inboxes/messages/messages.d.mts +212 -0
  214. package/resources/email-inboxes/messages/messages.d.mts.map +1 -0
  215. package/resources/email-inboxes/messages/messages.d.ts +212 -0
  216. package/resources/email-inboxes/messages/messages.d.ts.map +1 -0
  217. package/resources/email-inboxes/messages/messages.js +89 -0
  218. package/resources/email-inboxes/messages/messages.js.map +1 -0
  219. package/resources/email-inboxes/messages/messages.mjs +84 -0
  220. package/resources/email-inboxes/messages/messages.mjs.map +1 -0
  221. package/resources/email-inboxes/messages.d.mts +2 -0
  222. package/resources/email-inboxes/messages.d.mts.map +1 -0
  223. package/resources/email-inboxes/messages.d.ts +2 -0
  224. package/resources/email-inboxes/messages.d.ts.map +1 -0
  225. package/resources/email-inboxes/messages.js +6 -0
  226. package/resources/email-inboxes/messages.js.map +1 -0
  227. package/resources/email-inboxes/messages.mjs +3 -0
  228. package/resources/email-inboxes/messages.mjs.map +1 -0
  229. package/resources/email-inboxes/threads/index.d.mts +3 -0
  230. package/resources/email-inboxes/threads/index.d.mts.map +1 -0
  231. package/resources/email-inboxes/threads/index.d.ts +3 -0
  232. package/resources/email-inboxes/threads/index.d.ts.map +1 -0
  233. package/resources/email-inboxes/threads/index.js +9 -0
  234. package/resources/email-inboxes/threads/index.js.map +1 -0
  235. package/resources/email-inboxes/threads/index.mjs +4 -0
  236. package/resources/email-inboxes/threads/index.mjs.map +1 -0
  237. package/resources/email-inboxes/threads/labels.d.mts +99 -0
  238. package/resources/email-inboxes/threads/labels.d.mts.map +1 -0
  239. package/resources/email-inboxes/threads/labels.d.ts +99 -0
  240. package/resources/email-inboxes/threads/labels.d.ts.map +1 -0
  241. package/resources/email-inboxes/threads/labels.js +64 -0
  242. package/resources/email-inboxes/threads/labels.js.map +1 -0
  243. package/resources/email-inboxes/threads/labels.mjs +60 -0
  244. package/resources/email-inboxes/threads/labels.mjs.map +1 -0
  245. package/resources/email-inboxes/threads/threads.d.mts +199 -0
  246. package/resources/email-inboxes/threads/threads.d.mts.map +1 -0
  247. package/resources/email-inboxes/threads/threads.d.ts +199 -0
  248. package/resources/email-inboxes/threads/threads.d.ts.map +1 -0
  249. package/resources/email-inboxes/threads/threads.js +51 -0
  250. package/resources/email-inboxes/threads/threads.js.map +1 -0
  251. package/resources/email-inboxes/threads/threads.mjs +46 -0
  252. package/resources/email-inboxes/threads/threads.mjs.map +1 -0
  253. package/resources/email-inboxes/threads.d.mts +2 -0
  254. package/resources/email-inboxes/threads.d.mts.map +1 -0
  255. package/resources/email-inboxes/threads.d.ts +2 -0
  256. package/resources/email-inboxes/threads.d.ts.map +1 -0
  257. package/resources/email-inboxes/threads.js +6 -0
  258. package/resources/email-inboxes/threads.js.map +1 -0
  259. package/resources/email-inboxes/threads.mjs +3 -0
  260. package/resources/email-inboxes/threads.mjs.map +1 -0
  261. package/resources/email-inboxes.d.mts +2 -0
  262. package/resources/email-inboxes.d.mts.map +1 -0
  263. package/resources/email-inboxes.d.ts +2 -0
  264. package/resources/email-inboxes.d.ts.map +1 -0
  265. package/resources/email-inboxes.js +6 -0
  266. package/resources/email-inboxes.js.map +1 -0
  267. package/resources/email-inboxes.mjs +3 -0
  268. package/resources/email-inboxes.mjs.map +1 -0
  269. package/resources/email-messages/email-messages.d.mts +543 -0
  270. package/resources/email-messages/email-messages.d.mts.map +1 -0
  271. package/resources/email-messages/email-messages.d.ts +543 -0
  272. package/resources/email-messages/email-messages.d.ts.map +1 -0
  273. package/resources/email-messages/email-messages.js +186 -0
  274. package/resources/email-messages/email-messages.js.map +1 -0
  275. package/resources/email-messages/email-messages.mjs +181 -0
  276. package/resources/email-messages/email-messages.mjs.map +1 -0
  277. package/resources/email-messages/index.d.mts +3 -0
  278. package/resources/email-messages/index.d.mts.map +1 -0
  279. package/resources/email-messages/index.d.ts +3 -0
  280. package/resources/email-messages/index.d.ts.map +1 -0
  281. package/resources/email-messages/index.js +9 -0
  282. package/resources/email-messages/index.js.map +1 -0
  283. package/resources/email-messages/index.mjs +4 -0
  284. package/resources/email-messages/index.mjs.map +1 -0
  285. package/resources/email-messages/recipients.d.mts +118 -0
  286. package/resources/email-messages/recipients.d.mts.map +1 -0
  287. package/resources/email-messages/recipients.d.ts +118 -0
  288. package/resources/email-messages/recipients.d.ts.map +1 -0
  289. package/resources/email-messages/recipients.js +48 -0
  290. package/resources/email-messages/recipients.js.map +1 -0
  291. package/resources/email-messages/recipients.mjs +44 -0
  292. package/resources/email-messages/recipients.mjs.map +1 -0
  293. package/resources/email-messages.d.mts +2 -0
  294. package/resources/email-messages.d.mts.map +1 -0
  295. package/resources/email-messages.d.ts +2 -0
  296. package/resources/email-messages.d.ts.map +1 -0
  297. package/resources/email-messages.js +6 -0
  298. package/resources/email-messages.js.map +1 -0
  299. package/resources/email-messages.mjs +3 -0
  300. package/resources/email-messages.mjs.map +1 -0
  301. package/resources/email-templates.d.mts +236 -0
  302. package/resources/email-templates.d.mts.map +1 -0
  303. package/resources/email-templates.d.ts +236 -0
  304. package/resources/email-templates.d.ts.map +1 -0
  305. package/resources/email-templates.js +124 -0
  306. package/resources/email-templates.js.map +1 -0
  307. package/resources/email-templates.mjs +120 -0
  308. package/resources/email-templates.mjs.map +1 -0
  309. package/resources/email-threads.d.mts +71 -0
  310. package/resources/email-threads.d.mts.map +1 -0
  311. package/resources/email-threads.d.ts +71 -0
  312. package/resources/email-threads.d.ts.map +1 -0
  313. package/resources/email-threads.js +34 -0
  314. package/resources/email-threads.js.map +1 -0
  315. package/resources/email-threads.mjs +30 -0
  316. package/resources/email-threads.mjs.map +1 -0
  317. package/resources/email-unsubscribe-groups/email-unsubscribe-groups.d.mts +90 -0
  318. package/resources/email-unsubscribe-groups/email-unsubscribe-groups.d.mts.map +1 -0
  319. package/resources/email-unsubscribe-groups/email-unsubscribe-groups.d.ts +90 -0
  320. package/resources/email-unsubscribe-groups/email-unsubscribe-groups.d.ts.map +1 -0
  321. package/resources/email-unsubscribe-groups/email-unsubscribe-groups.js +70 -0
  322. package/resources/email-unsubscribe-groups/email-unsubscribe-groups.js.map +1 -0
  323. package/resources/email-unsubscribe-groups/email-unsubscribe-groups.mjs +65 -0
  324. package/resources/email-unsubscribe-groups/email-unsubscribe-groups.mjs.map +1 -0
  325. package/resources/email-unsubscribe-groups/index.d.mts +3 -0
  326. package/resources/email-unsubscribe-groups/index.d.mts.map +1 -0
  327. package/resources/email-unsubscribe-groups/index.d.ts +3 -0
  328. package/resources/email-unsubscribe-groups/index.d.ts.map +1 -0
  329. package/resources/email-unsubscribe-groups/index.js +9 -0
  330. package/resources/email-unsubscribe-groups/index.js.map +1 -0
  331. package/resources/email-unsubscribe-groups/index.mjs +4 -0
  332. package/resources/email-unsubscribe-groups/index.mjs.map +1 -0
  333. package/resources/email-unsubscribe-groups/suppressions.d.mts +54 -0
  334. package/resources/email-unsubscribe-groups/suppressions.d.mts.map +1 -0
  335. package/resources/email-unsubscribe-groups/suppressions.d.ts +54 -0
  336. package/resources/email-unsubscribe-groups/suppressions.d.ts.map +1 -0
  337. package/resources/email-unsubscribe-groups/suppressions.js +52 -0
  338. package/resources/email-unsubscribe-groups/suppressions.js.map +1 -0
  339. package/resources/email-unsubscribe-groups/suppressions.mjs +48 -0
  340. package/resources/email-unsubscribe-groups/suppressions.mjs.map +1 -0
  341. package/resources/email-unsubscribe-groups.d.mts +2 -0
  342. package/resources/email-unsubscribe-groups.d.mts.map +1 -0
  343. package/resources/email-unsubscribe-groups.d.ts +2 -0
  344. package/resources/email-unsubscribe-groups.d.ts.map +1 -0
  345. package/resources/email-unsubscribe-groups.js +6 -0
  346. package/resources/email-unsubscribe-groups.js.map +1 -0
  347. package/resources/email-unsubscribe-groups.mjs +3 -0
  348. package/resources/email-unsubscribe-groups.mjs.map +1 -0
  349. package/resources/email-validations/batch.d.mts +136 -0
  350. package/resources/email-validations/batch.d.mts.map +1 -0
  351. package/resources/email-validations/batch.d.ts +136 -0
  352. package/resources/email-validations/batch.d.ts.map +1 -0
  353. package/resources/email-validations/batch.js +51 -0
  354. package/resources/email-validations/batch.js.map +1 -0
  355. package/resources/email-validations/batch.mjs +47 -0
  356. package/resources/email-validations/batch.mjs.map +1 -0
  357. package/resources/email-validations/email-validations.d.mts +87 -0
  358. package/resources/email-validations/email-validations.d.mts.map +1 -0
  359. package/resources/email-validations/email-validations.d.ts +87 -0
  360. package/resources/email-validations/email-validations.d.ts.map +1 -0
  361. package/resources/email-validations/email-validations.js +43 -0
  362. package/resources/email-validations/email-validations.js.map +1 -0
  363. package/resources/email-validations/email-validations.mjs +38 -0
  364. package/resources/email-validations/email-validations.mjs.map +1 -0
  365. package/resources/email-validations/index.d.mts +3 -0
  366. package/resources/email-validations/index.d.mts.map +1 -0
  367. package/resources/email-validations/index.d.ts +3 -0
  368. package/resources/email-validations/index.d.ts.map +1 -0
  369. package/resources/email-validations/index.js +9 -0
  370. package/resources/email-validations/index.js.map +1 -0
  371. package/resources/email-validations/index.mjs +4 -0
  372. package/resources/email-validations/index.mjs.map +1 -0
  373. package/resources/email-validations.d.mts +2 -0
  374. package/resources/email-validations.d.mts.map +1 -0
  375. package/resources/email-validations.d.ts +2 -0
  376. package/resources/email-validations.d.ts.map +1 -0
  377. package/resources/email-validations.js +6 -0
  378. package/resources/email-validations.js.map +1 -0
  379. package/resources/email-validations.mjs +3 -0
  380. package/resources/email-validations.mjs.map +1 -0
  381. package/resources/index.d.mts +11 -1
  382. package/resources/index.d.mts.map +1 -1
  383. package/resources/index.d.ts +11 -1
  384. package/resources/index.d.ts.map +1 -1
  385. package/resources/index.js +24 -4
  386. package/resources/index.js.map +1 -1
  387. package/resources/index.mjs +10 -0
  388. package/resources/index.mjs.map +1 -1
  389. package/resources/pricing/index.d.mts +3 -0
  390. package/resources/pricing/index.d.mts.map +1 -0
  391. package/resources/pricing/index.d.ts +3 -0
  392. package/resources/pricing/index.d.ts.map +1 -0
  393. package/resources/pricing/index.js +9 -0
  394. package/resources/pricing/index.js.map +1 -0
  395. package/resources/pricing/index.mjs +4 -0
  396. package/resources/pricing/index.mjs.map +1 -0
  397. package/resources/pricing/pricing.d.mts +10 -0
  398. package/resources/pricing/pricing.d.mts.map +1 -0
  399. package/resources/pricing/pricing.d.ts +10 -0
  400. package/resources/pricing/pricing.d.ts.map +1 -0
  401. package/resources/pricing/pricing.js +17 -0
  402. package/resources/pricing/pricing.js.map +1 -0
  403. package/resources/pricing/pricing.mjs +12 -0
  404. package/resources/pricing/pricing.mjs.map +1 -0
  405. package/resources/pricing/products.d.mts +161 -0
  406. package/resources/pricing/products.d.mts.map +1 -0
  407. package/resources/pricing/products.d.ts +161 -0
  408. package/resources/pricing/products.d.ts.map +1 -0
  409. package/resources/pricing/products.js +32 -0
  410. package/resources/pricing/products.js.map +1 -0
  411. package/resources/pricing/products.mjs +28 -0
  412. package/resources/pricing/products.mjs.map +1 -0
  413. package/resources/pricing.d.mts +2 -0
  414. package/resources/pricing.d.mts.map +1 -0
  415. package/resources/pricing.d.ts +2 -0
  416. package/resources/pricing.d.ts.map +1 -0
  417. package/resources/pricing.js +6 -0
  418. package/resources/pricing.js.map +1 -0
  419. package/resources/pricing.mjs +3 -0
  420. package/resources/pricing.mjs.map +1 -0
  421. package/resources/speech-to-text/speech-to-text.d.mts +4 -4
  422. package/resources/speech-to-text/speech-to-text.d.mts.map +1 -1
  423. package/resources/speech-to-text/speech-to-text.d.ts +4 -4
  424. package/resources/speech-to-text/speech-to-text.d.ts.map +1 -1
  425. package/resources/speech-to-text/speech-to-text.js +1 -1
  426. package/resources/speech-to-text/speech-to-text.mjs +1 -1
  427. package/resources/uac-connections/uac-connections.d.mts +5 -0
  428. package/resources/uac-connections/uac-connections.d.mts.map +1 -1
  429. package/resources/uac-connections/uac-connections.d.ts +5 -0
  430. package/resources/uac-connections/uac-connections.d.ts.map +1 -1
  431. package/resources/uac-connections/uac-connections.js.map +1 -1
  432. package/resources/uac-connections/uac-connections.mjs.map +1 -1
  433. package/resources/webhooks.d.mts +483 -85
  434. package/resources/webhooks.d.mts.map +1 -1
  435. package/resources/webhooks.d.ts +483 -85
  436. package/resources/webhooks.d.ts.map +1 -1
  437. package/resources/webhooks.js.map +1 -1
  438. package/resources/webhooks.mjs.map +1 -1
  439. package/src/client.ts +260 -0
  440. package/src/resources/ai/ai.ts +7 -0
  441. package/src/resources/ai/anthropic/v1.ts +3 -1
  442. package/src/resources/ai/assistants/assistants.ts +6 -1
  443. package/src/resources/ai/chat.ts +7 -0
  444. package/src/resources/ai/openai/chat.ts +7 -0
  445. package/src/resources/ai/openai/openai.ts +7 -0
  446. package/src/resources/calls/actions.ts +269 -51
  447. package/src/resources/calls/calls.ts +8 -0
  448. package/src/resources/calls/index.ts +3 -0
  449. package/src/resources/custom-storage-credentials.ts +140 -14
  450. package/src/resources/dir/dir.ts +3 -2
  451. package/src/resources/dir/references.ts +41 -11
  452. package/src/resources/dir/verify-email.ts +12 -0
  453. package/src/resources/email-blocks/email-blocks.ts +358 -0
  454. package/src/resources/email-blocks/import.ts +143 -0
  455. package/src/resources/email-blocks/index.ts +16 -0
  456. package/src/resources/email-blocks.ts +3 -0
  457. package/src/resources/email-domains/email-domains.ts +510 -0
  458. package/src/resources/email-domains/index.ts +33 -0
  459. package/src/resources/email-domains/webhooks.ts +267 -0
  460. package/src/resources/email-domains.ts +3 -0
  461. package/src/resources/email-events.ts +269 -0
  462. package/src/resources/email-inboxes/drafts.ts +746 -0
  463. package/src/resources/email-inboxes/email-inboxes.ts +276 -0
  464. package/src/resources/email-inboxes/filters.ts +193 -0
  465. package/src/resources/email-inboxes/index.ts +58 -0
  466. package/src/resources/email-inboxes/messages/actions.ts +258 -0
  467. package/src/resources/email-inboxes/messages/index.ts +27 -0
  468. package/src/resources/email-inboxes/messages/labels.ts +139 -0
  469. package/src/resources/email-inboxes/messages/messages.ts +313 -0
  470. package/src/resources/email-inboxes/messages.ts +3 -0
  471. package/src/resources/email-inboxes/threads/index.ts +21 -0
  472. package/src/resources/email-inboxes/threads/labels.ts +143 -0
  473. package/src/resources/email-inboxes/threads/threads.ts +292 -0
  474. package/src/resources/email-inboxes/threads.ts +3 -0
  475. package/src/resources/email-inboxes.ts +3 -0
  476. package/src/resources/email-messages/email-messages.ts +713 -0
  477. package/src/resources/email-messages/index.ts +26 -0
  478. package/src/resources/email-messages/recipients.ts +182 -0
  479. package/src/resources/email-messages.ts +3 -0
  480. package/src/resources/email-templates.ts +333 -0
  481. package/src/resources/email-threads.ts +100 -0
  482. package/src/resources/email-unsubscribe-groups/email-unsubscribe-groups.ts +171 -0
  483. package/src/resources/email-unsubscribe-groups/index.ts +19 -0
  484. package/src/resources/email-unsubscribe-groups/suppressions.ts +90 -0
  485. package/src/resources/email-unsubscribe-groups.ts +3 -0
  486. package/src/resources/email-validations/batch.ts +187 -0
  487. package/src/resources/email-validations/email-validations.ts +141 -0
  488. package/src/resources/email-validations/index.ts +15 -0
  489. package/src/resources/email-validations.ts +3 -0
  490. package/src/resources/index.ts +103 -0
  491. package/src/resources/pricing/index.ts +13 -0
  492. package/src/resources/pricing/pricing.ts +33 -0
  493. package/src/resources/pricing/products.ts +226 -0
  494. package/src/resources/pricing.ts +3 -0
  495. package/src/resources/speech-to-text/speech-to-text.ts +6 -3
  496. package/src/resources/uac-connections/uac-connections.ts +6 -0
  497. package/src/resources/webhooks.ts +636 -110
  498. package/src/version.ts +1 -1
  499. package/version.d.mts +1 -1
  500. package/version.d.ts +1 -1
  501. package/version.js +1 -1
  502. package/version.mjs +1 -1
@@ -0,0 +1,543 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import * as EmailMessagesAPI from "./email-messages.mjs";
3
+ import * as EmailEventsAPI from "../email-events.mjs";
4
+ import * as DraftsAPI from "../email-inboxes/drafts.mjs";
5
+ import * as RecipientsAPI from "./recipients.mjs";
6
+ import { EmailRecipient, RecipientListParams, RecipientListResponse, RecipientRetrieveParams, RecipientRetrieveResponse, Recipients } from "./recipients.mjs";
7
+ import * as ThreadsAPI from "../email-inboxes/threads/threads.mjs";
8
+ import { APIPromise } from "../../core/api-promise.mjs";
9
+ import { RequestOptions } from "../../internal/request-options.mjs";
10
+ /**
11
+ * Send and manage email messages. Legacy `/v2/emails` routes are aliases for these endpoints.
12
+ */
13
+ export declare class EmailMessages extends APIResource {
14
+ recipients: RecipientsAPI.Recipients;
15
+ /**
16
+ * Permanently deletes every email in the authenticated account sent from or to the
17
+ * supplied address, including retained events whose parent message has expired.
18
+ * Events and durable recipients are deleted immediately with each message. The
19
+ * operation never searches or reports matches in another account. The legacy
20
+ * `/v2/emails` DELETE route is a backward-compatible alias.
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * await client.emailMessages.deleteAll({
25
+ * address: 'dev@stainless.com',
26
+ * });
27
+ * ```
28
+ */
29
+ deleteAll(params: EmailMessageDeleteAllParams, options?: RequestOptions): APIPromise<void>;
30
+ /**
31
+ * Lists messages sorted newest first by `created_at desc, id desc`. No filters
32
+ * other than cursor pagination are implemented. The legacy `/v2/emails` GET route
33
+ * is a backward-compatible alias for this operation.
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * const emailMessages = await client.emailMessages.list();
38
+ * ```
39
+ */
40
+ list(query?: EmailMessageListParams | null | undefined, options?: RequestOptions): APIPromise<EmailMessageListResponse>;
41
+ /**
42
+ * Queues, schedules, or sandbox-sends an email message. The legacy `/v2/emails`
43
+ * POST route is a backward-compatible alias for this operation.
44
+ *
45
+ * `subject` is required unless `template_id` is supplied. When using
46
+ * `template_id`, do not also provide `subject`, `html_body`, or `text_body`; the
47
+ * template is rendered with `template_variables`.
48
+ *
49
+ * Note: template lookup failures (not found, wrong account) return 400, not 404.
50
+ *
51
+ * @example
52
+ * ```ts
53
+ * const emailMessageResponse =
54
+ * await client.emailMessages.create({
55
+ * from: 'sender@example.com',
56
+ * to: ['recipient@example.com'],
57
+ * subject: 'Hello from Telnyx',
58
+ * text_body: 'This is a test email.',
59
+ * });
60
+ * ```
61
+ */
62
+ create(params: EmailMessageCreateParams, options?: RequestOptions): APIPromise<DraftsAPI.EmailMessageResponse>;
63
+ /**
64
+ * Creates up to 50 email messages in a single request.
65
+ *
66
+ * @example
67
+ * ```ts
68
+ * const response = await client.emailMessages.batch({
69
+ * messages: [
70
+ * {
71
+ * from: 'sender@example.com',
72
+ * to: ['recipient1@example.com'],
73
+ * subject: 'Hello 1',
74
+ * text_body: 'Message 1',
75
+ * },
76
+ * {
77
+ * from: 'sender@example.com',
78
+ * to: ['recipient2@example.com'],
79
+ * subject: 'Hello 2',
80
+ * text_body: 'Message 2',
81
+ * },
82
+ * ],
83
+ * });
84
+ * ```
85
+ */
86
+ batch(params: EmailMessageBatchParams, options?: RequestOptions): APIPromise<EmailMessageBatchResponse>;
87
+ /**
88
+ * Lists events for a single message sorted oldest first by
89
+ * `occurred_at asc, id asc`. The legacy `/v2/emails/{id}/events` GET route is a
90
+ * backward-compatible alias.
91
+ *
92
+ * @example
93
+ * ```ts
94
+ * const response = await client.emailMessages.retrieveEvents(
95
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
96
+ * );
97
+ * ```
98
+ */
99
+ retrieveEvents(emailID: string, query?: EmailMessageRetrieveEventsParams | null | undefined, options?: RequestOptions): APIPromise<EmailMessageRetrieveEventsResponse>;
100
+ /**
101
+ * Cancels a scheduled email and returns it with status `cancelled`. The legacy
102
+ * `/v2/emails/{id}/schedule` DELETE route is an alias.
103
+ *
104
+ * @example
105
+ * ```ts
106
+ * const emailMessageResponse =
107
+ * await client.emailMessages.deleteSchedule(
108
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
109
+ * );
110
+ * ```
111
+ */
112
+ deleteSchedule(emailID: string, options?: RequestOptions): APIPromise<DraftsAPI.EmailMessageResponse>;
113
+ /**
114
+ * Permanently deletes an account-scoped email message, its events, its durable
115
+ * recipients, and unshared attachment objects. Returns 404 when the message does
116
+ * not exist in the authenticated account. The legacy `/v2/emails/{id}` DELETE
117
+ * route is a backward-compatible alias.
118
+ *
119
+ * @example
120
+ * ```ts
121
+ * await client.emailMessages.delete(
122
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
123
+ * );
124
+ * ```
125
+ */
126
+ delete(id: string, options?: RequestOptions): APIPromise<void>;
127
+ /**
128
+ * The legacy `/v2/emails/{id}` GET route is a backward-compatible alias for this
129
+ * operation.
130
+ *
131
+ * @example
132
+ * ```ts
133
+ * const emailMessage = await client.emailMessages.retrieve(
134
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
135
+ * );
136
+ * ```
137
+ */
138
+ retrieve(id: string, options?: RequestOptions): APIPromise<EmailMessageRetrieveResponse>;
139
+ }
140
+ export interface AttachmentRequest {
141
+ /**
142
+ * Attachment content, typically Base64-encoded. Defaults to empty string when
143
+ * omitted.
144
+ */
145
+ content?: string;
146
+ /**
147
+ * MIME Content-ID used to reference an inline attachment.
148
+ */
149
+ content_id?: string | null;
150
+ /**
151
+ * MIME content type. Defaults to "application/octet-stream" when omitted.
152
+ */
153
+ content_type?: string;
154
+ /**
155
+ * MIME disposition (`attachment` or `inline`).
156
+ */
157
+ disposition?: string;
158
+ /**
159
+ * Attachment filename. Defaults to "attachment" when omitted.
160
+ */
161
+ filename?: string;
162
+ }
163
+ export type EmailAddressInput = string | DraftsAPI.EmailAddress;
164
+ export interface MessageEvent {
165
+ occurred_at: string;
166
+ type: EmailEventsAPI.EmailEventType;
167
+ payload?: {
168
+ [key: string]: unknown;
169
+ };
170
+ }
171
+ /**
172
+ * Per-send open and click tracking overrides. Omitted properties inherit the
173
+ * sender domain's tracking settings.
174
+ */
175
+ export interface TrackingSettings {
176
+ /**
177
+ * Whether to rewrite links for click tracking in this message.
178
+ */
179
+ click_tracking?: boolean;
180
+ /**
181
+ * Whether to inject an open-tracking pixel for this message.
182
+ */
183
+ open_tracking?: boolean;
184
+ }
185
+ export interface EmailMessageRetrieveResponse {
186
+ data: EmailMessageRetrieveResponse.Data;
187
+ }
188
+ export declare namespace EmailMessageRetrieveResponse {
189
+ interface Data extends DraftsAPI.EmailMessage {
190
+ /**
191
+ * HTML body submitted for the message.
192
+ */
193
+ html_body: string | null;
194
+ /**
195
+ * Plain-text body submitted for the message.
196
+ */
197
+ text_body: string | null;
198
+ }
199
+ }
200
+ export interface EmailMessageListResponse {
201
+ data: Array<DraftsAPI.EmailMessage>;
202
+ meta: ThreadsAPI.EmailPaginationMeta;
203
+ }
204
+ export interface EmailMessageBatchResponse {
205
+ data: Array<DraftsAPI.EmailMessage>;
206
+ errors: Array<EmailMessageBatchResponse.Error>;
207
+ meta: EmailMessageBatchResponse.Meta;
208
+ }
209
+ export declare namespace EmailMessageBatchResponse {
210
+ interface Error {
211
+ /**
212
+ * Batch item errors use `message` (not `detail`) for the human-readable text.
213
+ */
214
+ code: 'bad_request' | 'not_found' | 'forbidden' | 'service_unavailable' | 'validation_error' | 'recipient_suppressed' | 'reputation_suspended';
215
+ /**
216
+ * Zero-based index of the failed message in the request array.
217
+ */
218
+ index: number;
219
+ message: string;
220
+ }
221
+ interface Meta {
222
+ failed: number;
223
+ succeeded: number;
224
+ total: number;
225
+ }
226
+ }
227
+ export interface EmailMessageRetrieveEventsResponse {
228
+ data: Array<MessageEvent>;
229
+ meta: ThreadsAPI.EmailPaginationMeta;
230
+ }
231
+ export interface EmailMessageDeleteAllParams {
232
+ /**
233
+ * Sender or recipient address to delete. Matching is trimmed and case-insensitive.
234
+ */
235
+ address: string;
236
+ }
237
+ export interface EmailMessageListParams {
238
+ /**
239
+ * Opaque URL-safe Base64 cursor returned by a previous list response.
240
+ */
241
+ page_cursor?: string;
242
+ /**
243
+ * Number of results to return. Defaults to 25; maximum is 100. Invalid values are
244
+ * clamped to the valid range.
245
+ */
246
+ page_size?: number;
247
+ }
248
+ export interface EmailMessageCreateParams {
249
+ /**
250
+ * Body param
251
+ */
252
+ from: EmailAddressInput;
253
+ /**
254
+ * Body param
255
+ */
256
+ to: Array<EmailAddressInput>;
257
+ /**
258
+ * Body param
259
+ */
260
+ attachments?: Array<AttachmentRequest>;
261
+ /**
262
+ * Body param
263
+ */
264
+ bcc?: Array<EmailAddressInput>;
265
+ /**
266
+ * Body param
267
+ */
268
+ cc?: Array<EmailAddressInput>;
269
+ /**
270
+ * Body param: Telnyx message UUID of the message this send forwards. Forwarded
271
+ * messages start a NEW thread per RFC 5322 — NO `In-Reply-To` or `References`
272
+ * headers are set on the outbound MIME. The id is recorded in the message's
273
+ * metadata for EDR provenance only.
274
+ *
275
+ * The id is validated as a UUID but is NOT looked up against the message store —
276
+ * existence is the caller's responsibility (the forward is pure metadata; it does
277
+ * not affect delivery). Cannot be combined with `in_reply_to_message_id` (422).
278
+ */
279
+ forward_of_message_id?: string | null;
280
+ /**
281
+ * Body param: Optional display name for string `from`; overrides `from.name` when
282
+ * provided.
283
+ */
284
+ from_name?: string;
285
+ /**
286
+ * Body param: Optional unsubscribe-group UUID used for group-scoped suppression
287
+ * checks and unsubscribe handling.
288
+ */
289
+ group_id?: string | null;
290
+ /**
291
+ * Body param: Custom email headers. Write-only; not returned in responses.
292
+ */
293
+ headers?: {
294
+ [key: string]: string;
295
+ };
296
+ /**
297
+ * Body param: HTML email body. Returned only by `GET /email_messages/{id}`;
298
+ * omitted from create and list responses.
299
+ */
300
+ html_body?: string;
301
+ /**
302
+ * Body param: When true, allows delivery to recipients whose suppressions
303
+ * explicitly permit an override. Hard bounces, spam complaints, and
304
+ * invalid-address suppressions cannot be overridden. Requires the `email:override`
305
+ * API scope.
306
+ */
307
+ ignore_suppression?: boolean;
308
+ /**
309
+ * Body param: Telnyx message UUID of the message this send replies to. When
310
+ * provided, the API sets RFC 5322 `In-Reply-To` and `References` headers on the
311
+ * outbound MIME so the recipient's mailbox (Gmail/Outlook) threads it correctly.
312
+ * The parent is looked up under the caller's account scope; a UUID belonging to
313
+ * another account yields a non-enumerating 404.
314
+ *
315
+ * Wire-only (Phase 1): the API sets the headers and does NOT resolve or mutate
316
+ * `thread_id` on the server side. Messages sent without this parameter are
317
+ * standalone (no threading headers injected).
318
+ *
319
+ * Cannot be combined with `forward_of_message_id` (422).
320
+ */
321
+ in_reply_to_message_id?: string | null;
322
+ /**
323
+ * Body param
324
+ */
325
+ inline_css?: boolean;
326
+ /**
327
+ * Body param: Custom metadata. Write-only; not returned in responses.
328
+ */
329
+ metadata?: {
330
+ [key: string]: unknown;
331
+ };
332
+ /**
333
+ * Body param: Reply-to address. If provided as an object with a name, only the
334
+ * email is stored; the name is ignored.
335
+ */
336
+ reply_to?: EmailAddressInput;
337
+ /**
338
+ * Body param: Indicates a reply-all intent. In Phase 1 (wire-only) this does not
339
+ * change the threading headers — recipient selection is customer- controlled
340
+ * (`to`/`cc`), and a thread is not defined by its audience. When the referenced
341
+ * message has no thread context, reply-all degrades to a plain reply (parent ID
342
+ * only in `References`). The resolution engine (separate work) will expand the
343
+ * ancestor chain at a later phase with no API change.
344
+ *
345
+ * Only meaningful alongside `in_reply_to_message_id`.
346
+ */
347
+ reply_to_all?: boolean | null;
348
+ /**
349
+ * Body param
350
+ */
351
+ sandbox_mode?: boolean;
352
+ /**
353
+ * Body param: Future ISO 8601 time to schedule sending. Invalid or past timestamps
354
+ * are silently ignored and the email is sent immediately. The legacy alias
355
+ * `send_at` is still accepted for backward compatibility; when both are provided,
356
+ * `scheduled_at` wins.
357
+ */
358
+ scheduled_at?: string | null;
359
+ /**
360
+ * @deprecated Body param: Deprecated alias for `scheduled_at`.
361
+ */
362
+ send_at?: string;
363
+ /**
364
+ * Body param: Required unless `template_id` is supplied. When using a template,
365
+ * the template's subject is rendered; if the template has no subject or renders
366
+ * empty, the request returns 400.
367
+ */
368
+ subject?: string;
369
+ /**
370
+ * Body param: Tags for categorization and reporting. Stored on the message and
371
+ * propagated to Email Detail Records. Not returned in API responses.
372
+ */
373
+ tags?: Array<string>;
374
+ /**
375
+ * Body param
376
+ */
377
+ template_id?: string;
378
+ /**
379
+ * Body param: Variables for Liquid template rendering. Non-object values may cause
380
+ * a 422 validation error on message creation, but are silently treated as an empty
381
+ * object for template rendering.
382
+ */
383
+ template_variables?: {
384
+ [key: string]: unknown;
385
+ };
386
+ /**
387
+ * Body param: Plain text email body. Returned only by `GET /email_messages/{id}`;
388
+ * omitted from create and list responses.
389
+ */
390
+ text_body?: string;
391
+ /**
392
+ * Body param: Per-send open and click tracking overrides. Omitted properties
393
+ * inherit the sender domain's tracking settings.
394
+ */
395
+ tracking_settings?: TrackingSettings;
396
+ /**
397
+ * Header param: Optional opaque, unquoted key for safely retrying the same logical
398
+ * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
399
+ * Generate a unique UUID v4 for each operation and reuse it only when retrying
400
+ * that operation with the same request. Invalid headers—including duplicate,
401
+ * empty, malformed, or overlong values—return 400 with error code 10015. A request
402
+ * already in progress with the same key returns 409; reusing the key with a
403
+ * different request returns 422. Only successful responses are replayed, for up to
404
+ * 24 hours. Do not include sensitive data in the key.
405
+ */
406
+ 'Idempotency-Key'?: string;
407
+ }
408
+ export interface EmailMessageBatchParams {
409
+ /**
410
+ * Body param
411
+ */
412
+ messages: Array<EmailMessageBatchParams.Message>;
413
+ /**
414
+ * Body param: Applies sandbox mode to all messages in the batch. Overrides any
415
+ * per-message sandbox_mode in the messages array.
416
+ */
417
+ sandbox_mode?: boolean;
418
+ /**
419
+ * Header param: Optional opaque, unquoted key for safely retrying the same logical
420
+ * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
421
+ * Generate a unique UUID v4 for each operation and reuse it only when retrying
422
+ * that operation with the same request. Invalid headers—including duplicate,
423
+ * empty, malformed, or overlong values—return 400 with error code 10015. A request
424
+ * already in progress with the same key returns 409; reusing the key with a
425
+ * different request returns 422. Only successful responses are replayed, for up to
426
+ * 24 hours. Do not include sensitive data in the key.
427
+ */
428
+ 'Idempotency-Key'?: string;
429
+ }
430
+ export declare namespace EmailMessageBatchParams {
431
+ /**
432
+ * A single message in a batch create request. This schema mirrors
433
+ * `CreateEmailRequest` EXCEPT it does not accept the reply/forward threading
434
+ * parameters (`in_reply_to_message_id`, `reply_to_all`, `forward_of_message_id`) —
435
+ * those are single-send-only in Phase 1 (MSG-1491) and are not yet implemented on
436
+ * the batch endpoint. Recipient email addresses must be unique across `to`, `cc`,
437
+ * and `bcc` after case-insensitive normalization. Duplicate recipients return
438
+ * `400`.
439
+ */
440
+ interface Message {
441
+ from: EmailMessagesAPI.EmailAddressInput;
442
+ to: Array<EmailMessagesAPI.EmailAddressInput>;
443
+ attachments?: Array<EmailMessagesAPI.AttachmentRequest>;
444
+ bcc?: Array<EmailMessagesAPI.EmailAddressInput>;
445
+ cc?: Array<EmailMessagesAPI.EmailAddressInput>;
446
+ /**
447
+ * Optional display name for string `from`; overrides `from.name` when provided.
448
+ */
449
+ from_name?: string;
450
+ /**
451
+ * Optional unsubscribe-group UUID used for group-scoped suppression checks and
452
+ * unsubscribe handling.
453
+ */
454
+ group_id?: string | null;
455
+ /**
456
+ * Custom email headers. Write-only; not returned in responses.
457
+ */
458
+ headers?: {
459
+ [key: string]: string;
460
+ };
461
+ /**
462
+ * HTML email body. Returned only by `GET /email_messages/{id}`; omitted from
463
+ * create and list responses.
464
+ */
465
+ html_body?: string;
466
+ /**
467
+ * When true, allows delivery to recipients whose suppressions explicitly permit an
468
+ * override. Hard bounces, spam complaints, and invalid-address suppressions cannot
469
+ * be overridden. Requires the `email:override` API scope.
470
+ */
471
+ ignore_suppression?: boolean;
472
+ inline_css?: boolean;
473
+ /**
474
+ * Custom metadata. Write-only; not returned in responses.
475
+ */
476
+ metadata?: {
477
+ [key: string]: unknown;
478
+ };
479
+ /**
480
+ * Reply-to address. If provided as an object with a name, only the email is
481
+ * stored; the name is ignored.
482
+ */
483
+ reply_to?: EmailMessagesAPI.EmailAddressInput;
484
+ sandbox_mode?: boolean;
485
+ /**
486
+ * Future ISO 8601 time to schedule sending. Invalid or past timestamps are
487
+ * silently ignored and the email is sent immediately. The legacy alias `send_at`
488
+ * is still accepted for backward compatibility; when both are provided,
489
+ * `scheduled_at` wins.
490
+ */
491
+ scheduled_at?: string | null;
492
+ /**
493
+ * @deprecated Deprecated alias for `scheduled_at`.
494
+ */
495
+ send_at?: string;
496
+ /**
497
+ * Required unless `template_id` is supplied. When using a template, the template's
498
+ * subject is rendered; if the template has no subject or renders empty, the
499
+ * request returns 400.
500
+ */
501
+ subject?: string;
502
+ /**
503
+ * Tags for categorization and reporting. Stored on the message and propagated to
504
+ * Email Detail Records. Not returned in API responses.
505
+ */
506
+ tags?: Array<string>;
507
+ template_id?: string;
508
+ /**
509
+ * Variables for Liquid template rendering. Non-object values may cause a 422
510
+ * validation error on message creation, but are silently treated as an empty
511
+ * object for template rendering.
512
+ */
513
+ template_variables?: {
514
+ [key: string]: unknown;
515
+ };
516
+ /**
517
+ * Plain text email body. Returned only by `GET /email_messages/{id}`; omitted from
518
+ * create and list responses.
519
+ */
520
+ text_body?: string;
521
+ /**
522
+ * Per-send open and click tracking overrides. Omitted properties inherit the
523
+ * sender domain's tracking settings.
524
+ */
525
+ tracking_settings?: EmailMessagesAPI.TrackingSettings;
526
+ }
527
+ }
528
+ export interface EmailMessageRetrieveEventsParams {
529
+ /**
530
+ * Opaque URL-safe Base64 cursor returned by a previous list response.
531
+ */
532
+ page_cursor?: string;
533
+ /**
534
+ * Number of results to return. Defaults to 25; maximum is 100. Invalid values are
535
+ * clamped to the valid range.
536
+ */
537
+ page_size?: number;
538
+ }
539
+ export declare namespace EmailMessages {
540
+ export { type AttachmentRequest as AttachmentRequest, type EmailAddressInput as EmailAddressInput, type MessageEvent as MessageEvent, type TrackingSettings as TrackingSettings, type EmailMessageRetrieveResponse as EmailMessageRetrieveResponse, type EmailMessageListResponse as EmailMessageListResponse, type EmailMessageBatchResponse as EmailMessageBatchResponse, type EmailMessageRetrieveEventsResponse as EmailMessageRetrieveEventsResponse, type EmailMessageDeleteAllParams as EmailMessageDeleteAllParams, type EmailMessageListParams as EmailMessageListParams, type EmailMessageCreateParams as EmailMessageCreateParams, type EmailMessageBatchParams as EmailMessageBatchParams, type EmailMessageRetrieveEventsParams as EmailMessageRetrieveEventsParams, };
541
+ export { Recipients as Recipients, type EmailRecipient as EmailRecipient, type RecipientRetrieveResponse as RecipientRetrieveResponse, type RecipientListResponse as RecipientListResponse, type RecipientListParams as RecipientListParams, type RecipientRetrieveParams as RecipientRetrieveParams, };
542
+ }
543
+ //# sourceMappingURL=email-messages.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"email-messages.d.mts","sourceRoot":"","sources":["../../src/resources/email-messages/email-messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,gBAAgB,6BAAyB;AACrD,OAAO,KAAK,cAAc,4BAAwB;AAClD,OAAO,KAAK,SAAS,oCAAgC;AACrD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,yBAAyB,EACzB,UAAU,EACX,yBAAqB;AACtB,OAAO,KAAK,UAAU,6CAAyC;AAC/D,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,MAAM,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAS1F;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC;IAY7C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAYvG;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;IAIjD;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC;IAIrG;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;CAGzF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC;AAEhE,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,cAAc,CAAC,cAAc,CAAC;IAEpC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,4BAA4B,CAAC,IAAI,CAAC;CACzC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAK,SAAQ,SAAS,CAAC,YAAY;QAClD;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAEpC,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC;CACtC;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAEpC,MAAM,EAAE,KAAK,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;IAE/C,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EACA,aAAa,GACb,WAAW,GACX,WAAW,GACX,qBAAqB,GACrB,kBAAkB,GAClB,sBAAsB,GACtB,sBAAsB,CAAC;QAE3B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,UAAiB,IAAI;QACnB,MAAM,EAAE,MAAM,CAAC;QAEf,SAAS,EAAE,MAAM,CAAC;QAElB,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC;CACtC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC;IAExB;;OAEG;IACH,EAAE,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAEvC;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE/B;;OAEG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE9B;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAE7B;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEhD;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IAErC;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAEjD;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;;;;;;OAQG;IACH,UAAiB,OAAO;QACtB,IAAI,EAAE,gBAAgB,CAAC,iBAAiB,CAAC;QAEzC,EAAE,EAAE,KAAK,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAE9C,WAAW,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAExD,GAAG,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAEhD,EAAE,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAE/C;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAE7B,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC;QAE9C,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;;;;WAKG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAErB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,kBAAkB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEhD;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,gBAAgB,CAAC,gBAAgB,CAAC;KACvD;CACF;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}