@zavudev/sdk 0.57.0 → 0.58.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 (756) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/README.md +3 -3
  3. package/client.d.mts +39 -36
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +39 -36
  6. package/client.d.ts.map +1 -1
  7. package/client.js +43 -40
  8. package/client.js.map +1 -1
  9. package/client.mjs +43 -40
  10. package/client.mjs.map +1 -1
  11. package/core/api-promise.d.mts.map +1 -1
  12. package/core/api-promise.d.ts.map +1 -1
  13. package/core/api-promise.js +0 -1
  14. package/core/api-promise.js.map +1 -1
  15. package/core/api-promise.mjs +0 -1
  16. package/core/api-promise.mjs.map +1 -1
  17. package/core/error.d.mts.map +1 -1
  18. package/core/error.d.ts.map +1 -1
  19. package/core/error.js +0 -1
  20. package/core/error.js.map +1 -1
  21. package/core/error.mjs +0 -1
  22. package/core/error.mjs.map +1 -1
  23. package/core/pagination.d.mts.map +1 -1
  24. package/core/pagination.d.ts.map +1 -1
  25. package/core/pagination.js +0 -1
  26. package/core/pagination.js.map +1 -1
  27. package/core/pagination.mjs +0 -1
  28. package/core/pagination.mjs.map +1 -1
  29. package/core/resource.d.mts.map +1 -1
  30. package/core/resource.d.ts.map +1 -1
  31. package/core/resource.js +0 -1
  32. package/core/resource.js.map +1 -1
  33. package/core/resource.mjs +0 -1
  34. package/core/resource.mjs.map +1 -1
  35. package/index.d.mts.map +1 -1
  36. package/index.d.ts.map +1 -1
  37. package/index.js +0 -1
  38. package/index.js.map +1 -1
  39. package/index.mjs +0 -1
  40. package/index.mjs.map +1 -1
  41. package/internal/builtin-types.d.mts.map +1 -1
  42. package/internal/builtin-types.d.ts.map +1 -1
  43. package/internal/builtin-types.js +0 -1
  44. package/internal/builtin-types.js.map +1 -1
  45. package/internal/builtin-types.mjs +0 -1
  46. package/internal/builtin-types.mjs.map +1 -1
  47. package/internal/detect-platform.d.mts.map +1 -1
  48. package/internal/detect-platform.d.ts.map +1 -1
  49. package/internal/detect-platform.js +0 -1
  50. package/internal/detect-platform.js.map +1 -1
  51. package/internal/detect-platform.mjs +0 -1
  52. package/internal/detect-platform.mjs.map +1 -1
  53. package/internal/errors.d.mts.map +1 -1
  54. package/internal/errors.d.ts.map +1 -1
  55. package/internal/errors.js +0 -1
  56. package/internal/errors.js.map +1 -1
  57. package/internal/errors.mjs +0 -1
  58. package/internal/errors.mjs.map +1 -1
  59. package/internal/headers.d.mts.map +1 -1
  60. package/internal/headers.d.ts.map +1 -1
  61. package/internal/headers.js +0 -1
  62. package/internal/headers.js.map +1 -1
  63. package/internal/headers.mjs +0 -1
  64. package/internal/headers.mjs.map +1 -1
  65. package/internal/parse.d.mts.map +1 -1
  66. package/internal/parse.d.ts.map +1 -1
  67. package/internal/parse.js +0 -1
  68. package/internal/parse.js.map +1 -1
  69. package/internal/parse.mjs +0 -1
  70. package/internal/parse.mjs.map +1 -1
  71. package/internal/request-options.d.mts.map +1 -1
  72. package/internal/request-options.d.ts.map +1 -1
  73. package/internal/request-options.js +0 -1
  74. package/internal/request-options.js.map +1 -1
  75. package/internal/request-options.mjs +0 -1
  76. package/internal/request-options.mjs.map +1 -1
  77. package/internal/shim-types.d.mts.map +1 -1
  78. package/internal/shim-types.d.ts.map +1 -1
  79. package/internal/shim-types.js +6 -1
  80. package/internal/shim-types.js.map +1 -1
  81. package/internal/shim-types.mjs +6 -1
  82. package/internal/shim-types.mjs.map +1 -1
  83. package/internal/shims.d.mts.map +1 -1
  84. package/internal/shims.d.ts.map +1 -1
  85. package/internal/shims.js +6 -1
  86. package/internal/shims.js.map +1 -1
  87. package/internal/shims.mjs +6 -1
  88. package/internal/shims.mjs.map +1 -1
  89. package/internal/types.d.mts.map +1 -1
  90. package/internal/types.d.ts.map +1 -1
  91. package/internal/types.js +0 -1
  92. package/internal/types.js.map +1 -1
  93. package/internal/types.mjs +0 -1
  94. package/internal/types.mjs.map +1 -1
  95. package/internal/utils/base64.d.mts.map +1 -1
  96. package/internal/utils/base64.d.ts.map +1 -1
  97. package/internal/utils/base64.js +0 -1
  98. package/internal/utils/base64.js.map +1 -1
  99. package/internal/utils/base64.mjs +0 -1
  100. package/internal/utils/base64.mjs.map +1 -1
  101. package/internal/utils/env.d.mts.map +1 -1
  102. package/internal/utils/env.d.ts.map +1 -1
  103. package/internal/utils/env.js +0 -1
  104. package/internal/utils/env.js.map +1 -1
  105. package/internal/utils/env.mjs +0 -1
  106. package/internal/utils/env.mjs.map +1 -1
  107. package/internal/utils/log.d.mts.map +1 -1
  108. package/internal/utils/log.d.ts.map +1 -1
  109. package/internal/utils/log.js +0 -1
  110. package/internal/utils/log.js.map +1 -1
  111. package/internal/utils/log.mjs +0 -1
  112. package/internal/utils/log.mjs.map +1 -1
  113. package/internal/utils/query.d.mts.map +1 -1
  114. package/internal/utils/query.d.ts.map +1 -1
  115. package/internal/utils/query.js +1 -2
  116. package/internal/utils/query.js.map +1 -1
  117. package/internal/utils/query.mjs +1 -2
  118. package/internal/utils/query.mjs.map +1 -1
  119. package/internal/utils/sleep.d.mts.map +1 -1
  120. package/internal/utils/sleep.d.ts.map +1 -1
  121. package/internal/utils/sleep.js +0 -1
  122. package/internal/utils/sleep.js.map +1 -1
  123. package/internal/utils/sleep.mjs +0 -1
  124. package/internal/utils/sleep.mjs.map +1 -1
  125. package/internal/utils/uuid.d.mts.map +1 -1
  126. package/internal/utils/uuid.d.ts.map +1 -1
  127. package/internal/utils/uuid.js +0 -1
  128. package/internal/utils/uuid.js.map +1 -1
  129. package/internal/utils/uuid.mjs +0 -1
  130. package/internal/utils/uuid.mjs.map +1 -1
  131. package/internal/utils/values.d.mts.map +1 -1
  132. package/internal/utils/values.d.ts.map +1 -1
  133. package/internal/utils/values.js +0 -1
  134. package/internal/utils/values.js.map +1 -1
  135. package/internal/utils/values.mjs +0 -1
  136. package/internal/utils/values.mjs.map +1 -1
  137. package/internal/utils.d.mts.map +1 -1
  138. package/internal/utils.d.ts.map +1 -1
  139. package/internal/utils.js +0 -1
  140. package/internal/utils.js.map +1 -1
  141. package/internal/utils.mjs +0 -1
  142. package/internal/utils.mjs.map +1 -1
  143. package/package.json +29 -10
  144. package/resources/addresses.d.mts +27 -77
  145. package/resources/addresses.d.mts.map +1 -1
  146. package/resources/addresses.d.ts +27 -77
  147. package/resources/addresses.d.ts.map +1 -1
  148. package/resources/addresses.js +19 -32
  149. package/resources/addresses.js.map +1 -1
  150. package/resources/addresses.mjs +19 -32
  151. package/resources/addresses.mjs.map +1 -1
  152. package/resources/agent-templates.d.mts +17 -71
  153. package/resources/agent-templates.d.mts.map +1 -1
  154. package/resources/agent-templates.d.ts +17 -71
  155. package/resources/agent-templates.d.ts.map +1 -1
  156. package/resources/agent-templates.js +11 -15
  157. package/resources/agent-templates.js.map +1 -1
  158. package/resources/agent-templates.mjs +11 -15
  159. package/resources/agent-templates.mjs.map +1 -1
  160. package/resources/agents/agents.d.mts +53 -395
  161. package/resources/agents/agents.d.mts.map +1 -1
  162. package/resources/agents/agents.d.ts +53 -395
  163. package/resources/agents/agents.d.ts.map +1 -1
  164. package/resources/agents/agents.js +33 -48
  165. package/resources/agents/agents.js.map +1 -1
  166. package/resources/agents/agents.mjs +33 -48
  167. package/resources/agents/agents.mjs.map +1 -1
  168. package/resources/agents/index.js +1 -1
  169. package/resources/agents/index.js.map +1 -1
  170. package/resources/agents/index.mjs +1 -1
  171. package/resources/agents/index.mjs.map +1 -1
  172. package/resources/agents/senders.d.mts +10 -32
  173. package/resources/agents/senders.d.mts.map +1 -1
  174. package/resources/agents/senders.d.ts +10 -32
  175. package/resources/agents/senders.d.ts.map +1 -1
  176. package/resources/agents/senders.js +7 -14
  177. package/resources/agents/senders.js.map +1 -1
  178. package/resources/agents/senders.mjs +7 -14
  179. package/resources/agents/senders.mjs.map +1 -1
  180. package/resources/agents.js +1 -1
  181. package/resources/agents.js.map +1 -1
  182. package/resources/agents.mjs +1 -1
  183. package/resources/agents.mjs.map +1 -1
  184. package/resources/balance.d.mts +6 -19
  185. package/resources/balance.d.mts.map +1 -1
  186. package/resources/balance.d.ts +6 -19
  187. package/resources/balance.d.ts.map +1 -1
  188. package/resources/balance.js +5 -1
  189. package/resources/balance.js.map +1 -1
  190. package/resources/balance.mjs +5 -1
  191. package/resources/balance.mjs.map +1 -1
  192. package/resources/broadcasts/broadcasts.d.mts +87 -413
  193. package/resources/broadcasts/broadcasts.d.mts.map +1 -1
  194. package/resources/broadcasts/broadcasts.d.ts +87 -413
  195. package/resources/broadcasts/broadcasts.d.ts.map +1 -1
  196. package/resources/broadcasts/broadcasts.js +59 -87
  197. package/resources/broadcasts/broadcasts.js.map +1 -1
  198. package/resources/broadcasts/broadcasts.mjs +59 -87
  199. package/resources/broadcasts/broadcasts.mjs.map +1 -1
  200. package/resources/broadcasts/contacts.d.mts +19 -109
  201. package/resources/broadcasts/contacts.d.mts.map +1 -1
  202. package/resources/broadcasts/contacts.d.ts +19 -109
  203. package/resources/broadcasts/contacts.d.ts.map +1 -1
  204. package/resources/broadcasts/contacts.js +10 -40
  205. package/resources/broadcasts/contacts.js.map +1 -1
  206. package/resources/broadcasts/contacts.mjs +10 -40
  207. package/resources/broadcasts/contacts.mjs.map +1 -1
  208. package/resources/broadcasts/index.js +1 -1
  209. package/resources/broadcasts/index.js.map +1 -1
  210. package/resources/broadcasts/index.mjs +1 -1
  211. package/resources/broadcasts/index.mjs.map +1 -1
  212. package/resources/broadcasts.js +1 -1
  213. package/resources/broadcasts.js.map +1 -1
  214. package/resources/broadcasts.mjs +1 -1
  215. package/resources/broadcasts.mjs.map +1 -1
  216. package/resources/calls.d.mts +40 -484
  217. package/resources/calls.d.mts.map +1 -1
  218. package/resources/calls.d.ts +40 -484
  219. package/resources/calls.d.ts.map +1 -1
  220. package/resources/calls.js +25 -35
  221. package/resources/calls.js.map +1 -1
  222. package/resources/calls.mjs +25 -35
  223. package/resources/calls.mjs.map +1 -1
  224. package/resources/contacts/channels.d.mts +20 -98
  225. package/resources/contacts/channels.d.mts.map +1 -1
  226. package/resources/contacts/channels.d.ts +20 -98
  227. package/resources/contacts/channels.d.ts.map +1 -1
  228. package/resources/contacts/channels.js +13 -32
  229. package/resources/contacts/channels.js.map +1 -1
  230. package/resources/contacts/channels.mjs +13 -32
  231. package/resources/contacts/channels.mjs.map +1 -1
  232. package/resources/contacts/contacts.d.mts +33 -244
  233. package/resources/contacts/contacts.d.mts.map +1 -1
  234. package/resources/contacts/contacts.d.ts +33 -244
  235. package/resources/contacts/contacts.d.ts.map +1 -1
  236. package/resources/contacts/contacts.js +21 -52
  237. package/resources/contacts/contacts.js.map +1 -1
  238. package/resources/contacts/contacts.mjs +21 -52
  239. package/resources/contacts/contacts.mjs.map +1 -1
  240. package/resources/contacts/index.js +1 -1
  241. package/resources/contacts/index.js.map +1 -1
  242. package/resources/contacts/index.mjs +1 -1
  243. package/resources/contacts/index.mjs.map +1 -1
  244. package/resources/contacts.js +1 -1
  245. package/resources/contacts.js.map +1 -1
  246. package/resources/contacts.mjs +1 -1
  247. package/resources/contacts.mjs.map +1 -1
  248. package/resources/conversations.d.mts +32 -316
  249. package/resources/conversations.d.mts.map +1 -1
  250. package/resources/conversations.d.ts +32 -316
  251. package/resources/conversations.d.ts.map +1 -1
  252. package/resources/conversations.js +15 -1
  253. package/resources/conversations.js.map +1 -1
  254. package/resources/conversations.mjs +15 -1
  255. package/resources/conversations.mjs.map +1 -1
  256. package/resources/email-domains.d.mts +25 -208
  257. package/resources/email-domains.d.mts.map +1 -1
  258. package/resources/email-domains.d.ts +25 -208
  259. package/resources/email-domains.d.ts.map +1 -1
  260. package/resources/email-domains.js +12 -27
  261. package/resources/email-domains.js.map +1 -1
  262. package/resources/email-domains.mjs +12 -27
  263. package/resources/email-domains.mjs.map +1 -1
  264. package/resources/functions/functions.d.mts +67 -553
  265. package/resources/functions/functions.d.mts.map +1 -1
  266. package/resources/functions/functions.d.ts +67 -553
  267. package/resources/functions/functions.d.ts.map +1 -1
  268. package/resources/functions/functions.js +39 -82
  269. package/resources/functions/functions.js.map +1 -1
  270. package/resources/functions/functions.mjs +39 -82
  271. package/resources/functions/functions.mjs.map +1 -1
  272. package/resources/functions/git-link.d.mts +25 -240
  273. package/resources/functions/git-link.d.mts.map +1 -1
  274. package/resources/functions/git-link.d.ts +25 -240
  275. package/resources/functions/git-link.d.ts.map +1 -1
  276. package/resources/functions/git-link.js +16 -34
  277. package/resources/functions/git-link.js.map +1 -1
  278. package/resources/functions/git-link.mjs +16 -34
  279. package/resources/functions/git-link.mjs.map +1 -1
  280. package/resources/functions/index.js +1 -1
  281. package/resources/functions/index.js.map +1 -1
  282. package/resources/functions/index.mjs +1 -1
  283. package/resources/functions/index.mjs.map +1 -1
  284. package/resources/functions/secrets.d.mts +15 -47
  285. package/resources/functions/secrets.d.mts.map +1 -1
  286. package/resources/functions/secrets.d.ts +15 -47
  287. package/resources/functions/secrets.d.ts.map +1 -1
  288. package/resources/functions/secrets.js +11 -21
  289. package/resources/functions/secrets.js.map +1 -1
  290. package/resources/functions/secrets.mjs +11 -21
  291. package/resources/functions/secrets.mjs.map +1 -1
  292. package/resources/functions/triggers.d.mts +14 -123
  293. package/resources/functions/triggers.d.mts.map +1 -1
  294. package/resources/functions/triggers.d.ts +14 -123
  295. package/resources/functions/triggers.d.ts.map +1 -1
  296. package/resources/functions/triggers.js +7 -25
  297. package/resources/functions/triggers.js.map +1 -1
  298. package/resources/functions/triggers.mjs +7 -25
  299. package/resources/functions/triggers.mjs.map +1 -1
  300. package/resources/functions.js +1 -1
  301. package/resources/functions.js.map +1 -1
  302. package/resources/functions.mjs +1 -1
  303. package/resources/functions.mjs.map +1 -1
  304. package/resources/index.d.mts +1 -0
  305. package/resources/index.d.mts.map +1 -1
  306. package/resources/index.d.ts +1 -0
  307. package/resources/index.d.ts.map +1 -1
  308. package/resources/index.js +4 -2
  309. package/resources/index.js.map +1 -1
  310. package/resources/index.mjs +2 -1
  311. package/resources/index.mjs.map +1 -1
  312. package/resources/introspect.d.mts +15 -105
  313. package/resources/introspect.d.mts.map +1 -1
  314. package/resources/introspect.d.ts +15 -105
  315. package/resources/introspect.d.ts.map +1 -1
  316. package/resources/introspect.js +7 -13
  317. package/resources/introspect.js.map +1 -1
  318. package/resources/introspect.mjs +7 -13
  319. package/resources/introspect.mjs.map +1 -1
  320. package/resources/invitations/webhook.d.mts +57 -0
  321. package/resources/invitations/webhook.d.mts.map +1 -0
  322. package/resources/invitations/webhook.d.ts +57 -0
  323. package/resources/invitations/webhook.d.ts.map +1 -0
  324. package/resources/invitations/webhook.js +61 -0
  325. package/resources/invitations/webhook.js.map +1 -0
  326. package/resources/invitations/webhook.mjs +57 -0
  327. package/resources/invitations/webhook.mjs.map +1 -0
  328. package/resources/invitations.d.mts +27 -174
  329. package/resources/invitations.d.mts.map +1 -1
  330. package/resources/invitations.d.ts +27 -174
  331. package/resources/invitations.d.ts.map +1 -1
  332. package/resources/invitations.js +20 -30
  333. package/resources/invitations.js.map +1 -1
  334. package/resources/invitations.mjs +19 -30
  335. package/resources/invitations.mjs.map +1 -1
  336. package/resources/me.d.mts +9 -18
  337. package/resources/me.d.mts.map +1 -1
  338. package/resources/me.d.ts +9 -18
  339. package/resources/me.d.ts.map +1 -1
  340. package/resources/me.js +5 -1
  341. package/resources/me.js.map +1 -1
  342. package/resources/me.mjs +5 -1
  343. package/resources/me.mjs.map +1 -1
  344. package/resources/memory/collections/collections.d.mts +75 -0
  345. package/resources/memory/collections/collections.d.mts.map +1 -0
  346. package/resources/memory/collections/collections.d.ts +75 -0
  347. package/resources/memory/collections/collections.d.ts.map +1 -0
  348. package/resources/memory/collections/collections.js +79 -0
  349. package/resources/memory/collections/collections.js.map +1 -0
  350. package/resources/memory/collections/collections.mjs +74 -0
  351. package/resources/memory/collections/collections.mjs.map +1 -0
  352. package/resources/memory/collections/index.d.mts +3 -0
  353. package/resources/memory/collections/index.d.mts.map +1 -0
  354. package/resources/memory/collections/index.d.ts +3 -0
  355. package/resources/memory/collections/index.d.ts.map +1 -0
  356. package/resources/memory/collections/index.js +9 -0
  357. package/resources/memory/collections/index.js.map +1 -0
  358. package/resources/memory/collections/index.mjs +4 -0
  359. package/resources/memory/collections/index.mjs.map +1 -0
  360. package/resources/memory/collections/items.d.mts +88 -0
  361. package/resources/memory/collections/items.d.mts.map +1 -0
  362. package/resources/memory/collections/items.d.ts +88 -0
  363. package/resources/memory/collections/items.d.ts.map +1 -0
  364. package/resources/memory/collections/items.js +120 -0
  365. package/resources/memory/collections/items.js.map +1 -0
  366. package/resources/memory/collections/items.mjs +116 -0
  367. package/resources/memory/collections/items.mjs.map +1 -0
  368. package/resources/memory/collections.d.mts +2 -0
  369. package/resources/memory/collections.d.mts.map +1 -0
  370. package/resources/memory/collections.d.ts +2 -0
  371. package/resources/memory/collections.d.ts.map +1 -0
  372. package/resources/memory/collections.js +6 -0
  373. package/resources/memory/collections.js.map +1 -0
  374. package/resources/memory/collections.mjs +3 -0
  375. package/resources/memory/collections.mjs.map +1 -0
  376. package/resources/memory/index.d.mts +3 -0
  377. package/resources/memory/index.d.mts.map +1 -0
  378. package/resources/memory/index.d.ts +3 -0
  379. package/resources/memory/index.d.ts.map +1 -0
  380. package/resources/memory/index.js +9 -0
  381. package/resources/memory/index.js.map +1 -0
  382. package/resources/memory/index.mjs +4 -0
  383. package/resources/memory/index.mjs.map +1 -0
  384. package/resources/memory/memory.d.mts +111 -0
  385. package/resources/memory/memory.d.mts.map +1 -0
  386. package/resources/memory/memory.d.ts +111 -0
  387. package/resources/memory/memory.d.ts.map +1 -0
  388. package/resources/memory/memory.js +116 -0
  389. package/resources/memory/memory.js.map +1 -0
  390. package/resources/memory/memory.mjs +111 -0
  391. package/resources/memory/memory.mjs.map +1 -0
  392. package/resources/memory.d.mts +2 -0
  393. package/resources/memory.d.mts.map +1 -0
  394. package/resources/memory.d.ts +2 -0
  395. package/resources/memory.d.ts.map +1 -0
  396. package/resources/memory.js +6 -0
  397. package/resources/memory.js.map +1 -0
  398. package/resources/memory.mjs +3 -0
  399. package/resources/memory.mjs.map +1 -0
  400. package/resources/messages.d.mts +106 -583
  401. package/resources/messages.d.mts.map +1 -1
  402. package/resources/messages.d.ts +106 -583
  403. package/resources/messages.d.ts.map +1 -1
  404. package/resources/messages.js +85 -75
  405. package/resources/messages.js.map +1 -1
  406. package/resources/messages.mjs +85 -75
  407. package/resources/messages.mjs.map +1 -1
  408. package/resources/number-10dlc/brands.d.mts +34 -204
  409. package/resources/number-10dlc/brands.d.mts.map +1 -1
  410. package/resources/number-10dlc/brands.d.ts +34 -204
  411. package/resources/number-10dlc/brands.d.ts.map +1 -1
  412. package/resources/number-10dlc/brands.js +21 -59
  413. package/resources/number-10dlc/brands.js.map +1 -1
  414. package/resources/number-10dlc/brands.mjs +21 -59
  415. package/resources/number-10dlc/brands.mjs.map +1 -1
  416. package/resources/number-10dlc/campaigns/campaigns.d.mts +32 -176
  417. package/resources/number-10dlc/campaigns/campaigns.d.mts.map +1 -1
  418. package/resources/number-10dlc/campaigns/campaigns.d.ts +32 -176
  419. package/resources/number-10dlc/campaigns/campaigns.d.ts.map +1 -1
  420. package/resources/number-10dlc/campaigns/campaigns.js +19 -62
  421. package/resources/number-10dlc/campaigns/campaigns.js.map +1 -1
  422. package/resources/number-10dlc/campaigns/campaigns.mjs +19 -62
  423. package/resources/number-10dlc/campaigns/campaigns.mjs.map +1 -1
  424. package/resources/number-10dlc/campaigns/index.js +1 -1
  425. package/resources/number-10dlc/campaigns/index.js.map +1 -1
  426. package/resources/number-10dlc/campaigns/index.mjs +1 -1
  427. package/resources/number-10dlc/campaigns/index.mjs.map +1 -1
  428. package/resources/number-10dlc/campaigns/phone-numbers.d.mts +21 -56
  429. package/resources/number-10dlc/campaigns/phone-numbers.d.mts.map +1 -1
  430. package/resources/number-10dlc/campaigns/phone-numbers.d.ts +21 -56
  431. package/resources/number-10dlc/campaigns/phone-numbers.d.ts.map +1 -1
  432. package/resources/number-10dlc/campaigns/phone-numbers.js +15 -26
  433. package/resources/number-10dlc/campaigns/phone-numbers.js.map +1 -1
  434. package/resources/number-10dlc/campaigns/phone-numbers.mjs +15 -26
  435. package/resources/number-10dlc/campaigns/phone-numbers.mjs.map +1 -1
  436. package/resources/number-10dlc/campaigns.js +1 -1
  437. package/resources/number-10dlc/campaigns.js.map +1 -1
  438. package/resources/number-10dlc/campaigns.mjs +1 -1
  439. package/resources/number-10dlc/campaigns.mjs.map +1 -1
  440. package/resources/number-10dlc/index.js +1 -1
  441. package/resources/number-10dlc/index.js.map +1 -1
  442. package/resources/number-10dlc/index.mjs +1 -1
  443. package/resources/number-10dlc/index.mjs.map +1 -1
  444. package/resources/number-10dlc/number-10dlc.d.mts +3 -4
  445. package/resources/number-10dlc/number-10dlc.d.mts.map +1 -1
  446. package/resources/number-10dlc/number-10dlc.d.ts +3 -4
  447. package/resources/number-10dlc/number-10dlc.d.ts.map +1 -1
  448. package/resources/number-10dlc/number-10dlc.js +1 -5
  449. package/resources/number-10dlc/number-10dlc.js.map +1 -1
  450. package/resources/number-10dlc/number-10dlc.mjs +1 -5
  451. package/resources/number-10dlc/number-10dlc.mjs.map +1 -1
  452. package/resources/number-10dlc.js +1 -1
  453. package/resources/number-10dlc.js.map +1 -1
  454. package/resources/number-10dlc.mjs +1 -1
  455. package/resources/number-10dlc.mjs.map +1 -1
  456. package/resources/phone-numbers.d.mts +95 -239
  457. package/resources/phone-numbers.d.mts.map +1 -1
  458. package/resources/phone-numbers.d.ts +95 -239
  459. package/resources/phone-numbers.d.ts.map +1 -1
  460. package/resources/phone-numbers.js +74 -54
  461. package/resources/phone-numbers.js.map +1 -1
  462. package/resources/phone-numbers.mjs +74 -54
  463. package/resources/phone-numbers.mjs.map +1 -1
  464. package/resources/regulatory-documents.d.mts +24 -78
  465. package/resources/regulatory-documents.d.mts.map +1 -1
  466. package/resources/regulatory-documents.d.ts +24 -78
  467. package/resources/regulatory-documents.d.ts.map +1 -1
  468. package/resources/regulatory-documents.js +16 -33
  469. package/resources/regulatory-documents.js.map +1 -1
  470. package/resources/regulatory-documents.mjs +16 -33
  471. package/resources/regulatory-documents.mjs.map +1 -1
  472. package/resources/senders/agent/agent.d.mts +44 -496
  473. package/resources/senders/agent/agent.d.mts.map +1 -1
  474. package/resources/senders/agent/agent.d.ts +44 -496
  475. package/resources/senders/agent/agent.d.ts.map +1 -1
  476. package/resources/senders/agent/agent.js +24 -49
  477. package/resources/senders/agent/agent.js.map +1 -1
  478. package/resources/senders/agent/agent.mjs +24 -49
  479. package/resources/senders/agent/agent.mjs.map +1 -1
  480. package/resources/senders/agent/executions.d.mts +13 -33
  481. package/resources/senders/agent/executions.d.mts.map +1 -1
  482. package/resources/senders/agent/executions.d.ts +13 -33
  483. package/resources/senders/agent/executions.d.ts.map +1 -1
  484. package/resources/senders/agent/executions.js +7 -18
  485. package/resources/senders/agent/executions.js.map +1 -1
  486. package/resources/senders/agent/executions.mjs +7 -18
  487. package/resources/senders/agent/executions.mjs.map +1 -1
  488. package/resources/senders/agent/flows.d.mts +34 -188
  489. package/resources/senders/agent/flows.d.mts.map +1 -1
  490. package/resources/senders/agent/flows.d.ts +34 -188
  491. package/resources/senders/agent/flows.d.ts.map +1 -1
  492. package/resources/senders/agent/flows.js +19 -69
  493. package/resources/senders/agent/flows.js.map +1 -1
  494. package/resources/senders/agent/flows.mjs +19 -69
  495. package/resources/senders/agent/flows.mjs.map +1 -1
  496. package/resources/senders/agent/index.js +1 -1
  497. package/resources/senders/agent/index.js.map +1 -1
  498. package/resources/senders/agent/index.mjs +1 -1
  499. package/resources/senders/agent/index.mjs.map +1 -1
  500. package/resources/senders/agent/knowledge-bases/documents.d.mts +27 -105
  501. package/resources/senders/agent/knowledge-bases/documents.d.mts.map +1 -1
  502. package/resources/senders/agent/knowledge-bases/documents.d.ts +27 -105
  503. package/resources/senders/agent/knowledge-bases/documents.d.ts.map +1 -1
  504. package/resources/senders/agent/knowledge-bases/documents.js +16 -47
  505. package/resources/senders/agent/knowledge-bases/documents.js.map +1 -1
  506. package/resources/senders/agent/knowledge-bases/documents.mjs +16 -47
  507. package/resources/senders/agent/knowledge-bases/documents.mjs.map +1 -1
  508. package/resources/senders/agent/knowledge-bases/index.js +1 -1
  509. package/resources/senders/agent/knowledge-bases/index.js.map +1 -1
  510. package/resources/senders/agent/knowledge-bases/index.mjs +1 -1
  511. package/resources/senders/agent/knowledge-bases/index.mjs.map +1 -1
  512. package/resources/senders/agent/knowledge-bases/knowledge-bases.d.mts +32 -113
  513. package/resources/senders/agent/knowledge-bases/knowledge-bases.d.mts.map +1 -1
  514. package/resources/senders/agent/knowledge-bases/knowledge-bases.d.ts +32 -113
  515. package/resources/senders/agent/knowledge-bases/knowledge-bases.d.ts.map +1 -1
  516. package/resources/senders/agent/knowledge-bases/knowledge-bases.js +17 -46
  517. package/resources/senders/agent/knowledge-bases/knowledge-bases.js.map +1 -1
  518. package/resources/senders/agent/knowledge-bases/knowledge-bases.mjs +17 -46
  519. package/resources/senders/agent/knowledge-bases/knowledge-bases.mjs.map +1 -1
  520. package/resources/senders/agent/knowledge-bases.js +1 -1
  521. package/resources/senders/agent/knowledge-bases.js.map +1 -1
  522. package/resources/senders/agent/knowledge-bases.mjs +1 -1
  523. package/resources/senders/agent/knowledge-bases.mjs.map +1 -1
  524. package/resources/senders/agent/tools/index.js +1 -1
  525. package/resources/senders/agent/tools/index.js.map +1 -1
  526. package/resources/senders/agent/tools/index.mjs +1 -1
  527. package/resources/senders/agent/tools/index.mjs.map +1 -1
  528. package/resources/senders/agent/tools/tools.d.mts +47 -280
  529. package/resources/senders/agent/tools/tools.d.mts.map +1 -1
  530. package/resources/senders/agent/tools/tools.d.ts +47 -280
  531. package/resources/senders/agent/tools/tools.d.ts.map +1 -1
  532. package/resources/senders/agent/tools/tools.js +25 -75
  533. package/resources/senders/agent/tools/tools.js.map +1 -1
  534. package/resources/senders/agent/tools/tools.mjs +25 -75
  535. package/resources/senders/agent/tools/tools.mjs.map +1 -1
  536. package/resources/senders/agent/tools/webhook.d.mts +6 -12
  537. package/resources/senders/agent/tools/webhook.d.mts.map +1 -1
  538. package/resources/senders/agent/tools/webhook.d.ts +6 -12
  539. package/resources/senders/agent/tools/webhook.d.ts.map +1 -1
  540. package/resources/senders/agent/tools/webhook.js +4 -9
  541. package/resources/senders/agent/tools/webhook.js.map +1 -1
  542. package/resources/senders/agent/tools/webhook.mjs +4 -9
  543. package/resources/senders/agent/tools/webhook.mjs.map +1 -1
  544. package/resources/senders/agent/tools.js +1 -1
  545. package/resources/senders/agent/tools.js.map +1 -1
  546. package/resources/senders/agent/tools.mjs +1 -1
  547. package/resources/senders/agent/tools.mjs.map +1 -1
  548. package/resources/senders/agent.js +1 -1
  549. package/resources/senders/agent.js.map +1 -1
  550. package/resources/senders/agent.mjs +1 -1
  551. package/resources/senders/agent.mjs.map +1 -1
  552. package/resources/senders/channels.d.mts +61 -0
  553. package/resources/senders/channels.d.mts.map +1 -0
  554. package/resources/senders/channels.d.ts +61 -0
  555. package/resources/senders/channels.d.ts.map +1 -0
  556. package/resources/senders/channels.js +60 -0
  557. package/resources/senders/channels.js.map +1 -0
  558. package/resources/senders/channels.mjs +56 -0
  559. package/resources/senders/channels.mjs.map +1 -0
  560. package/resources/senders/index.d.mts +1 -0
  561. package/resources/senders/index.d.mts.map +1 -1
  562. package/resources/senders/index.d.ts +1 -0
  563. package/resources/senders/index.d.ts.map +1 -1
  564. package/resources/senders/index.js +4 -2
  565. package/resources/senders/index.js.map +1 -1
  566. package/resources/senders/index.mjs +2 -1
  567. package/resources/senders/index.mjs.map +1 -1
  568. package/resources/senders/senders.d.mts +53 -514
  569. package/resources/senders/senders.d.mts.map +1 -1
  570. package/resources/senders/senders.d.ts +53 -514
  571. package/resources/senders/senders.d.ts.map +1 -1
  572. package/resources/senders/senders.js +30 -70
  573. package/resources/senders/senders.js.map +1 -1
  574. package/resources/senders/senders.mjs +30 -70
  575. package/resources/senders/senders.mjs.map +1 -1
  576. package/resources/senders/telegram.d.mts +10 -25
  577. package/resources/senders/telegram.d.mts.map +1 -1
  578. package/resources/senders/telegram.d.ts +10 -25
  579. package/resources/senders/telegram.d.ts.map +1 -1
  580. package/resources/senders/telegram.js +7 -12
  581. package/resources/senders/telegram.js.map +1 -1
  582. package/resources/senders/telegram.mjs +7 -12
  583. package/resources/senders/telegram.mjs.map +1 -1
  584. package/resources/senders/whatsapp-sync.d.mts +16 -104
  585. package/resources/senders/whatsapp-sync.d.mts.map +1 -1
  586. package/resources/senders/whatsapp-sync.d.ts +16 -104
  587. package/resources/senders/whatsapp-sync.d.ts.map +1 -1
  588. package/resources/senders/whatsapp-sync.js +10 -20
  589. package/resources/senders/whatsapp-sync.js.map +1 -1
  590. package/resources/senders/whatsapp-sync.mjs +10 -20
  591. package/resources/senders/whatsapp-sync.mjs.map +1 -1
  592. package/resources/senders.js +1 -1
  593. package/resources/senders.js.map +1 -1
  594. package/resources/senders.mjs +1 -1
  595. package/resources/senders.mjs.map +1 -1
  596. package/resources/sub-accounts/api-keys.d.mts +16 -57
  597. package/resources/sub-accounts/api-keys.d.mts.map +1 -1
  598. package/resources/sub-accounts/api-keys.d.ts +16 -57
  599. package/resources/sub-accounts/api-keys.d.ts.map +1 -1
  600. package/resources/sub-accounts/api-keys.js +10 -18
  601. package/resources/sub-accounts/api-keys.js.map +1 -1
  602. package/resources/sub-accounts/api-keys.mjs +10 -18
  603. package/resources/sub-accounts/api-keys.mjs.map +1 -1
  604. package/resources/sub-accounts/index.js +1 -1
  605. package/resources/sub-accounts/index.js.map +1 -1
  606. package/resources/sub-accounts/index.mjs +1 -1
  607. package/resources/sub-accounts/index.mjs.map +1 -1
  608. package/resources/sub-accounts/sub-accounts.d.mts +33 -125
  609. package/resources/sub-accounts/sub-accounts.d.mts.map +1 -1
  610. package/resources/sub-accounts/sub-accounts.d.ts +33 -125
  611. package/resources/sub-accounts/sub-accounts.d.ts.map +1 -1
  612. package/resources/sub-accounts/sub-accounts.js +20 -33
  613. package/resources/sub-accounts/sub-accounts.js.map +1 -1
  614. package/resources/sub-accounts/sub-accounts.mjs +20 -33
  615. package/resources/sub-accounts/sub-accounts.mjs.map +1 -1
  616. package/resources/sub-accounts.js +1 -1
  617. package/resources/sub-accounts.js.map +1 -1
  618. package/resources/sub-accounts.mjs +1 -1
  619. package/resources/sub-accounts.mjs.map +1 -1
  620. package/resources/templates.d.mts +46 -302
  621. package/resources/templates.d.mts.map +1 -1
  622. package/resources/templates.d.ts +46 -302
  623. package/resources/templates.d.ts.map +1 -1
  624. package/resources/templates.js +34 -51
  625. package/resources/templates.js.map +1 -1
  626. package/resources/templates.mjs +34 -51
  627. package/resources/templates.mjs.map +1 -1
  628. package/resources/urls.d.mts +27 -78
  629. package/resources/urls.d.mts.map +1 -1
  630. package/resources/urls.d.ts +27 -78
  631. package/resources/urls.d.ts.map +1 -1
  632. package/resources/urls.js +18 -28
  633. package/resources/urls.js.map +1 -1
  634. package/resources/urls.mjs +18 -28
  635. package/resources/urls.mjs.map +1 -1
  636. package/resources.d.mts.map +1 -1
  637. package/resources.d.ts.map +1 -1
  638. package/resources.js +1 -0
  639. package/resources.js.map +1 -1
  640. package/resources.mjs +1 -0
  641. package/resources.mjs.map +1 -1
  642. package/src/client.ts +273 -230
  643. package/src/core/api-promise.ts +0 -2
  644. package/src/core/error.ts +0 -2
  645. package/src/core/pagination.ts +0 -2
  646. package/src/core/resource.ts +0 -2
  647. package/src/index.ts +0 -2
  648. package/src/internal/builtin-types.ts +0 -2
  649. package/src/internal/detect-platform.ts +0 -2
  650. package/src/internal/errors.ts +0 -2
  651. package/src/internal/headers.ts +0 -2
  652. package/src/internal/parse.ts +0 -2
  653. package/src/internal/request-options.ts +0 -2
  654. package/src/internal/shim-types.ts +0 -2
  655. package/src/internal/shims.ts +0 -2
  656. package/src/internal/types.ts +0 -2
  657. package/src/internal/utils/base64.ts +0 -2
  658. package/src/internal/utils/env.ts +0 -2
  659. package/src/internal/utils/log.ts +0 -2
  660. package/src/internal/utils/query.ts +1 -3
  661. package/src/internal/utils/sleep.ts +0 -2
  662. package/src/internal/utils/uuid.ts +0 -2
  663. package/src/internal/utils/values.ts +0 -2
  664. package/src/internal/utils.ts +0 -2
  665. package/src/resources/addresses.ts +28 -97
  666. package/src/resources/agent-templates.ts +18 -89
  667. package/src/resources/agents/agents.ts +58 -472
  668. package/src/resources/agents/index.ts +1 -1
  669. package/src/resources/agents/senders.ts +11 -33
  670. package/src/resources/agents.ts +1 -1
  671. package/src/resources/balance.ts +7 -24
  672. package/src/resources/broadcasts/broadcasts.ts +92 -492
  673. package/src/resources/broadcasts/contacts.ts +20 -114
  674. package/src/resources/broadcasts/index.ts +1 -1
  675. package/src/resources/broadcasts.ts +1 -1
  676. package/src/resources/calls.ts +41 -560
  677. package/src/resources/contacts/channels.ts +21 -104
  678. package/src/resources/contacts/contacts.ts +42 -289
  679. package/src/resources/contacts/index.ts +1 -1
  680. package/src/resources/contacts.ts +1 -1
  681. package/src/resources/conversations.ts +33 -387
  682. package/src/resources/email-domains.ts +26 -253
  683. package/src/resources/functions/functions.ts +83 -669
  684. package/src/resources/functions/git-link.ts +26 -301
  685. package/src/resources/functions/index.ts +1 -1
  686. package/src/resources/functions/secrets.ts +16 -55
  687. package/src/resources/functions/triggers.ts +15 -149
  688. package/src/resources/functions.ts +1 -1
  689. package/src/resources/index.ts +21 -1
  690. package/src/resources/introspect.ts +16 -136
  691. package/src/resources/invitations/webhook.ts +93 -0
  692. package/src/resources/invitations.ts +45 -201
  693. package/src/resources/me.ts +10 -28
  694. package/src/resources/memory/collections/collections.ts +149 -0
  695. package/src/resources/memory/collections/index.ts +30 -0
  696. package/src/resources/memory/collections/items.ts +185 -0
  697. package/src/resources/memory/collections.ts +3 -0
  698. package/src/resources/memory/index.ts +34 -0
  699. package/src/resources/memory/memory.ts +211 -0
  700. package/src/resources/memory.ts +3 -0
  701. package/src/resources/messages.ts +106 -701
  702. package/src/resources/number-10dlc/brands.ts +35 -263
  703. package/src/resources/number-10dlc/campaigns/campaigns.ts +39 -239
  704. package/src/resources/number-10dlc/campaigns/index.ts +1 -1
  705. package/src/resources/number-10dlc/campaigns/phone-numbers.ts +31 -64
  706. package/src/resources/number-10dlc/campaigns.ts +1 -1
  707. package/src/resources/number-10dlc/index.ts +1 -1
  708. package/src/resources/number-10dlc/number-10dlc.ts +23 -29
  709. package/src/resources/number-10dlc.ts +1 -1
  710. package/src/resources/phone-numbers.ts +96 -280
  711. package/src/resources/regulatory-documents.ts +25 -106
  712. package/src/resources/senders/agent/agent.ts +91 -662
  713. package/src/resources/senders/agent/executions.ts +14 -35
  714. package/src/resources/senders/agent/flows.ts +35 -213
  715. package/src/resources/senders/agent/index.ts +1 -1
  716. package/src/resources/senders/agent/knowledge-bases/documents.ts +28 -114
  717. package/src/resources/senders/agent/knowledge-bases/index.ts +1 -1
  718. package/src/resources/senders/agent/knowledge-bases/knowledge-bases.ts +42 -143
  719. package/src/resources/senders/agent/knowledge-bases.ts +1 -1
  720. package/src/resources/senders/agent/tools/index.ts +1 -1
  721. package/src/resources/senders/agent/tools/tools.ts +48 -318
  722. package/src/resources/senders/agent/tools/webhook.ts +7 -13
  723. package/src/resources/senders/agent/tools.ts +1 -1
  724. package/src/resources/senders/agent.ts +1 -1
  725. package/src/resources/senders/channels.ts +95 -0
  726. package/src/resources/senders/index.ts +11 -1
  727. package/src/resources/senders/senders.ts +86 -634
  728. package/src/resources/senders/telegram.ts +11 -29
  729. package/src/resources/senders/whatsapp-sync.ts +17 -115
  730. package/src/resources/senders.ts +1 -1
  731. package/src/resources/sub-accounts/api-keys.ts +17 -73
  732. package/src/resources/sub-accounts/index.ts +1 -1
  733. package/src/resources/sub-accounts/sub-accounts.ts +38 -147
  734. package/src/resources/sub-accounts.ts +1 -1
  735. package/src/resources/templates.ts +47 -358
  736. package/src/resources/urls.ts +28 -86
  737. package/src/resources.ts +2 -0
  738. package/src/types.ts +5464 -0
  739. package/src/version.ts +3 -1
  740. package/types.d.mts +4901 -0
  741. package/types.d.mts.map +1 -0
  742. package/types.d.ts +4901 -0
  743. package/types.d.ts.map +1 -0
  744. package/types.js +4 -0
  745. package/types.js.map +1 -0
  746. package/types.mjs +3 -0
  747. package/types.mjs.map +1 -0
  748. package/version.d.mts +1 -1
  749. package/version.d.mts.map +1 -1
  750. package/version.d.ts +1 -1
  751. package/version.d.ts.map +1 -1
  752. package/version.js +2 -1
  753. package/version.js.map +1 -1
  754. package/version.mjs +2 -1
  755. package/version.mjs.map +1 -1
  756. package/src/lib/.keep +0 -4
@@ -1,30 +1,24 @@
1
1
  "use strict";
2
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ // Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Broadcasts = void 0;
5
5
  const tslib_1 = require("../../internal/tslib.js");
6
6
  const resource_1 = require("../../core/resource.js");
7
- const ContactsAPI = tslib_1.__importStar(require("./contacts.js"));
8
- const contacts_1 = require("./contacts.js");
9
7
  const pagination_1 = require("../../core/pagination.js");
10
8
  const headers_1 = require("../../internal/headers.js");
11
9
  const path_1 = require("../../internal/utils/path.js");
10
+ const ContactsAPI = tslib_1.__importStar(require("./contacts.js"));
12
11
  class Broadcasts extends resource_1.APIResource {
13
12
  constructor() {
14
13
  super(...arguments);
15
14
  this.contacts = new ContactsAPI.Contacts(this._client);
16
15
  }
17
16
  /**
17
+ * Create broadcast
18
+ *
18
19
  * Create a new broadcast campaign. Add contacts after creation, then send.
19
20
  *
20
- * @example
21
- * ```ts
22
- * const broadcast = await client.broadcasts.create({
23
- * channel: 'sms',
24
- * name: 'Black Friday Sale',
25
- * text: 'Hi {{name}}, check out our Black Friday deals! Use code FRIDAY20 for 20% off.',
26
- * });
27
- * ```
21
+ * `POST /v1/broadcasts`
28
22
  */
29
23
  create(body, options) {
30
24
  return this._client.post('/v1/broadcasts', { body, ...options });
@@ -32,50 +26,37 @@ class Broadcasts extends resource_1.APIResource {
32
26
  /**
33
27
  * Get broadcast
34
28
  *
35
- * @example
36
- * ```ts
37
- * const broadcast = await client.broadcasts.retrieve(
38
- * 'broadcastId',
39
- * );
40
- * ```
29
+ * `GET /v1/broadcasts/{broadcastId}`
41
30
  */
42
31
  retrieve(broadcastID, options) {
43
32
  return this._client.get((0, path_1.path) `/v1/broadcasts/${broadcastID}`, options);
44
33
  }
45
34
  /**
35
+ * Update broadcast
36
+ *
46
37
  * Update a broadcast in draft status.
47
38
  *
48
- * @example
49
- * ```ts
50
- * const broadcast = await client.broadcasts.update(
51
- * 'broadcastId',
52
- * );
53
- * ```
39
+ * `PATCH /v1/broadcasts/{broadcastId}`
54
40
  */
55
41
  update(broadcastID, body, options) {
56
42
  return this._client.patch((0, path_1.path) `/v1/broadcasts/${broadcastID}`, { body, ...options });
57
43
  }
58
44
  /**
45
+ * List broadcasts
46
+ *
59
47
  * List broadcasts for this project.
60
48
  *
61
- * @example
62
- * ```ts
63
- * // Automatically fetches more pages as needed.
64
- * for await (const broadcast of client.broadcasts.list()) {
65
- * // ...
66
- * }
67
- * ```
49
+ * `GET /v1/broadcasts`
68
50
  */
69
51
  list(query = {}, options) {
70
52
  return this._client.getAPIList('/v1/broadcasts', (pagination_1.Cursor), { query, ...options });
71
53
  }
72
54
  /**
55
+ * Delete broadcast
56
+ *
73
57
  * Delete a broadcast in draft status.
74
58
  *
75
- * @example
76
- * ```ts
77
- * await client.broadcasts.delete('broadcastId');
78
- * ```
59
+ * `DELETE /v1/broadcasts/{broadcastId}`
79
60
  */
80
61
  delete(broadcastID, options) {
81
62
  return this._client.delete((0, path_1.path) `/v1/broadcasts/${broadcastID}`, {
@@ -84,90 +65,82 @@ class Broadcasts extends resource_1.APIResource {
84
65
  });
85
66
  }
86
67
  /**
68
+ * Cancel broadcast
69
+ *
87
70
  * Cancel a broadcast. Pending contacts will be skipped, but already queued
88
71
  * messages may still be delivered.
89
72
  *
90
- * @example
91
- * ```ts
92
- * const response = await client.broadcasts.cancel(
93
- * 'broadcastId',
94
- * );
95
- * ```
73
+ * A broadcast can be cancelled from `draft`, `pending_review`,
74
+ * `pending_admin_review`, `approved`, `rejected`, `escalated`, `scheduled` and
75
+ * `sending`. Any balance reserved for it is released. A review still running when
76
+ * it is cancelled cannot bring it back.
77
+ *
78
+ * `POST /v1/broadcasts/{broadcastId}/cancel`
96
79
  */
97
80
  cancel(broadcastID, options) {
98
81
  return this._client.post((0, path_1.path) `/v1/broadcasts/${broadcastID}/cancel`, options);
99
82
  }
100
83
  /**
84
+ * Escalate to manual review
85
+ *
101
86
  * Request manual review by the Zavu team for a rejected broadcast. Use this after
102
87
  * automated review rejection if you believe the content is legitimate.
103
88
  *
104
- * @example
105
- * ```ts
106
- * const response = await client.broadcasts.escalateReview(
107
- * 'broadcastId',
108
- * );
109
- * ```
89
+ * `POST /v1/broadcasts/{broadcastId}/escalate`
110
90
  */
111
91
  escalateReview(broadcastID, options) {
112
92
  return this._client.post((0, path_1.path) `/v1/broadcasts/${broadcastID}/escalate`, options);
113
93
  }
114
94
  /**
95
+ * Get broadcast progress
96
+ *
115
97
  * Get real-time progress of a broadcast including delivery counts and estimated
116
98
  * completion time.
117
99
  *
118
- * @example
119
- * ```ts
120
- * const broadcastProgress = await client.broadcasts.progress(
121
- * 'broadcastId',
122
- * );
123
- * ```
100
+ * `GET /v1/broadcasts/{broadcastId}/progress`
124
101
  */
125
102
  progress(broadcastID, options) {
126
103
  return this._client.get((0, path_1.path) `/v1/broadcasts/${broadcastID}/progress`, options);
127
104
  }
128
105
  /**
106
+ * Reschedule broadcast
107
+ *
129
108
  * Update the scheduled time for a broadcast. The broadcast must be in scheduled
130
109
  * status.
131
110
  *
132
- * @example
133
- * ```ts
134
- * const response = await client.broadcasts.reschedule(
135
- * 'broadcastId',
136
- * { scheduledAt: '2024-01-15T14:00:00Z' },
137
- * );
138
- * ```
111
+ * `PATCH /v1/broadcasts/{broadcastId}/schedule`
139
112
  */
140
113
  reschedule(broadcastID, body, options) {
141
114
  return this._client.patch((0, path_1.path) `/v1/broadcasts/${broadcastID}/schedule`, { body, ...options });
142
115
  }
143
116
  /**
117
+ * Retry broadcast review
118
+ *
144
119
  * Resubmit a rejected broadcast for AI review after editing content. Maximum 3
145
120
  * review attempts allowed per broadcast.
146
121
  *
147
- * @example
148
- * ```ts
149
- * const response = await client.broadcasts.retryReview(
150
- * 'broadcastId',
151
- * );
152
- * ```
122
+ * `POST /v1/broadcasts/{broadcastId}/retry-review`
153
123
  */
154
124
  retryReview(broadcastID, options) {
155
125
  return this._client.post((0, path_1.path) `/v1/broadcasts/${broadcastID}/retry-review`, options);
156
126
  }
157
127
  /**
128
+ * Send broadcast
129
+ *
158
130
  * Start sending the broadcast immediately or schedule for later.
159
131
  *
160
- * **The account must be past the unverified level to send, except on WhatsApp.**
161
- * An account that has verified nothing is refused with `403` and code
162
- * `kyc_required` on every channel other than `whatsapp`. Any one of these lifts
163
- * it: identity verification (KYC), a saved payment method, a settled deposit, or a
164
- * paid plan. Business verification (KYB) is not required to broadcast; it gates
165
- * 10DLC registration only. A `whatsapp` broadcast is exempt: it can only be built
166
- * on a template, and Meta vets the business and the content when it approves that
167
- * template, so an unapproved template is refused instead. `smart` is not exempt,
168
- * since it can route a contact to SMS or email. Drafts can be created, edited and
169
- * kept without any check. Every send path (dashboard, API and CLI) enforces the
170
- * same rule.
132
+ * **Sending a broadcast needs no account verification.** Identity and business
133
+ * verification raise daily ceilings; neither is a permission to broadcast, on any
134
+ * channel. What stands in front of a broadcast is the content review below, and it
135
+ * applies to every send path — dashboard, API and CLI. Drafts can be created,
136
+ * edited and kept freely.
137
+ *
138
+ * **Email broadcasts need a paid plan.** On Free, sending or scheduling a
139
+ * broadcast on the `email` channel is refused with `402` and code
140
+ * `paid_plan_required`; drafts can still be created and edited. A `smart`
141
+ * broadcast is not refused: its email recipients fail individually with
142
+ * `errorCode` `PAID_PLAN_REQUIRED` and the others are sent. Teams created before
143
+ * August 1, 2026 keep their earlier terms.
171
144
  *
172
145
  * **Daily ceilings apply per recipient.** Each message a broadcast sends counts
173
146
  * against the channel's daily ceiling (see `POST /v1/messages`). Once the ceiling
@@ -177,26 +150,25 @@ class Broadcasts extends resource_1.APIResource {
177
150
  * **Review depends on the channel, and cannot be bypassed.** A draft is submitted
178
151
  * to automated content review here; it does not go straight out. A WhatsApp
179
152
  * broadcast built on a Meta-approved template skips review (Meta already vetted
180
- * the content) and begins sending. An email broadcast sends as soon as the
181
- * automated review passes. Every other channel moves to `pending_admin_review` and
182
- * waits for a person. If the review rejects it, use PATCH to edit the content then
183
- * call POST /retry-review.
153
+ * the content) and begins sending. An email broadcast sends as soon as the review
154
+ * passes it, unless the review asks for a person. Every other channel moves to
155
+ * `pending_admin_review` and waits for a person. A broadcast the review refuses
156
+ * lands on `rejected`: use PATCH to edit the content then call POST /retry-review,
157
+ * or escalate it for a manual review.
158
+ *
159
+ * A broadcast is read once, on its own text, rather than per recipient. While an
160
+ * account's sending is suspended its recipients fail individually with `errorCode`
161
+ * `SENDING_SUSPENDED`; see `POST /v1/messages`.
184
162
  *
185
163
  * Calling this on a broadcast that is already `approved` or `scheduled` sends or
186
164
  * reschedules it directly, since it has already been reviewed. Reserves the
187
165
  * estimated cost from your balance.
188
166
  *
189
- * @example
190
- * ```ts
191
- * const response = await client.broadcasts.send(
192
- * 'broadcastId',
193
- * );
194
- * ```
167
+ * `POST /v1/broadcasts/{broadcastId}/send`
195
168
  */
196
169
  send(broadcastID, body = {}, options) {
197
170
  return this._client.post((0, path_1.path) `/v1/broadcasts/${broadcastID}/send`, { body, ...options });
198
171
  }
199
172
  }
200
173
  exports.Broadcasts = Broadcasts;
201
- Broadcasts.Contacts = contacts_1.Contacts;
202
174
  //# sourceMappingURL=broadcasts.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"broadcasts.js","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CAMoB;AAEpB,yDAA+E;AAC/E,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiN1E,CAAC;IA/MC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,WAAmB,EACnB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,mBAAiB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,EAAE,EAAE;YAC9D,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,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAC,WAAmB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CACR,WAAmB,EACnB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,WAAmB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,eAAe,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,IAAI,CACF,WAAmB,EACnB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AAlND,gCAkNC;AAqaD,UAAU,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
1
+ {"version":3,"file":"broadcasts.js","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":";AAAA,6FAA6F;;;;AAE7F,qDAAkD;AAElD,yDAA4D;AAC5D,uDAAsD;AAEtD,uDAAiD;AAEjD,mEAA0C;AAS1C,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuL1E,CAAC;IArLC;;;;;;OAMG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,WAAmB,EACnB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,mBAAiB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,EAAE,EAAE;YAC9D,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;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,WAAmB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,WAAmB,EACnB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,WAAmB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,eAAe,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,WAAmB,EACnB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AAxLD,gCAwLC"}
@@ -1,26 +1,20 @@
1
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
1
+ // Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
2
2
  import { APIResource } from "../../core/resource.mjs";
3
- import * as ContactsAPI from "./contacts.mjs";
4
- import { Contacts, } from "./contacts.mjs";
5
3
  import { Cursor } from "../../core/pagination.mjs";
6
4
  import { buildHeaders } from "../../internal/headers.mjs";
7
5
  import { path } from "../../internal/utils/path.mjs";
6
+ import * as ContactsAPI from "./contacts.mjs";
8
7
  export class Broadcasts extends APIResource {
9
8
  constructor() {
10
9
  super(...arguments);
11
10
  this.contacts = new ContactsAPI.Contacts(this._client);
12
11
  }
13
12
  /**
13
+ * Create broadcast
14
+ *
14
15
  * Create a new broadcast campaign. Add contacts after creation, then send.
15
16
  *
16
- * @example
17
- * ```ts
18
- * const broadcast = await client.broadcasts.create({
19
- * channel: 'sms',
20
- * name: 'Black Friday Sale',
21
- * text: 'Hi {{name}}, check out our Black Friday deals! Use code FRIDAY20 for 20% off.',
22
- * });
23
- * ```
17
+ * `POST /v1/broadcasts`
24
18
  */
25
19
  create(body, options) {
26
20
  return this._client.post('/v1/broadcasts', { body, ...options });
@@ -28,50 +22,37 @@ export class Broadcasts extends APIResource {
28
22
  /**
29
23
  * Get broadcast
30
24
  *
31
- * @example
32
- * ```ts
33
- * const broadcast = await client.broadcasts.retrieve(
34
- * 'broadcastId',
35
- * );
36
- * ```
25
+ * `GET /v1/broadcasts/{broadcastId}`
37
26
  */
38
27
  retrieve(broadcastID, options) {
39
28
  return this._client.get(path `/v1/broadcasts/${broadcastID}`, options);
40
29
  }
41
30
  /**
31
+ * Update broadcast
32
+ *
42
33
  * Update a broadcast in draft status.
43
34
  *
44
- * @example
45
- * ```ts
46
- * const broadcast = await client.broadcasts.update(
47
- * 'broadcastId',
48
- * );
49
- * ```
35
+ * `PATCH /v1/broadcasts/{broadcastId}`
50
36
  */
51
37
  update(broadcastID, body, options) {
52
38
  return this._client.patch(path `/v1/broadcasts/${broadcastID}`, { body, ...options });
53
39
  }
54
40
  /**
41
+ * List broadcasts
42
+ *
55
43
  * List broadcasts for this project.
56
44
  *
57
- * @example
58
- * ```ts
59
- * // Automatically fetches more pages as needed.
60
- * for await (const broadcast of client.broadcasts.list()) {
61
- * // ...
62
- * }
63
- * ```
45
+ * `GET /v1/broadcasts`
64
46
  */
65
47
  list(query = {}, options) {
66
48
  return this._client.getAPIList('/v1/broadcasts', (Cursor), { query, ...options });
67
49
  }
68
50
  /**
51
+ * Delete broadcast
52
+ *
69
53
  * Delete a broadcast in draft status.
70
54
  *
71
- * @example
72
- * ```ts
73
- * await client.broadcasts.delete('broadcastId');
74
- * ```
55
+ * `DELETE /v1/broadcasts/{broadcastId}`
75
56
  */
76
57
  delete(broadcastID, options) {
77
58
  return this._client.delete(path `/v1/broadcasts/${broadcastID}`, {
@@ -80,90 +61,82 @@ export class Broadcasts extends APIResource {
80
61
  });
81
62
  }
82
63
  /**
64
+ * Cancel broadcast
65
+ *
83
66
  * Cancel a broadcast. Pending contacts will be skipped, but already queued
84
67
  * messages may still be delivered.
85
68
  *
86
- * @example
87
- * ```ts
88
- * const response = await client.broadcasts.cancel(
89
- * 'broadcastId',
90
- * );
91
- * ```
69
+ * A broadcast can be cancelled from `draft`, `pending_review`,
70
+ * `pending_admin_review`, `approved`, `rejected`, `escalated`, `scheduled` and
71
+ * `sending`. Any balance reserved for it is released. A review still running when
72
+ * it is cancelled cannot bring it back.
73
+ *
74
+ * `POST /v1/broadcasts/{broadcastId}/cancel`
92
75
  */
93
76
  cancel(broadcastID, options) {
94
77
  return this._client.post(path `/v1/broadcasts/${broadcastID}/cancel`, options);
95
78
  }
96
79
  /**
80
+ * Escalate to manual review
81
+ *
97
82
  * Request manual review by the Zavu team for a rejected broadcast. Use this after
98
83
  * automated review rejection if you believe the content is legitimate.
99
84
  *
100
- * @example
101
- * ```ts
102
- * const response = await client.broadcasts.escalateReview(
103
- * 'broadcastId',
104
- * );
105
- * ```
85
+ * `POST /v1/broadcasts/{broadcastId}/escalate`
106
86
  */
107
87
  escalateReview(broadcastID, options) {
108
88
  return this._client.post(path `/v1/broadcasts/${broadcastID}/escalate`, options);
109
89
  }
110
90
  /**
91
+ * Get broadcast progress
92
+ *
111
93
  * Get real-time progress of a broadcast including delivery counts and estimated
112
94
  * completion time.
113
95
  *
114
- * @example
115
- * ```ts
116
- * const broadcastProgress = await client.broadcasts.progress(
117
- * 'broadcastId',
118
- * );
119
- * ```
96
+ * `GET /v1/broadcasts/{broadcastId}/progress`
120
97
  */
121
98
  progress(broadcastID, options) {
122
99
  return this._client.get(path `/v1/broadcasts/${broadcastID}/progress`, options);
123
100
  }
124
101
  /**
102
+ * Reschedule broadcast
103
+ *
125
104
  * Update the scheduled time for a broadcast. The broadcast must be in scheduled
126
105
  * status.
127
106
  *
128
- * @example
129
- * ```ts
130
- * const response = await client.broadcasts.reschedule(
131
- * 'broadcastId',
132
- * { scheduledAt: '2024-01-15T14:00:00Z' },
133
- * );
134
- * ```
107
+ * `PATCH /v1/broadcasts/{broadcastId}/schedule`
135
108
  */
136
109
  reschedule(broadcastID, body, options) {
137
110
  return this._client.patch(path `/v1/broadcasts/${broadcastID}/schedule`, { body, ...options });
138
111
  }
139
112
  /**
113
+ * Retry broadcast review
114
+ *
140
115
  * Resubmit a rejected broadcast for AI review after editing content. Maximum 3
141
116
  * review attempts allowed per broadcast.
142
117
  *
143
- * @example
144
- * ```ts
145
- * const response = await client.broadcasts.retryReview(
146
- * 'broadcastId',
147
- * );
148
- * ```
118
+ * `POST /v1/broadcasts/{broadcastId}/retry-review`
149
119
  */
150
120
  retryReview(broadcastID, options) {
151
121
  return this._client.post(path `/v1/broadcasts/${broadcastID}/retry-review`, options);
152
122
  }
153
123
  /**
124
+ * Send broadcast
125
+ *
154
126
  * Start sending the broadcast immediately or schedule for later.
155
127
  *
156
- * **The account must be past the unverified level to send, except on WhatsApp.**
157
- * An account that has verified nothing is refused with `403` and code
158
- * `kyc_required` on every channel other than `whatsapp`. Any one of these lifts
159
- * it: identity verification (KYC), a saved payment method, a settled deposit, or a
160
- * paid plan. Business verification (KYB) is not required to broadcast; it gates
161
- * 10DLC registration only. A `whatsapp` broadcast is exempt: it can only be built
162
- * on a template, and Meta vets the business and the content when it approves that
163
- * template, so an unapproved template is refused instead. `smart` is not exempt,
164
- * since it can route a contact to SMS or email. Drafts can be created, edited and
165
- * kept without any check. Every send path (dashboard, API and CLI) enforces the
166
- * same rule.
128
+ * **Sending a broadcast needs no account verification.** Identity and business
129
+ * verification raise daily ceilings; neither is a permission to broadcast, on any
130
+ * channel. What stands in front of a broadcast is the content review below, and it
131
+ * applies to every send path — dashboard, API and CLI. Drafts can be created,
132
+ * edited and kept freely.
133
+ *
134
+ * **Email broadcasts need a paid plan.** On Free, sending or scheduling a
135
+ * broadcast on the `email` channel is refused with `402` and code
136
+ * `paid_plan_required`; drafts can still be created and edited. A `smart`
137
+ * broadcast is not refused: its email recipients fail individually with
138
+ * `errorCode` `PAID_PLAN_REQUIRED` and the others are sent. Teams created before
139
+ * August 1, 2026 keep their earlier terms.
167
140
  *
168
141
  * **Daily ceilings apply per recipient.** Each message a broadcast sends counts
169
142
  * against the channel's daily ceiling (see `POST /v1/messages`). Once the ceiling
@@ -173,25 +146,24 @@ export class Broadcasts extends APIResource {
173
146
  * **Review depends on the channel, and cannot be bypassed.** A draft is submitted
174
147
  * to automated content review here; it does not go straight out. A WhatsApp
175
148
  * broadcast built on a Meta-approved template skips review (Meta already vetted
176
- * the content) and begins sending. An email broadcast sends as soon as the
177
- * automated review passes. Every other channel moves to `pending_admin_review` and
178
- * waits for a person. If the review rejects it, use PATCH to edit the content then
179
- * call POST /retry-review.
149
+ * the content) and begins sending. An email broadcast sends as soon as the review
150
+ * passes it, unless the review asks for a person. Every other channel moves to
151
+ * `pending_admin_review` and waits for a person. A broadcast the review refuses
152
+ * lands on `rejected`: use PATCH to edit the content then call POST /retry-review,
153
+ * or escalate it for a manual review.
154
+ *
155
+ * A broadcast is read once, on its own text, rather than per recipient. While an
156
+ * account's sending is suspended its recipients fail individually with `errorCode`
157
+ * `SENDING_SUSPENDED`; see `POST /v1/messages`.
180
158
  *
181
159
  * Calling this on a broadcast that is already `approved` or `scheduled` sends or
182
160
  * reschedules it directly, since it has already been reviewed. Reserves the
183
161
  * estimated cost from your balance.
184
162
  *
185
- * @example
186
- * ```ts
187
- * const response = await client.broadcasts.send(
188
- * 'broadcastId',
189
- * );
190
- * ```
163
+ * `POST /v1/broadcasts/{broadcastId}/send`
191
164
  */
192
165
  send(broadcastID, body = {}, options) {
193
166
  return this._client.post(path `/v1/broadcasts/${broadcastID}/send`, { body, ...options });
194
167
  }
195
168
  }
196
- Broadcasts.Contacts = Contacts;
197
169
  //# sourceMappingURL=broadcasts.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"broadcasts.mjs","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAKL,QAAQ,GACT,uBAAmB;AAEpB,OAAO,EAAE,MAAM,EAAkC,kCAA8B;AAC/E,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiN1E,CAAC;IA/MC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,WAAmB,EACnB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,MAAiB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kBAAkB,WAAW,EAAE,EAAE;YAC9D,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,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAC,WAAmB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CACR,WAAmB,EACnB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,WAAmB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,eAAe,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,IAAI,CACF,WAAmB,EACnB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AAqaD,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
1
+ {"version":3,"file":"broadcasts.mjs","sourceRoot":"","sources":["../../src/resources/broadcasts/broadcasts.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAE7F,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,MAAM,EAAe,kCAA8B;AAC5D,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,OAAO,KAAK,WAAW,uBAAmB;AAS1C,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuL1E,CAAC;IArLC;;;;;;OAMG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,WAAmB,EACnB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,MAAiB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,kBAAkB,WAAW,EAAE,EAAE;YAC9D,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;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,SAAS,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,WAAmB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAmB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,WAAmB,EACnB,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,kBAAkB,WAAW,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,WAAmB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,eAAe,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,IAAI,CACF,WAAmB,EACnB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,WAAW,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF"}