@trycourier/courier 7.10.2 → 7.19.1

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 (423) hide show
  1. package/CHANGELOG.md +140 -0
  2. package/README.md +1 -0
  3. package/api-promise.d.mts +1 -0
  4. package/api-promise.d.mts.map +1 -1
  5. package/api-promise.d.ts +1 -0
  6. package/api-promise.d.ts.map +1 -1
  7. package/api-promise.mjs +1 -0
  8. package/api-promise.mjs.map +1 -1
  9. package/client.d.mts +10 -4
  10. package/client.d.mts.map +1 -1
  11. package/client.d.ts +10 -4
  12. package/client.d.ts.map +1 -1
  13. package/client.js +27 -2
  14. package/client.js.map +1 -1
  15. package/client.mjs +27 -2
  16. package/client.mjs.map +1 -1
  17. package/core/api-promise.d.mts.map +1 -1
  18. package/core/api-promise.d.ts.map +1 -1
  19. package/core/api-promise.mjs.map +1 -1
  20. package/core/error.mjs.map +1 -1
  21. package/core/resource.d.mts.map +1 -1
  22. package/core/resource.d.ts.map +1 -1
  23. package/core/uploads.d.mts.map +1 -1
  24. package/core/uploads.d.ts.map +1 -1
  25. package/core/uploads.mjs.map +1 -1
  26. package/error.d.mts +1 -0
  27. package/error.d.mts.map +1 -1
  28. package/error.d.ts +1 -0
  29. package/error.d.ts.map +1 -1
  30. package/error.mjs +1 -0
  31. package/error.mjs.map +1 -1
  32. package/index.d.mts.map +1 -1
  33. package/index.d.ts.map +1 -1
  34. package/index.mjs.map +1 -1
  35. package/internal/detect-platform.mjs.map +1 -1
  36. package/internal/headers.mjs.map +1 -1
  37. package/internal/parse.d.mts.map +1 -1
  38. package/internal/parse.d.ts.map +1 -1
  39. package/internal/parse.mjs.map +1 -1
  40. package/internal/qs/formats.d.mts.map +1 -1
  41. package/internal/qs/formats.d.ts.map +1 -1
  42. package/internal/qs/index.d.mts +2 -2
  43. package/internal/qs/index.d.mts.map +1 -1
  44. package/internal/qs/index.d.ts +2 -2
  45. package/internal/qs/index.d.ts.map +1 -1
  46. package/internal/qs/index.mjs.map +1 -1
  47. package/internal/qs/stringify.d.mts.map +1 -1
  48. package/internal/qs/stringify.d.ts.map +1 -1
  49. package/internal/qs/stringify.mjs.map +1 -1
  50. package/internal/qs/utils.d.mts.map +1 -1
  51. package/internal/qs/utils.d.ts.map +1 -1
  52. package/internal/qs/utils.mjs.map +1 -1
  53. package/internal/request-options.d.mts.map +1 -1
  54. package/internal/request-options.d.ts.map +1 -1
  55. package/internal/shims.d.mts +6 -0
  56. package/internal/shims.d.mts.map +1 -1
  57. package/internal/shims.d.ts +6 -0
  58. package/internal/shims.d.ts.map +1 -1
  59. package/internal/to-file.d.mts.map +1 -1
  60. package/internal/to-file.d.ts.map +1 -1
  61. package/internal/to-file.mjs.map +1 -1
  62. package/internal/types.d.mts +10 -10
  63. package/internal/types.d.mts.map +1 -1
  64. package/internal/types.d.ts +10 -10
  65. package/internal/types.d.ts.map +1 -1
  66. package/internal/uploads.d.mts.map +1 -1
  67. package/internal/uploads.d.ts.map +1 -1
  68. package/internal/uploads.mjs.map +1 -1
  69. package/internal/utils/base64.mjs.map +1 -1
  70. package/internal/utils/log.d.mts.map +1 -1
  71. package/internal/utils/log.d.ts.map +1 -1
  72. package/internal/utils/log.js +2 -0
  73. package/internal/utils/log.js.map +1 -1
  74. package/internal/utils/log.mjs +2 -0
  75. package/internal/utils/log.mjs.map +1 -1
  76. package/internal/utils/path.mjs.map +1 -1
  77. package/internal/utils/query.mjs.map +1 -1
  78. package/internal/utils/values.mjs.map +1 -1
  79. package/internal/utils.d.mts.map +1 -1
  80. package/internal/utils.d.ts.map +1 -1
  81. package/internal/utils.mjs.map +1 -1
  82. package/package.json +1 -1
  83. package/resource.d.mts +1 -0
  84. package/resource.d.mts.map +1 -1
  85. package/resource.d.ts +1 -0
  86. package/resource.d.ts.map +1 -1
  87. package/resource.mjs +1 -0
  88. package/resource.mjs.map +1 -1
  89. package/resources/audiences.d.mts +5 -2
  90. package/resources/audiences.d.mts.map +1 -1
  91. package/resources/audiences.d.ts +5 -2
  92. package/resources/audiences.d.ts.map +1 -1
  93. package/resources/audiences.mjs.map +1 -1
  94. package/resources/audit-events.d.mts.map +1 -1
  95. package/resources/audit-events.d.ts.map +1 -1
  96. package/resources/audit-events.mjs.map +1 -1
  97. package/resources/auth.d.mts.map +1 -1
  98. package/resources/auth.d.ts.map +1 -1
  99. package/resources/auth.mjs.map +1 -1
  100. package/resources/automations/automations.d.mts.map +1 -1
  101. package/resources/automations/automations.d.ts.map +1 -1
  102. package/resources/automations/automations.mjs.map +1 -1
  103. package/resources/automations/index.d.mts.map +1 -1
  104. package/resources/automations/index.d.ts.map +1 -1
  105. package/resources/automations/index.mjs.map +1 -1
  106. package/resources/automations/invoke.d.mts.map +1 -1
  107. package/resources/automations/invoke.d.ts.map +1 -1
  108. package/resources/automations/invoke.mjs.map +1 -1
  109. package/resources/automations.d.mts.map +1 -1
  110. package/resources/automations.d.ts.map +1 -1
  111. package/resources/automations.mjs.map +1 -1
  112. package/resources/brands.d.mts +35 -2
  113. package/resources/brands.d.mts.map +1 -1
  114. package/resources/brands.d.ts +35 -2
  115. package/resources/brands.d.ts.map +1 -1
  116. package/resources/brands.js +34 -1
  117. package/resources/brands.js.map +1 -1
  118. package/resources/brands.mjs +34 -1
  119. package/resources/brands.mjs.map +1 -1
  120. package/resources/bulk.d.mts.map +1 -1
  121. package/resources/bulk.d.ts.map +1 -1
  122. package/resources/bulk.mjs.map +1 -1
  123. package/resources/digests/digests.d.mts +94 -0
  124. package/resources/digests/digests.d.mts.map +1 -0
  125. package/resources/digests/digests.d.ts +94 -0
  126. package/resources/digests/digests.d.ts.map +1 -0
  127. package/resources/digests/digests.js +17 -0
  128. package/resources/digests/digests.js.map +1 -0
  129. package/resources/digests/digests.mjs +12 -0
  130. package/resources/digests/digests.mjs.map +1 -0
  131. package/resources/digests/index.d.mts +3 -0
  132. package/resources/digests/index.d.mts.map +1 -0
  133. package/resources/digests/index.d.ts +3 -0
  134. package/resources/digests/index.d.ts.map +1 -0
  135. package/resources/digests/index.js +9 -0
  136. package/resources/digests/index.js.map +1 -0
  137. package/resources/digests/index.mjs +4 -0
  138. package/resources/digests/index.mjs.map +1 -0
  139. package/resources/digests/schedules.d.mts +32 -0
  140. package/resources/digests/schedules.d.mts.map +1 -0
  141. package/resources/digests/schedules.d.ts +32 -0
  142. package/resources/digests/schedules.d.ts.map +1 -0
  143. package/resources/digests/schedules.js +29 -0
  144. package/resources/digests/schedules.js.map +1 -0
  145. package/resources/digests/schedules.mjs +25 -0
  146. package/resources/digests/schedules.mjs.map +1 -0
  147. package/resources/digests.d.mts +2 -0
  148. package/resources/digests.d.mts.map +1 -0
  149. package/resources/digests.d.ts +2 -0
  150. package/resources/digests.d.ts.map +1 -0
  151. package/resources/digests.js +6 -0
  152. package/resources/digests.js.map +1 -0
  153. package/resources/digests.mjs +3 -0
  154. package/resources/digests.mjs.map +1 -0
  155. package/resources/inbound.d.mts.map +1 -1
  156. package/resources/inbound.d.ts.map +1 -1
  157. package/resources/inbound.mjs.map +1 -1
  158. package/resources/index.d.mts +4 -2
  159. package/resources/index.d.mts.map +1 -1
  160. package/resources/index.d.ts +4 -2
  161. package/resources/index.d.ts.map +1 -1
  162. package/resources/index.js +6 -2
  163. package/resources/index.js.map +1 -1
  164. package/resources/index.mjs +3 -1
  165. package/resources/index.mjs.map +1 -1
  166. package/resources/journeys/index.d.mts +3 -0
  167. package/resources/journeys/index.d.mts.map +1 -0
  168. package/resources/journeys/index.d.ts +3 -0
  169. package/resources/journeys/index.d.ts.map +1 -0
  170. package/resources/journeys/index.js +9 -0
  171. package/resources/journeys/index.js.map +1 -0
  172. package/resources/journeys/index.mjs +4 -0
  173. package/resources/journeys/index.mjs.map +1 -0
  174. package/resources/journeys/journeys.d.mts +943 -0
  175. package/resources/journeys/journeys.d.mts.map +1 -0
  176. package/resources/journeys/journeys.d.ts +943 -0
  177. package/resources/journeys/journeys.d.ts.map +1 -0
  178. package/resources/journeys/journeys.js +166 -0
  179. package/resources/journeys/journeys.js.map +1 -0
  180. package/resources/journeys/journeys.mjs +161 -0
  181. package/resources/journeys/journeys.mjs.map +1 -0
  182. package/resources/journeys/templates.d.mts +338 -0
  183. package/resources/journeys/templates.d.mts.map +1 -0
  184. package/resources/journeys/templates.d.ts +338 -0
  185. package/resources/journeys/templates.d.ts.map +1 -0
  186. package/resources/journeys/templates.js +213 -0
  187. package/resources/journeys/templates.js.map +1 -0
  188. package/resources/journeys/templates.mjs +209 -0
  189. package/resources/journeys/templates.mjs.map +1 -0
  190. package/resources/journeys.d.mts +1 -142
  191. package/resources/journeys.d.mts.map +1 -1
  192. package/resources/journeys.d.ts +1 -142
  193. package/resources/journeys.d.ts.map +1 -1
  194. package/resources/journeys.js +2 -34
  195. package/resources/journeys.js.map +1 -1
  196. package/resources/journeys.mjs +1 -32
  197. package/resources/journeys.mjs.map +1 -1
  198. package/resources/lists/index.d.mts.map +1 -1
  199. package/resources/lists/index.d.ts.map +1 -1
  200. package/resources/lists/index.mjs.map +1 -1
  201. package/resources/lists/lists.d.mts.map +1 -1
  202. package/resources/lists/lists.d.ts.map +1 -1
  203. package/resources/lists/lists.mjs.map +1 -1
  204. package/resources/lists/subscriptions.d.mts.map +1 -1
  205. package/resources/lists/subscriptions.d.ts.map +1 -1
  206. package/resources/lists/subscriptions.mjs.map +1 -1
  207. package/resources/lists.d.mts.map +1 -1
  208. package/resources/lists.d.ts.map +1 -1
  209. package/resources/lists.mjs.map +1 -1
  210. package/resources/messages.d.mts +16 -1
  211. package/resources/messages.d.mts.map +1 -1
  212. package/resources/messages.d.ts +16 -1
  213. package/resources/messages.d.ts.map +1 -1
  214. package/resources/messages.js +10 -0
  215. package/resources/messages.js.map +1 -1
  216. package/resources/messages.mjs +10 -0
  217. package/resources/messages.mjs.map +1 -1
  218. package/resources/notifications/checks.d.mts +3 -3
  219. package/resources/notifications/checks.d.mts.map +1 -1
  220. package/resources/notifications/checks.d.ts +3 -3
  221. package/resources/notifications/checks.d.ts.map +1 -1
  222. package/resources/notifications/checks.js +3 -3
  223. package/resources/notifications/checks.mjs +3 -3
  224. package/resources/notifications/checks.mjs.map +1 -1
  225. package/resources/notifications/index.d.mts.map +1 -1
  226. package/resources/notifications/index.d.ts.map +1 -1
  227. package/resources/notifications/index.mjs.map +1 -1
  228. package/resources/notifications/notifications.d.mts.map +1 -1
  229. package/resources/notifications/notifications.d.ts.map +1 -1
  230. package/resources/notifications/notifications.mjs.map +1 -1
  231. package/resources/notifications.d.mts.map +1 -1
  232. package/resources/notifications.d.ts.map +1 -1
  233. package/resources/notifications.mjs.map +1 -1
  234. package/resources/profiles/index.d.mts.map +1 -1
  235. package/resources/profiles/index.d.ts.map +1 -1
  236. package/resources/profiles/index.mjs.map +1 -1
  237. package/resources/profiles/lists.d.mts.map +1 -1
  238. package/resources/profiles/lists.d.ts.map +1 -1
  239. package/resources/profiles/lists.mjs.map +1 -1
  240. package/resources/profiles/profiles.d.mts.map +1 -1
  241. package/resources/profiles/profiles.d.ts.map +1 -1
  242. package/resources/profiles/profiles.mjs.map +1 -1
  243. package/resources/profiles.d.mts.map +1 -1
  244. package/resources/profiles.d.ts.map +1 -1
  245. package/resources/profiles.mjs.map +1 -1
  246. package/resources/providers/catalog.d.mts.map +1 -1
  247. package/resources/providers/catalog.d.ts.map +1 -1
  248. package/resources/providers/catalog.mjs.map +1 -1
  249. package/resources/providers/index.d.mts.map +1 -1
  250. package/resources/providers/index.d.ts.map +1 -1
  251. package/resources/providers/index.mjs.map +1 -1
  252. package/resources/providers/providers.d.mts.map +1 -1
  253. package/resources/providers/providers.d.ts.map +1 -1
  254. package/resources/providers/providers.mjs.map +1 -1
  255. package/resources/providers.d.mts.map +1 -1
  256. package/resources/providers.d.ts.map +1 -1
  257. package/resources/providers.mjs.map +1 -1
  258. package/resources/requests.d.mts.map +1 -1
  259. package/resources/requests.d.ts.map +1 -1
  260. package/resources/requests.mjs.map +1 -1
  261. package/resources/routing-strategies.d.mts.map +1 -1
  262. package/resources/routing-strategies.d.ts.map +1 -1
  263. package/resources/routing-strategies.mjs.map +1 -1
  264. package/resources/send.d.mts.map +1 -1
  265. package/resources/send.d.ts.map +1 -1
  266. package/resources/send.mjs.map +1 -1
  267. package/resources/shared.d.mts +6 -0
  268. package/resources/shared.d.mts.map +1 -1
  269. package/resources/shared.d.ts +6 -0
  270. package/resources/shared.d.ts.map +1 -1
  271. package/resources/tenants/index.d.mts +1 -1
  272. package/resources/tenants/index.d.mts.map +1 -1
  273. package/resources/tenants/index.d.ts +1 -1
  274. package/resources/tenants/index.d.ts.map +1 -1
  275. package/resources/tenants/index.js.map +1 -1
  276. package/resources/tenants/index.mjs.map +1 -1
  277. package/resources/tenants/preferences/index.d.mts.map +1 -1
  278. package/resources/tenants/preferences/index.d.ts.map +1 -1
  279. package/resources/tenants/preferences/index.mjs.map +1 -1
  280. package/resources/tenants/preferences/items.d.mts.map +1 -1
  281. package/resources/tenants/preferences/items.d.ts.map +1 -1
  282. package/resources/tenants/preferences/items.mjs.map +1 -1
  283. package/resources/tenants/preferences/preferences.d.mts.map +1 -1
  284. package/resources/tenants/preferences/preferences.d.ts.map +1 -1
  285. package/resources/tenants/preferences/preferences.mjs.map +1 -1
  286. package/resources/tenants/preferences.d.mts.map +1 -1
  287. package/resources/tenants/preferences.d.ts.map +1 -1
  288. package/resources/tenants/preferences.mjs.map +1 -1
  289. package/resources/tenants/templates/index.d.mts +1 -1
  290. package/resources/tenants/templates/index.d.mts.map +1 -1
  291. package/resources/tenants/templates/index.d.ts +1 -1
  292. package/resources/tenants/templates/index.d.ts.map +1 -1
  293. package/resources/tenants/templates/index.js.map +1 -1
  294. package/resources/tenants/templates/index.mjs.map +1 -1
  295. package/resources/tenants/templates/templates.d.mts +23 -1
  296. package/resources/tenants/templates/templates.d.mts.map +1 -1
  297. package/resources/tenants/templates/templates.d.ts +23 -1
  298. package/resources/tenants/templates/templates.d.ts.map +1 -1
  299. package/resources/tenants/templates/templates.js +23 -0
  300. package/resources/tenants/templates/templates.js.map +1 -1
  301. package/resources/tenants/templates/templates.mjs +23 -0
  302. package/resources/tenants/templates/templates.mjs.map +1 -1
  303. package/resources/tenants/templates/versions.d.mts.map +1 -1
  304. package/resources/tenants/templates/versions.d.ts.map +1 -1
  305. package/resources/tenants/templates/versions.mjs.map +1 -1
  306. package/resources/tenants/templates.d.mts.map +1 -1
  307. package/resources/tenants/templates.d.ts.map +1 -1
  308. package/resources/tenants/templates.mjs.map +1 -1
  309. package/resources/tenants/tenants.d.mts +2 -2
  310. package/resources/tenants/tenants.d.mts.map +1 -1
  311. package/resources/tenants/tenants.d.ts +2 -2
  312. package/resources/tenants/tenants.d.ts.map +1 -1
  313. package/resources/tenants/tenants.js.map +1 -1
  314. package/resources/tenants/tenants.mjs.map +1 -1
  315. package/resources/tenants.d.mts.map +1 -1
  316. package/resources/tenants.d.ts.map +1 -1
  317. package/resources/tenants.mjs.map +1 -1
  318. package/resources/translations.d.mts.map +1 -1
  319. package/resources/translations.d.ts.map +1 -1
  320. package/resources/translations.mjs.map +1 -1
  321. package/resources/users/index.d.mts +1 -1
  322. package/resources/users/index.d.mts.map +1 -1
  323. package/resources/users/index.d.ts +1 -1
  324. package/resources/users/index.d.ts.map +1 -1
  325. package/resources/users/index.js.map +1 -1
  326. package/resources/users/index.mjs.map +1 -1
  327. package/resources/users/preferences.d.mts +211 -1
  328. package/resources/users/preferences.d.mts.map +1 -1
  329. package/resources/users/preferences.d.ts +211 -1
  330. package/resources/users/preferences.d.ts.map +1 -1
  331. package/resources/users/preferences.js +105 -0
  332. package/resources/users/preferences.js.map +1 -1
  333. package/resources/users/preferences.mjs +105 -0
  334. package/resources/users/preferences.mjs.map +1 -1
  335. package/resources/users/tenants.d.mts.map +1 -1
  336. package/resources/users/tenants.d.ts.map +1 -1
  337. package/resources/users/tenants.mjs.map +1 -1
  338. package/resources/users/tokens.d.mts.map +1 -1
  339. package/resources/users/tokens.d.ts.map +1 -1
  340. package/resources/users/tokens.mjs.map +1 -1
  341. package/resources/users/users.d.mts +2 -2
  342. package/resources/users/users.d.mts.map +1 -1
  343. package/resources/users/users.d.ts +2 -2
  344. package/resources/users/users.d.ts.map +1 -1
  345. package/resources/users/users.js.map +1 -1
  346. package/resources/users/users.mjs.map +1 -1
  347. package/resources/users.d.mts.map +1 -1
  348. package/resources/users.d.ts.map +1 -1
  349. package/resources/users.mjs.map +1 -1
  350. package/resources/workspace-preferences/index.d.mts +3 -0
  351. package/resources/workspace-preferences/index.d.mts.map +1 -0
  352. package/resources/workspace-preferences/index.d.ts +3 -0
  353. package/resources/workspace-preferences/index.d.ts.map +1 -0
  354. package/resources/workspace-preferences/index.js +9 -0
  355. package/resources/workspace-preferences/index.js.map +1 -0
  356. package/resources/workspace-preferences/index.mjs +4 -0
  357. package/resources/workspace-preferences/index.mjs.map +1 -0
  358. package/resources/workspace-preferences/topics.d.mts +168 -0
  359. package/resources/workspace-preferences/topics.d.mts.map +1 -0
  360. package/resources/workspace-preferences/topics.d.ts +168 -0
  361. package/resources/workspace-preferences/topics.d.ts.map +1 -0
  362. package/resources/workspace-preferences/topics.js +103 -0
  363. package/resources/workspace-preferences/topics.js.map +1 -0
  364. package/resources/workspace-preferences/topics.mjs +99 -0
  365. package/resources/workspace-preferences/topics.mjs.map +1 -0
  366. package/resources/workspace-preferences/workspace-preferences.d.mts +410 -0
  367. package/resources/workspace-preferences/workspace-preferences.d.mts.map +1 -0
  368. package/resources/workspace-preferences/workspace-preferences.d.ts +410 -0
  369. package/resources/workspace-preferences/workspace-preferences.d.ts.map +1 -0
  370. package/resources/workspace-preferences/workspace-preferences.js +104 -0
  371. package/resources/workspace-preferences/workspace-preferences.js.map +1 -0
  372. package/resources/workspace-preferences/workspace-preferences.mjs +99 -0
  373. package/resources/workspace-preferences/workspace-preferences.mjs.map +1 -0
  374. package/resources/workspace-preferences.d.mts +2 -0
  375. package/resources/workspace-preferences.d.mts.map +1 -0
  376. package/resources/workspace-preferences.d.ts +2 -0
  377. package/resources/workspace-preferences.d.ts.map +1 -0
  378. package/resources/workspace-preferences.js +6 -0
  379. package/resources/workspace-preferences.js.map +1 -0
  380. package/resources/workspace-preferences.mjs +3 -0
  381. package/resources/workspace-preferences.mjs.map +1 -0
  382. package/resources.d.mts.map +1 -1
  383. package/resources.d.ts.map +1 -1
  384. package/resources.mjs.map +1 -1
  385. package/src/client.ts +158 -10
  386. package/src/internal/types.ts +6 -8
  387. package/src/internal/utils/log.ts +2 -0
  388. package/src/resources/audiences.ts +5 -2
  389. package/src/resources/brands.ts +36 -3
  390. package/src/resources/digests/digests.ts +120 -0
  391. package/src/resources/digests/index.ts +9 -0
  392. package/src/resources/digests/schedules.ts +51 -0
  393. package/src/resources/digests.ts +3 -0
  394. package/src/resources/index.ts +62 -1
  395. package/src/resources/journeys/index.ts +62 -0
  396. package/src/resources/journeys/journeys.ts +1289 -0
  397. package/src/resources/journeys/templates.ts +486 -0
  398. package/src/resources/journeys.ts +1 -172
  399. package/src/resources/messages.ts +20 -0
  400. package/src/resources/notifications/checks.ts +3 -3
  401. package/src/resources/shared.ts +7 -0
  402. package/src/resources/tenants/index.ts +1 -0
  403. package/src/resources/tenants/templates/index.ts +1 -0
  404. package/src/resources/tenants/templates/templates.ts +32 -0
  405. package/src/resources/tenants/tenants.ts +2 -0
  406. package/src/resources/users/index.ts +6 -0
  407. package/src/resources/users/preferences.ts +269 -0
  408. package/src/resources/users/users.ts +12 -0
  409. package/src/resources/workspace-preferences/index.ts +25 -0
  410. package/src/resources/workspace-preferences/topics.ts +229 -0
  411. package/src/resources/workspace-preferences/workspace-preferences.ts +534 -0
  412. package/src/resources/workspace-preferences.ts +3 -0
  413. package/src/version.ts +1 -1
  414. package/uploads.d.mts +1 -0
  415. package/uploads.d.mts.map +1 -1
  416. package/uploads.d.ts +1 -0
  417. package/uploads.d.ts.map +1 -1
  418. package/uploads.mjs +1 -0
  419. package/uploads.mjs.map +1 -1
  420. package/version.d.mts +1 -1
  421. package/version.d.ts +1 -1
  422. package/version.js +1 -1
  423. package/version.mjs +1 -1
package/resources.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":"AAAA,sCAAkC"}
package/src/client.ts CHANGED
@@ -67,15 +67,6 @@ import {
67
67
  InboundBulkMessageUser,
68
68
  } from './resources/bulk';
69
69
  import { Inbound, InboundTrackEventParams, InboundTrackEventResponse } from './resources/inbound';
70
- import {
71
- Journey,
72
- JourneyInvokeParams,
73
- JourneyListParams,
74
- Journeys,
75
- JourneysInvokeRequest,
76
- JourneysInvokeResponse,
77
- JourneysListResponse,
78
- } from './resources/journeys';
79
70
  import {
80
71
  MessageContentResponse,
81
72
  MessageDetails,
@@ -83,6 +74,7 @@ import {
83
74
  MessageHistoryResponse,
84
75
  MessageListParams,
85
76
  MessageListResponse,
77
+ MessageResendResponse,
86
78
  MessageRetrieveResponse,
87
79
  Messages,
88
80
  } from './resources/messages';
@@ -114,6 +106,59 @@ import {
114
106
  AutomationTemplateListResponse,
115
107
  Automations,
116
108
  } from './resources/automations/automations';
109
+ import {
110
+ DigestCategory,
111
+ DigestInstance,
112
+ DigestInstanceListResponse,
113
+ Digests,
114
+ } from './resources/digests/digests';
115
+ import {
116
+ CancelJourneyRequest,
117
+ CancelJourneyResponse,
118
+ CreateJourneyRequest,
119
+ Journey,
120
+ JourneyAINode,
121
+ JourneyAPIInvokeTriggerNode,
122
+ JourneyCancelParams,
123
+ JourneyConditionAtom,
124
+ JourneyConditionGroup,
125
+ JourneyConditionNestedGroup,
126
+ JourneyConditionsField,
127
+ JourneyCreateParams,
128
+ JourneyDelayDurationNode,
129
+ JourneyDelayUntilNode,
130
+ JourneyExitNode,
131
+ JourneyExperiment,
132
+ JourneyExperimentVariant,
133
+ JourneyFetchGetDeleteNode,
134
+ JourneyFetchPostPutNode,
135
+ JourneyInvokeParams,
136
+ JourneyListParams,
137
+ JourneyMergeStrategy,
138
+ JourneyNode,
139
+ JourneyPublishParams,
140
+ JourneyPublishRequest,
141
+ JourneyReplaceParams,
142
+ JourneyResponse,
143
+ JourneyRetrieveParams,
144
+ JourneySegmentTriggerNode,
145
+ JourneySendNode,
146
+ JourneyState,
147
+ JourneyTemplateCreateRequest,
148
+ JourneyTemplateGetResponse,
149
+ JourneyTemplateListResponse,
150
+ JourneyTemplatePublishRequest,
151
+ JourneyTemplateReplaceRequest,
152
+ JourneyTemplateSummary,
153
+ JourneyThrottleDynamicNode,
154
+ JourneyThrottleStaticNode,
155
+ JourneyVersionItem,
156
+ JourneyVersionsListResponse,
157
+ Journeys,
158
+ JourneysInvokeRequest,
159
+ JourneysInvokeResponse,
160
+ JourneysListResponse,
161
+ } from './resources/journeys/journeys';
117
162
  import {
118
163
  ListListParams,
119
164
  ListListResponse,
@@ -194,6 +239,22 @@ import {
194
239
  Tenants,
195
240
  } from './resources/tenants/tenants';
196
241
  import { Users } from './resources/users/users';
242
+ import {
243
+ PublishPreferencesRequest,
244
+ PublishPreferencesResponse,
245
+ WorkspacePreferenceCreateParams,
246
+ WorkspacePreferenceCreateRequest,
247
+ WorkspacePreferenceGetResponse,
248
+ WorkspacePreferenceListResponse,
249
+ WorkspacePreferencePublishParams,
250
+ WorkspacePreferenceReplaceParams,
251
+ WorkspacePreferenceReplaceRequest,
252
+ WorkspacePreferenceTopicCreateRequest,
253
+ WorkspacePreferenceTopicGetResponse,
254
+ WorkspacePreferenceTopicListResponse,
255
+ WorkspacePreferenceTopicReplaceRequest,
256
+ WorkspacePreferences,
257
+ } from './resources/workspace-preferences/workspace-preferences';
197
258
  import { type Fetch } from './internal/builtin-types';
198
259
  import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
199
260
  import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -344,6 +405,18 @@ export class Courier {
344
405
  this.fetch = options.fetch ?? Shims.getDefaultFetch();
345
406
  this.#encoder = Opts.FallbackEncoder;
346
407
 
408
+ const customHeadersEnv = readEnv('COURIER_CUSTOM_HEADERS');
409
+ if (customHeadersEnv) {
410
+ const parsed: Record<string, string> = {};
411
+ for (const line of customHeadersEnv.split('\n')) {
412
+ const colon = line.indexOf(':');
413
+ if (colon >= 0) {
414
+ parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim();
415
+ }
416
+ }
417
+ options.defaultHeaders = { ...parsed, ...options.defaultHeaders };
418
+ }
419
+
347
420
  this._options = options;
348
421
 
349
422
  this.apiKey = apiKey;
@@ -827,11 +900,19 @@ export class Courier {
827
900
  return () => controller.abort();
828
901
  }
829
902
 
830
- private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
903
+ private buildBody({ options }: { options: FinalRequestOptions }): {
831
904
  bodyHeaders: HeadersLike;
832
905
  body: BodyInit | undefined;
833
906
  } {
907
+ const { body, headers: rawHeaders } = options;
834
908
  if (!body) {
909
+ // A resource method always passes a `body` key when its operation defines a
910
+ // request body, even if the caller omitted an optional body param. Keep the
911
+ // content-type for those, and only elide it for operations with no body at
912
+ // all (e.g. GET/DELETE).
913
+ if (body == null && 'body' in options) {
914
+ return this.#encoder({ body, headers: buildHeaders([rawHeaders]) });
915
+ }
835
916
  return { bodyHeaders: undefined, body: undefined };
836
917
  }
837
918
  const headers = buildHeaders([rawHeaders]);
@@ -900,12 +981,14 @@ export class Courier {
900
981
  journeys: API.Journeys = new API.Journeys(this);
901
982
  brands: API.Brands = new API.Brands(this);
902
983
  bulk: API.Bulk = new API.Bulk(this);
984
+ digests: API.Digests = new API.Digests(this);
903
985
  inbound: API.Inbound = new API.Inbound(this);
904
986
  lists: API.Lists = new API.Lists(this);
905
987
  messages: API.Messages = new API.Messages(this);
906
988
  requests: API.Requests = new API.Requests(this);
907
989
  notifications: API.Notifications = new API.Notifications(this);
908
990
  routingStrategies: API.RoutingStrategies = new API.RoutingStrategies(this);
991
+ workspacePreferences: API.WorkspacePreferences = new API.WorkspacePreferences(this);
909
992
  profiles: API.Profiles = new API.Profiles(this);
910
993
  tenants: API.Tenants = new API.Tenants(this);
911
994
  translations: API.Translations = new API.Translations(this);
@@ -921,12 +1004,14 @@ Courier.Automations = Automations;
921
1004
  Courier.Journeys = Journeys;
922
1005
  Courier.Brands = Brands;
923
1006
  Courier.Bulk = Bulk;
1007
+ Courier.Digests = Digests;
924
1008
  Courier.Inbound = Inbound;
925
1009
  Courier.Lists = Lists;
926
1010
  Courier.Messages = Messages;
927
1011
  Courier.Requests = Requests;
928
1012
  Courier.Notifications = Notifications;
929
1013
  Courier.RoutingStrategies = RoutingStrategies;
1014
+ Courier.WorkspacePreferences = WorkspacePreferences;
930
1015
  Courier.Profiles = Profiles;
931
1016
  Courier.Tenants = Tenants;
932
1017
  Courier.Translations = Translations;
@@ -985,12 +1070,50 @@ export declare namespace Courier {
985
1070
 
986
1071
  export {
987
1072
  Journeys as Journeys,
1073
+ type CancelJourneyRequest as CancelJourneyRequest,
1074
+ type CancelJourneyResponse as CancelJourneyResponse,
1075
+ type CreateJourneyRequest as CreateJourneyRequest,
988
1076
  type Journey as Journey,
1077
+ type JourneyAINode as JourneyAINode,
1078
+ type JourneyAPIInvokeTriggerNode as JourneyAPIInvokeTriggerNode,
1079
+ type JourneyConditionAtom as JourneyConditionAtom,
1080
+ type JourneyConditionGroup as JourneyConditionGroup,
1081
+ type JourneyConditionNestedGroup as JourneyConditionNestedGroup,
1082
+ type JourneyConditionsField as JourneyConditionsField,
1083
+ type JourneyDelayDurationNode as JourneyDelayDurationNode,
1084
+ type JourneyDelayUntilNode as JourneyDelayUntilNode,
1085
+ type JourneyExitNode as JourneyExitNode,
1086
+ type JourneyExperiment as JourneyExperiment,
1087
+ type JourneyExperimentVariant as JourneyExperimentVariant,
1088
+ type JourneyFetchGetDeleteNode as JourneyFetchGetDeleteNode,
1089
+ type JourneyFetchPostPutNode as JourneyFetchPostPutNode,
1090
+ type JourneyMergeStrategy as JourneyMergeStrategy,
1091
+ type JourneyNode as JourneyNode,
1092
+ type JourneyPublishRequest as JourneyPublishRequest,
1093
+ type JourneyResponse as JourneyResponse,
1094
+ type JourneySegmentTriggerNode as JourneySegmentTriggerNode,
1095
+ type JourneySendNode as JourneySendNode,
1096
+ type JourneyState as JourneyState,
1097
+ type JourneyTemplateCreateRequest as JourneyTemplateCreateRequest,
1098
+ type JourneyTemplateGetResponse as JourneyTemplateGetResponse,
1099
+ type JourneyTemplateListResponse as JourneyTemplateListResponse,
1100
+ type JourneyTemplatePublishRequest as JourneyTemplatePublishRequest,
1101
+ type JourneyTemplateReplaceRequest as JourneyTemplateReplaceRequest,
1102
+ type JourneyTemplateSummary as JourneyTemplateSummary,
1103
+ type JourneyThrottleDynamicNode as JourneyThrottleDynamicNode,
1104
+ type JourneyThrottleStaticNode as JourneyThrottleStaticNode,
1105
+ type JourneyVersionItem as JourneyVersionItem,
1106
+ type JourneyVersionsListResponse as JourneyVersionsListResponse,
989
1107
  type JourneysInvokeRequest as JourneysInvokeRequest,
990
1108
  type JourneysInvokeResponse as JourneysInvokeResponse,
991
1109
  type JourneysListResponse as JourneysListResponse,
1110
+ type JourneyCreateParams as JourneyCreateParams,
1111
+ type JourneyRetrieveParams as JourneyRetrieveParams,
992
1112
  type JourneyListParams as JourneyListParams,
1113
+ type JourneyCancelParams as JourneyCancelParams,
993
1114
  type JourneyInvokeParams as JourneyInvokeParams,
1115
+ type JourneyPublishParams as JourneyPublishParams,
1116
+ type JourneyReplaceParams as JourneyReplaceParams,
994
1117
  };
995
1118
 
996
1119
  export {
@@ -1027,6 +1150,13 @@ export declare namespace Courier {
1027
1150
  type BulkListUsersParams as BulkListUsersParams,
1028
1151
  };
1029
1152
 
1153
+ export {
1154
+ Digests as Digests,
1155
+ type DigestCategory as DigestCategory,
1156
+ type DigestInstance as DigestInstance,
1157
+ type DigestInstanceListResponse as DigestInstanceListResponse,
1158
+ };
1159
+
1030
1160
  export {
1031
1161
  Inbound as Inbound,
1032
1162
  type InboundTrackEventResponse as InboundTrackEventResponse,
@@ -1050,6 +1180,7 @@ export declare namespace Courier {
1050
1180
  type MessageListResponse as MessageListResponse,
1051
1181
  type MessageContentResponse as MessageContentResponse,
1052
1182
  type MessageHistoryResponse as MessageHistoryResponse,
1183
+ type MessageResendResponse as MessageResendResponse,
1053
1184
  type MessageListParams as MessageListParams,
1054
1185
  type MessageHistoryParams as MessageHistoryParams,
1055
1186
  };
@@ -1104,6 +1235,23 @@ export declare namespace Courier {
1104
1235
  type RoutingStrategyReplaceParams as RoutingStrategyReplaceParams,
1105
1236
  };
1106
1237
 
1238
+ export {
1239
+ WorkspacePreferences as WorkspacePreferences,
1240
+ type PublishPreferencesRequest as PublishPreferencesRequest,
1241
+ type PublishPreferencesResponse as PublishPreferencesResponse,
1242
+ type WorkspacePreferenceCreateRequest as WorkspacePreferenceCreateRequest,
1243
+ type WorkspacePreferenceGetResponse as WorkspacePreferenceGetResponse,
1244
+ type WorkspacePreferenceListResponse as WorkspacePreferenceListResponse,
1245
+ type WorkspacePreferenceReplaceRequest as WorkspacePreferenceReplaceRequest,
1246
+ type WorkspacePreferenceTopicCreateRequest as WorkspacePreferenceTopicCreateRequest,
1247
+ type WorkspacePreferenceTopicGetResponse as WorkspacePreferenceTopicGetResponse,
1248
+ type WorkspacePreferenceTopicListResponse as WorkspacePreferenceTopicListResponse,
1249
+ type WorkspacePreferenceTopicReplaceRequest as WorkspacePreferenceTopicReplaceRequest,
1250
+ type WorkspacePreferenceCreateParams as WorkspacePreferenceCreateParams,
1251
+ type WorkspacePreferencePublishParams as WorkspacePreferencePublishParams,
1252
+ type WorkspacePreferenceReplaceParams as WorkspacePreferenceReplaceParams,
1253
+ };
1254
+
1107
1255
  export {
1108
1256
  Profiles as Profiles,
1109
1257
  type SubscribeToListsRequestItem as SubscribeToListsRequestItem,
@@ -40,7 +40,6 @@ type OverloadedParameters<T> =
40
40
  : T extends (...args: infer A) => unknown ? A
41
41
  : never;
42
42
 
43
- /* eslint-disable */
44
43
  /**
45
44
  * These imports attempt to get types from a parent package's dependencies.
46
45
  * Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which
@@ -63,19 +62,18 @@ type OverloadedParameters<T> =
63
62
  *
64
63
  * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition
65
64
  */
66
- /** @ts-ignore For users with \@types/node */
65
+ /** @ts-ignore For users with \@types/node */ /* prettier-ignore */
67
66
  type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit>;
68
- /** @ts-ignore For users with undici */
67
+ /** @ts-ignore For users with undici */ /* prettier-ignore */
69
68
  type UndiciRequestInit = NotAny<import('../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici/index.d.ts').RequestInit>;
70
- /** @ts-ignore For users with \@types/bun */
69
+ /** @ts-ignore For users with \@types/bun */ /* prettier-ignore */
71
70
  type BunRequestInit = globalThis.FetchRequestInit;
72
- /** @ts-ignore For users with node-fetch@2 */
71
+ /** @ts-ignore For users with node-fetch@2 */ /* prettier-ignore */
73
72
  type NodeFetch2RequestInit = NotAny<import('../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit>;
74
- /** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */
73
+ /** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ /* prettier-ignore */
75
74
  type NodeFetch3RequestInit = NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
76
- /** @ts-ignore For users who use Deno */
75
+ /** @ts-ignore For users who use Deno */ /* prettier-ignore */
77
76
  type FetchRequestInit = NonNullable<OverloadedParameters<typeof fetch>[1]>;
78
- /* eslint-enable */
79
77
 
80
78
  type RequestInits =
81
79
  | NotAny<UndiciTypesRequestInit>
@@ -107,6 +107,8 @@ export const formatRequestDetails = (details: {
107
107
  name,
108
108
  (
109
109
  name.toLowerCase() === 'authorization' ||
110
+ name.toLowerCase() === 'api-key' ||
111
+ name.toLowerCase() === 'x-api-key' ||
110
112
  name.toLowerCase() === 'cookie' ||
111
113
  name.toLowerCase() === 'set-cookie'
112
114
  ) ?
@@ -84,7 +84,8 @@ export interface Audience {
84
84
  filter?: Shared.AudienceFilterConfig | null;
85
85
 
86
86
  /**
87
- * The logical operator (AND/OR) for the top-level filter
87
+ * The logical operator (AND/OR) combining the top-level `filter.filters`.
88
+ * Convenience alias for `filter.operator`.
88
89
  */
89
90
  operator?: 'AND' | 'OR';
90
91
  }
@@ -136,7 +137,9 @@ export interface AudienceUpdateParams {
136
137
  name?: string | null;
137
138
 
138
139
  /**
139
- * The logical operator (AND/OR) for the top-level filter
140
+ * The logical operator (AND/OR) combining the top-level `filter.filters`.
141
+ * Convenience alias for `filter.operator`: if set, it is applied to the top-level
142
+ * filter group. Prefer setting `operator` directly inside `filter`.
140
143
  */
141
144
  operator?: 'AND' | 'OR' | null;
142
145
  }
@@ -10,7 +10,18 @@ import { path } from '../internal/utils/path';
10
10
 
11
11
  export class Brands extends APIResource {
12
12
  /**
13
- * Create a new brand
13
+ * Create a new brand. Requires `name` and `settings` (with at least
14
+ * `colors.primary` and `colors.secondary`).
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const brand = await client.brands.create({
19
+ * name: 'My Brand',
20
+ * settings: {
21
+ * colors: { primary: '#9D3789', secondary: '#FFFFFF' },
22
+ * },
23
+ * });
24
+ * ```
14
25
  */
15
26
  create(body: BrandCreateParams, options?: RequestOptions): APIPromise<Brand> {
16
27
  return this._client.post('/brands', { body, ...options });
@@ -18,6 +29,11 @@ export class Brands extends APIResource {
18
29
 
19
30
  /**
20
31
  * Fetch a specific brand by brand ID.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const brand = await client.brands.retrieve('brand_id');
36
+ * ```
21
37
  */
22
38
  retrieve(brandID: string, options?: RequestOptions): APIPromise<Brand> {
23
39
  return this._client.get(path`/brands/${brandID}`, options);
@@ -25,6 +41,13 @@ export class Brands extends APIResource {
25
41
 
26
42
  /**
27
43
  * Replace an existing brand with the supplied values.
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * const brand = await client.brands.update('brand_id', {
48
+ * name: 'name',
49
+ * });
50
+ * ```
28
51
  */
29
52
  update(brandID: string, body: BrandUpdateParams, options?: RequestOptions): APIPromise<Brand> {
30
53
  return this._client.put(path`/brands/${brandID}`, { body, ...options });
@@ -32,6 +55,11 @@ export class Brands extends APIResource {
32
55
 
33
56
  /**
34
57
  * Get the list of brands.
58
+ *
59
+ * @example
60
+ * ```ts
61
+ * const brands = await client.brands.list();
62
+ * ```
35
63
  */
36
64
  list(
37
65
  query: BrandListParams | null | undefined = {},
@@ -42,6 +70,11 @@ export class Brands extends APIResource {
42
70
 
43
71
  /**
44
72
  * Delete a brand by brand ID.
73
+ *
74
+ * @example
75
+ * ```ts
76
+ * await client.brands.delete('brand_id');
77
+ * ```
45
78
  */
46
79
  delete(brandID: string, options?: RequestOptions): APIPromise<void> {
47
80
  return this._client.delete(path`/brands/${brandID}`, {
@@ -194,9 +227,9 @@ export interface BrandListResponse {
194
227
  export interface BrandCreateParams {
195
228
  name: string;
196
229
 
197
- id?: string | null;
230
+ settings: BrandSettings;
198
231
 
199
- settings?: BrandSettings | null;
232
+ id?: string | null;
200
233
 
201
234
  snippets?: BrandSnippets | null;
202
235
  }
@@ -0,0 +1,120 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import * as SchedulesAPI from './schedules';
5
+ import { ScheduleListInstancesParams, Schedules } from './schedules';
6
+
7
+ export class Digests extends APIResource {
8
+ schedules: SchedulesAPI.Schedules = new SchedulesAPI.Schedules(this._client);
9
+ }
10
+
11
+ export interface DigestCategory {
12
+ /**
13
+ * The key that identifies the category within the digest.
14
+ */
15
+ category_key: string;
16
+
17
+ /**
18
+ * Which events to keep when the number of events exceeds the retention limit for
19
+ * the category.
20
+ */
21
+ retain: 'first' | 'last' | 'highest' | 'lowest' | 'none';
22
+
23
+ /**
24
+ * The data key used to order events when `retain` is `highest` or `lowest`.
25
+ */
26
+ sort_key?: string;
27
+ }
28
+
29
+ export interface DigestInstance {
30
+ /**
31
+ * A unique identifier for the digest instance.
32
+ */
33
+ digest_instance_id: string;
34
+
35
+ /**
36
+ * The total number of events received for this instance.
37
+ */
38
+ event_count: number;
39
+
40
+ /**
41
+ * The status of the digest instance. `IN_PROGRESS` instances are still
42
+ * accumulating events; `COMPLETED` instances have been released.
43
+ */
44
+ status: 'IN_PROGRESS' | 'COMPLETED';
45
+
46
+ /**
47
+ * The ID of the user this digest instance belongs to.
48
+ */
49
+ user_id: string;
50
+
51
+ /**
52
+ * The categories configured for the digest.
53
+ */
54
+ categories?: Array<DigestCategory>;
55
+
56
+ /**
57
+ * A map of category key to the number of events received for that category.
58
+ */
59
+ category_key_counts?: { [key: string]: number };
60
+
61
+ /**
62
+ * An ISO 8601 timestamp of when the digest instance was created.
63
+ */
64
+ created_at?: string;
65
+
66
+ /**
67
+ * Whether the digest instance has been disabled.
68
+ */
69
+ disabled?: boolean;
70
+
71
+ /**
72
+ * The ID of the tenant this digest instance belongs to, if any.
73
+ */
74
+ tenant_id?: string | null;
75
+ }
76
+
77
+ export interface DigestInstanceListResponse {
78
+ /**
79
+ * Whether there are more digest instances to fetch using the cursor.
80
+ */
81
+ has_more: boolean;
82
+
83
+ /**
84
+ * The digest instances for this page of results.
85
+ */
86
+ items: Array<DigestInstance>;
87
+
88
+ /**
89
+ * Always `list` for a paginated list response.
90
+ */
91
+ type: 'list';
92
+
93
+ /**
94
+ * A cursor token for fetching the next page of results, or null when there are
95
+ * none.
96
+ */
97
+ cursor?: string | null;
98
+
99
+ /**
100
+ * The path to fetch the next page of results, or null when there are none.
101
+ */
102
+ next_url?: string | null;
103
+
104
+ /**
105
+ * The path of the current request.
106
+ */
107
+ url?: string;
108
+ }
109
+
110
+ Digests.Schedules = Schedules;
111
+
112
+ export declare namespace Digests {
113
+ export {
114
+ type DigestCategory as DigestCategory,
115
+ type DigestInstance as DigestInstance,
116
+ type DigestInstanceListResponse as DigestInstanceListResponse,
117
+ };
118
+
119
+ export { Schedules as Schedules, type ScheduleListInstancesParams as ScheduleListInstancesParams };
120
+ }
@@ -0,0 +1,9 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ export {
4
+ Digests,
5
+ type DigestCategory,
6
+ type DigestInstance,
7
+ type DigestInstanceListResponse,
8
+ } from './digests';
9
+ export { Schedules, type ScheduleListInstancesParams } from './schedules';
@@ -0,0 +1,51 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import * as DigestsAPI from './digests';
5
+ import { APIPromise } from '../../core/api-promise';
6
+ import { buildHeaders } from '../../internal/headers';
7
+ import { RequestOptions } from '../../internal/request-options';
8
+ import { path } from '../../internal/utils/path';
9
+
10
+ export class Schedules extends APIResource {
11
+ /**
12
+ * List the digest instances for a schedule. Each instance represents the events
13
+ * accumulated for a single user against the schedule, and can be used to monitor
14
+ * digest accumulation before the digest is released.
15
+ */
16
+ listInstances(
17
+ scheduleID: string,
18
+ query: ScheduleListInstancesParams | null | undefined = {},
19
+ options?: RequestOptions,
20
+ ): APIPromise<DigestsAPI.DigestInstanceListResponse> {
21
+ return this._client.get(path`/digests/schedules/${scheduleID}/instances`, { query, ...options });
22
+ }
23
+
24
+ /**
25
+ * Send a digest now instead of waiting for its scheduled time, so your users get
26
+ * what they have collected so far right away.
27
+ */
28
+ release(scheduleID: string, options?: RequestOptions): APIPromise<void> {
29
+ return this._client.post(path`/digests/schedules/${scheduleID}/trigger`, {
30
+ ...options,
31
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
32
+ });
33
+ }
34
+ }
35
+
36
+ export interface ScheduleListInstancesParams {
37
+ /**
38
+ * A cursor token from a previous response, used to fetch the next page of results.
39
+ */
40
+ cursor?: string;
41
+
42
+ /**
43
+ * The maximum number of digest instances to return. Defaults to 20, with a maximum
44
+ * of 100.
45
+ */
46
+ limit?: number;
47
+ }
48
+
49
+ export declare namespace Schedules {
50
+ export { type ScheduleListInstancesParams as ScheduleListInstancesParams };
51
+ }
@@ -0,0 +1,3 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ export * from './digests/index';