@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
@@ -4,15 +4,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.AuditEvents = void 0;
5
5
  const resource_1 = require("../core/resource.js");
6
6
  const path_1 = require("../internal/utils/path.js");
7
+ /**
8
+ * Read the audit trail of configuration and access changes in your workspace.
9
+ */
7
10
  class AuditEvents extends resource_1.APIResource {
8
11
  /**
9
- * Fetch a specific audit event by ID.
12
+ * Returns one audit event by id, including the actor who performed it, the target
13
+ * they changed, the source, the event type, and a timestamp.
10
14
  */
11
15
  retrieve(auditEventID, options) {
12
16
  return this._client.get((0, path_1.path) `/audit-events/${auditEventID}`, options);
13
17
  }
14
18
  /**
15
- * Fetch the list of audit events
19
+ * Returns the workspace's audit event log with cursor paging. Each event records
20
+ * the actor, target, source, type, and timestamp of a change.
16
21
  */
17
22
  list(query = {}, options) {
18
23
  return this._client.get('/audit-events', { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"audit-events.js","sourceRoot":"","sources":["../src/resources/audit-events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;OAEG;IACH,QAAQ,CAAC,YAAoB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AAjBD,kCAiBC"}
1
+ {"version":3,"file":"audit-events.js","sourceRoot":"","sources":["../src/resources/audit-events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;OAGG;IACH,QAAQ,CAAC,YAAoB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AAnBD,kCAmBC"}
@@ -1,15 +1,20 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../core/resource.mjs";
3
3
  import { path } from "../internal/utils/path.mjs";
4
+ /**
5
+ * Read the audit trail of configuration and access changes in your workspace.
6
+ */
4
7
  export class AuditEvents extends APIResource {
5
8
  /**
6
- * Fetch a specific audit event by ID.
9
+ * Returns one audit event by id, including the actor who performed it, the target
10
+ * they changed, the source, the event type, and a timestamp.
7
11
  */
8
12
  retrieve(auditEventID, options) {
9
13
  return this._client.get(path `/audit-events/${auditEventID}`, options);
10
14
  }
11
15
  /**
12
- * Fetch the list of audit events
16
+ * Returns the workspace's audit event log with cursor paging. Each event records
17
+ * the actor, target, source, type, and timestamp of a change.
13
18
  */
14
19
  list(query = {}, options) {
15
20
  return this._client.get('/audit-events', { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"audit-events.mjs","sourceRoot":"","sources":["../src/resources/audit-events.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,QAAQ,CAAC,YAAoB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF"}
1
+ {"version":3,"file":"audit-events.mjs","sourceRoot":"","sources":["../src/resources/audit-events.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;OAGG;IACH,QAAQ,CAAC,YAAoB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF"}
@@ -1,9 +1,13 @@
1
1
  import { APIResource } from "../core/resource.mjs";
2
2
  import { APIPromise } from "../core/api-promise.mjs";
3
3
  import { RequestOptions } from "../internal/request-options.mjs";
4
+ /**
5
+ * Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences, and the embedded designer — can call Courier as a single user. Server-side requests authenticate with your workspace API key instead.
6
+ */
4
7
  export declare class Auth extends APIResource {
5
8
  /**
6
- * Returns a new access token.
9
+ * Returns a JWT for authenticating client-side SDKs such as the Inbox. You supply
10
+ * the scope and an expires_in duration, both required.
7
11
  *
8
12
  * @example
9
13
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"auth.d.mts","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGrG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"auth.d.mts","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGrG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
@@ -1,9 +1,13 @@
1
1
  import { APIResource } from "../core/resource.js";
2
2
  import { APIPromise } from "../core/api-promise.js";
3
3
  import { RequestOptions } from "../internal/request-options.js";
4
+ /**
5
+ * Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences, and the embedded designer — can call Courier as a single user. Server-side requests authenticate with your workspace API key instead.
6
+ */
4
7
  export declare class Auth extends APIResource {
5
8
  /**
6
- * Returns a new access token.
9
+ * Returns a JWT for authenticating client-side SDKs such as the Inbox. You supply
10
+ * the scope and an expires_in duration, both required.
7
11
  *
8
12
  * @example
9
13
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGrG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
1
+ {"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGrG;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
package/resources/auth.js CHANGED
@@ -3,9 +3,13 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Auth = void 0;
5
5
  const resource_1 = require("../core/resource.js");
6
+ /**
7
+ * Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences, and the embedded designer — can call Courier as a single user. Server-side requests authenticate with your workspace API key instead.
8
+ */
6
9
  class Auth extends resource_1.APIResource {
7
10
  /**
8
- * Returns a new access token.
11
+ * Returns a JWT for authenticating client-side SDKs such as the Inbox. You supply
12
+ * the scope and an expires_in duration, both required.
9
13
  *
10
14
  * @example
11
15
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAA0B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAhBD,oBAgBC"}
1
+ {"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,IAA0B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAjBD,oBAiBC"}
@@ -1,8 +1,12 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../core/resource.mjs";
3
+ /**
4
+ * Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences, and the embedded designer — can call Courier as a single user. Server-side requests authenticate with your workspace API key instead.
5
+ */
3
6
  export class Auth extends APIResource {
4
7
  /**
5
- * Returns a new access token.
8
+ * Returns a JWT for authenticating client-side SDKs such as the Inbox. You supply
9
+ * the scope and an expires_in duration, both required.
6
10
  *
7
11
  * @example
8
12
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"auth.mjs","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAA0B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}
1
+ {"version":3,"file":"auth.mjs","sourceRoot":"","sources":["../src/resources/auth.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,IAA0B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}
@@ -3,10 +3,14 @@ import * as InvokeAPI from "./invoke.mjs";
3
3
  import { Invoke, InvokeInvokeAdHocParams, InvokeInvokeByTemplateParams } from "./invoke.mjs";
4
4
  import { APIPromise } from "../../core/api-promise.mjs";
5
5
  import { RequestOptions } from "../../internal/request-options.mjs";
6
+ /**
7
+ * Invoke a stored automation template or an ad hoc automation defined in the request.
8
+ */
6
9
  export declare class Automations extends APIResource {
7
10
  invoke: InvokeAPI.Invoke;
8
11
  /**
9
- * Get the list of automations.
12
+ * Lists the workspace's saved automation templates, each with its id and a cursor
13
+ * for paging to the next page of results.
10
14
  *
11
15
  * @example
12
16
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"automations.d.mts","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,MAAM,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,qBAAiB;AACzF,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;CACjC;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"automations.d.mts","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,MAAM,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,qBAAiB;AACzF,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;CACjC;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -3,10 +3,14 @@ import * as InvokeAPI from "./invoke.js";
3
3
  import { Invoke, InvokeInvokeAdHocParams, InvokeInvokeByTemplateParams } from "./invoke.js";
4
4
  import { APIPromise } from "../../core/api-promise.js";
5
5
  import { RequestOptions } from "../../internal/request-options.js";
6
+ /**
7
+ * Invoke a stored automation template or an ad hoc automation defined in the request.
8
+ */
6
9
  export declare class Automations extends APIResource {
7
10
  invoke: InvokeAPI.Invoke;
8
11
  /**
9
- * Get the list of automations.
12
+ * Lists the workspace's saved automation templates, each with its id and a cursor
13
+ * for paging to the next page of results.
10
14
  *
11
15
  * @example
12
16
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"automations.d.ts","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,MAAM,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,oBAAiB;AACzF,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;CACjC;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"automations.d.ts","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,MAAM,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,oBAAiB;AACzF,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,SAAS,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;CACjC;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -6,13 +6,17 @@ const tslib_1 = require("../../internal/tslib.js");
6
6
  const resource_1 = require("../../core/resource.js");
7
7
  const InvokeAPI = tslib_1.__importStar(require("./invoke.js"));
8
8
  const invoke_1 = require("./invoke.js");
9
+ /**
10
+ * Invoke a stored automation template or an ad hoc automation defined in the request.
11
+ */
9
12
  class Automations extends resource_1.APIResource {
10
13
  constructor() {
11
14
  super(...arguments);
12
15
  this.invoke = new InvokeAPI.Invoke(this._client);
13
16
  }
14
17
  /**
15
- * Get the list of automations.
18
+ * Lists the workspace's saved automation templates, each with its id and a cursor
19
+ * for paging to the next page of results.
16
20
  *
17
21
  * @example
18
22
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"automations.js","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,+DAAsC;AACtC,wCAAyF;AAIzF,MAAa,WAAY,SAAQ,sBAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiBhE,CAAC;IAfC;;;;;;;;OAQG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAlBD,kCAkBC;AAwDD,WAAW,CAAC,MAAM,GAAG,eAAM,CAAC"}
1
+ {"version":3,"file":"automations.js","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,+DAAsC;AACtC,wCAAyF;AAIzF;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkBhE,CAAC;IAhBC;;;;;;;;;OASG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAnBD,kCAmBC;AAwDD,WAAW,CAAC,MAAM,GAAG,eAAM,CAAC"}
@@ -2,13 +2,17 @@
2
2
  import { APIResource } from "../../core/resource.mjs";
3
3
  import * as InvokeAPI from "./invoke.mjs";
4
4
  import { Invoke } from "./invoke.mjs";
5
+ /**
6
+ * Invoke a stored automation template or an ad hoc automation defined in the request.
7
+ */
5
8
  export class Automations extends APIResource {
6
9
  constructor() {
7
10
  super(...arguments);
8
11
  this.invoke = new InvokeAPI.Invoke(this._client);
9
12
  }
10
13
  /**
11
- * Get the list of automations.
14
+ * Lists the workspace's saved automation templates, each with its id and a cursor
15
+ * for paging to the next page of results.
12
16
  *
13
17
  * @example
14
18
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"automations.mjs","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,MAAM,EAAyD,qBAAiB;AAIzF,MAAM,OAAO,WAAY,SAAQ,WAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAiBhE,CAAC;IAfC;;;;;;;;OAQG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAwDD,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"automations.mjs","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,MAAM,EAAyD,qBAAiB;AAIzF;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkBhE,CAAC;IAhBC;;;;;;;;;OASG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAwDD,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC"}
@@ -2,12 +2,13 @@ import { APIResource } from "../../core/resource.mjs";
2
2
  import * as AutomationsAPI from "./automations.mjs";
3
3
  import { APIPromise } from "../../core/api-promise.mjs";
4
4
  import { RequestOptions } from "../../internal/request-options.mjs";
5
+ /**
6
+ * Invoke a stored automation template or an ad hoc automation defined in the request.
7
+ */
5
8
  export declare class Invoke extends APIResource {
6
9
  /**
7
- * Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a
8
- * series of automation steps. For information about what steps are available,
9
- * checkout the ad hoc automation guide
10
- * [here](https://www.courier.com/docs/automations/steps/).
10
+ * Runs a series of automation steps supplied inline, without a saved template, and
11
+ * returns a runId.
11
12
  *
12
13
  * @example
13
14
  * ```ts
@@ -29,9 +30,10 @@ export declare class Invoke extends APIResource {
29
30
  * });
30
31
  * ```
31
32
  */
32
- invokeAdHoc(body: InvokeInvokeAdHocParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
33
+ invokeAdHoc(params: InvokeInvokeAdHocParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
33
34
  /**
34
- * Invoke an automation run from an automation template.
35
+ * Starts an automation run from a saved template for one recipient, with optional
36
+ * data and profile, and returns a runId.
35
37
  *
36
38
  * @example
37
39
  * ```ts
@@ -42,19 +44,53 @@ export declare class Invoke extends APIResource {
42
44
  * );
43
45
  * ```
44
46
  */
45
- invokeByTemplate(templateID: string, body: InvokeInvokeByTemplateParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
47
+ invokeByTemplate(templateID: string, params: InvokeInvokeByTemplateParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
46
48
  }
47
49
  export interface InvokeInvokeAdHocParams {
50
+ /**
51
+ * Body param
52
+ */
48
53
  automation: InvokeInvokeAdHocParams.Automation;
54
+ /**
55
+ * Body param
56
+ */
49
57
  brand?: string | null;
58
+ /**
59
+ * Body param
60
+ */
50
61
  data?: {
51
62
  [key: string]: unknown;
52
63
  } | null;
64
+ /**
65
+ * Body param
66
+ */
53
67
  profile?: {
54
68
  [key: string]: unknown;
55
69
  } | null;
70
+ /**
71
+ * Body param
72
+ */
56
73
  recipient?: string | null;
74
+ /**
75
+ * Body param
76
+ */
57
77
  template?: string | null;
78
+ /**
79
+ * Header param: A unique key that makes this request idempotent. If Courier
80
+ * receives another request with the same `Idempotency-Key`, it returns the stored
81
+ * response from the first request without performing the operation again
82
+ * (including the original status code and any error). Use it to safely retry
83
+ * `POST` requests after network failures without risking duplicate sends. The key
84
+ * is scoped to this endpoint.
85
+ */
86
+ 'Idempotency-Key'?: string;
87
+ /**
88
+ * Header param: How long the idempotency key remains valid, as a Unix epoch
89
+ * timestamp in seconds or an ISO 8601 date string. Only applies when
90
+ * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
91
+ * maximum is 1 year.
92
+ */
93
+ 'x-idempotency-expiration'?: string;
58
94
  }
59
95
  export declare namespace InvokeInvokeAdHocParams {
60
96
  interface Automation {
@@ -121,15 +157,46 @@ export declare namespace InvokeInvokeAdHocParams {
121
157
  }
122
158
  }
123
159
  export interface InvokeInvokeByTemplateParams {
160
+ /**
161
+ * Body param
162
+ */
124
163
  recipient: string | null;
164
+ /**
165
+ * Body param
166
+ */
125
167
  brand?: string | null;
168
+ /**
169
+ * Body param
170
+ */
126
171
  data?: {
127
172
  [key: string]: unknown;
128
173
  } | null;
174
+ /**
175
+ * Body param
176
+ */
129
177
  profile?: {
130
178
  [key: string]: unknown;
131
179
  } | null;
180
+ /**
181
+ * Body param
182
+ */
132
183
  template?: string | null;
184
+ /**
185
+ * Header param: A unique key that makes this request idempotent. If Courier
186
+ * receives another request with the same `Idempotency-Key`, it returns the stored
187
+ * response from the first request without performing the operation again
188
+ * (including the original status code and any error). Use it to safely retry
189
+ * `POST` requests after network failures without risking duplicate sends. The key
190
+ * is scoped to this endpoint.
191
+ */
192
+ 'Idempotency-Key'?: string;
193
+ /**
194
+ * Header param: How long the idempotency key remains valid, as a Unix epoch
195
+ * timestamp in seconds or an ISO 8601 date string. Only applies when
196
+ * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
197
+ * maximum is 1 year.
198
+ */
199
+ 'x-idempotency-expiration'?: string;
133
200
  }
134
201
  export declare namespace Invoke {
135
202
  export { type InvokeInvokeAdHocParams as InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams as InvokeInvokeByTemplateParams, };
@@ -1 +1 @@
1
- {"version":3,"file":"invoke.d.mts","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,WAAW,CACT,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,wBAAwB,CAAC;IAItD;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,wBAAwB,CAAC;CAGvD;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAE/C,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,UAAU;QACzB,KAAK,EAAE,KAAK,CACR,UAAU,CAAC,mBAAmB,GAC9B,UAAU,CAAC,kBAAkB,GAC7B,UAAU,CAAC,sBAAsB,GACjC,UAAU,CAAC,2BAA2B,GACtC,UAAU,CAAC,oBAAoB,GAC/B,UAAU,CAAC,uBAAuB,GAClC,UAAU,CAAC,oBAAoB,CAClC,CAAC;QAEF,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,mBAAmB;YAClC,MAAM,EAAE,OAAO,CAAC;YAEhB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACvB;QAED,UAAiB,kBAAkB;YACjC,MAAM,EAAE,MAAM,CAAC;YAEf,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAEzC,OAAO,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAE5C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED,UAAiB,sBAAsB;YACrC,MAAM,EAAE,WAAW,CAAC;YAEpB,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;SAC1C;QAED,UAAiB,2BAA2B;YAC1C,MAAM,EAAE,gBAAgB,CAAC;YAEzB,OAAO,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEpC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,CAAC;YAE/D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED,UAAiB,oBAAoB;YACnC,MAAM,EAAE,QAAQ,CAAC;YAEjB,iBAAiB,EAAE,MAAM,CAAC;SAC3B;QAED,UAAiB,uBAAuB;YACtC,MAAM,EAAE,YAAY,CAAC;YAErB,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC;YAEzC,cAAc,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,IAAI,CAAC;SAChE;QAED,UAAiB,uBAAuB,CAAC;YACvC,UAAiB,OAAO;gBACtB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;gBAEpD,GAAG,EAAE,MAAM,CAAC;gBAEZ,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB,OAAO,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,GAAG,IAAI,CAAC;aAC5C;SACF;QAED,UAAiB,oBAAoB;YACnC,MAAM,EAAE,QAAQ,CAAC;YAEjB,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"invoke.d.mts","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,CACT,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,wBAAwB,CAAC;IAqBtD;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,wBAAwB,CAAC;CAoBvD;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAE/C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,UAAU;QACzB,KAAK,EAAE,KAAK,CACR,UAAU,CAAC,mBAAmB,GAC9B,UAAU,CAAC,kBAAkB,GAC7B,UAAU,CAAC,sBAAsB,GACjC,UAAU,CAAC,2BAA2B,GACtC,UAAU,CAAC,oBAAoB,GAC/B,UAAU,CAAC,uBAAuB,GAClC,UAAU,CAAC,oBAAoB,CAClC,CAAC;QAEF,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,mBAAmB;YAClC,MAAM,EAAE,OAAO,CAAC;YAEhB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACvB;QAED,UAAiB,kBAAkB;YACjC,MAAM,EAAE,MAAM,CAAC;YAEf,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAEzC,OAAO,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAE5C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED,UAAiB,sBAAsB;YACrC,MAAM,EAAE,WAAW,CAAC;YAEpB,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;SAC1C;QAED,UAAiB,2BAA2B;YAC1C,MAAM,EAAE,gBAAgB,CAAC;YAEzB,OAAO,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEpC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,CAAC;YAE/D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED,UAAiB,oBAAoB;YACnC,MAAM,EAAE,QAAQ,CAAC;YAEjB,iBAAiB,EAAE,MAAM,CAAC;SAC3B;QAED,UAAiB,uBAAuB;YACtC,MAAM,EAAE,YAAY,CAAC;YAErB,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC;YAEzC,cAAc,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,IAAI,CAAC;SAChE;QAED,UAAiB,uBAAuB,CAAC;YACvC,UAAiB,OAAO;gBACtB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;gBAEpD,GAAG,EAAE,MAAM,CAAC;gBAEZ,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB,OAAO,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,GAAG,IAAI,CAAC;aAC5C;SACF;QAED,UAAiB,oBAAoB;YACnC,MAAM,EAAE,QAAQ,CAAC;YAEjB,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -2,12 +2,13 @@ import { APIResource } from "../../core/resource.js";
2
2
  import * as AutomationsAPI from "./automations.js";
3
3
  import { APIPromise } from "../../core/api-promise.js";
4
4
  import { RequestOptions } from "../../internal/request-options.js";
5
+ /**
6
+ * Invoke a stored automation template or an ad hoc automation defined in the request.
7
+ */
5
8
  export declare class Invoke extends APIResource {
6
9
  /**
7
- * Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a
8
- * series of automation steps. For information about what steps are available,
9
- * checkout the ad hoc automation guide
10
- * [here](https://www.courier.com/docs/automations/steps/).
10
+ * Runs a series of automation steps supplied inline, without a saved template, and
11
+ * returns a runId.
11
12
  *
12
13
  * @example
13
14
  * ```ts
@@ -29,9 +30,10 @@ export declare class Invoke extends APIResource {
29
30
  * });
30
31
  * ```
31
32
  */
32
- invokeAdHoc(body: InvokeInvokeAdHocParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
33
+ invokeAdHoc(params: InvokeInvokeAdHocParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
33
34
  /**
34
- * Invoke an automation run from an automation template.
35
+ * Starts an automation run from a saved template for one recipient, with optional
36
+ * data and profile, and returns a runId.
35
37
  *
36
38
  * @example
37
39
  * ```ts
@@ -42,19 +44,53 @@ export declare class Invoke extends APIResource {
42
44
  * );
43
45
  * ```
44
46
  */
45
- invokeByTemplate(templateID: string, body: InvokeInvokeByTemplateParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
47
+ invokeByTemplate(templateID: string, params: InvokeInvokeByTemplateParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
46
48
  }
47
49
  export interface InvokeInvokeAdHocParams {
50
+ /**
51
+ * Body param
52
+ */
48
53
  automation: InvokeInvokeAdHocParams.Automation;
54
+ /**
55
+ * Body param
56
+ */
49
57
  brand?: string | null;
58
+ /**
59
+ * Body param
60
+ */
50
61
  data?: {
51
62
  [key: string]: unknown;
52
63
  } | null;
64
+ /**
65
+ * Body param
66
+ */
53
67
  profile?: {
54
68
  [key: string]: unknown;
55
69
  } | null;
70
+ /**
71
+ * Body param
72
+ */
56
73
  recipient?: string | null;
74
+ /**
75
+ * Body param
76
+ */
57
77
  template?: string | null;
78
+ /**
79
+ * Header param: A unique key that makes this request idempotent. If Courier
80
+ * receives another request with the same `Idempotency-Key`, it returns the stored
81
+ * response from the first request without performing the operation again
82
+ * (including the original status code and any error). Use it to safely retry
83
+ * `POST` requests after network failures without risking duplicate sends. The key
84
+ * is scoped to this endpoint.
85
+ */
86
+ 'Idempotency-Key'?: string;
87
+ /**
88
+ * Header param: How long the idempotency key remains valid, as a Unix epoch
89
+ * timestamp in seconds or an ISO 8601 date string. Only applies when
90
+ * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
91
+ * maximum is 1 year.
92
+ */
93
+ 'x-idempotency-expiration'?: string;
58
94
  }
59
95
  export declare namespace InvokeInvokeAdHocParams {
60
96
  interface Automation {
@@ -121,15 +157,46 @@ export declare namespace InvokeInvokeAdHocParams {
121
157
  }
122
158
  }
123
159
  export interface InvokeInvokeByTemplateParams {
160
+ /**
161
+ * Body param
162
+ */
124
163
  recipient: string | null;
164
+ /**
165
+ * Body param
166
+ */
125
167
  brand?: string | null;
168
+ /**
169
+ * Body param
170
+ */
126
171
  data?: {
127
172
  [key: string]: unknown;
128
173
  } | null;
174
+ /**
175
+ * Body param
176
+ */
129
177
  profile?: {
130
178
  [key: string]: unknown;
131
179
  } | null;
180
+ /**
181
+ * Body param
182
+ */
132
183
  template?: string | null;
184
+ /**
185
+ * Header param: A unique key that makes this request idempotent. If Courier
186
+ * receives another request with the same `Idempotency-Key`, it returns the stored
187
+ * response from the first request without performing the operation again
188
+ * (including the original status code and any error). Use it to safely retry
189
+ * `POST` requests after network failures without risking duplicate sends. The key
190
+ * is scoped to this endpoint.
191
+ */
192
+ 'Idempotency-Key'?: string;
193
+ /**
194
+ * Header param: How long the idempotency key remains valid, as a Unix epoch
195
+ * timestamp in seconds or an ISO 8601 date string. Only applies when
196
+ * `Idempotency-Key` is provided. If omitted, the key is retained for 25 hours; the
197
+ * maximum is 1 year.
198
+ */
199
+ 'x-idempotency-expiration'?: string;
133
200
  }
134
201
  export declare namespace Invoke {
135
202
  export { type InvokeInvokeAdHocParams as InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams as InvokeInvokeByTemplateParams, };
@@ -1 +1 @@
1
- {"version":3,"file":"invoke.d.ts","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,cAAc,yBAAsB;AAChD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,WAAW,CACT,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,wBAAwB,CAAC;IAItD;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,wBAAwB,CAAC;CAGvD;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAE/C,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,UAAU;QACzB,KAAK,EAAE,KAAK,CACR,UAAU,CAAC,mBAAmB,GAC9B,UAAU,CAAC,kBAAkB,GAC7B,UAAU,CAAC,sBAAsB,GACjC,UAAU,CAAC,2BAA2B,GACtC,UAAU,CAAC,oBAAoB,GAC/B,UAAU,CAAC,uBAAuB,GAClC,UAAU,CAAC,oBAAoB,CAClC,CAAC;QAEF,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,mBAAmB;YAClC,MAAM,EAAE,OAAO,CAAC;YAEhB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACvB;QAED,UAAiB,kBAAkB;YACjC,MAAM,EAAE,MAAM,CAAC;YAEf,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAEzC,OAAO,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAE5C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED,UAAiB,sBAAsB;YACrC,MAAM,EAAE,WAAW,CAAC;YAEpB,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;SAC1C;QAED,UAAiB,2BAA2B;YAC1C,MAAM,EAAE,gBAAgB,CAAC;YAEzB,OAAO,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEpC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,CAAC;YAE/D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED,UAAiB,oBAAoB;YACnC,MAAM,EAAE,QAAQ,CAAC;YAEjB,iBAAiB,EAAE,MAAM,CAAC;SAC3B;QAED,UAAiB,uBAAuB;YACtC,MAAM,EAAE,YAAY,CAAC;YAErB,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC;YAEzC,cAAc,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,IAAI,CAAC;SAChE;QAED,UAAiB,uBAAuB,CAAC;YACvC,UAAiB,OAAO;gBACtB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;gBAEpD,GAAG,EAAE,MAAM,CAAC;gBAEZ,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB,OAAO,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,GAAG,IAAI,CAAC;aAC5C;SACF;QAED,UAAiB,oBAAoB;YACnC,MAAM,EAAE,QAAQ,CAAC;YAEjB,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"invoke.d.ts","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,cAAc,yBAAsB;AAChD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,CACT,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,wBAAwB,CAAC;IAqBtD;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC,wBAAwB,CAAC;CAoBvD;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAE/C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,UAAU;QACzB,KAAK,EAAE,KAAK,CACR,UAAU,CAAC,mBAAmB,GAC9B,UAAU,CAAC,kBAAkB,GAC7B,UAAU,CAAC,sBAAsB,GACjC,UAAU,CAAC,2BAA2B,GACtC,UAAU,CAAC,oBAAoB,GAC/B,UAAU,CAAC,uBAAuB,GAClC,UAAU,CAAC,oBAAoB,CAClC,CAAC;QAEF,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,mBAAmB;YAClC,MAAM,EAAE,OAAO,CAAC;YAEhB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACvB;QAED,UAAiB,kBAAkB;YACjC,MAAM,EAAE,MAAM,CAAC;YAEf,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAEzC,OAAO,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;YAE5C,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED,UAAiB,sBAAsB;YACrC,MAAM,EAAE,WAAW,CAAC;YAEpB,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;SAC1C;QAED,UAAiB,2BAA2B;YAC1C,MAAM,EAAE,gBAAgB,CAAC;YAEzB,OAAO,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAEpC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,IAAI,CAAC;YAE/D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC9B;QAED,UAAiB,oBAAoB;YACnC,MAAM,EAAE,QAAQ,CAAC;YAEjB,iBAAiB,EAAE,MAAM,CAAC;SAC3B;QAED,UAAiB,uBAAuB;YACtC,MAAM,EAAE,YAAY,CAAC;YAErB,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC;YAEzC,cAAc,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,IAAI,CAAC;SAChE;QAED,UAAiB,uBAAuB,CAAC;YACvC,UAAiB,OAAO;gBACtB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;gBAEpD,GAAG,EAAE,MAAM,CAAC;gBAEZ,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB,OAAO,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,GAAG,IAAI,CAAC;aAC5C;SACF;QAED,UAAiB,oBAAoB;YACnC,MAAM,EAAE,QAAQ,CAAC;YAEjB,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -3,13 +3,15 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.Invoke = void 0;
5
5
  const resource_1 = require("../../core/resource.js");
6
+ const headers_1 = require("../../internal/headers.js");
6
7
  const path_1 = require("../../internal/utils/path.js");
8
+ /**
9
+ * Invoke a stored automation template or an ad hoc automation defined in the request.
10
+ */
7
11
  class Invoke extends resource_1.APIResource {
8
12
  /**
9
- * Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a
10
- * series of automation steps. For information about what steps are available,
11
- * checkout the ad hoc automation guide
12
- * [here](https://www.courier.com/docs/automations/steps/).
13
+ * Runs a series of automation steps supplied inline, without a saved template, and
14
+ * returns a runId.
13
15
  *
14
16
  * @example
15
17
  * ```ts
@@ -31,11 +33,25 @@ class Invoke extends resource_1.APIResource {
31
33
  * });
32
34
  * ```
33
35
  */
34
- invokeAdHoc(body, options) {
35
- return this._client.post('/automations/invoke', { body, ...options });
36
+ invokeAdHoc(params, options) {
37
+ const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
38
+ return this._client.post('/automations/invoke', {
39
+ body,
40
+ ...options,
41
+ headers: (0, headers_1.buildHeaders)([
42
+ {
43
+ ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
44
+ ...(xIdempotencyExpiration != null ?
45
+ { 'x-idempotency-expiration': xIdempotencyExpiration }
46
+ : undefined),
47
+ },
48
+ options?.headers,
49
+ ]),
50
+ });
36
51
  }
37
52
  /**
38
- * Invoke an automation run from an automation template.
53
+ * Starts an automation run from a saved template for one recipient, with optional
54
+ * data and profile, and returns a runId.
39
55
  *
40
56
  * @example
41
57
  * ```ts
@@ -46,8 +62,21 @@ class Invoke extends resource_1.APIResource {
46
62
  * );
47
63
  * ```
48
64
  */
49
- invokeByTemplate(templateID, body, options) {
50
- return this._client.post((0, path_1.path) `/automations/${templateID}/invoke`, { body, ...options });
65
+ invokeByTemplate(templateID, params, options) {
66
+ const { 'Idempotency-Key': idempotencyKey, 'x-idempotency-expiration': xIdempotencyExpiration, ...body } = params;
67
+ return this._client.post((0, path_1.path) `/automations/${templateID}/invoke`, {
68
+ body,
69
+ ...options,
70
+ headers: (0, headers_1.buildHeaders)([
71
+ {
72
+ ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
73
+ ...(xIdempotencyExpiration != null ?
74
+ { 'x-idempotency-expiration': xIdempotencyExpiration }
75
+ : undefined),
76
+ },
77
+ options?.headers,
78
+ ]),
79
+ });
51
80
  }
52
81
  }
53
82
  exports.Invoke = Invoke;