@trycourier/courier 7.22.0 → 7.24.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 (79) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/client.d.mts +6 -3
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +6 -3
  5. package/client.d.ts.map +1 -1
  6. package/client.js +6 -3
  7. package/client.js.map +1 -1
  8. package/client.mjs +6 -3
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/broadcasts.d.mts +384 -0
  12. package/resources/broadcasts.d.mts.map +1 -0
  13. package/resources/broadcasts.d.ts +384 -0
  14. package/resources/broadcasts.d.ts.map +1 -0
  15. package/resources/broadcasts.js +184 -0
  16. package/resources/broadcasts.js.map +1 -0
  17. package/resources/broadcasts.mjs +180 -0
  18. package/resources/broadcasts.mjs.map +1 -0
  19. package/resources/index.d.mts +1 -1
  20. package/resources/index.d.mts.map +1 -1
  21. package/resources/index.d.ts +1 -1
  22. package/resources/index.d.ts.map +1 -1
  23. package/resources/index.js +3 -3
  24. package/resources/index.js.map +1 -1
  25. package/resources/index.mjs +1 -1
  26. package/resources/index.mjs.map +1 -1
  27. package/resources/journeys/journeys.d.mts +36 -4
  28. package/resources/journeys/journeys.d.mts.map +1 -1
  29. package/resources/journeys/journeys.d.ts +36 -4
  30. package/resources/journeys/journeys.d.ts.map +1 -1
  31. package/resources/journeys/journeys.js +9 -2
  32. package/resources/journeys/journeys.js.map +1 -1
  33. package/resources/journeys/journeys.mjs +9 -2
  34. package/resources/journeys/journeys.mjs.map +1 -1
  35. package/src/client.ts +40 -5
  36. package/src/resources/broadcasts.ts +492 -0
  37. package/src/resources/index.ts +17 -1
  38. package/src/resources/journeys/journeys.ts +38 -4
  39. package/src/version.ts +1 -1
  40. package/version.d.mts +1 -1
  41. package/version.d.ts +1 -1
  42. package/version.js +1 -1
  43. package/version.mjs +1 -1
  44. package/resources/inbox/inbox.d.mts +0 -10
  45. package/resources/inbox/inbox.d.mts.map +0 -1
  46. package/resources/inbox/inbox.d.ts +0 -10
  47. package/resources/inbox/inbox.d.ts.map +0 -1
  48. package/resources/inbox/inbox.js +0 -17
  49. package/resources/inbox/inbox.js.map +0 -1
  50. package/resources/inbox/inbox.mjs +0 -12
  51. package/resources/inbox/inbox.mjs.map +0 -1
  52. package/resources/inbox/index.d.mts +0 -3
  53. package/resources/inbox/index.d.mts.map +0 -1
  54. package/resources/inbox/index.d.ts +0 -3
  55. package/resources/inbox/index.d.ts.map +0 -1
  56. package/resources/inbox/index.js +0 -9
  57. package/resources/inbox/index.js.map +0 -1
  58. package/resources/inbox/index.mjs +0 -4
  59. package/resources/inbox/index.mjs.map +0 -1
  60. package/resources/inbox/messages.d.mts +0 -23
  61. package/resources/inbox/messages.d.mts.map +0 -1
  62. package/resources/inbox/messages.d.ts +0 -23
  63. package/resources/inbox/messages.d.ts.map +0 -1
  64. package/resources/inbox/messages.js +0 -34
  65. package/resources/inbox/messages.js.map +0 -1
  66. package/resources/inbox/messages.mjs +0 -30
  67. package/resources/inbox/messages.mjs.map +0 -1
  68. package/resources/inbox.d.mts +0 -2
  69. package/resources/inbox.d.mts.map +0 -1
  70. package/resources/inbox.d.ts +0 -2
  71. package/resources/inbox.d.ts.map +0 -1
  72. package/resources/inbox.js +0 -6
  73. package/resources/inbox.js.map +0 -1
  74. package/resources/inbox.mjs +0 -3
  75. package/resources/inbox.mjs.map +0 -1
  76. package/src/resources/inbox/inbox.ts +0 -15
  77. package/src/resources/inbox/index.ts +0 -4
  78. package/src/resources/inbox/messages.ts +0 -40
  79. package/src/resources/inbox.ts +0 -3
@@ -1 +1 @@
1
- {"version":3,"file":"journeys.js","sourceRoot":"","sources":["../../src/resources/journeys/journeys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAGlD,qEAA4C;AAC5C,8CAYqB;AAErB,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0O/E,CAAC;IAxOC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;YACpC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CACN,UAAkB,EAClB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAkB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,EAAE,EAAE;YACxD,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,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAkB,EAClB,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,SAAS,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,UAAkB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CACL,UAAkB,EAClB,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,UAAU,EAAE;YAC9D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,UAAkB,EAClB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AA3OD,4BA2OC;AA4mCD,QAAQ,CAAC,SAAS,GAAG,qBAAS,CAAC"}
1
+ {"version":3,"file":"journeys.js","sourceRoot":"","sources":["../../src/resources/journeys/journeys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAGlD,qEAA4C;AAC5C,8CAYqB;AAErB,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiP/E,CAAC;IA/OC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;YACpC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CACN,UAAkB,EAClB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAkB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,EAAE,EAAE;YACxD,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,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAkB,EAClB,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,SAAS,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,UAAkB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CACL,UAAkB,EAClB,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,UAAU,EAAE;YAC9D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,UAAkB,EAClB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAlPD,4BAkPC;AAuoCD,QAAQ,CAAC,SAAS,GAAG,qBAAS,CAAC"}
@@ -24,9 +24,16 @@ export class Journeys extends APIResource {
24
24
  * {
25
25
  * id: 'trigger-1',
26
26
  * type: 'trigger',
27
- * trigger_type: 'api',
27
+ * trigger_type: 'api-invoke',
28
28
  * },
29
- * { id: 'send-1', type: 'send' },
29
+ * {
30
+ * id: 'send-1',
31
+ * type: 'send',
32
+ * message: {
33
+ * template: 'nt_01kx4h2jdafq8bk9aftxak4b40',
34
+ * },
35
+ * },
36
+ * { id: 'exit-1', type: 'exit' },
30
37
  * ],
31
38
  * enabled: true,
32
39
  * state: 'DRAFT',
@@ -1 +1 @@
1
- {"version":3,"file":"journeys.mjs","sourceRoot":"","sources":["../../src/resources/journeys/journeys.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAWL,SAAS,GACV,wBAAoB;AAErB,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA0O/E,CAAC;IAxOC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;YACpC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CACN,UAAkB,EAClB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAkB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,UAAU,EAAE,EAAE;YACxD,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,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAkB,EAClB,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,UAAU,SAAS,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,UAAkB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CACL,UAAkB,EAClB,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,UAAU,UAAU,EAAE;YAC9D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,UAAkB,EAClB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AA4mCD,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC"}
1
+ {"version":3,"file":"journeys.mjs","sourceRoot":"","sources":["../../src/resources/journeys/journeys.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAWL,SAAS,GACV,wBAAoB;AAErB,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiP/E,CAAC;IA/OC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;YACpC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CACN,UAAkB,EAClB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAkB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,UAAU,EAAE,EAAE;YACxD,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,MAA2B,EAAE,OAAwB;QAC1D,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC3C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAkB,EAClB,MAA2B,EAC3B,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,UAAU,SAAS,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,UAAkB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CACL,UAAkB,EAClB,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,UAAU,UAAU,EAAE;YAC9D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,UAAkB,EAClB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAuoCD,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC"}
package/src/client.ts CHANGED
@@ -55,6 +55,23 @@ import {
55
55
  Logo,
56
56
  WidgetBackground,
57
57
  } from './resources/brands';
58
+ import {
59
+ Broadcast,
60
+ BroadcastCreateParams,
61
+ BroadcastListParams,
62
+ BroadcastListResponse,
63
+ BroadcastPutContentParams,
64
+ BroadcastRetrieveContentParams,
65
+ BroadcastSchedule,
66
+ BroadcastScheduleParams,
67
+ BroadcastSendParams,
68
+ BroadcastUpdateParams,
69
+ Broadcasts,
70
+ CreateBroadcastRequest,
71
+ ScheduleBroadcastRequest,
72
+ SendBroadcastRequest,
73
+ UpdateBroadcastRequest,
74
+ } from './resources/broadcasts';
58
75
  import { Inbound, InboundTrackEventParams, InboundTrackEventResponse } from './resources/inbound';
59
76
  import {
60
77
  MessageContentResponse,
@@ -101,7 +118,6 @@ import {
101
118
  DigestInstanceListResponse,
102
119
  Digests,
103
120
  } from './resources/digests/digests';
104
- import { Inbox } from './resources/inbox/inbox';
105
121
  import {
106
122
  CancelJourneyRequest,
107
123
  CancelJourneyResponse,
@@ -990,6 +1006,10 @@ export class Courier {
990
1006
  * Build, version, publish, invoke, and cancel multi-step notification workflows, along with the templates scoped to them.
991
1007
  */
992
1008
  journeys: API.Journeys = new API.Journeys(this);
1009
+ /**
1010
+ * Create a one-off send to a list or audience, author its content, then send it immediately or schedule it for later.
1011
+ */
1012
+ broadcasts: API.Broadcasts = new API.Broadcasts(this);
993
1013
  /**
994
1014
  * Manage the logos, colors, and layout that give the templates you send a consistent look.
995
1015
  */
@@ -1003,7 +1023,6 @@ export class Courier {
1003
1023
  * Manage static groups of users that you subscribe explicitly, and send to them by list id or list pattern.
1004
1024
  */
1005
1025
  lists: API.Lists = new API.Lists(this);
1006
- inbox: API.Inbox = new API.Inbox(this);
1007
1026
  /**
1008
1027
  * Look up the messages Courier has accepted, inspect their delivery history and rendered output, and cancel, resend, or archive them.
1009
1028
  */
@@ -1046,11 +1065,11 @@ Courier.AuditEvents = AuditEvents;
1046
1065
  Courier.Auth = Auth;
1047
1066
  Courier.Automations = Automations;
1048
1067
  Courier.Journeys = Journeys;
1068
+ Courier.Broadcasts = Broadcasts;
1049
1069
  Courier.Brands = Brands;
1050
1070
  Courier.Digests = Digests;
1051
1071
  Courier.Inbound = Inbound;
1052
1072
  Courier.Lists = Lists;
1053
- Courier.Inbox = Inbox;
1054
1073
  Courier.Messages = Messages;
1055
1074
  Courier.Requests = Requests;
1056
1075
  Courier.Notifications = Notifications;
@@ -1160,6 +1179,24 @@ export declare namespace Courier {
1160
1179
  type JourneyReplaceParams as JourneyReplaceParams,
1161
1180
  };
1162
1181
 
1182
+ export {
1183
+ Broadcasts as Broadcasts,
1184
+ type Broadcast as Broadcast,
1185
+ type BroadcastListResponse as BroadcastListResponse,
1186
+ type BroadcastSchedule as BroadcastSchedule,
1187
+ type CreateBroadcastRequest as CreateBroadcastRequest,
1188
+ type ScheduleBroadcastRequest as ScheduleBroadcastRequest,
1189
+ type SendBroadcastRequest as SendBroadcastRequest,
1190
+ type UpdateBroadcastRequest as UpdateBroadcastRequest,
1191
+ type BroadcastCreateParams as BroadcastCreateParams,
1192
+ type BroadcastUpdateParams as BroadcastUpdateParams,
1193
+ type BroadcastListParams as BroadcastListParams,
1194
+ type BroadcastPutContentParams as BroadcastPutContentParams,
1195
+ type BroadcastRetrieveContentParams as BroadcastRetrieveContentParams,
1196
+ type BroadcastScheduleParams as BroadcastScheduleParams,
1197
+ type BroadcastSendParams as BroadcastSendParams,
1198
+ };
1199
+
1163
1200
  export {
1164
1201
  Brands as Brands,
1165
1202
  type Brand as Brand,
@@ -1205,8 +1242,6 @@ export declare namespace Courier {
1205
1242
  type ListRestoreParams as ListRestoreParams,
1206
1243
  };
1207
1244
 
1208
- export { Inbox as Inbox };
1209
-
1210
1245
  export {
1211
1246
  Messages as Messages,
1212
1247
  type MessageDetails as MessageDetails,
@@ -0,0 +1,492 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../core/resource';
4
+ import * as Shared from './shared';
5
+ import * as NotificationsAPI from './notifications/notifications';
6
+ import { APIPromise } from '../core/api-promise';
7
+ import { RequestOptions } from '../internal/request-options';
8
+ import { path } from '../internal/utils/path';
9
+
10
+ /**
11
+ * Create a one-off send to a list or audience, author its content, then send it immediately or schedule it for later.
12
+ */
13
+ export class Broadcasts extends APIResource {
14
+ /**
15
+ * Create a broadcast. Provisions a private notification template for the broadcast
16
+ * and returns the new broadcast in the draft state. Exactly one channel is
17
+ * required.
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * const broadcast = await client.broadcasts.create({
22
+ * channel: 'email',
23
+ * name: 'Spring Sale Announcement',
24
+ * });
25
+ * ```
26
+ */
27
+ create(body: BroadcastCreateParams, options?: RequestOptions): APIPromise<Broadcast> {
28
+ return this._client.post('/broadcasts', { body, ...options });
29
+ }
30
+
31
+ /**
32
+ * Retrieve a broadcast by ID. Archived broadcasts return 404.
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * const broadcast = await client.broadcasts.retrieve(
37
+ * 'broadcastId',
38
+ * );
39
+ * ```
40
+ */
41
+ retrieve(broadcastID: string, options?: RequestOptions): APIPromise<Broadcast> {
42
+ return this._client.get(path`/broadcasts/${broadcastID}`, options);
43
+ }
44
+
45
+ /**
46
+ * Update a broadcast's name. Content is edited via the broadcast's notification
47
+ * template, not this endpoint.
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const broadcast = await client.broadcasts.update(
52
+ * 'broadcastId',
53
+ * { name: 'Spring Sale Announcement (v2)' },
54
+ * );
55
+ * ```
56
+ */
57
+ update(broadcastID: string, body: BroadcastUpdateParams, options?: RequestOptions): APIPromise<Broadcast> {
58
+ return this._client.put(path`/broadcasts/${broadcastID}`, { body, ...options });
59
+ }
60
+
61
+ /**
62
+ * List broadcasts in your workspace. Cursor-paginated; returns broadcasts
63
+ * newest-first.
64
+ *
65
+ * @example
66
+ * ```ts
67
+ * const broadcastListResponse =
68
+ * await client.broadcasts.list();
69
+ * ```
70
+ */
71
+ list(
72
+ query: BroadcastListParams | null | undefined = {},
73
+ options?: RequestOptions,
74
+ ): APIPromise<BroadcastListResponse> {
75
+ return this._client.get('/broadcasts', { query, ...options });
76
+ }
77
+
78
+ /**
79
+ * Archive a broadcast. This is a soft delete — the archived broadcast is returned
80
+ * and no longer appears in list results.
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const broadcast = await client.broadcasts.archive(
85
+ * 'broadcastId',
86
+ * );
87
+ * ```
88
+ */
89
+ archive(broadcastID: string, options?: RequestOptions): APIPromise<Broadcast> {
90
+ return this._client.delete(path`/broadcasts/${broadcastID}`, options);
91
+ }
92
+
93
+ /**
94
+ * Cancel a broadcast's pending schedule, returning it to the draft state. Only
95
+ * valid for a scheduled broadcast.
96
+ *
97
+ * @example
98
+ * ```ts
99
+ * const broadcast = await client.broadcasts.cancel(
100
+ * 'broadcastId',
101
+ * );
102
+ * ```
103
+ */
104
+ cancel(broadcastID: string, options?: RequestOptions): APIPromise<Broadcast> {
105
+ return this._client.post(path`/broadcasts/${broadcastID}/cancel`, options);
106
+ }
107
+
108
+ /**
109
+ * Duplicate a broadcast (and its template) into a new draft named "{source name}
110
+ * (copy)".
111
+ *
112
+ * @example
113
+ * ```ts
114
+ * const broadcast = await client.broadcasts.duplicate(
115
+ * 'broadcastId',
116
+ * );
117
+ * ```
118
+ */
119
+ duplicate(broadcastID: string, options?: RequestOptions): APIPromise<Broadcast> {
120
+ return this._client.post(path`/broadcasts/${broadcastID}/duplicate`, options);
121
+ }
122
+
123
+ /**
124
+ * Author the broadcast's content by replacing the draft elemental content of its
125
+ * private notification template. The draft is published automatically when the
126
+ * broadcast is sent or scheduled.
127
+ *
128
+ * @example
129
+ * ```ts
130
+ * const notificationContentMutationResponse =
131
+ * await client.broadcasts.putContent('broadcastId', {
132
+ * content: {
133
+ * version: '2022-01-01',
134
+ * elements: [{ type: 'meta' }, { type: 'text' }],
135
+ * },
136
+ * });
137
+ * ```
138
+ */
139
+ putContent(
140
+ broadcastID: string,
141
+ body: BroadcastPutContentParams,
142
+ options?: RequestOptions,
143
+ ): APIPromise<NotificationsAPI.NotificationContentMutationResponse> {
144
+ return this._client.put(path`/broadcasts/${broadcastID}/content`, { body, ...options });
145
+ }
146
+
147
+ /**
148
+ * Retrieve the broadcast's content — the elemental content of its private
149
+ * notification template. Defaults to the working draft, since broadcast content is
150
+ * authored as a draft until the broadcast is sent.
151
+ *
152
+ * @example
153
+ * ```ts
154
+ * const notificationContentGetResponse =
155
+ * await client.broadcasts.retrieveContent('broadcastId');
156
+ * ```
157
+ */
158
+ retrieveContent(
159
+ broadcastID: string,
160
+ query: BroadcastRetrieveContentParams | null | undefined = {},
161
+ options?: RequestOptions,
162
+ ): APIPromise<NotificationsAPI.NotificationContentGetResponse> {
163
+ return this._client.get(path`/broadcasts/${broadcastID}/content`, { query, ...options });
164
+ }
165
+
166
+ /**
167
+ * Schedule a broadcast for a future send to a list or audience. Publishes the
168
+ * broadcast template first. Not allowed once the broadcast is sending or sent. For
169
+ * an immediate send use POST /broadcasts/{broadcastId}/send.
170
+ *
171
+ * @example
172
+ * ```ts
173
+ * const broadcast = await client.broadcasts.schedule(
174
+ * 'broadcastId',
175
+ * {
176
+ * recipient_id: 'aud_01kx4h2jdafq8bk9amzvy6hbv0',
177
+ * recipient_type: 'audience',
178
+ * scheduled_to: '2026-08-01T15:00:00',
179
+ * timezone: 'America/New_York',
180
+ * },
181
+ * );
182
+ * ```
183
+ */
184
+ schedule(
185
+ broadcastID: string,
186
+ body: BroadcastScheduleParams,
187
+ options?: RequestOptions,
188
+ ): APIPromise<Broadcast> {
189
+ return this._client.post(path`/broadcasts/${broadcastID}/schedule`, { body, ...options });
190
+ }
191
+
192
+ /**
193
+ * Send a broadcast immediately to a list or audience. Publishes the broadcast
194
+ * template first. Not allowed once the broadcast is sending or sent.
195
+ *
196
+ * @example
197
+ * ```ts
198
+ * const broadcast = await client.broadcasts.send(
199
+ * 'broadcastId',
200
+ * {
201
+ * recipient_id: 'cool-customers',
202
+ * recipient_type: 'list',
203
+ * },
204
+ * );
205
+ * ```
206
+ */
207
+ send(broadcastID: string, body: BroadcastSendParams, options?: RequestOptions): APIPromise<Broadcast> {
208
+ return this._client.post(path`/broadcasts/${broadcastID}/send`, { body, ...options });
209
+ }
210
+ }
211
+
212
+ /**
213
+ * A broadcast — a single-channel message delivered to a known set of recipients (a
214
+ * list or audience).
215
+ */
216
+ export interface Broadcast {
217
+ /**
218
+ * The broadcast ID (bst\_ prefix).
219
+ */
220
+ id: string;
221
+
222
+ /**
223
+ * The broadcast's delivery channel.
224
+ */
225
+ channel: 'email' | 'sms' | 'push' | 'inbox' | 'slack' | 'msteams';
226
+
227
+ /**
228
+ * ISO 8601 timestamp when the broadcast was created.
229
+ */
230
+ created_at: string;
231
+
232
+ /**
233
+ * Actor that created the broadcast.
234
+ */
235
+ created_by: string;
236
+
237
+ /**
238
+ * Human-readable name.
239
+ */
240
+ name: string;
241
+
242
+ /**
243
+ * Lifecycle status of the broadcast.
244
+ */
245
+ status: 'draft' | 'scheduled' | 'sending' | 'sent';
246
+
247
+ /**
248
+ * ISO 8601 timestamp of the last update.
249
+ */
250
+ updated_at: string;
251
+
252
+ /**
253
+ * Actor that last updated the broadcast.
254
+ */
255
+ updated_by: string;
256
+
257
+ /**
258
+ * ISO 8601 timestamp when the broadcast was archived, if archived.
259
+ */
260
+ archived_at?: string | null;
261
+
262
+ /**
263
+ * Actor that archived the broadcast, if archived.
264
+ */
265
+ archived_by?: string | null;
266
+
267
+ /**
268
+ * The delivery schedule and recipient targeting for a broadcast.
269
+ */
270
+ schedule?: BroadcastSchedule | null;
271
+ }
272
+
273
+ /**
274
+ * Paginated list of broadcasts.
275
+ */
276
+ export interface BroadcastListResponse {
277
+ paging: Shared.Paging;
278
+
279
+ results: Array<Broadcast>;
280
+ }
281
+
282
+ /**
283
+ * The delivery schedule and recipient targeting for a broadcast.
284
+ */
285
+ export interface BroadcastSchedule {
286
+ /**
287
+ * ID of the target list or audience.
288
+ */
289
+ recipient_id: string;
290
+
291
+ /**
292
+ * Whether the broadcast targets a list or an audience.
293
+ */
294
+ recipient_type: 'list' | 'audience';
295
+
296
+ /**
297
+ * Wall-clock timestamp of the scheduled send, no timezone offset (e.g.
298
+ * "2026-07-21T20:00:00").
299
+ */
300
+ scheduled_to?: string | null;
301
+
302
+ /**
303
+ * IANA timezone for the scheduled send (e.g. America/New_York).
304
+ */
305
+ timezone?: string | null;
306
+ }
307
+
308
+ /**
309
+ * Request body for creating a broadcast.
310
+ */
311
+ export interface CreateBroadcastRequest {
312
+ /**
313
+ * The single delivery channel for this broadcast.
314
+ */
315
+ channel: 'email' | 'sms' | 'push' | 'inbox' | 'slack' | 'msteams';
316
+
317
+ /**
318
+ * Human-readable name.
319
+ */
320
+ name: string;
321
+ }
322
+
323
+ /**
324
+ * Request body for scheduling a broadcast for a future send.
325
+ */
326
+ export interface ScheduleBroadcastRequest {
327
+ /**
328
+ * ID of the target list or audience.
329
+ */
330
+ recipient_id: string;
331
+
332
+ /**
333
+ * Whether the broadcast targets a list or an audience.
334
+ */
335
+ recipient_type: 'list' | 'audience';
336
+
337
+ /**
338
+ * Wall-clock timestamp of the future send, no timezone offset (e.g.
339
+ * "2026-07-21T20:00:00"). The zone is given by `timezone`.
340
+ */
341
+ scheduled_to: string;
342
+
343
+ /**
344
+ * IANA timezone for the scheduled send (e.g. America/New_York).
345
+ */
346
+ timezone?: string;
347
+ }
348
+
349
+ /**
350
+ * Request body for sending a broadcast immediately.
351
+ */
352
+ export interface SendBroadcastRequest {
353
+ /**
354
+ * ID of the target list or audience.
355
+ */
356
+ recipient_id: string;
357
+
358
+ /**
359
+ * Whether the broadcast targets a list or an audience.
360
+ */
361
+ recipient_type: 'list' | 'audience';
362
+ }
363
+
364
+ /**
365
+ * Request body for updating a broadcast. Only the name is mutable.
366
+ */
367
+ export interface UpdateBroadcastRequest {
368
+ /**
369
+ * New human-readable name.
370
+ */
371
+ name: string;
372
+ }
373
+
374
+ export interface BroadcastCreateParams {
375
+ /**
376
+ * The single delivery channel for this broadcast.
377
+ */
378
+ channel: 'email' | 'sms' | 'push' | 'inbox' | 'slack' | 'msteams';
379
+
380
+ /**
381
+ * Human-readable name.
382
+ */
383
+ name: string;
384
+ }
385
+
386
+ export interface BroadcastUpdateParams {
387
+ /**
388
+ * New human-readable name.
389
+ */
390
+ name: string;
391
+ }
392
+
393
+ export interface BroadcastListParams {
394
+ /**
395
+ * Opaque pagination cursor from a previous response. Omit for the first page.
396
+ */
397
+ cursor?: string | null;
398
+
399
+ /**
400
+ * Maximum number of results per page.
401
+ */
402
+ limit?: number;
403
+ }
404
+
405
+ export interface BroadcastPutContentParams {
406
+ /**
407
+ * Elemental content payload. The server defaults `version` when omitted.
408
+ */
409
+ content: BroadcastPutContentParams.Content;
410
+
411
+ /**
412
+ * Template state. Defaults to `DRAFT`.
413
+ */
414
+ state?: NotificationsAPI.NotificationTemplateState;
415
+ }
416
+
417
+ export namespace BroadcastPutContentParams {
418
+ /**
419
+ * Elemental content payload. The server defaults `version` when omitted.
420
+ */
421
+ export interface Content {
422
+ elements: Array<Shared.ElementalNode>;
423
+
424
+ /**
425
+ * Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
426
+ * omitted.
427
+ */
428
+ version?: string;
429
+ }
430
+ }
431
+
432
+ export interface BroadcastRetrieveContentParams {
433
+ /**
434
+ * Accepts `draft`, `published`, or a version string (e.g. `v001`). Defaults to
435
+ * `draft`.
436
+ */
437
+ version?: string;
438
+ }
439
+
440
+ export interface BroadcastScheduleParams {
441
+ /**
442
+ * ID of the target list or audience.
443
+ */
444
+ recipient_id: string;
445
+
446
+ /**
447
+ * Whether the broadcast targets a list or an audience.
448
+ */
449
+ recipient_type: 'list' | 'audience';
450
+
451
+ /**
452
+ * Wall-clock timestamp of the future send, no timezone offset (e.g.
453
+ * "2026-07-21T20:00:00"). The zone is given by `timezone`.
454
+ */
455
+ scheduled_to: string;
456
+
457
+ /**
458
+ * IANA timezone for the scheduled send (e.g. America/New_York).
459
+ */
460
+ timezone?: string;
461
+ }
462
+
463
+ export interface BroadcastSendParams {
464
+ /**
465
+ * ID of the target list or audience.
466
+ */
467
+ recipient_id: string;
468
+
469
+ /**
470
+ * Whether the broadcast targets a list or an audience.
471
+ */
472
+ recipient_type: 'list' | 'audience';
473
+ }
474
+
475
+ export declare namespace Broadcasts {
476
+ export {
477
+ type Broadcast as Broadcast,
478
+ type BroadcastListResponse as BroadcastListResponse,
479
+ type BroadcastSchedule as BroadcastSchedule,
480
+ type CreateBroadcastRequest as CreateBroadcastRequest,
481
+ type ScheduleBroadcastRequest as ScheduleBroadcastRequest,
482
+ type SendBroadcastRequest as SendBroadcastRequest,
483
+ type UpdateBroadcastRequest as UpdateBroadcastRequest,
484
+ type BroadcastCreateParams as BroadcastCreateParams,
485
+ type BroadcastUpdateParams as BroadcastUpdateParams,
486
+ type BroadcastListParams as BroadcastListParams,
487
+ type BroadcastPutContentParams as BroadcastPutContentParams,
488
+ type BroadcastRetrieveContentParams as BroadcastRetrieveContentParams,
489
+ type BroadcastScheduleParams as BroadcastScheduleParams,
490
+ type BroadcastSendParams as BroadcastSendParams,
491
+ };
492
+ }
@@ -46,6 +46,23 @@ export {
46
46
  type BrandUpdateParams,
47
47
  type BrandListParams,
48
48
  } from './brands';
49
+ export {
50
+ Broadcasts,
51
+ type Broadcast,
52
+ type BroadcastListResponse,
53
+ type BroadcastSchedule,
54
+ type CreateBroadcastRequest,
55
+ type ScheduleBroadcastRequest,
56
+ type SendBroadcastRequest,
57
+ type UpdateBroadcastRequest,
58
+ type BroadcastCreateParams,
59
+ type BroadcastUpdateParams,
60
+ type BroadcastListParams,
61
+ type BroadcastPutContentParams,
62
+ type BroadcastRetrieveContentParams,
63
+ type BroadcastScheduleParams,
64
+ type BroadcastSendParams,
65
+ } from './broadcasts';
49
66
  export {
50
67
  Digests,
51
68
  type DigestCategory,
@@ -53,7 +70,6 @@ export {
53
70
  type DigestInstanceListResponse,
54
71
  } from './digests/digests';
55
72
  export { Inbound, type InboundTrackEventResponse, type InboundTrackEventParams } from './inbound';
56
- export { Inbox } from './inbox/inbox';
57
73
  export {
58
74
  Journeys,
59
75
  type CancelJourneyRequest,