@trycourier/courier 7.21.0 → 7.23.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 (358) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/client.d.mts +60 -0
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +60 -0
  5. package/client.d.ts.map +1 -1
  6. package/client.js +60 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +60 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/audiences.d.mts +13 -5
  12. package/resources/audiences.d.mts.map +1 -1
  13. package/resources/audiences.d.ts +13 -5
  14. package/resources/audiences.d.ts.map +1 -1
  15. package/resources/audiences.js +13 -5
  16. package/resources/audiences.js.map +1 -1
  17. package/resources/audiences.mjs +13 -5
  18. package/resources/audiences.mjs.map +1 -1
  19. package/resources/audit-events.d.mts +7 -2
  20. package/resources/audit-events.d.mts.map +1 -1
  21. package/resources/audit-events.d.ts +7 -2
  22. package/resources/audit-events.d.ts.map +1 -1
  23. package/resources/audit-events.js +7 -2
  24. package/resources/audit-events.js.map +1 -1
  25. package/resources/audit-events.mjs +7 -2
  26. package/resources/audit-events.mjs.map +1 -1
  27. package/resources/auth.d.mts +5 -1
  28. package/resources/auth.d.mts.map +1 -1
  29. package/resources/auth.d.ts +5 -1
  30. package/resources/auth.d.ts.map +1 -1
  31. package/resources/auth.js +5 -1
  32. package/resources/auth.js.map +1 -1
  33. package/resources/auth.mjs +5 -1
  34. package/resources/auth.mjs.map +1 -1
  35. package/resources/automations/automations.d.mts +5 -1
  36. package/resources/automations/automations.d.mts.map +1 -1
  37. package/resources/automations/automations.d.ts +5 -1
  38. package/resources/automations/automations.d.ts.map +1 -1
  39. package/resources/automations/automations.js +5 -1
  40. package/resources/automations/automations.js.map +1 -1
  41. package/resources/automations/automations.mjs +5 -1
  42. package/resources/automations/automations.mjs.map +1 -1
  43. package/resources/automations/invoke.d.mts +74 -7
  44. package/resources/automations/invoke.d.mts.map +1 -1
  45. package/resources/automations/invoke.d.ts +74 -7
  46. package/resources/automations/invoke.d.ts.map +1 -1
  47. package/resources/automations/invoke.js +38 -9
  48. package/resources/automations/invoke.js.map +1 -1
  49. package/resources/automations/invoke.mjs +38 -9
  50. package/resources/automations/invoke.mjs.map +1 -1
  51. package/resources/brands.d.mts +42 -7
  52. package/resources/brands.d.mts.map +1 -1
  53. package/resources/brands.d.ts +42 -7
  54. package/resources/brands.d.ts.map +1 -1
  55. package/resources/brands.js +28 -8
  56. package/resources/brands.js.map +1 -1
  57. package/resources/brands.mjs +28 -8
  58. package/resources/brands.mjs.map +1 -1
  59. package/resources/broadcasts.d.mts +381 -0
  60. package/resources/broadcasts.d.mts.map +1 -0
  61. package/resources/broadcasts.d.ts +381 -0
  62. package/resources/broadcasts.d.ts.map +1 -0
  63. package/resources/broadcasts.js +181 -0
  64. package/resources/broadcasts.js.map +1 -0
  65. package/resources/broadcasts.mjs +177 -0
  66. package/resources/broadcasts.mjs.map +1 -0
  67. package/resources/digests/schedules.d.mts +5 -3
  68. package/resources/digests/schedules.d.mts.map +1 -1
  69. package/resources/digests/schedules.d.ts +5 -3
  70. package/resources/digests/schedules.d.ts.map +1 -1
  71. package/resources/digests/schedules.js +5 -3
  72. package/resources/digests/schedules.js.map +1 -1
  73. package/resources/digests/schedules.mjs +5 -3
  74. package/resources/digests/schedules.mjs.map +1 -1
  75. package/resources/inbound.d.mts +5 -1
  76. package/resources/inbound.d.mts.map +1 -1
  77. package/resources/inbound.d.ts +5 -1
  78. package/resources/inbound.d.ts.map +1 -1
  79. package/resources/inbound.js +5 -1
  80. package/resources/inbound.js.map +1 -1
  81. package/resources/inbound.mjs +5 -1
  82. package/resources/inbound.mjs.map +1 -1
  83. package/resources/inbox/inbox.d.mts +10 -0
  84. package/resources/inbox/inbox.d.mts.map +1 -0
  85. package/resources/inbox/inbox.d.ts +10 -0
  86. package/resources/inbox/inbox.d.ts.map +1 -0
  87. package/resources/inbox/inbox.js +17 -0
  88. package/resources/inbox/inbox.js.map +1 -0
  89. package/resources/inbox/inbox.mjs +12 -0
  90. package/resources/inbox/inbox.mjs.map +1 -0
  91. package/resources/inbox/index.d.mts +3 -0
  92. package/resources/inbox/index.d.mts.map +1 -0
  93. package/resources/inbox/index.d.ts +3 -0
  94. package/resources/inbox/index.d.ts.map +1 -0
  95. package/resources/inbox/index.js +9 -0
  96. package/resources/inbox/index.js.map +1 -0
  97. package/resources/inbox/index.mjs +4 -0
  98. package/resources/inbox/index.mjs.map +1 -0
  99. package/resources/inbox/messages.d.mts +23 -0
  100. package/resources/inbox/messages.d.mts.map +1 -0
  101. package/resources/inbox/messages.d.ts +23 -0
  102. package/resources/inbox/messages.d.ts.map +1 -0
  103. package/resources/inbox/messages.js +34 -0
  104. package/resources/inbox/messages.js.map +1 -0
  105. package/resources/inbox/messages.mjs +30 -0
  106. package/resources/inbox/messages.mjs.map +1 -0
  107. package/resources/inbox.d.mts +2 -0
  108. package/resources/inbox.d.mts.map +1 -0
  109. package/resources/inbox.d.ts +2 -0
  110. package/resources/inbox.d.ts.map +1 -0
  111. package/resources/inbox.js +6 -0
  112. package/resources/inbox.js.map +1 -0
  113. package/resources/inbox.mjs +3 -0
  114. package/resources/inbox.mjs.map +1 -0
  115. package/resources/index.d.mts +2 -0
  116. package/resources/index.d.mts.map +1 -1
  117. package/resources/index.d.ts +2 -0
  118. package/resources/index.d.ts.map +1 -1
  119. package/resources/index.js +5 -1
  120. package/resources/index.js.map +1 -1
  121. package/resources/index.mjs +2 -0
  122. package/resources/index.mjs.map +1 -1
  123. package/resources/journeys/journeys.d.mts +130 -39
  124. package/resources/journeys/journeys.d.mts.map +1 -1
  125. package/resources/journeys/journeys.d.ts +130 -39
  126. package/resources/journeys/journeys.d.ts.map +1 -1
  127. package/resources/journeys/journeys.js +79 -34
  128. package/resources/journeys/journeys.js.map +1 -1
  129. package/resources/journeys/journeys.mjs +79 -34
  130. package/resources/journeys/journeys.mjs.map +1 -1
  131. package/resources/journeys/templates.d.mts +60 -17
  132. package/resources/journeys/templates.d.mts.map +1 -1
  133. package/resources/journeys/templates.d.ts +60 -17
  134. package/resources/journeys/templates.d.ts.map +1 -1
  135. package/resources/journeys/templates.js +41 -20
  136. package/resources/journeys/templates.js.map +1 -1
  137. package/resources/journeys/templates.mjs +41 -20
  138. package/resources/journeys/templates.mjs.map +1 -1
  139. package/resources/lists/lists.d.mts +40 -5
  140. package/resources/lists/lists.d.mts.map +1 -1
  141. package/resources/lists/lists.d.ts +40 -5
  142. package/resources/lists/lists.d.ts.map +1 -1
  143. package/resources/lists/lists.js +40 -5
  144. package/resources/lists/lists.js.map +1 -1
  145. package/resources/lists/lists.mjs +40 -5
  146. package/resources/lists/lists.mjs.map +1 -1
  147. package/resources/lists/subscriptions.d.mts +65 -5
  148. package/resources/lists/subscriptions.d.mts.map +1 -1
  149. package/resources/lists/subscriptions.d.ts +65 -5
  150. package/resources/lists/subscriptions.d.ts.map +1 -1
  151. package/resources/lists/subscriptions.js +57 -6
  152. package/resources/lists/subscriptions.js.map +1 -1
  153. package/resources/lists/subscriptions.mjs +57 -6
  154. package/resources/lists/subscriptions.mjs.map +1 -1
  155. package/resources/messages.d.mts +15 -14
  156. package/resources/messages.d.mts.map +1 -1
  157. package/resources/messages.d.ts +15 -14
  158. package/resources/messages.d.ts.map +1 -1
  159. package/resources/messages.js +15 -14
  160. package/resources/messages.js.map +1 -1
  161. package/resources/messages.mjs +15 -14
  162. package/resources/messages.mjs.map +1 -1
  163. package/resources/notifications/checks.d.mts +9 -3
  164. package/resources/notifications/checks.d.mts.map +1 -1
  165. package/resources/notifications/checks.d.ts +9 -3
  166. package/resources/notifications/checks.d.ts.map +1 -1
  167. package/resources/notifications/checks.js +9 -3
  168. package/resources/notifications/checks.js.map +1 -1
  169. package/resources/notifications/checks.mjs +9 -3
  170. package/resources/notifications/checks.mjs.map +1 -1
  171. package/resources/notifications/notifications.d.mts +62 -29
  172. package/resources/notifications/notifications.d.mts.map +1 -1
  173. package/resources/notifications/notifications.d.ts +62 -29
  174. package/resources/notifications/notifications.d.ts.map +1 -1
  175. package/resources/notifications/notifications.js +49 -26
  176. package/resources/notifications/notifications.js.map +1 -1
  177. package/resources/notifications/notifications.mjs +49 -26
  178. package/resources/notifications/notifications.mjs.map +1 -1
  179. package/resources/profiles/lists.d.mts +49 -5
  180. package/resources/profiles/lists.d.mts.map +1 -1
  181. package/resources/profiles/lists.d.ts +49 -5
  182. package/resources/profiles/lists.d.ts.map +1 -1
  183. package/resources/profiles/lists.js +45 -6
  184. package/resources/profiles/lists.js.map +1 -1
  185. package/resources/profiles/lists.mjs +45 -6
  186. package/resources/profiles/lists.mjs.map +1 -1
  187. package/resources/profiles/profiles.d.mts +70 -11
  188. package/resources/profiles/profiles.d.mts.map +1 -1
  189. package/resources/profiles/profiles.d.ts +70 -11
  190. package/resources/profiles/profiles.d.ts.map +1 -1
  191. package/resources/profiles/profiles.js +65 -12
  192. package/resources/profiles/profiles.js.map +1 -1
  193. package/resources/profiles/profiles.mjs +65 -12
  194. package/resources/profiles/profiles.mjs.map +1 -1
  195. package/resources/providers/catalog.d.mts +10 -4
  196. package/resources/providers/catalog.d.mts.map +1 -1
  197. package/resources/providers/catalog.d.ts +10 -4
  198. package/resources/providers/catalog.d.ts.map +1 -1
  199. package/resources/providers/catalog.js +10 -4
  200. package/resources/providers/catalog.js.map +1 -1
  201. package/resources/providers/catalog.mjs +10 -4
  202. package/resources/providers/catalog.mjs.map +1 -1
  203. package/resources/providers/providers.d.mts +68 -22
  204. package/resources/providers/providers.d.mts.map +1 -1
  205. package/resources/providers/providers.d.ts +68 -22
  206. package/resources/providers/providers.d.ts.map +1 -1
  207. package/resources/providers/providers.js +57 -14
  208. package/resources/providers/providers.js.map +1 -1
  209. package/resources/providers/providers.mjs +57 -14
  210. package/resources/providers/providers.mjs.map +1 -1
  211. package/resources/requests.d.mts +5 -1
  212. package/resources/requests.d.mts.map +1 -1
  213. package/resources/requests.d.ts +5 -1
  214. package/resources/requests.d.ts.map +1 -1
  215. package/resources/requests.js +5 -1
  216. package/resources/requests.js.map +1 -1
  217. package/resources/requests.mjs +5 -1
  218. package/resources/requests.mjs.map +1 -1
  219. package/resources/routing-strategies.d.mts +30 -11
  220. package/resources/routing-strategies.d.mts.map +1 -1
  221. package/resources/routing-strategies.d.ts +30 -11
  222. package/resources/routing-strategies.d.ts.map +1 -1
  223. package/resources/routing-strategies.js +22 -6
  224. package/resources/routing-strategies.js.map +1 -1
  225. package/resources/routing-strategies.mjs +22 -6
  226. package/resources/routing-strategies.mjs.map +1 -1
  227. package/resources/send.d.mts +24 -4
  228. package/resources/send.d.mts.map +1 -1
  229. package/resources/send.d.ts +24 -4
  230. package/resources/send.d.ts.map +1 -1
  231. package/resources/send.js +21 -3
  232. package/resources/send.js.map +1 -1
  233. package/resources/send.mjs +21 -3
  234. package/resources/send.mjs.map +1 -1
  235. package/resources/tenants/preferences/items.d.mts +7 -2
  236. package/resources/tenants/preferences/items.d.mts.map +1 -1
  237. package/resources/tenants/preferences/items.d.ts +7 -2
  238. package/resources/tenants/preferences/items.d.ts.map +1 -1
  239. package/resources/tenants/preferences/items.js +7 -2
  240. package/resources/tenants/preferences/items.js.map +1 -1
  241. package/resources/tenants/preferences/items.mjs +7 -2
  242. package/resources/tenants/preferences/items.mjs.map +1 -1
  243. package/resources/tenants/templates/templates.d.mts +13 -19
  244. package/resources/tenants/templates/templates.d.mts.map +1 -1
  245. package/resources/tenants/templates/templates.d.ts +13 -19
  246. package/resources/tenants/templates/templates.d.ts.map +1 -1
  247. package/resources/tenants/templates/templates.js +13 -19
  248. package/resources/tenants/templates/templates.js.map +1 -1
  249. package/resources/tenants/templates/templates.mjs +13 -19
  250. package/resources/tenants/templates/templates.mjs.map +1 -1
  251. package/resources/tenants/templates/versions.d.mts +5 -7
  252. package/resources/tenants/templates/versions.d.mts.map +1 -1
  253. package/resources/tenants/templates/versions.d.ts +5 -7
  254. package/resources/tenants/templates/versions.d.ts.map +1 -1
  255. package/resources/tenants/templates/versions.js +5 -7
  256. package/resources/tenants/templates/versions.js.map +1 -1
  257. package/resources/tenants/templates/versions.mjs +5 -7
  258. package/resources/tenants/templates/versions.mjs.map +1 -1
  259. package/resources/tenants/tenants.d.mts +13 -5
  260. package/resources/tenants/tenants.d.mts.map +1 -1
  261. package/resources/tenants/tenants.d.ts +13 -5
  262. package/resources/tenants/tenants.d.ts.map +1 -1
  263. package/resources/tenants/tenants.js +13 -5
  264. package/resources/tenants/tenants.js.map +1 -1
  265. package/resources/tenants/tenants.mjs +13 -5
  266. package/resources/tenants/tenants.mjs.map +1 -1
  267. package/resources/translations.d.mts +7 -2
  268. package/resources/translations.d.mts.map +1 -1
  269. package/resources/translations.d.ts +7 -2
  270. package/resources/translations.d.ts.map +1 -1
  271. package/resources/translations.js +7 -2
  272. package/resources/translations.js.map +1 -1
  273. package/resources/translations.mjs +7 -2
  274. package/resources/translations.mjs.map +1 -1
  275. package/resources/users/preferences.d.mts +64 -42
  276. package/resources/users/preferences.d.mts.map +1 -1
  277. package/resources/users/preferences.d.ts +64 -42
  278. package/resources/users/preferences.d.ts.map +1 -1
  279. package/resources/users/preferences.js +30 -42
  280. package/resources/users/preferences.js.map +1 -1
  281. package/resources/users/preferences.mjs +30 -42
  282. package/resources/users/preferences.mjs.map +1 -1
  283. package/resources/users/tenants.d.mts +13 -10
  284. package/resources/users/tenants.d.mts.map +1 -1
  285. package/resources/users/tenants.d.ts +13 -10
  286. package/resources/users/tenants.d.ts.map +1 -1
  287. package/resources/users/tenants.js +13 -10
  288. package/resources/users/tenants.js.map +1 -1
  289. package/resources/users/tenants.mjs +13 -10
  290. package/resources/users/tenants.mjs.map +1 -1
  291. package/resources/users/tokens.d.mts +15 -6
  292. package/resources/users/tokens.d.mts.map +1 -1
  293. package/resources/users/tokens.d.ts +15 -6
  294. package/resources/users/tokens.d.ts.map +1 -1
  295. package/resources/users/tokens.js +15 -6
  296. package/resources/users/tokens.js.map +1 -1
  297. package/resources/users/tokens.mjs +15 -6
  298. package/resources/users/tokens.mjs.map +1 -1
  299. package/resources/workspace-preferences/topics.d.mts +40 -18
  300. package/resources/workspace-preferences/topics.d.mts.map +1 -1
  301. package/resources/workspace-preferences/topics.d.ts +40 -18
  302. package/resources/workspace-preferences/topics.d.ts.map +1 -1
  303. package/resources/workspace-preferences/topics.js +26 -11
  304. package/resources/workspace-preferences/topics.js.map +1 -1
  305. package/resources/workspace-preferences/topics.mjs +26 -11
  306. package/resources/workspace-preferences/topics.mjs.map +1 -1
  307. package/resources/workspace-preferences/workspace-preferences.d.mts +56 -19
  308. package/resources/workspace-preferences/workspace-preferences.d.mts.map +1 -1
  309. package/resources/workspace-preferences/workspace-preferences.d.ts +56 -19
  310. package/resources/workspace-preferences/workspace-preferences.d.ts.map +1 -1
  311. package/resources/workspace-preferences/workspace-preferences.js +41 -13
  312. package/resources/workspace-preferences/workspace-preferences.js.map +1 -1
  313. package/resources/workspace-preferences/workspace-preferences.mjs +41 -13
  314. package/resources/workspace-preferences/workspace-preferences.mjs.map +1 -1
  315. package/src/client.ts +96 -0
  316. package/src/resources/audiences.ts +13 -5
  317. package/src/resources/audit-events.ts +7 -2
  318. package/src/resources/auth.ts +5 -1
  319. package/src/resources/automations/automations.ts +5 -1
  320. package/src/resources/automations/invoke.ts +115 -9
  321. package/src/resources/brands.ts +62 -8
  322. package/src/resources/broadcasts.ts +489 -0
  323. package/src/resources/digests/schedules.ts +5 -3
  324. package/src/resources/inbound.ts +5 -1
  325. package/src/resources/inbox/inbox.ts +15 -0
  326. package/src/resources/inbox/index.ts +4 -0
  327. package/src/resources/inbox/messages.ts +40 -0
  328. package/src/resources/inbox.ts +3 -0
  329. package/src/resources/index.ts +18 -0
  330. package/src/resources/journeys/journeys.ts +212 -43
  331. package/src/resources/journeys/templates.ts +98 -20
  332. package/src/resources/lists/lists.ts +40 -5
  333. package/src/resources/lists/subscriptions.ts +82 -6
  334. package/src/resources/messages.ts +15 -14
  335. package/src/resources/notifications/checks.ts +9 -3
  336. package/src/resources/notifications/notifications.ts +102 -31
  337. package/src/resources/profiles/lists.ts +70 -6
  338. package/src/resources/profiles/profiles.ts +90 -12
  339. package/src/resources/providers/catalog.ts +10 -4
  340. package/src/resources/providers/providers.ts +86 -21
  341. package/src/resources/requests.ts +5 -1
  342. package/src/resources/routing-strategies.ts +50 -12
  343. package/src/resources/send.ts +45 -5
  344. package/src/resources/tenants/preferences/items.ts +7 -2
  345. package/src/resources/tenants/templates/templates.ts +13 -19
  346. package/src/resources/tenants/templates/versions.ts +5 -7
  347. package/src/resources/tenants/tenants.ts +13 -5
  348. package/src/resources/translations.ts +7 -2
  349. package/src/resources/users/preferences.ts +86 -44
  350. package/src/resources/users/tenants.ts +13 -10
  351. package/src/resources/users/tokens.ts +15 -6
  352. package/src/resources/workspace-preferences/topics.ts +60 -19
  353. package/src/resources/workspace-preferences/workspace-preferences.ts +96 -21
  354. package/src/version.ts +1 -1
  355. package/version.d.mts +1 -1
  356. package/version.d.ts +1 -1
  357. package/version.js +1 -1
  358. package/version.mjs +1 -1
@@ -3,28 +3,69 @@ import * as Shared from "../shared.mjs";
3
3
  import * as ListsAPI from "./lists.mjs";
4
4
  import { APIPromise } from "../../core/api-promise.mjs";
5
5
  import { RequestOptions } from "../../internal/request-options.mjs";
6
+ /**
7
+ * Manage static groups of users that you subscribe explicitly, and send to them by list id or list pattern.
8
+ */
6
9
  export declare class Subscriptions extends APIResource {
7
10
  /**
8
- * Get the list's subscriptions.
11
+ * Returns the users subscribed to a list with paging, each with the preferences
12
+ * recorded for that subscription.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const subscriptions = await client.lists.subscriptions.list(
17
+ * 'list_id',
18
+ * );
19
+ * ```
9
20
  */
10
21
  list(listID: string, query?: SubscriptionListParams | null | undefined, options?: RequestOptions): APIPromise<SubscriptionListResponse>;
11
22
  /**
12
23
  * Subscribes additional users to the list, without modifying existing
13
24
  * subscriptions. If the list does not exist, it will be automatically created.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * await client.lists.subscriptions.add('list_id', {
29
+ * recipients: [{ recipientId: 'recipientId' }],
30
+ * });
31
+ * ```
14
32
  */
15
- add(listID: string, body: SubscriptionAddParams, options?: RequestOptions): APIPromise<void>;
33
+ add(listID: string, params: SubscriptionAddParams, options?: RequestOptions): APIPromise<void>;
16
34
  /**
17
35
  * Subscribes the users to the list, overwriting existing subscriptions. If the
18
36
  * list does not exist, it will be automatically created.
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * await client.lists.subscriptions.subscribe('list_id', {
41
+ * recipients: [{ recipientId: 'recipientId' }],
42
+ * });
43
+ * ```
19
44
  */
20
45
  subscribe(listID: string, body: SubscriptionSubscribeParams, options?: RequestOptions): APIPromise<void>;
21
46
  /**
22
- * Subscribe a user to an existing list (note: if the List does not exist, it will
23
- * be automatically created).
47
+ * Subscribes one user to a list, creating the list if it does not yet exist.
48
+ * Optional preferences apply to this subscription only.
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * await client.lists.subscriptions.subscribeUser('user_id', {
53
+ * list_id: 'list_id',
54
+ * });
55
+ * ```
24
56
  */
25
57
  subscribeUser(userID: string, params: SubscriptionSubscribeUserParams, options?: RequestOptions): APIPromise<void>;
26
58
  /**
27
- * Delete a subscription to a list by list ID and user ID.
59
+ * Removes one user's subscription to a list, addressed by list id and user id. The
60
+ * user's profile and other subscriptions are separate resources.
61
+ *
62
+ * @example
63
+ * ```ts
64
+ * await client.lists.subscriptions.unsubscribeUser(
65
+ * 'user_id',
66
+ * { list_id: 'list_id' },
67
+ * );
68
+ * ```
28
69
  */
29
70
  unsubscribeUser(userID: string, params: SubscriptionUnsubscribeUserParams, options?: RequestOptions): APIPromise<void>;
30
71
  }
@@ -46,7 +87,26 @@ export interface SubscriptionListParams {
46
87
  cursor?: string | null;
47
88
  }
48
89
  export interface SubscriptionAddParams {
90
+ /**
91
+ * Body param
92
+ */
49
93
  recipients: Array<ListsAPI.PutSubscriptionsRecipient>;
94
+ /**
95
+ * Header param: A unique key that makes this request idempotent. If Courier
96
+ * receives another request with the same `Idempotency-Key`, it returns the stored
97
+ * response from the first request without performing the operation again
98
+ * (including the original status code and any error). Use it to safely retry
99
+ * `POST` requests after network failures without risking duplicate sends. The key
100
+ * is scoped to this endpoint.
101
+ */
102
+ 'Idempotency-Key'?: string;
103
+ /**
104
+ * Header param: How long the idempotency key remains valid, as a Unix epoch
105
+ * timestamp in seconds or an ISO 8601 date string. Only applies when
106
+ * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
107
+ * maximum is 1 year.
108
+ */
109
+ 'x-idempotency-expiration'?: string;
50
110
  }
51
111
  export interface SubscriptionSubscribeParams {
52
112
  recipients: Array<ListsAPI.PutSubscriptionsRecipient>;
@@ -1 +1 @@
1
- {"version":3,"file":"subscriptions.d.mts","sourceRoot":"","sources":["../../src/resources/lists/subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;OAGG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ5F;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQxG;;;OAGG;IACH,aAAa,CACX,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;OAEG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAE5C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAClD;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
1
+ {"version":3,"file":"subscriptions.d.mts","sourceRoot":"","sources":["../../src/resources/lists/subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAsB9F;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQxG;;;;;;;;;;OAUG;IACH,aAAa,CACX,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;;;;;OAWG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAE5C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAClD;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
@@ -3,28 +3,69 @@ import * as Shared from "../shared.js";
3
3
  import * as ListsAPI from "./lists.js";
4
4
  import { APIPromise } from "../../core/api-promise.js";
5
5
  import { RequestOptions } from "../../internal/request-options.js";
6
+ /**
7
+ * Manage static groups of users that you subscribe explicitly, and send to them by list id or list pattern.
8
+ */
6
9
  export declare class Subscriptions extends APIResource {
7
10
  /**
8
- * Get the list's subscriptions.
11
+ * Returns the users subscribed to a list with paging, each with the preferences
12
+ * recorded for that subscription.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const subscriptions = await client.lists.subscriptions.list(
17
+ * 'list_id',
18
+ * );
19
+ * ```
9
20
  */
10
21
  list(listID: string, query?: SubscriptionListParams | null | undefined, options?: RequestOptions): APIPromise<SubscriptionListResponse>;
11
22
  /**
12
23
  * Subscribes additional users to the list, without modifying existing
13
24
  * subscriptions. If the list does not exist, it will be automatically created.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * await client.lists.subscriptions.add('list_id', {
29
+ * recipients: [{ recipientId: 'recipientId' }],
30
+ * });
31
+ * ```
14
32
  */
15
- add(listID: string, body: SubscriptionAddParams, options?: RequestOptions): APIPromise<void>;
33
+ add(listID: string, params: SubscriptionAddParams, options?: RequestOptions): APIPromise<void>;
16
34
  /**
17
35
  * Subscribes the users to the list, overwriting existing subscriptions. If the
18
36
  * list does not exist, it will be automatically created.
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * await client.lists.subscriptions.subscribe('list_id', {
41
+ * recipients: [{ recipientId: 'recipientId' }],
42
+ * });
43
+ * ```
19
44
  */
20
45
  subscribe(listID: string, body: SubscriptionSubscribeParams, options?: RequestOptions): APIPromise<void>;
21
46
  /**
22
- * Subscribe a user to an existing list (note: if the List does not exist, it will
23
- * be automatically created).
47
+ * Subscribes one user to a list, creating the list if it does not yet exist.
48
+ * Optional preferences apply to this subscription only.
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * await client.lists.subscriptions.subscribeUser('user_id', {
53
+ * list_id: 'list_id',
54
+ * });
55
+ * ```
24
56
  */
25
57
  subscribeUser(userID: string, params: SubscriptionSubscribeUserParams, options?: RequestOptions): APIPromise<void>;
26
58
  /**
27
- * Delete a subscription to a list by list ID and user ID.
59
+ * Removes one user's subscription to a list, addressed by list id and user id. The
60
+ * user's profile and other subscriptions are separate resources.
61
+ *
62
+ * @example
63
+ * ```ts
64
+ * await client.lists.subscriptions.unsubscribeUser(
65
+ * 'user_id',
66
+ * { list_id: 'list_id' },
67
+ * );
68
+ * ```
28
69
  */
29
70
  unsubscribeUser(userID: string, params: SubscriptionUnsubscribeUserParams, options?: RequestOptions): APIPromise<void>;
30
71
  }
@@ -46,7 +87,26 @@ export interface SubscriptionListParams {
46
87
  cursor?: string | null;
47
88
  }
48
89
  export interface SubscriptionAddParams {
90
+ /**
91
+ * Body param
92
+ */
49
93
  recipients: Array<ListsAPI.PutSubscriptionsRecipient>;
94
+ /**
95
+ * Header param: A unique key that makes this request idempotent. If Courier
96
+ * receives another request with the same `Idempotency-Key`, it returns the stored
97
+ * response from the first request without performing the operation again
98
+ * (including the original status code and any error). Use it to safely retry
99
+ * `POST` requests after network failures without risking duplicate sends. The key
100
+ * is scoped to this endpoint.
101
+ */
102
+ 'Idempotency-Key'?: string;
103
+ /**
104
+ * Header param: How long the idempotency key remains valid, as a Unix epoch
105
+ * timestamp in seconds or an ISO 8601 date string. Only applies when
106
+ * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
107
+ * maximum is 1 year.
108
+ */
109
+ 'x-idempotency-expiration'?: string;
50
110
  }
51
111
  export interface SubscriptionSubscribeParams {
52
112
  recipients: Array<ListsAPI.PutSubscriptionsRecipient>;
@@ -1 +1 @@
1
- {"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/resources/lists/subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;OAGG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ5F;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQxG;;;OAGG;IACH,aAAa,CACX,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;OAEG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAE5C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAClD;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
1
+ {"version":3,"file":"subscriptions.d.ts","sourceRoot":"","sources":["../../src/resources/lists/subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAsB9F;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQxG;;;;;;;;;;OAUG;IACH,aAAa,CACX,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;;;;;OAWG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAE5C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACvB;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;KAClD;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;IAEtD;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}
@@ -5,9 +5,20 @@ exports.Subscriptions = void 0;
5
5
  const resource_1 = require("../../core/resource.js");
6
6
  const headers_1 = require("../../internal/headers.js");
7
7
  const path_1 = require("../../internal/utils/path.js");
8
+ /**
9
+ * Manage static groups of users that you subscribe explicitly, and send to them by list id or list pattern.
10
+ */
8
11
  class Subscriptions extends resource_1.APIResource {
9
12
  /**
10
- * Get the list's subscriptions.
13
+ * Returns the users subscribed to a list with paging, each with the preferences
14
+ * recorded for that subscription.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const subscriptions = await client.lists.subscriptions.list(
19
+ * 'list_id',
20
+ * );
21
+ * ```
11
22
  */
12
23
  list(listID, query = {}, options) {
13
24
  return this._client.get((0, path_1.path) `/lists/${listID}/subscriptions`, { query, ...options });
@@ -15,17 +26,41 @@ class Subscriptions extends resource_1.APIResource {
15
26
  /**
16
27
  * Subscribes additional users to the list, without modifying existing
17
28
  * subscriptions. If the list does not exist, it will be automatically created.
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * await client.lists.subscriptions.add('list_id', {
33
+ * recipients: [{ recipientId: 'recipientId' }],
34
+ * });
35
+ * ```
18
36
  */
19
- add(listID, body, options) {
37
+ add(listID, params, options) {
38
+ const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
20
39
  return this._client.post((0, path_1.path) `/lists/${listID}/subscriptions`, {
21
40
  body,
22
41
  ...options,
23
- headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
42
+ headers: (0, headers_1.buildHeaders)([
43
+ {
44
+ Accept: '*/*',
45
+ ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
46
+ ...(xIdempotencyExpiration != null ?
47
+ { 'x-idempotency-expiration': xIdempotencyExpiration }
48
+ : undefined),
49
+ },
50
+ options?.headers,
51
+ ]),
24
52
  });
25
53
  }
26
54
  /**
27
55
  * Subscribes the users to the list, overwriting existing subscriptions. If the
28
56
  * list does not exist, it will be automatically created.
57
+ *
58
+ * @example
59
+ * ```ts
60
+ * await client.lists.subscriptions.subscribe('list_id', {
61
+ * recipients: [{ recipientId: 'recipientId' }],
62
+ * });
63
+ * ```
29
64
  */
30
65
  subscribe(listID, body, options) {
31
66
  return this._client.put((0, path_1.path) `/lists/${listID}/subscriptions`, {
@@ -35,8 +70,15 @@ class Subscriptions extends resource_1.APIResource {
35
70
  });
36
71
  }
37
72
  /**
38
- * Subscribe a user to an existing list (note: if the List does not exist, it will
39
- * be automatically created).
73
+ * Subscribes one user to a list, creating the list if it does not yet exist.
74
+ * Optional preferences apply to this subscription only.
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * await client.lists.subscriptions.subscribeUser('user_id', {
79
+ * list_id: 'list_id',
80
+ * });
81
+ * ```
40
82
  */
41
83
  subscribeUser(userID, params, options) {
42
84
  const { list_id, ...body } = params;
@@ -47,7 +89,16 @@ class Subscriptions extends resource_1.APIResource {
47
89
  });
48
90
  }
49
91
  /**
50
- * Delete a subscription to a list by list ID and user ID.
92
+ * Removes one user's subscription to a list, addressed by list id and user id. The
93
+ * user's profile and other subscriptions are separate resources.
94
+ *
95
+ * @example
96
+ * ```ts
97
+ * await client.lists.subscriptions.unsubscribeUser(
98
+ * 'user_id',
99
+ * { list_id: 'list_id' },
100
+ * );
101
+ * ```
51
102
  */
52
103
  unsubscribeUser(userID, params, options) {
53
104
  const { list_id } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../src/resources/lists/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;OAEG;IACH,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,MAAc,EAAE,IAA2B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,gBAAgB,EAAE;YAC7D,IAAI;YACJ,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;;;OAGG;IACH,SAAS,CAAC,MAAc,EAAE,IAAiC,EAAE,OAAwB;QACnF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,gBAAgB,EAAE;YAC5D,IAAI;YACJ,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;;;OAGG;IACH,aAAa,CACX,MAAc,EACd,MAAuC,EACvC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,kBAAkB,MAAM,EAAE,EAAE;YACvE,IAAI;YACJ,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;;OAEG;IACH,eAAe,CACb,MAAc,EACd,MAAyC,EACzC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,kBAAkB,MAAM,EAAE,EAAE;YAC1E,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;CACF;AAnED,sCAmEC"}
1
+ {"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../../src/resources/lists/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAc,EAAE,MAA6B,EAAE,OAAwB;QACzE,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,UAAU,MAAM,gBAAgB,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,MAAM,EAAE,KAAK;oBACb,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;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAc,EAAE,IAAiC,EAAE,OAAwB;QACnF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,gBAAgB,EAAE;YAC5D,IAAI;YACJ,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,aAAa,CACX,MAAc,EACd,MAAuC,EACvC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,kBAAkB,MAAM,EAAE,EAAE;YACvE,IAAI;YACJ,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;;;;;;;;;;;OAWG;IACH,eAAe,CACb,MAAc,EACd,MAAyC,EACzC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,UAAU,OAAO,kBAAkB,MAAM,EAAE,EAAE;YAC1E,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;CACF;AAvHD,sCAuHC"}
@@ -2,9 +2,20 @@
2
2
  import { APIResource } from "../../core/resource.mjs";
3
3
  import { buildHeaders } from "../../internal/headers.mjs";
4
4
  import { path } from "../../internal/utils/path.mjs";
5
+ /**
6
+ * Manage static groups of users that you subscribe explicitly, and send to them by list id or list pattern.
7
+ */
5
8
  export class Subscriptions extends APIResource {
6
9
  /**
7
- * Get the list's subscriptions.
10
+ * Returns the users subscribed to a list with paging, each with the preferences
11
+ * recorded for that subscription.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const subscriptions = await client.lists.subscriptions.list(
16
+ * 'list_id',
17
+ * );
18
+ * ```
8
19
  */
9
20
  list(listID, query = {}, options) {
10
21
  return this._client.get(path `/lists/${listID}/subscriptions`, { query, ...options });
@@ -12,17 +23,41 @@ export class Subscriptions extends APIResource {
12
23
  /**
13
24
  * Subscribes additional users to the list, without modifying existing
14
25
  * subscriptions. If the list does not exist, it will be automatically created.
26
+ *
27
+ * @example
28
+ * ```ts
29
+ * await client.lists.subscriptions.add('list_id', {
30
+ * recipients: [{ recipientId: 'recipientId' }],
31
+ * });
32
+ * ```
15
33
  */
16
- add(listID, body, options) {
34
+ add(listID, params, options) {
35
+ const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
17
36
  return this._client.post(path `/lists/${listID}/subscriptions`, {
18
37
  body,
19
38
  ...options,
20
- headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
39
+ headers: buildHeaders([
40
+ {
41
+ Accept: '*/*',
42
+ ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
43
+ ...(xIdempotencyExpiration != null ?
44
+ { 'x-idempotency-expiration': xIdempotencyExpiration }
45
+ : undefined),
46
+ },
47
+ options?.headers,
48
+ ]),
21
49
  });
22
50
  }
23
51
  /**
24
52
  * Subscribes the users to the list, overwriting existing subscriptions. If the
25
53
  * list does not exist, it will be automatically created.
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * await client.lists.subscriptions.subscribe('list_id', {
58
+ * recipients: [{ recipientId: 'recipientId' }],
59
+ * });
60
+ * ```
26
61
  */
27
62
  subscribe(listID, body, options) {
28
63
  return this._client.put(path `/lists/${listID}/subscriptions`, {
@@ -32,8 +67,15 @@ export class Subscriptions extends APIResource {
32
67
  });
33
68
  }
34
69
  /**
35
- * Subscribe a user to an existing list (note: if the List does not exist, it will
36
- * be automatically created).
70
+ * Subscribes one user to a list, creating the list if it does not yet exist.
71
+ * Optional preferences apply to this subscription only.
72
+ *
73
+ * @example
74
+ * ```ts
75
+ * await client.lists.subscriptions.subscribeUser('user_id', {
76
+ * list_id: 'list_id',
77
+ * });
78
+ * ```
37
79
  */
38
80
  subscribeUser(userID, params, options) {
39
81
  const { list_id, ...body } = params;
@@ -44,7 +86,16 @@ export class Subscriptions extends APIResource {
44
86
  });
45
87
  }
46
88
  /**
47
- * Delete a subscription to a list by list ID and user ID.
89
+ * Removes one user's subscription to a list, addressed by list id and user id. The
90
+ * user's profile and other subscriptions are separate resources.
91
+ *
92
+ * @example
93
+ * ```ts
94
+ * await client.lists.subscriptions.unsubscribeUser(
95
+ * 'user_id',
96
+ * { list_id: 'list_id' },
97
+ * );
98
+ * ```
48
99
  */
49
100
  unsubscribeUser(userID, params, options) {
50
101
  const { list_id } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../../src/resources/lists/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,MAAc,EAAE,IAA2B,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,UAAU,MAAM,gBAAgB,EAAE;YAC7D,IAAI;YACJ,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;;;OAGG;IACH,SAAS,CAAC,MAAc,EAAE,IAAiC,EAAE,OAAwB;QACnF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,gBAAgB,EAAE;YAC5D,IAAI;YACJ,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;;;OAGG;IACH,aAAa,CACX,MAAc,EACd,MAAuC,EACvC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,kBAAkB,MAAM,EAAE,EAAE;YACvE,IAAI;YACJ,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;;OAEG;IACH,eAAe,CACb,MAAc,EACd,MAAyC,EACzC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,OAAO,kBAAkB,MAAM,EAAE,EAAE;YAC1E,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../../src/resources/lists/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,IAAI,CACF,MAAc,EACd,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAc,EAAE,MAA6B,EAAE,OAAwB;QACzE,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,UAAU,MAAM,gBAAgB,EAAE;YAC7D,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,MAAM,EAAE,KAAK;oBACb,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;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAc,EAAE,IAAiC,EAAE,OAAwB;QACnF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,gBAAgB,EAAE;YAC5D,IAAI;YACJ,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,aAAa,CACX,MAAc,EACd,MAAuC,EACvC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,OAAO,kBAAkB,MAAM,EAAE,EAAE;YACvE,IAAI;YACJ,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;;;;;;;;;;;OAWG;IACH,eAAe,CACb,MAAc,EACd,MAAyC,EACzC,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,UAAU,OAAO,kBAAkB,MAAM,EAAE,EAAE;YAC1E,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -2,37 +2,38 @@ import { APIResource } from "../core/resource.mjs";
2
2
  import * as Shared from "./shared.mjs";
3
3
  import { APIPromise } from "../core/api-promise.mjs";
4
4
  import { RequestOptions } from "../internal/request-options.mjs";
5
+ /**
6
+ * Look up the messages Courier has accepted, inspect their delivery history and rendered output, and cancel, resend, or archive them.
7
+ */
5
8
  export declare class Messages extends APIResource {
6
9
  /**
7
- * Fetch the status of a message you've previously sent.
10
+ * Returns a sent message's status, recipient, event, and per-provider delivery
11
+ * detail, with timestamps for enqueued, sent, delivered, opened, and clicked.
8
12
  */
9
13
  retrieve(messageID: string, options?: RequestOptions): APIPromise<MessageRetrieveResponse>;
10
14
  /**
11
- * Fetch the statuses of messages you've previously sent.
15
+ * Returns previously sent messages, most recent first, each carrying its status,
16
+ * recipient, channel, and provider. Paged by cursor.
12
17
  */
13
18
  list(query?: MessageListParams | null | undefined, options?: RequestOptions): APIPromise<MessageListResponse>;
14
19
  /**
15
- * Cancel a message that is currently in the process of being delivered. A
16
- * well-formatted API call to the cancel message API will return either `200`
17
- * status code for a successful cancellation or `409` status code for an
18
- * unsuccessful cancellation. Both cases will include the actual message record in
19
- * the response body (see details below).
20
+ * Cancels a message that is still in the delivery pipeline and returns the message
21
+ * record with its resulting canceled or failed status.
20
22
  */
21
23
  cancel(messageID: string, options?: RequestOptions): APIPromise<MessageDetails>;
22
24
  /**
23
- * Get message content
25
+ * Returns the rendered content Courier delivered for a message, broken out per
26
+ * channel, to confirm what the recipient received.
24
27
  */
25
28
  content(messageID: string, options?: RequestOptions): APIPromise<MessageContentResponse>;
26
29
  /**
27
- * Fetch the array of events of a message you've previously sent.
30
+ * Returns the ordered event history for a sent message, one entry per status
31
+ * transition with its timestamp.
28
32
  */
29
33
  history(messageID: string, query?: MessageHistoryParams | null | undefined, options?: RequestOptions): APIPromise<MessageHistoryResponse>;
30
34
  /**
31
- * Resend a previously sent message. The original send request is loaded from
32
- * storage and a brand-new send is enqueued for the same recipient and content,
33
- * producing a **new** `messageId` — the original message is not modified.
34
- * Throttled by a per-message rate limit; a repeat inside the limit window returns
35
- * `429 Too Many Requests`.
35
+ * Resends a previously sent message to the same recipient and content, returning a
36
+ * new messageId. The original send request is not modified.
36
37
  */
37
38
  resend(messageID: string, options?: RequestOptions): APIPromise<MessageResendResponse>;
38
39
  }
@@ -1 +1 @@
1
- {"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAI1F;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI/E;;OAEG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIxF;;OAEG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGvF;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,WAAW,GACX,WAAW,GACX,eAAe,GACf,UAAU,GACV,YAAY,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EACH,SAAS,GACT,QAAQ,GACR,UAAU,GACV,aAAa,GACb,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,IAAI,CAAC;IAET;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D,SAAS,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;CAC/C;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;KACzB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAE7B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;SACF;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE3B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,MAAM,qBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAI1F;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI/E;;;OAGG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIxF;;;OAGG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGvF;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,WAAW,GACX,WAAW,GACX,eAAe,GACf,UAAU,GACV,YAAY,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EACH,SAAS,GACT,QAAQ,GACR,UAAU,GACV,aAAa,GACb,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,IAAI,CAAC;IAET;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D,SAAS,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;CAC/C;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;KACzB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAE7B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;SACF;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE3B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
@@ -2,37 +2,38 @@ import { APIResource } from "../core/resource.js";
2
2
  import * as Shared from "./shared.js";
3
3
  import { APIPromise } from "../core/api-promise.js";
4
4
  import { RequestOptions } from "../internal/request-options.js";
5
+ /**
6
+ * Look up the messages Courier has accepted, inspect their delivery history and rendered output, and cancel, resend, or archive them.
7
+ */
5
8
  export declare class Messages extends APIResource {
6
9
  /**
7
- * Fetch the status of a message you've previously sent.
10
+ * Returns a sent message's status, recipient, event, and per-provider delivery
11
+ * detail, with timestamps for enqueued, sent, delivered, opened, and clicked.
8
12
  */
9
13
  retrieve(messageID: string, options?: RequestOptions): APIPromise<MessageRetrieveResponse>;
10
14
  /**
11
- * Fetch the statuses of messages you've previously sent.
15
+ * Returns previously sent messages, most recent first, each carrying its status,
16
+ * recipient, channel, and provider. Paged by cursor.
12
17
  */
13
18
  list(query?: MessageListParams | null | undefined, options?: RequestOptions): APIPromise<MessageListResponse>;
14
19
  /**
15
- * Cancel a message that is currently in the process of being delivered. A
16
- * well-formatted API call to the cancel message API will return either `200`
17
- * status code for a successful cancellation or `409` status code for an
18
- * unsuccessful cancellation. Both cases will include the actual message record in
19
- * the response body (see details below).
20
+ * Cancels a message that is still in the delivery pipeline and returns the message
21
+ * record with its resulting canceled or failed status.
20
22
  */
21
23
  cancel(messageID: string, options?: RequestOptions): APIPromise<MessageDetails>;
22
24
  /**
23
- * Get message content
25
+ * Returns the rendered content Courier delivered for a message, broken out per
26
+ * channel, to confirm what the recipient received.
24
27
  */
25
28
  content(messageID: string, options?: RequestOptions): APIPromise<MessageContentResponse>;
26
29
  /**
27
- * Fetch the array of events of a message you've previously sent.
30
+ * Returns the ordered event history for a sent message, one entry per status
31
+ * transition with its timestamp.
28
32
  */
29
33
  history(messageID: string, query?: MessageHistoryParams | null | undefined, options?: RequestOptions): APIPromise<MessageHistoryResponse>;
30
34
  /**
31
- * Resend a previously sent message. The original send request is loaded from
32
- * storage and a brand-new send is enqueued for the same recipient and content,
33
- * producing a **new** `messageId` — the original message is not modified.
34
- * Throttled by a per-message rate limit; a repeat inside the limit window returns
35
- * `429 Too Many Requests`.
35
+ * Resends a previously sent message to the same recipient and content, returning a
36
+ * new messageId. The original send request is not modified.
36
37
  */
37
38
  resend(messageID: string, options?: RequestOptions): APIPromise<MessageResendResponse>;
38
39
  }
@@ -1 +1 @@
1
- {"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAI1F;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI/E;;OAEG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIxF;;OAEG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGvF;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,WAAW,GACX,WAAW,GACX,eAAe,GACf,UAAU,GACV,YAAY,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EACH,SAAS,GACT,QAAQ,GACR,UAAU,GACV,aAAa,GACb,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,IAAI,CAAC;IAET;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D,SAAS,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;CAC/C;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;KACzB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAE7B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;SACF;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE3B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAI1F;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI/E;;;OAGG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIxF;;;OAGG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGvF;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EACF,UAAU,GACV,SAAS,GACT,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,WAAW,GACX,WAAW,GACX,eAAe,GACf,UAAU,GACV,YAAY,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EACH,SAAS,GACT,QAAQ,GACR,UAAU,GACV,aAAa,GACb,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,IAAI,CAAC;IAET;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D,SAAS,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;CAC/C;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;KACzB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAE7B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;SACF;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE9B;;;OAGG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE3B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}