@trycourier/courier 7.25.0 → 7.25.2

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 (180) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +0 -3
  3. package/client.d.mts +3 -0
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +3 -0
  6. package/client.d.ts.map +1 -1
  7. package/client.js +3 -0
  8. package/client.js.map +1 -1
  9. package/client.mjs +3 -0
  10. package/client.mjs.map +1 -1
  11. package/package.json +1 -1
  12. package/resources/audiences.d.mts +46 -0
  13. package/resources/audiences.d.mts.map +1 -1
  14. package/resources/audiences.d.ts +46 -0
  15. package/resources/audiences.d.ts.map +1 -1
  16. package/resources/audiences.js +46 -0
  17. package/resources/audiences.js.map +1 -1
  18. package/resources/audiences.mjs +46 -0
  19. package/resources/audiences.mjs.map +1 -1
  20. package/resources/automations/invoke.d.mts +5 -1
  21. package/resources/automations/invoke.d.mts.map +1 -1
  22. package/resources/automations/invoke.d.ts +5 -1
  23. package/resources/automations/invoke.d.ts.map +1 -1
  24. package/resources/automations/invoke.js +5 -1
  25. package/resources/automations/invoke.js.map +1 -1
  26. package/resources/automations/invoke.mjs +5 -1
  27. package/resources/automations/invoke.mjs.map +1 -1
  28. package/resources/brands.d.mts +4 -1
  29. package/resources/brands.d.mts.map +1 -1
  30. package/resources/brands.d.ts +4 -1
  31. package/resources/brands.d.ts.map +1 -1
  32. package/resources/brands.js +4 -1
  33. package/resources/brands.js.map +1 -1
  34. package/resources/brands.mjs +4 -1
  35. package/resources/brands.mjs.map +1 -1
  36. package/resources/bulk.d.mts +199 -0
  37. package/resources/bulk.d.mts.map +1 -0
  38. package/resources/bulk.d.ts +199 -0
  39. package/resources/bulk.d.ts.map +1 -0
  40. package/resources/bulk.js +102 -0
  41. package/resources/bulk.js.map +1 -0
  42. package/resources/bulk.mjs +98 -0
  43. package/resources/bulk.mjs.map +1 -0
  44. package/resources/index.d.mts +1 -0
  45. package/resources/index.d.mts.map +1 -1
  46. package/resources/index.d.ts +1 -0
  47. package/resources/index.d.ts.map +1 -1
  48. package/resources/index.js +3 -1
  49. package/resources/index.js.map +1 -1
  50. package/resources/index.mjs +1 -0
  51. package/resources/index.mjs.map +1 -1
  52. package/resources/lists/lists.d.mts +3 -1
  53. package/resources/lists/lists.d.mts.map +1 -1
  54. package/resources/lists/lists.d.ts +3 -1
  55. package/resources/lists/lists.d.ts.map +1 -1
  56. package/resources/lists/lists.js +3 -1
  57. package/resources/lists/lists.js.map +1 -1
  58. package/resources/lists/lists.mjs +3 -1
  59. package/resources/lists/lists.mjs.map +1 -1
  60. package/resources/lists/subscriptions.d.mts +13 -2
  61. package/resources/lists/subscriptions.d.mts.map +1 -1
  62. package/resources/lists/subscriptions.d.ts +13 -2
  63. package/resources/lists/subscriptions.d.ts.map +1 -1
  64. package/resources/lists/subscriptions.js +13 -2
  65. package/resources/lists/subscriptions.js.map +1 -1
  66. package/resources/lists/subscriptions.mjs +13 -2
  67. package/resources/lists/subscriptions.mjs.map +1 -1
  68. package/resources/notifications/checks.d.mts +2 -2
  69. package/resources/notifications/checks.d.ts +2 -2
  70. package/resources/notifications/checks.js +2 -2
  71. package/resources/notifications/checks.mjs +2 -2
  72. package/resources/profiles/lists.d.mts +1 -1
  73. package/resources/profiles/lists.d.ts +1 -1
  74. package/resources/profiles/lists.js +1 -1
  75. package/resources/profiles/lists.mjs +1 -1
  76. package/resources/profiles/profiles.d.mts +12 -5
  77. package/resources/profiles/profiles.d.mts.map +1 -1
  78. package/resources/profiles/profiles.d.ts +12 -5
  79. package/resources/profiles/profiles.d.ts.map +1 -1
  80. package/resources/profiles/profiles.js +12 -5
  81. package/resources/profiles/profiles.js.map +1 -1
  82. package/resources/profiles/profiles.mjs +12 -5
  83. package/resources/profiles/profiles.mjs.map +1 -1
  84. package/resources/providers/providers.d.mts +6 -2
  85. package/resources/providers/providers.d.mts.map +1 -1
  86. package/resources/providers/providers.d.ts +6 -2
  87. package/resources/providers/providers.d.ts.map +1 -1
  88. package/resources/providers/providers.js +6 -2
  89. package/resources/providers/providers.js.map +1 -1
  90. package/resources/providers/providers.mjs +6 -2
  91. package/resources/providers/providers.mjs.map +1 -1
  92. package/resources/send.d.mts +2 -1
  93. package/resources/send.d.mts.map +1 -1
  94. package/resources/send.d.ts +2 -1
  95. package/resources/send.d.ts.map +1 -1
  96. package/resources/send.js +2 -1
  97. package/resources/send.js.map +1 -1
  98. package/resources/send.mjs +2 -1
  99. package/resources/send.mjs.map +1 -1
  100. package/resources/tenants/templates/templates.d.mts +7 -1
  101. package/resources/tenants/templates/templates.d.mts.map +1 -1
  102. package/resources/tenants/templates/templates.d.ts +7 -1
  103. package/resources/tenants/templates/templates.d.ts.map +1 -1
  104. package/resources/tenants/templates/templates.js +7 -1
  105. package/resources/tenants/templates/templates.js.map +1 -1
  106. package/resources/tenants/templates/templates.mjs +7 -1
  107. package/resources/tenants/templates/templates.mjs.map +1 -1
  108. package/resources/tenants/tenants.d.mts +3 -1
  109. package/resources/tenants/tenants.d.mts.map +1 -1
  110. package/resources/tenants/tenants.d.ts +3 -1
  111. package/resources/tenants/tenants.d.ts.map +1 -1
  112. package/resources/tenants/tenants.js +3 -1
  113. package/resources/tenants/tenants.js.map +1 -1
  114. package/resources/tenants/tenants.mjs +3 -1
  115. package/resources/tenants/tenants.mjs.map +1 -1
  116. package/resources/translations.d.mts +16 -0
  117. package/resources/translations.d.mts.map +1 -1
  118. package/resources/translations.d.ts +16 -0
  119. package/resources/translations.d.ts.map +1 -1
  120. package/resources/translations.js +16 -0
  121. package/resources/translations.js.map +1 -1
  122. package/resources/translations.mjs +16 -0
  123. package/resources/translations.mjs.map +1 -1
  124. package/resources/users/tenants.d.mts +5 -1
  125. package/resources/users/tenants.d.mts.map +1 -1
  126. package/resources/users/tenants.d.ts +5 -1
  127. package/resources/users/tenants.d.ts.map +1 -1
  128. package/resources/users/tenants.js +5 -1
  129. package/resources/users/tenants.js.map +1 -1
  130. package/resources/users/tenants.mjs +5 -1
  131. package/resources/users/tenants.mjs.map +1 -1
  132. package/resources/users/tokens.d.mts +8 -1
  133. package/resources/users/tokens.d.mts.map +1 -1
  134. package/resources/users/tokens.d.ts +8 -1
  135. package/resources/users/tokens.d.ts.map +1 -1
  136. package/resources/users/tokens.js +8 -1
  137. package/resources/users/tokens.js.map +1 -1
  138. package/resources/users/tokens.mjs +8 -1
  139. package/resources/users/tokens.mjs.map +1 -1
  140. package/resources/workspace-preferences/topics.d.mts +5 -2
  141. package/resources/workspace-preferences/topics.d.mts.map +1 -1
  142. package/resources/workspace-preferences/topics.d.ts +5 -2
  143. package/resources/workspace-preferences/topics.d.ts.map +1 -1
  144. package/resources/workspace-preferences/topics.js +5 -2
  145. package/resources/workspace-preferences/topics.js.map +1 -1
  146. package/resources/workspace-preferences/topics.mjs +5 -2
  147. package/resources/workspace-preferences/topics.mjs.map +1 -1
  148. package/resources/workspace-preferences/workspace-preferences.d.mts +8 -2
  149. package/resources/workspace-preferences/workspace-preferences.d.mts.map +1 -1
  150. package/resources/workspace-preferences/workspace-preferences.d.ts +8 -2
  151. package/resources/workspace-preferences/workspace-preferences.d.ts.map +1 -1
  152. package/resources/workspace-preferences/workspace-preferences.js +8 -2
  153. package/resources/workspace-preferences/workspace-preferences.js.map +1 -1
  154. package/resources/workspace-preferences/workspace-preferences.mjs +8 -2
  155. package/resources/workspace-preferences/workspace-preferences.mjs.map +1 -1
  156. package/src/client.ts +25 -0
  157. package/src/resources/audiences.ts +46 -0
  158. package/src/resources/automations/invoke.ts +5 -1
  159. package/src/resources/brands.ts +4 -1
  160. package/src/resources/bulk.ts +254 -0
  161. package/src/resources/index.ts +11 -0
  162. package/src/resources/lists/lists.ts +3 -1
  163. package/src/resources/lists/subscriptions.ts +13 -2
  164. package/src/resources/notifications/checks.ts +2 -2
  165. package/src/resources/profiles/lists.ts +1 -1
  166. package/src/resources/profiles/profiles.ts +12 -5
  167. package/src/resources/providers/providers.ts +6 -2
  168. package/src/resources/send.ts +2 -1
  169. package/src/resources/tenants/templates/templates.ts +7 -1
  170. package/src/resources/tenants/tenants.ts +3 -1
  171. package/src/resources/translations.ts +16 -0
  172. package/src/resources/users/tenants.ts +5 -1
  173. package/src/resources/users/tokens.ts +8 -1
  174. package/src/resources/workspace-preferences/topics.ts +5 -2
  175. package/src/resources/workspace-preferences/workspace-preferences.ts +8 -2
  176. package/src/version.ts +1 -1
  177. package/version.d.mts +1 -1
  178. package/version.d.ts +1 -1
  179. package/version.js +1 -1
  180. package/version.mjs +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"workspace-preferences.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,oBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAqB7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAIjG;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI3E;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;OASG;IACH,OAAO,CACL,MAAM,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAqBzC;;;;;;;;;;;OAWG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEnD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,CAAC;IAE7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,OAAO,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAID,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"workspace-preferences.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,oBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAqB7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAIjG;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI3E;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,MAAM,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAqBzC;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEnD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,CAAC;IAE7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,OAAO,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAID,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -92,7 +92,11 @@ class WorkspacePreferences extends resource_1.APIResource {
92
92
  * @example
93
93
  * ```ts
94
94
  * const publishPreferencesResponse =
95
- * await client.workspacePreferences.publish();
95
+ * await client.workspacePreferences.publish({
96
+ * brand_id: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag',
97
+ * description: 'Choose what you hear from us about.',
98
+ * heading: 'Notification Preferences',
99
+ * });
96
100
  * ```
97
101
  */
98
102
  publish(params = {}, options) {
@@ -119,7 +123,9 @@ class WorkspacePreferences extends resource_1.APIResource {
119
123
  * ```ts
120
124
  * const workspacePreferenceGetResponse =
121
125
  * await client.workspacePreferences.replace('section_id', {
122
- * name: 'name',
126
+ * name: 'Account Notifications',
127
+ * has_custom_routing: true,
128
+ * routing_options: ['email', 'push'],
123
129
  * });
124
130
  * ```
125
131
  */
@@ -1 +1 @@
1
- {"version":3,"file":"workspace-preferences.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,+DAAsC;AACtC,wCAMkB;AAElB,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,sBAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuIhE,CAAC;IArIC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAuC,EACvC,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,uBAAuB,EAAE;YAChD,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,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,SAA8D,EAAE,EAChE,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,sBAAsB,EAAE;YAC/C,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;;;;;;;;;;;OAWG;IACH,OAAO,CACL,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAxID,oDAwIC;AA0aD,oBAAoB,CAAC,MAAM,GAAG,eAAM,CAAC"}
1
+ {"version":3,"file":"workspace-preferences.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,+DAAsC;AACtC,wCAMkB;AAElB,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,sBAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6IhE,CAAC;IA3IC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAuC,EACvC,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,uBAAuB,EAAE;YAChD,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,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE;YACnE,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;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAA8D,EAAE,EAChE,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,sBAAsB,EAAE;YAC/C,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,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA9ID,oDA8IC;AA0aD,oBAAoB,CAAC,MAAM,GAAG,eAAM,CAAC"}
@@ -88,7 +88,11 @@ export class WorkspacePreferences extends APIResource {
88
88
  * @example
89
89
  * ```ts
90
90
  * const publishPreferencesResponse =
91
- * await client.workspacePreferences.publish();
91
+ * await client.workspacePreferences.publish({
92
+ * brand_id: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag',
93
+ * description: 'Choose what you hear from us about.',
94
+ * heading: 'Notification Preferences',
95
+ * });
92
96
  * ```
93
97
  */
94
98
  publish(params = {}, options) {
@@ -115,7 +119,9 @@ export class WorkspacePreferences extends APIResource {
115
119
  * ```ts
116
120
  * const workspacePreferenceGetResponse =
117
121
  * await client.workspacePreferences.replace('section_id', {
118
- * name: 'name',
122
+ * name: 'Account Notifications',
123
+ * has_custom_routing: true,
124
+ * routing_options: ['email', 'push'],
119
125
  * });
120
126
  * ```
121
127
  */
@@ -1 +1 @@
1
- {"version":3,"file":"workspace-preferences.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAKL,MAAM,GACP,qBAAiB;AAElB,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAuIhE,CAAC;IArIC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAuC,EACvC,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,uBAAuB,EAAE;YAChD,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,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,SAA8D,EAAE,EAChE,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,sBAAsB,EAAE;YAC/C,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;;;;;;;;;;;OAWG;IACH,OAAO,CACL,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA0aD,oBAAoB,CAAC,MAAM,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"workspace-preferences.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAKL,MAAM,GACP,qBAAiB;AAElB,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6IhE,CAAC;IA3IC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAuC,EACvC,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,uBAAuB,EAAE;YAChD,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,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE;YACnE,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;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAA8D,EAAE,EAChE,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,sBAAsB,EAAE;YAC/C,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,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA0aD,oBAAoB,CAAC,MAAM,GAAG,MAAM,CAAC"}
package/src/client.ts CHANGED
@@ -72,6 +72,17 @@ import {
72
72
  SendBroadcastRequest,
73
73
  UpdateBroadcastRequest,
74
74
  } from './resources/broadcasts';
75
+ import {
76
+ Bulk,
77
+ BulkAddUsersParams,
78
+ BulkCreateJobParams,
79
+ BulkCreateJobResponse,
80
+ BulkListUsersParams,
81
+ BulkListUsersResponse,
82
+ BulkRetrieveJobResponse,
83
+ InboundBulkMessage,
84
+ InboundBulkMessageUser,
85
+ } from './resources/bulk';
75
86
  import { Inbound, InboundTrackEventParams, InboundTrackEventResponse } from './resources/inbound';
76
87
  import {
77
88
  MessageContentResponse,
@@ -1012,6 +1023,7 @@ export class Courier {
1012
1023
  * Create a one-off send to a list or audience, author its content, then send it immediately or schedule it for later.
1013
1024
  */
1014
1025
  broadcasts: API.Broadcasts = new API.Broadcasts(this);
1026
+ bulk: API.Bulk = new API.Bulk(this);
1015
1027
  /**
1016
1028
  * Manage the logos, colors, and layout that give the templates you send a consistent look.
1017
1029
  */
@@ -1068,6 +1080,7 @@ Courier.Auth = Auth;
1068
1080
  Courier.Automations = Automations;
1069
1081
  Courier.Journeys = Journeys;
1070
1082
  Courier.Broadcasts = Broadcasts;
1083
+ Courier.Bulk = Bulk;
1071
1084
  Courier.Brands = Brands;
1072
1085
  Courier.Digests = Digests;
1073
1086
  Courier.Inbound = Inbound;
@@ -1199,6 +1212,18 @@ export declare namespace Courier {
1199
1212
  type BroadcastSendParams as BroadcastSendParams,
1200
1213
  };
1201
1214
 
1215
+ export {
1216
+ Bulk as Bulk,
1217
+ type InboundBulkMessage as InboundBulkMessage,
1218
+ type InboundBulkMessageUser as InboundBulkMessageUser,
1219
+ type BulkCreateJobResponse as BulkCreateJobResponse,
1220
+ type BulkListUsersResponse as BulkListUsersResponse,
1221
+ type BulkRetrieveJobResponse as BulkRetrieveJobResponse,
1222
+ type BulkAddUsersParams as BulkAddUsersParams,
1223
+ type BulkCreateJobParams as BulkCreateJobParams,
1224
+ type BulkListUsersParams as BulkListUsersParams,
1225
+ };
1226
+
1202
1227
  export {
1203
1228
  Brands as Brands,
1204
1229
  type Brand as Brand,
@@ -14,6 +14,13 @@ export class Audiences extends APIResource {
14
14
  /**
15
15
  * Returns one audience with its name, description, and the filter and AND or OR
16
16
  * operator that decide which users belong to it.
17
+ *
18
+ * @example
19
+ * ```ts
20
+ * const audience = await client.audiences.retrieve(
21
+ * 'audience_id',
22
+ * );
23
+ * ```
17
24
  */
18
25
  retrieve(audienceID: string, options?: RequestOptions): APIPromise<Audience> {
19
26
  return this._client.get(path`/audiences/${audienceID}`, options);
@@ -22,6 +29,28 @@ export class Audiences extends APIResource {
22
29
  /**
23
30
  * Creates or replaces an audience from a filter and an AND or OR operator.
24
31
  * Membership recalculates automatically as profiles change.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const audience = await client.audiences.update(
36
+ * 'audience_id',
37
+ * {
38
+ * description: 'Users located in the US',
39
+ * filter: {
40
+ * operator: 'AND',
41
+ * filters: [
42
+ * {
43
+ * operator: 'EQ',
44
+ * path: 'profile.location',
45
+ * value: 'US',
46
+ * },
47
+ * ],
48
+ * },
49
+ * name: 'Engaged US Users',
50
+ * operator: 'AND',
51
+ * },
52
+ * );
53
+ * ```
25
54
  */
26
55
  update(
27
56
  audienceID: string,
@@ -34,6 +63,11 @@ export class Audiences extends APIResource {
34
63
  /**
35
64
  * Returns the audiences in the workspace with paging. Audiences are filter-based
36
65
  * groups that recalculate as user profiles change.
66
+ *
67
+ * @example
68
+ * ```ts
69
+ * const audiences = await client.audiences.list();
70
+ * ```
37
71
  */
38
72
  list(
39
73
  query: AudienceListParams | null | undefined = {},
@@ -45,6 +79,11 @@ export class Audiences extends APIResource {
45
79
  /**
46
80
  * Deletes an audience permanently, so update any caller sending to it by audience
47
81
  * id first. Those sends fail once the audience is gone.
82
+ *
83
+ * @example
84
+ * ```ts
85
+ * await client.audiences.delete('audience_id');
86
+ * ```
48
87
  */
49
88
  delete(audienceID: string, options?: RequestOptions): APIPromise<void> {
50
89
  return this._client.delete(path`/audiences/${audienceID}`, {
@@ -56,6 +95,13 @@ export class Audiences extends APIResource {
56
95
  /**
57
96
  * Returns the users currently matching an audience filter, with paging. Membership
58
97
  * is recalculated, so results shift as profiles change.
98
+ *
99
+ * @example
100
+ * ```ts
101
+ * const response = await client.audiences.listMembers(
102
+ * 'audience_id',
103
+ * );
104
+ * ```
59
105
  */
60
106
  listMembers(
61
107
  audienceID: string,
@@ -68,7 +68,11 @@ export class Invoke extends APIResource {
68
68
  * const automationInvokeResponse =
69
69
  * await client.automations.invoke.invokeByTemplate(
70
70
  * 'templateId',
71
- * { recipient: 'recipient' },
71
+ * {
72
+ * recipient: 'user_abc',
73
+ * data: { orderId: '1234' },
74
+ * profile: { email: 'jdoe@example.com' },
75
+ * },
72
76
  * );
73
77
  * ```
74
78
  */
@@ -67,7 +67,10 @@ export class Brands extends APIResource {
67
67
  * @example
68
68
  * ```ts
69
69
  * const brand = await client.brands.update('brand_id', {
70
- * name: 'name',
70
+ * name: 'My Brand',
71
+ * settings: {
72
+ * colors: { primary: '#9D3789', secondary: '#FFFFFF' },
73
+ * },
71
74
  * });
72
75
  * ```
73
76
  */
@@ -0,0 +1,254 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../core/resource';
4
+ import * as BulkAPI from './bulk';
5
+ import * as Shared from './shared';
6
+ import { APIPromise } from '../core/api-promise';
7
+ import { buildHeaders } from '../internal/headers';
8
+ import { RequestOptions } from '../internal/request-options';
9
+ import { path } from '../internal/utils/path';
10
+
11
+ export class Bulk extends APIResource {
12
+ /**
13
+ * Ingest user data into a Bulk Job.
14
+ *
15
+ * **Important**: For email-based bulk jobs, each user must include `profile.email`
16
+ * for provider routing to work correctly. The `to.email` field is not sufficient
17
+ * for email provider routing.
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * await client.bulk.addUsers('job_id', {
22
+ * users: [
23
+ * {
24
+ * recipient: 'user_abc',
25
+ * profile: { email: 'jdoe@example.com' },
26
+ * data: { name: 'Jane' },
27
+ * },
28
+ * ],
29
+ * });
30
+ * ```
31
+ */
32
+ addUsers(jobID: string, body: BulkAddUsersParams, options?: RequestOptions): APIPromise<void> {
33
+ return this._client.post(path`/bulk/${jobID}`, {
34
+ body,
35
+ ...options,
36
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
37
+ });
38
+ }
39
+
40
+ /**
41
+ * Creates a new bulk job for sending messages to multiple recipients.
42
+ *
43
+ * **Required**: `message.event` (event ID or notification ID)
44
+ *
45
+ * **Optional (V2 format)**: `message.template` (notification ID) or
46
+ * `message.content` (Elemental content) can be provided to override the
47
+ * notification associated with the event.
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const response = await client.bulk.createJob({
52
+ * message: {
53
+ * event: 'welcome-series',
54
+ * brand: 'bnd_01kx4mrd0pfzw8wt7pn7p2fzag',
55
+ * data: { campaign: 'spring-2024' },
56
+ * },
57
+ * });
58
+ * ```
59
+ */
60
+ createJob(body: BulkCreateJobParams, options?: RequestOptions): APIPromise<BulkCreateJobResponse> {
61
+ return this._client.post('/bulk', { body, ...options });
62
+ }
63
+
64
+ /**
65
+ * Returns the users ingested into a bulk job with paging, each carrying the status
66
+ * Courier recorded for it and the id of the message it produced.
67
+ *
68
+ * @example
69
+ * ```ts
70
+ * const response = await client.bulk.listUsers('job_id');
71
+ * ```
72
+ */
73
+ listUsers(
74
+ jobID: string,
75
+ query: BulkListUsersParams | null | undefined = {},
76
+ options?: RequestOptions,
77
+ ): APIPromise<BulkListUsersResponse> {
78
+ return this._client.get(path`/bulk/${jobID}/users`, { query, ...options });
79
+ }
80
+
81
+ /**
82
+ * Returns a bulk job's message definition, its status — CREATED, PROCESSING,
83
+ * COMPLETED, or ERROR — and running counts of users received, messages enqueued,
84
+ * and failures. Poll it to follow a job through to completion.
85
+ *
86
+ * @example
87
+ * ```ts
88
+ * const response = await client.bulk.retrieveJob('job_id');
89
+ * ```
90
+ */
91
+ retrieveJob(jobID: string, options?: RequestOptions): APIPromise<BulkRetrieveJobResponse> {
92
+ return this._client.get(path`/bulk/${jobID}`, options);
93
+ }
94
+
95
+ /**
96
+ * Starts processing a bulk job, sending to every user ingested into it. Returns
97
+ * 204 immediately; the job runs asynchronously, so poll the job to watch its
98
+ * status and counts.
99
+ *
100
+ * @example
101
+ * ```ts
102
+ * await client.bulk.runJob('job_id');
103
+ * ```
104
+ */
105
+ runJob(jobID: string, options?: RequestOptions): APIPromise<void> {
106
+ return this._client.post(path`/bulk/${jobID}/run`, {
107
+ ...options,
108
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
109
+ });
110
+ }
111
+ }
112
+
113
+ /**
114
+ * Bulk message definition. Supports two formats:
115
+ *
116
+ * - V1 format: Requires `event` field (event ID or notification ID)
117
+ * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
118
+ * content) in addition to `event`
119
+ */
120
+ export interface InboundBulkMessage {
121
+ /**
122
+ * Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
123
+ * "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
124
+ * mapped to a notification.
125
+ */
126
+ event: string;
127
+
128
+ brand?: string | null;
129
+
130
+ /**
131
+ * Elemental content (optional, for V2 format). When provided, this will be used
132
+ * instead of the notification associated with the `event` field.
133
+ */
134
+ content?: Shared.ElementalContentSugar | Shared.ElementalContent | null;
135
+
136
+ data?: { [key: string]: unknown } | null;
137
+
138
+ locale?: { [key: string]: { [key: string]: unknown } } | null;
139
+
140
+ override?: { [key: string]: unknown } | null;
141
+
142
+ /**
143
+ * Notification ID or template ID (optional, for V2 format). When provided, this
144
+ * will be used instead of the notification associated with the `event` field.
145
+ */
146
+ template?: string | null;
147
+ }
148
+
149
+ export interface InboundBulkMessageUser {
150
+ /**
151
+ * User-specific data that will be merged with message.data
152
+ */
153
+ data?: unknown;
154
+
155
+ preferences?: Shared.RecipientPreferences | null;
156
+
157
+ /**
158
+ * User profile information. For email-based bulk jobs, `profile.email` is required
159
+ * for provider routing to determine if the message can be delivered. The email
160
+ * address should be provided here rather than in `to.email`.
161
+ */
162
+ profile?: { [key: string]: unknown } | null;
163
+
164
+ /**
165
+ * User ID (legacy field, use profile or to.user_id instead)
166
+ */
167
+ recipient?: string | null;
168
+
169
+ /**
170
+ * Optional recipient information. Note: For email provider routing, use
171
+ * `profile.email` instead of `to.email`. The `to` field is primarily used for
172
+ * recipient identification and data merging.
173
+ */
174
+ to?: Shared.UserRecipient | null;
175
+ }
176
+
177
+ export interface BulkCreateJobResponse {
178
+ jobId: string;
179
+ }
180
+
181
+ export interface BulkListUsersResponse {
182
+ items: Array<BulkListUsersResponse.Item>;
183
+
184
+ paging: Shared.Paging;
185
+ }
186
+
187
+ export namespace BulkListUsersResponse {
188
+ export interface Item extends BulkAPI.InboundBulkMessageUser {
189
+ status: 'PENDING' | 'ENQUEUED' | 'ERROR';
190
+
191
+ messageId?: string | null;
192
+ }
193
+ }
194
+
195
+ export interface BulkRetrieveJobResponse {
196
+ job: BulkRetrieveJobResponse.Job;
197
+ }
198
+
199
+ export namespace BulkRetrieveJobResponse {
200
+ export interface Job {
201
+ /**
202
+ * Bulk message definition. Supports two formats:
203
+ *
204
+ * - V1 format: Requires `event` field (event ID or notification ID)
205
+ * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
206
+ * content) in addition to `event`
207
+ */
208
+ definition: BulkAPI.InboundBulkMessage;
209
+
210
+ enqueued: number;
211
+
212
+ failures: number;
213
+
214
+ received: number;
215
+
216
+ status: 'CREATED' | 'PROCESSING' | 'COMPLETED' | 'ERROR';
217
+ }
218
+ }
219
+
220
+ export interface BulkAddUsersParams {
221
+ users: Array<InboundBulkMessageUser>;
222
+ }
223
+
224
+ export interface BulkCreateJobParams {
225
+ /**
226
+ * Bulk message definition. Supports two formats:
227
+ *
228
+ * - V1 format: Requires `event` field (event ID or notification ID)
229
+ * - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
230
+ * content) in addition to `event`
231
+ */
232
+ message: InboundBulkMessage;
233
+ }
234
+
235
+ export interface BulkListUsersParams {
236
+ /**
237
+ * A unique identifier that allows for fetching the next set of users added to the
238
+ * bulk job
239
+ */
240
+ cursor?: string | null;
241
+ }
242
+
243
+ export declare namespace Bulk {
244
+ export {
245
+ type InboundBulkMessage as InboundBulkMessage,
246
+ type InboundBulkMessageUser as InboundBulkMessageUser,
247
+ type BulkCreateJobResponse as BulkCreateJobResponse,
248
+ type BulkListUsersResponse as BulkListUsersResponse,
249
+ type BulkRetrieveJobResponse as BulkRetrieveJobResponse,
250
+ type BulkAddUsersParams as BulkAddUsersParams,
251
+ type BulkCreateJobParams as BulkCreateJobParams,
252
+ type BulkListUsersParams as BulkListUsersParams,
253
+ };
254
+ }
@@ -63,6 +63,17 @@ export {
63
63
  type BroadcastScheduleParams,
64
64
  type BroadcastSendParams,
65
65
  } from './broadcasts';
66
+ export {
67
+ Bulk,
68
+ type InboundBulkMessage,
69
+ type InboundBulkMessageUser,
70
+ type BulkCreateJobResponse,
71
+ type BulkListUsersResponse,
72
+ type BulkRetrieveJobResponse,
73
+ type BulkAddUsersParams,
74
+ type BulkCreateJobParams,
75
+ type BulkListUsersParams,
76
+ } from './bulk';
66
77
  export {
67
78
  Digests,
68
79
  type DigestCategory,
@@ -44,7 +44,9 @@ export class Lists extends APIResource {
44
44
  *
45
45
  * @example
46
46
  * ```ts
47
- * await client.lists.update('list_id', { name: 'name' });
47
+ * await client.lists.update('list_id', {
48
+ * name: 'Product Updates',
49
+ * });
48
50
  * ```
49
51
  */
50
52
  update(listID: string, body: ListUpdateParams, options?: RequestOptions): APIPromise<void> {
@@ -38,7 +38,10 @@ export class Subscriptions extends APIResource {
38
38
  * @example
39
39
  * ```ts
40
40
  * await client.lists.subscriptions.add('list_id', {
41
- * recipients: [{ recipientId: 'recipientId' }],
41
+ * recipients: [
42
+ * { recipientId: 'user_abc' },
43
+ * { recipientId: 'user_def' },
44
+ * ],
42
45
  * });
43
46
  * ```
44
47
  */
@@ -71,7 +74,10 @@ export class Subscriptions extends APIResource {
71
74
  * @example
72
75
  * ```ts
73
76
  * await client.lists.subscriptions.subscribe('list_id', {
74
- * recipients: [{ recipientId: 'recipientId' }],
77
+ * recipients: [
78
+ * { recipientId: 'user_abc' },
79
+ * { recipientId: 'user_def' },
80
+ * ],
75
81
  * });
76
82
  * ```
77
83
  */
@@ -91,6 +97,11 @@ export class Subscriptions extends APIResource {
91
97
  * ```ts
92
98
  * await client.lists.subscriptions.subscribeUser('user_id', {
93
99
  * list_id: 'list_id',
100
+ * preferences: {
101
+ * notifications: {
102
+ * nt_01kx4h2jdafq8bk9aftxak4b40: { status: 'OPTED_IN' },
103
+ * },
104
+ * },
94
105
  * });
95
106
  * ```
96
107
  */
@@ -23,9 +23,9 @@ export class Checks extends APIResource {
23
23
  * id: 'id',
24
24
  * checks: [
25
25
  * {
26
- * id: 'id',
27
- * status: 'RESOLVED',
26
+ * id: 'abc-123',
28
27
  * type: 'custom',
28
+ * status: 'RESOLVED',
29
29
  * },
30
30
  * ],
31
31
  * },
@@ -52,7 +52,7 @@ export class Lists extends APIResource {
52
52
  * ```ts
53
53
  * const response = await client.profiles.lists.subscribe(
54
54
  * 'user_id',
55
- * { lists: [{ listId: 'listId' }] },
55
+ * { lists: [{ listId: 'example.list.id' }] },
56
56
  * );
57
57
  * ```
58
58
  */
@@ -29,7 +29,10 @@ export class Profiles extends APIResource {
29
29
  * @example
30
30
  * ```ts
31
31
  * const profile = await client.profiles.create('user_id', {
32
- * profile: { foo: 'bar' },
32
+ * profile: {
33
+ * email: 'jdoe@example.com',
34
+ * phone_number: '+15558675309',
35
+ * },
33
36
  * });
34
37
  * ```
35
38
  */
@@ -80,9 +83,9 @@ export class Profiles extends APIResource {
80
83
  * await client.profiles.update('user_id', {
81
84
  * patch: [
82
85
  * {
83
- * op: 'op',
84
- * path: 'path',
85
- * value: 'value',
86
+ * op: 'replace',
87
+ * path: '/email',
88
+ * value: 'jdoe@example.com',
86
89
  * },
87
90
  * ],
88
91
  * });
@@ -119,7 +122,11 @@ export class Profiles extends APIResource {
119
122
  * @example
120
123
  * ```ts
121
124
  * const response = await client.profiles.replace('user_id', {
122
- * profile: { foo: 'bar' },
125
+ * profile: {
126
+ * email: 'jdoe@example.com',
127
+ * phone_number: '+15558675309',
128
+ * locale: 'en-US',
129
+ * },
123
130
  * });
124
131
  * ```
125
132
  */
@@ -22,7 +22,9 @@ export class Providers extends APIResource {
22
22
  * @example
23
23
  * ```ts
24
24
  * const provider = await client.providers.create({
25
- * provider: 'provider',
25
+ * provider: 'sendgrid',
26
+ * settings: { api_key: 'SG.xxxxxxxx' },
27
+ * title: 'Production SendGrid',
26
28
  * });
27
29
  * ```
28
30
  */
@@ -67,7 +69,9 @@ export class Providers extends APIResource {
67
69
  * @example
68
70
  * ```ts
69
71
  * const provider = await client.providers.update('id', {
70
- * provider: 'provider',
72
+ * provider: 'sendgrid',
73
+ * settings: { api_key: 'SG.xxxxxxxx' },
74
+ * title: 'Production SendGrid',
71
75
  * });
72
76
  * ```
73
77
  */