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,186 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.EmailMessages = void 0;
5
+ const tslib_1 = require("../../internal/tslib.js");
6
+ const resource_1 = require("../../core/resource.js");
7
+ const RecipientsAPI = tslib_1.__importStar(require("./recipients.js"));
8
+ const recipients_1 = require("./recipients.js");
9
+ const headers_1 = require("../../internal/headers.js");
10
+ const path_1 = require("../../internal/utils/path.js");
11
+ /**
12
+ * Send and manage email messages. Legacy `/v2/emails` routes are aliases for these endpoints.
13
+ */
14
+ class EmailMessages extends resource_1.APIResource {
15
+ constructor() {
16
+ super(...arguments);
17
+ this.recipients = new RecipientsAPI.Recipients(this._client);
18
+ }
19
+ /**
20
+ * Permanently deletes every email in the authenticated account sent from or to the
21
+ * supplied address, including retained events whose parent message has expired.
22
+ * Events and durable recipients are deleted immediately with each message. The
23
+ * operation never searches or reports matches in another account. The legacy
24
+ * `/v2/emails` DELETE route is a backward-compatible alias.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * await client.emailMessages.deleteAll({
29
+ * address: 'dev@stainless.com',
30
+ * });
31
+ * ```
32
+ */
33
+ deleteAll(params, options) {
34
+ const { address } = params;
35
+ return this._client.delete('/email_messages', {
36
+ query: { address },
37
+ ...options,
38
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
39
+ });
40
+ }
41
+ /**
42
+ * Lists messages sorted newest first by `created_at desc, id desc`. No filters
43
+ * other than cursor pagination are implemented. The legacy `/v2/emails` GET route
44
+ * is a backward-compatible alias for this operation.
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * const emailMessages = await client.emailMessages.list();
49
+ * ```
50
+ */
51
+ list(query = {}, options) {
52
+ return this._client.get('/email_messages', { query, ...options });
53
+ }
54
+ /**
55
+ * Queues, schedules, or sandbox-sends an email message. The legacy `/v2/emails`
56
+ * POST route is a backward-compatible alias for this operation.
57
+ *
58
+ * `subject` is required unless `template_id` is supplied. When using
59
+ * `template_id`, do not also provide `subject`, `html_body`, or `text_body`; the
60
+ * template is rendered with `template_variables`.
61
+ *
62
+ * Note: template lookup failures (not found, wrong account) return 400, not 404.
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * const emailMessageResponse =
67
+ * await client.emailMessages.create({
68
+ * from: 'sender@example.com',
69
+ * to: ['recipient@example.com'],
70
+ * subject: 'Hello from Telnyx',
71
+ * text_body: 'This is a test email.',
72
+ * });
73
+ * ```
74
+ */
75
+ create(params, options) {
76
+ const { 'Idempotency-Key': idempotencyKey, ...body } = params;
77
+ return this._client.post('/email_messages', {
78
+ body,
79
+ ...options,
80
+ headers: (0, headers_1.buildHeaders)([
81
+ { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
82
+ options?.headers,
83
+ ]),
84
+ });
85
+ }
86
+ /**
87
+ * Creates up to 50 email messages in a single request.
88
+ *
89
+ * @example
90
+ * ```ts
91
+ * const response = await client.emailMessages.batch({
92
+ * messages: [
93
+ * {
94
+ * from: 'sender@example.com',
95
+ * to: ['recipient1@example.com'],
96
+ * subject: 'Hello 1',
97
+ * text_body: 'Message 1',
98
+ * },
99
+ * {
100
+ * from: 'sender@example.com',
101
+ * to: ['recipient2@example.com'],
102
+ * subject: 'Hello 2',
103
+ * text_body: 'Message 2',
104
+ * },
105
+ * ],
106
+ * });
107
+ * ```
108
+ */
109
+ batch(params, options) {
110
+ const { 'Idempotency-Key': idempotencyKey, ...body } = params;
111
+ return this._client.post('/email_messages/batch', {
112
+ body,
113
+ ...options,
114
+ headers: (0, headers_1.buildHeaders)([
115
+ { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
116
+ options?.headers,
117
+ ]),
118
+ });
119
+ }
120
+ /**
121
+ * Lists events for a single message sorted oldest first by
122
+ * `occurred_at asc, id asc`. The legacy `/v2/emails/{id}/events` GET route is a
123
+ * backward-compatible alias.
124
+ *
125
+ * @example
126
+ * ```ts
127
+ * const response = await client.emailMessages.retrieveEvents(
128
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
129
+ * );
130
+ * ```
131
+ */
132
+ retrieveEvents(emailID, query = {}, options) {
133
+ return this._client.get((0, path_1.path) `/email_messages/${emailID}/events`, { query, ...options });
134
+ }
135
+ /**
136
+ * Cancels a scheduled email and returns it with status `cancelled`. The legacy
137
+ * `/v2/emails/{id}/schedule` DELETE route is an alias.
138
+ *
139
+ * @example
140
+ * ```ts
141
+ * const emailMessageResponse =
142
+ * await client.emailMessages.deleteSchedule(
143
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
144
+ * );
145
+ * ```
146
+ */
147
+ deleteSchedule(emailID, options) {
148
+ return this._client.delete((0, path_1.path) `/email_messages/${emailID}/schedule`, options);
149
+ }
150
+ /**
151
+ * Permanently deletes an account-scoped email message, its events, its durable
152
+ * recipients, and unshared attachment objects. Returns 404 when the message does
153
+ * not exist in the authenticated account. The legacy `/v2/emails/{id}` DELETE
154
+ * route is a backward-compatible alias.
155
+ *
156
+ * @example
157
+ * ```ts
158
+ * await client.emailMessages.delete(
159
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
160
+ * );
161
+ * ```
162
+ */
163
+ delete(id, options) {
164
+ return this._client.delete((0, path_1.path) `/email_messages/${id}`, {
165
+ ...options,
166
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
167
+ });
168
+ }
169
+ /**
170
+ * The legacy `/v2/emails/{id}` GET route is a backward-compatible alias for this
171
+ * operation.
172
+ *
173
+ * @example
174
+ * ```ts
175
+ * const emailMessage = await client.emailMessages.retrieve(
176
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
177
+ * );
178
+ * ```
179
+ */
180
+ retrieve(id, options) {
181
+ return this._client.get((0, path_1.path) `/email_messages/${id}`, options);
182
+ }
183
+ }
184
+ exports.EmailMessages = EmailMessages;
185
+ EmailMessages.Recipients = recipients_1.Recipients;
186
+ //# sourceMappingURL=email-messages.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"email-messages.js","sourceRoot":"","sources":["../../src/resources/email-messages/email-messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAIlD,uEAA8C;AAC9C,gDAOsB;AAGtB,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAA9C;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuLpF,CAAC;IArLC;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,MAAmC,EAAE,OAAwB;QACrE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE;YAC5C,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC1C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,MAA+B,EAAE,OAAwB;QAC7D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE;YAChD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,OAAe,EACf,QAA6D,EAAE,EAC/D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,OAAO,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,OAAe,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,OAAO,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AAxLD,sCAwLC;AA6dD,aAAa,CAAC,UAAU,GAAG,uBAAU,CAAC"}
@@ -0,0 +1,181 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../core/resource.mjs";
3
+ import * as RecipientsAPI from "./recipients.mjs";
4
+ import { Recipients, } from "./recipients.mjs";
5
+ import { buildHeaders } from "../../internal/headers.mjs";
6
+ import { path } from "../../internal/utils/path.mjs";
7
+ /**
8
+ * Send and manage email messages. Legacy `/v2/emails` routes are aliases for these endpoints.
9
+ */
10
+ export class EmailMessages extends APIResource {
11
+ constructor() {
12
+ super(...arguments);
13
+ this.recipients = new RecipientsAPI.Recipients(this._client);
14
+ }
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, options) {
30
+ const { address } = params;
31
+ return this._client.delete('/email_messages', {
32
+ query: { address },
33
+ ...options,
34
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
35
+ });
36
+ }
37
+ /**
38
+ * Lists messages sorted newest first by `created_at desc, id desc`. No filters
39
+ * other than cursor pagination are implemented. The legacy `/v2/emails` GET route
40
+ * is a backward-compatible alias for this operation.
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * const emailMessages = await client.emailMessages.list();
45
+ * ```
46
+ */
47
+ list(query = {}, options) {
48
+ return this._client.get('/email_messages', { query, ...options });
49
+ }
50
+ /**
51
+ * Queues, schedules, or sandbox-sends an email message. The legacy `/v2/emails`
52
+ * POST route is a backward-compatible alias for this operation.
53
+ *
54
+ * `subject` is required unless `template_id` is supplied. When using
55
+ * `template_id`, do not also provide `subject`, `html_body`, or `text_body`; the
56
+ * template is rendered with `template_variables`.
57
+ *
58
+ * Note: template lookup failures (not found, wrong account) return 400, not 404.
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * const emailMessageResponse =
63
+ * await client.emailMessages.create({
64
+ * from: 'sender@example.com',
65
+ * to: ['recipient@example.com'],
66
+ * subject: 'Hello from Telnyx',
67
+ * text_body: 'This is a test email.',
68
+ * });
69
+ * ```
70
+ */
71
+ create(params, options) {
72
+ const { 'Idempotency-Key': idempotencyKey, ...body } = params;
73
+ return this._client.post('/email_messages', {
74
+ body,
75
+ ...options,
76
+ headers: buildHeaders([
77
+ { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
78
+ options?.headers,
79
+ ]),
80
+ });
81
+ }
82
+ /**
83
+ * Creates up to 50 email messages in a single request.
84
+ *
85
+ * @example
86
+ * ```ts
87
+ * const response = await client.emailMessages.batch({
88
+ * messages: [
89
+ * {
90
+ * from: 'sender@example.com',
91
+ * to: ['recipient1@example.com'],
92
+ * subject: 'Hello 1',
93
+ * text_body: 'Message 1',
94
+ * },
95
+ * {
96
+ * from: 'sender@example.com',
97
+ * to: ['recipient2@example.com'],
98
+ * subject: 'Hello 2',
99
+ * text_body: 'Message 2',
100
+ * },
101
+ * ],
102
+ * });
103
+ * ```
104
+ */
105
+ batch(params, options) {
106
+ const { 'Idempotency-Key': idempotencyKey, ...body } = params;
107
+ return this._client.post('/email_messages/batch', {
108
+ body,
109
+ ...options,
110
+ headers: buildHeaders([
111
+ { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
112
+ options?.headers,
113
+ ]),
114
+ });
115
+ }
116
+ /**
117
+ * Lists events for a single message sorted oldest first by
118
+ * `occurred_at asc, id asc`. The legacy `/v2/emails/{id}/events` GET route is a
119
+ * backward-compatible alias.
120
+ *
121
+ * @example
122
+ * ```ts
123
+ * const response = await client.emailMessages.retrieveEvents(
124
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
125
+ * );
126
+ * ```
127
+ */
128
+ retrieveEvents(emailID, query = {}, options) {
129
+ return this._client.get(path `/email_messages/${emailID}/events`, { query, ...options });
130
+ }
131
+ /**
132
+ * Cancels a scheduled email and returns it with status `cancelled`. The legacy
133
+ * `/v2/emails/{id}/schedule` DELETE route is an alias.
134
+ *
135
+ * @example
136
+ * ```ts
137
+ * const emailMessageResponse =
138
+ * await client.emailMessages.deleteSchedule(
139
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
140
+ * );
141
+ * ```
142
+ */
143
+ deleteSchedule(emailID, options) {
144
+ return this._client.delete(path `/email_messages/${emailID}/schedule`, options);
145
+ }
146
+ /**
147
+ * Permanently deletes an account-scoped email message, its events, its durable
148
+ * recipients, and unshared attachment objects. Returns 404 when the message does
149
+ * not exist in the authenticated account. The legacy `/v2/emails/{id}` DELETE
150
+ * route is a backward-compatible alias.
151
+ *
152
+ * @example
153
+ * ```ts
154
+ * await client.emailMessages.delete(
155
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
156
+ * );
157
+ * ```
158
+ */
159
+ delete(id, options) {
160
+ return this._client.delete(path `/email_messages/${id}`, {
161
+ ...options,
162
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
163
+ });
164
+ }
165
+ /**
166
+ * The legacy `/v2/emails/{id}` GET route is a backward-compatible alias for this
167
+ * operation.
168
+ *
169
+ * @example
170
+ * ```ts
171
+ * const emailMessage = await client.emailMessages.retrieve(
172
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
173
+ * );
174
+ * ```
175
+ */
176
+ retrieve(id, options) {
177
+ return this._client.get(path `/email_messages/${id}`, options);
178
+ }
179
+ }
180
+ EmailMessages.Recipients = Recipients;
181
+ //# sourceMappingURL=email-messages.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"email-messages.mjs","sourceRoot":"","sources":["../../src/resources/email-messages/email-messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,KAAK,aAAa,yBAAqB;AAC9C,OAAO,EAML,UAAU,GACX,yBAAqB;AAGtB,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAA9C;;QACE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuLpF,CAAC;IArLC;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,MAAmC,EAAE,OAAwB;QACrE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE;YAC5C,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CACJ,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC1C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,MAA+B,EAAE,OAAwB;QAC7D,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE;YAChD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,OAAe,EACf,QAA6D,EAAE,EAC/D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,OAAO,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,OAAe,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,OAAO,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE;YACtD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACF;AA6dD,aAAa,CAAC,UAAU,GAAG,UAAU,CAAC"}
@@ -0,0 +1,3 @@
1
+ export { EmailMessages, type AttachmentRequest, type EmailAddressInput, type MessageEvent, type TrackingSettings, type EmailMessageRetrieveResponse, type EmailMessageListResponse, type EmailMessageBatchResponse, type EmailMessageRetrieveEventsResponse, type EmailMessageDeleteAllParams, type EmailMessageListParams, type EmailMessageCreateParams, type EmailMessageBatchParams, type EmailMessageRetrieveEventsParams, } from "./email-messages.mjs";
2
+ export { Recipients, type EmailRecipient, type RecipientRetrieveResponse, type RecipientListResponse, type RecipientListParams, type RecipientRetrieveParams, } from "./recipients.mjs";
3
+ //# sourceMappingURL=index.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/email-messages/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,aAAa,EACb,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,kCAAkC,EACvC,KAAK,2BAA2B,EAChC,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,gCAAgC,GACtC,6BAAyB;AAC1B,OAAO,EACL,UAAU,EACV,KAAK,cAAc,EACnB,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,GAC7B,yBAAqB"}
@@ -0,0 +1,3 @@
1
+ export { EmailMessages, type AttachmentRequest, type EmailAddressInput, type MessageEvent, type TrackingSettings, type EmailMessageRetrieveResponse, type EmailMessageListResponse, type EmailMessageBatchResponse, type EmailMessageRetrieveEventsResponse, type EmailMessageDeleteAllParams, type EmailMessageListParams, type EmailMessageCreateParams, type EmailMessageBatchParams, type EmailMessageRetrieveEventsParams, } from "./email-messages.js";
2
+ export { Recipients, type EmailRecipient, type RecipientRetrieveResponse, type RecipientListResponse, type RecipientListParams, type RecipientRetrieveParams, } from "./recipients.js";
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/email-messages/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,aAAa,EACb,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,kCAAkC,EACvC,KAAK,2BAA2B,EAChC,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,gCAAgC,GACtC,4BAAyB;AAC1B,OAAO,EACL,UAAU,EACV,KAAK,cAAc,EACnB,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,GAC7B,wBAAqB"}
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.Recipients = exports.EmailMessages = void 0;
5
+ var email_messages_1 = require("./email-messages.js");
6
+ Object.defineProperty(exports, "EmailMessages", { enumerable: true, get: function () { return email_messages_1.EmailMessages; } });
7
+ var recipients_1 = require("./recipients.js");
8
+ Object.defineProperty(exports, "Recipients", { enumerable: true, get: function () { return recipients_1.Recipients; } });
9
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/email-messages/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sDAe0B;AAdxB,+GAAA,aAAa,OAAA;AAef,8CAOsB;AANpB,wGAAA,UAAU,OAAA"}
@@ -0,0 +1,4 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ export { EmailMessages, } from "./email-messages.mjs";
3
+ export { Recipients, } from "./recipients.mjs";
4
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/email-messages/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EACL,aAAa,GAcd,6BAAyB;AAC1B,OAAO,EACL,UAAU,GAMX,yBAAqB"}
@@ -0,0 +1,118 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import { APIPromise } from "../../core/api-promise.mjs";
3
+ import { RequestOptions } from "../../internal/request-options.mjs";
4
+ /**
5
+ * Send and manage email messages. Legacy `/v2/emails` routes are aliases for these endpoints.
6
+ */
7
+ export declare class Recipients extends APIResource {
8
+ /**
9
+ * Lists per-recipient delivery states for a single message with cursor pagination.
10
+ * Each recipient has an independent status, billable flag, and lifecycle
11
+ * timestamps. BCC recipient addresses are redacted (returned as null) to protect
12
+ * BCC privacy. Default page size is 25, maximum is 100.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const recipients =
17
+ * await client.emailMessages.recipients.list(
18
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
19
+ * );
20
+ * ```
21
+ */
22
+ list(emailID: string, query?: RecipientListParams | null | undefined, options?: RequestOptions): APIPromise<RecipientListResponse>;
23
+ /**
24
+ * Returns the current delivery state of a single recipient, including status,
25
+ * billable flag, SMTP detail, and lifecycle timestamps. BCC recipient addresses
26
+ * are redacted (returned as null).
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * const recipient =
31
+ * await client.emailMessages.recipients.retrieve(
32
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
33
+ * { email_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
34
+ * );
35
+ * ```
36
+ */
37
+ retrieve(recipientID: string, params: RecipientRetrieveParams, options?: RequestOptions): APIPromise<RecipientRetrieveResponse>;
38
+ }
39
+ export interface EmailRecipient {
40
+ /**
41
+ * Recipient UUID.
42
+ */
43
+ id: string;
44
+ /**
45
+ * Recipient email address. Null for BCC recipients (redacted for privacy).
46
+ */
47
+ address: string | null;
48
+ /**
49
+ * Whether this recipient's delivery is billable (set on queue acceptance).
50
+ */
51
+ billable: boolean;
52
+ kind: 'to' | 'cc' | 'bcc';
53
+ /**
54
+ * Parent email message UUID.
55
+ */
56
+ message_id: string;
57
+ record_type: 'email_recipient';
58
+ /**
59
+ * Current per-recipient delivery status.
60
+ */
61
+ status: 'queued' | 'sending' | 'sent' | 'deferred' | 'delivered' | 'bounced' | 'failed' | 'gw_reject' | 'cancelled';
62
+ delivered_at?: string | null;
63
+ failed_at?: string | null;
64
+ sent_at?: string | null;
65
+ /**
66
+ * SMTP response code when available (e.g. 550 for bounces).
67
+ */
68
+ smtp_code?: number | null;
69
+ /**
70
+ * SMTP response message when available.
71
+ */
72
+ smtp_response?: string | null;
73
+ }
74
+ export interface RecipientRetrieveResponse {
75
+ data: EmailRecipient;
76
+ }
77
+ export interface RecipientListResponse {
78
+ data: Array<EmailRecipient>;
79
+ meta: RecipientListResponse.Meta;
80
+ }
81
+ export declare namespace RecipientListResponse {
82
+ interface Meta {
83
+ page_size: number;
84
+ /**
85
+ * Cursor for the next page. Absent when there are no more results.
86
+ */
87
+ page_cursor?: string | null;
88
+ }
89
+ }
90
+ export interface RecipientListParams {
91
+ /**
92
+ * Filter recipients by address kind.
93
+ */
94
+ kind?: 'to' | 'cc' | 'bcc';
95
+ /**
96
+ * Opaque URL-safe Base64 cursor returned by a previous list response.
97
+ */
98
+ page_cursor?: string;
99
+ /**
100
+ * Number of results to return. Defaults to 25; maximum is 100. Invalid values are
101
+ * clamped to the valid range.
102
+ */
103
+ page_size?: number;
104
+ /**
105
+ * Filter recipients by status.
106
+ */
107
+ status?: 'queued' | 'sending' | 'sent' | 'deferred' | 'delivered' | 'bounced' | 'failed' | 'gw_reject' | 'cancelled';
108
+ }
109
+ export interface RecipientRetrieveParams {
110
+ /**
111
+ * Email message UUID.
112
+ */
113
+ email_id: string;
114
+ }
115
+ export declare namespace Recipients {
116
+ export { type EmailRecipient as EmailRecipient, type RecipientRetrieveResponse as RecipientRetrieveResponse, type RecipientListResponse as RecipientListResponse, type RecipientListParams as RecipientListParams, type RecipientRetrieveParams as RecipientRetrieveParams, };
117
+ }
118
+ //# sourceMappingURL=recipients.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"recipients.d.mts","sourceRoot":"","sources":["../../src/resources/email-messages/recipients.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,iBAAiB,CAAC;IAE/B;;OAEG;IACH,MAAM,EACF,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,WAAW,GACX,SAAS,GACT,QAAQ,GACR,WAAW,GACX,WAAW,CAAC;IAEhB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE5B,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EACH,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,WAAW,GACX,SAAS,GACT,QAAQ,GACR,WAAW,GACX,WAAW,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,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"}
@@ -0,0 +1,118 @@
1
+ import { APIResource } from "../../core/resource.js";
2
+ import { APIPromise } from "../../core/api-promise.js";
3
+ import { RequestOptions } from "../../internal/request-options.js";
4
+ /**
5
+ * Send and manage email messages. Legacy `/v2/emails` routes are aliases for these endpoints.
6
+ */
7
+ export declare class Recipients extends APIResource {
8
+ /**
9
+ * Lists per-recipient delivery states for a single message with cursor pagination.
10
+ * Each recipient has an independent status, billable flag, and lifecycle
11
+ * timestamps. BCC recipient addresses are redacted (returned as null) to protect
12
+ * BCC privacy. Default page size is 25, maximum is 100.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const recipients =
17
+ * await client.emailMessages.recipients.list(
18
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
19
+ * );
20
+ * ```
21
+ */
22
+ list(emailID: string, query?: RecipientListParams | null | undefined, options?: RequestOptions): APIPromise<RecipientListResponse>;
23
+ /**
24
+ * Returns the current delivery state of a single recipient, including status,
25
+ * billable flag, SMTP detail, and lifecycle timestamps. BCC recipient addresses
26
+ * are redacted (returned as null).
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * const recipient =
31
+ * await client.emailMessages.recipients.retrieve(
32
+ * '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
33
+ * { email_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
34
+ * );
35
+ * ```
36
+ */
37
+ retrieve(recipientID: string, params: RecipientRetrieveParams, options?: RequestOptions): APIPromise<RecipientRetrieveResponse>;
38
+ }
39
+ export interface EmailRecipient {
40
+ /**
41
+ * Recipient UUID.
42
+ */
43
+ id: string;
44
+ /**
45
+ * Recipient email address. Null for BCC recipients (redacted for privacy).
46
+ */
47
+ address: string | null;
48
+ /**
49
+ * Whether this recipient's delivery is billable (set on queue acceptance).
50
+ */
51
+ billable: boolean;
52
+ kind: 'to' | 'cc' | 'bcc';
53
+ /**
54
+ * Parent email message UUID.
55
+ */
56
+ message_id: string;
57
+ record_type: 'email_recipient';
58
+ /**
59
+ * Current per-recipient delivery status.
60
+ */
61
+ status: 'queued' | 'sending' | 'sent' | 'deferred' | 'delivered' | 'bounced' | 'failed' | 'gw_reject' | 'cancelled';
62
+ delivered_at?: string | null;
63
+ failed_at?: string | null;
64
+ sent_at?: string | null;
65
+ /**
66
+ * SMTP response code when available (e.g. 550 for bounces).
67
+ */
68
+ smtp_code?: number | null;
69
+ /**
70
+ * SMTP response message when available.
71
+ */
72
+ smtp_response?: string | null;
73
+ }
74
+ export interface RecipientRetrieveResponse {
75
+ data: EmailRecipient;
76
+ }
77
+ export interface RecipientListResponse {
78
+ data: Array<EmailRecipient>;
79
+ meta: RecipientListResponse.Meta;
80
+ }
81
+ export declare namespace RecipientListResponse {
82
+ interface Meta {
83
+ page_size: number;
84
+ /**
85
+ * Cursor for the next page. Absent when there are no more results.
86
+ */
87
+ page_cursor?: string | null;
88
+ }
89
+ }
90
+ export interface RecipientListParams {
91
+ /**
92
+ * Filter recipients by address kind.
93
+ */
94
+ kind?: 'to' | 'cc' | 'bcc';
95
+ /**
96
+ * Opaque URL-safe Base64 cursor returned by a previous list response.
97
+ */
98
+ page_cursor?: string;
99
+ /**
100
+ * Number of results to return. Defaults to 25; maximum is 100. Invalid values are
101
+ * clamped to the valid range.
102
+ */
103
+ page_size?: number;
104
+ /**
105
+ * Filter recipients by status.
106
+ */
107
+ status?: 'queued' | 'sending' | 'sent' | 'deferred' | 'delivered' | 'bounced' | 'failed' | 'gw_reject' | 'cancelled';
108
+ }
109
+ export interface RecipientRetrieveParams {
110
+ /**
111
+ * Email message UUID.
112
+ */
113
+ email_id: string;
114
+ }
115
+ export declare namespace Recipients {
116
+ export { type EmailRecipient as EmailRecipient, type RecipientRetrieveResponse as RecipientRetrieveResponse, type RecipientListResponse as RecipientListResponse, type RecipientListParams as RecipientListParams, type RecipientRetrieveParams as RecipientRetrieveParams, };
117
+ }
118
+ //# sourceMappingURL=recipients.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"recipients.d.ts","sourceRoot":"","sources":["../../src/resources/email-messages/recipients.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAIzC;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,iBAAiB,CAAC;IAE/B;;OAEG;IACH,MAAM,EACF,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,WAAW,GACX,SAAS,GACT,QAAQ,GACR,WAAW,GACX,WAAW,CAAC;IAEhB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE5B,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EACH,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,WAAW,GACX,SAAS,GACT,QAAQ,GACR,WAAW,GACX,WAAW,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,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"}