@trycourier/courier 6.6.1-alpha0 → 6.7.0-alpha10

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 (312) hide show
  1. package/CHANGELOG.md +124 -0
  2. package/README.md +11 -11
  3. package/client.d.mts +48 -20
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +48 -20
  6. package/client.d.ts.map +1 -1
  7. package/client.js.map +1 -1
  8. package/client.mjs +3 -3
  9. package/client.mjs.map +1 -1
  10. package/internal/to-file.d.mts +1 -1
  11. package/internal/to-file.d.ts +1 -1
  12. package/internal/to-file.js +1 -1
  13. package/internal/to-file.mjs +1 -1
  14. package/internal/tslib.js +6 -6
  15. package/package.json +1 -1
  16. package/resources/audiences.d.mts +30 -52
  17. package/resources/audiences.d.mts.map +1 -1
  18. package/resources/audiences.d.ts +30 -52
  19. package/resources/audiences.d.ts.map +1 -1
  20. package/resources/audiences.js.map +1 -1
  21. package/resources/audiences.mjs.map +1 -1
  22. package/resources/audit-events.d.mts +5 -9
  23. package/resources/audit-events.d.mts.map +1 -1
  24. package/resources/audit-events.d.ts +5 -9
  25. package/resources/audit-events.d.ts.map +1 -1
  26. package/resources/auth.d.mts +2 -2
  27. package/resources/auth.d.mts.map +1 -1
  28. package/resources/auth.d.ts +2 -2
  29. package/resources/auth.d.ts.map +1 -1
  30. package/resources/automations/automations.d.mts +5 -252
  31. package/resources/automations/automations.d.mts.map +1 -1
  32. package/resources/automations/automations.d.ts +5 -252
  33. package/resources/automations/automations.d.ts.map +1 -1
  34. package/resources/automations/automations.js +0 -42
  35. package/resources/automations/automations.js.map +1 -1
  36. package/resources/automations/automations.mjs +1 -43
  37. package/resources/automations/automations.mjs.map +1 -1
  38. package/resources/automations/index.d.mts +2 -2
  39. package/resources/automations/index.d.mts.map +1 -1
  40. package/resources/automations/index.d.ts +2 -2
  41. package/resources/automations/index.d.ts.map +1 -1
  42. package/resources/automations/index.js.map +1 -1
  43. package/resources/automations/index.mjs +2 -2
  44. package/resources/automations/index.mjs.map +1 -1
  45. package/resources/automations/invoke.d.mts +122 -9
  46. package/resources/automations/invoke.d.mts.map +1 -1
  47. package/resources/automations/invoke.d.ts +122 -9
  48. package/resources/automations/invoke.d.ts.map +1 -1
  49. package/resources/automations/invoke.js +45 -0
  50. package/resources/automations/invoke.js.map +1 -1
  51. package/resources/automations/invoke.mjs +45 -0
  52. package/resources/automations/invoke.mjs.map +1 -1
  53. package/resources/brands.d.mts +76 -52
  54. package/resources/brands.d.mts.map +1 -1
  55. package/resources/brands.d.ts +76 -52
  56. package/resources/brands.d.ts.map +1 -1
  57. package/resources/brands.js.map +1 -1
  58. package/resources/brands.mjs.map +1 -1
  59. package/resources/bulk.d.mts +36 -127
  60. package/resources/bulk.d.mts.map +1 -1
  61. package/resources/bulk.d.ts +36 -127
  62. package/resources/bulk.d.ts.map +1 -1
  63. package/resources/bulk.js.map +1 -1
  64. package/resources/bulk.mjs.map +1 -1
  65. package/resources/inbound.d.mts +1 -1
  66. package/resources/inbound.d.ts +1 -1
  67. package/resources/index.d.mts +11 -10
  68. package/resources/index.d.mts.map +1 -1
  69. package/resources/index.d.ts +11 -10
  70. package/resources/index.d.ts.map +1 -1
  71. package/resources/index.js +2 -0
  72. package/resources/index.js.map +1 -1
  73. package/resources/index.mjs +3 -2
  74. package/resources/index.mjs.map +1 -1
  75. package/resources/lists/index.d.mts +2 -2
  76. package/resources/lists/index.d.mts.map +1 -1
  77. package/resources/lists/index.d.ts +2 -2
  78. package/resources/lists/index.d.ts.map +1 -1
  79. package/resources/lists/index.js.map +1 -1
  80. package/resources/lists/index.mjs +1 -1
  81. package/resources/lists/index.mjs.map +1 -1
  82. package/resources/lists/lists.d.mts +19 -13
  83. package/resources/lists/lists.d.mts.map +1 -1
  84. package/resources/lists/lists.d.ts +19 -13
  85. package/resources/lists/lists.d.ts.map +1 -1
  86. package/resources/lists/lists.js +7 -2
  87. package/resources/lists/lists.js.map +1 -1
  88. package/resources/lists/lists.mjs +7 -2
  89. package/resources/lists/lists.mjs.map +1 -1
  90. package/resources/lists/subscriptions.d.mts +8 -52
  91. package/resources/lists/subscriptions.d.mts.map +1 -1
  92. package/resources/lists/subscriptions.d.ts +8 -52
  93. package/resources/lists/subscriptions.d.ts.map +1 -1
  94. package/resources/lists/subscriptions.js.map +1 -1
  95. package/resources/lists/subscriptions.mjs.map +1 -1
  96. package/resources/messages.d.mts +8 -8
  97. package/resources/messages.d.mts.map +1 -1
  98. package/resources/messages.d.ts +8 -8
  99. package/resources/messages.d.ts.map +1 -1
  100. package/resources/messages.js +1 -1
  101. package/resources/messages.js.map +1 -1
  102. package/resources/messages.mjs +1 -1
  103. package/resources/messages.mjs.map +1 -1
  104. package/resources/notifications/checks.d.mts +5 -12
  105. package/resources/notifications/checks.d.mts.map +1 -1
  106. package/resources/notifications/checks.d.ts +5 -12
  107. package/resources/notifications/checks.d.ts.map +1 -1
  108. package/resources/notifications/checks.js.map +1 -1
  109. package/resources/notifications/checks.mjs.map +1 -1
  110. package/resources/notifications/index.d.mts +2 -2
  111. package/resources/notifications/index.d.mts.map +1 -1
  112. package/resources/notifications/index.d.ts +2 -2
  113. package/resources/notifications/index.d.ts.map +1 -1
  114. package/resources/notifications/index.js.map +1 -1
  115. package/resources/notifications/index.mjs.map +1 -1
  116. package/resources/notifications/notifications.d.mts +13 -11
  117. package/resources/notifications/notifications.d.mts.map +1 -1
  118. package/resources/notifications/notifications.d.ts +13 -11
  119. package/resources/notifications/notifications.d.ts.map +1 -1
  120. package/resources/notifications/notifications.js.map +1 -1
  121. package/resources/notifications/notifications.mjs.map +1 -1
  122. package/resources/profiles/index.d.mts +1 -1
  123. package/resources/profiles/index.d.mts.map +1 -1
  124. package/resources/profiles/index.d.ts +1 -1
  125. package/resources/profiles/index.d.ts.map +1 -1
  126. package/resources/profiles/index.js.map +1 -1
  127. package/resources/profiles/index.mjs.map +1 -1
  128. package/resources/profiles/lists.d.mts +5 -11
  129. package/resources/profiles/lists.d.mts.map +1 -1
  130. package/resources/profiles/lists.d.ts +5 -11
  131. package/resources/profiles/lists.d.ts.map +1 -1
  132. package/resources/profiles/profiles.d.mts +7 -3
  133. package/resources/profiles/profiles.d.mts.map +1 -1
  134. package/resources/profiles/profiles.d.ts +7 -3
  135. package/resources/profiles/profiles.d.ts.map +1 -1
  136. package/resources/profiles/profiles.js.map +1 -1
  137. package/resources/profiles/profiles.mjs.map +1 -1
  138. package/resources/send.d.mts +127 -745
  139. package/resources/send.d.mts.map +1 -1
  140. package/resources/send.d.ts +127 -745
  141. package/resources/send.d.ts.map +1 -1
  142. package/resources/send.js +12 -1
  143. package/resources/send.js.map +1 -1
  144. package/resources/send.mjs +12 -1
  145. package/resources/send.mjs.map +1 -1
  146. package/resources/shared.d.mts +245 -0
  147. package/resources/shared.d.mts.map +1 -0
  148. package/resources/shared.d.ts +245 -0
  149. package/resources/shared.d.ts.map +1 -0
  150. package/resources/shared.js +4 -0
  151. package/resources/shared.js.map +1 -0
  152. package/{src/resources/tenants/default-preferences.ts → resources/shared.mjs} +2 -2
  153. package/resources/shared.mjs.map +1 -0
  154. package/resources/tenants/index.d.mts +3 -1
  155. package/resources/tenants/index.d.mts.map +1 -1
  156. package/resources/tenants/index.d.ts +3 -1
  157. package/resources/tenants/index.d.ts.map +1 -1
  158. package/resources/tenants/index.js +5 -1
  159. package/resources/tenants/index.js.map +1 -1
  160. package/resources/tenants/index.mjs +2 -0
  161. package/resources/tenants/index.mjs.map +1 -1
  162. package/resources/tenants/templates.d.mts +91 -0
  163. package/resources/tenants/templates.d.mts.map +1 -0
  164. package/resources/tenants/templates.d.ts +91 -0
  165. package/resources/tenants/templates.d.ts.map +1 -0
  166. package/resources/tenants/templates.js +38 -0
  167. package/resources/tenants/templates.js.map +1 -0
  168. package/resources/tenants/templates.mjs +34 -0
  169. package/resources/tenants/templates.mjs.map +1 -0
  170. package/resources/tenants/tenant-default-preferences/index.d.mts +3 -0
  171. package/resources/tenants/tenant-default-preferences/index.d.mts.map +1 -0
  172. package/resources/tenants/tenant-default-preferences/index.d.ts +3 -0
  173. package/resources/tenants/tenant-default-preferences/index.d.ts.map +1 -0
  174. package/resources/tenants/tenant-default-preferences/index.js +9 -0
  175. package/resources/tenants/tenant-default-preferences/index.js.map +1 -0
  176. package/resources/tenants/tenant-default-preferences/index.mjs +4 -0
  177. package/resources/tenants/tenant-default-preferences/index.mjs.map +1 -0
  178. package/resources/tenants/{default-preferences → tenant-default-preferences}/items.d.mts +5 -18
  179. package/resources/tenants/tenant-default-preferences/items.d.mts.map +1 -0
  180. package/resources/tenants/{default-preferences → tenant-default-preferences}/items.d.ts +5 -18
  181. package/resources/tenants/tenant-default-preferences/items.d.ts.map +1 -0
  182. package/resources/tenants/{default-preferences → tenant-default-preferences}/items.js +2 -2
  183. package/resources/tenants/tenant-default-preferences/items.js.map +1 -0
  184. package/resources/tenants/{default-preferences → tenant-default-preferences}/items.mjs +2 -2
  185. package/resources/tenants/tenant-default-preferences/items.mjs.map +1 -0
  186. package/resources/tenants/tenant-default-preferences/tenant-default-preferences.d.mts +10 -0
  187. package/resources/tenants/tenant-default-preferences/tenant-default-preferences.d.mts.map +1 -0
  188. package/resources/tenants/tenant-default-preferences/tenant-default-preferences.d.ts +10 -0
  189. package/resources/tenants/tenant-default-preferences/tenant-default-preferences.d.ts.map +1 -0
  190. package/resources/tenants/{default-preferences/default-preferences.js → tenant-default-preferences/tenant-default-preferences.js} +5 -5
  191. package/resources/tenants/tenant-default-preferences/tenant-default-preferences.js.map +1 -0
  192. package/resources/tenants/{default-preferences/default-preferences.mjs → tenant-default-preferences/tenant-default-preferences.mjs} +4 -4
  193. package/resources/tenants/tenant-default-preferences/tenant-default-preferences.mjs.map +1 -0
  194. package/resources/tenants/tenant-default-preferences.d.mts +2 -0
  195. package/resources/tenants/tenant-default-preferences.d.mts.map +1 -0
  196. package/resources/tenants/tenant-default-preferences.d.ts +2 -0
  197. package/resources/tenants/tenant-default-preferences.d.ts.map +1 -0
  198. package/resources/tenants/{default-preferences.js → tenant-default-preferences.js} +2 -2
  199. package/resources/tenants/tenant-default-preferences.js.map +1 -0
  200. package/resources/tenants/tenant-default-preferences.mjs +3 -0
  201. package/resources/tenants/tenant-default-preferences.mjs.map +1 -0
  202. package/resources/tenants/tenants.d.mts +66 -7
  203. package/resources/tenants/tenants.d.mts.map +1 -1
  204. package/resources/tenants/tenants.d.ts +66 -7
  205. package/resources/tenants/tenants.d.ts.map +1 -1
  206. package/resources/tenants/tenants.js +8 -2
  207. package/resources/tenants/tenants.js.map +1 -1
  208. package/resources/tenants/tenants.mjs +8 -2
  209. package/resources/tenants/tenants.mjs.map +1 -1
  210. package/resources/users/index.d.mts +3 -3
  211. package/resources/users/index.d.mts.map +1 -1
  212. package/resources/users/index.d.ts +3 -3
  213. package/resources/users/index.d.ts.map +1 -1
  214. package/resources/users/index.js.map +1 -1
  215. package/resources/users/index.mjs.map +1 -1
  216. package/resources/users/preferences.d.mts +8 -11
  217. package/resources/users/preferences.d.mts.map +1 -1
  218. package/resources/users/preferences.d.ts +8 -11
  219. package/resources/users/preferences.d.ts.map +1 -1
  220. package/resources/users/preferences.js.map +1 -1
  221. package/resources/users/preferences.mjs.map +1 -1
  222. package/resources/users/tenants.d.mts +4 -21
  223. package/resources/users/tenants.d.mts.map +1 -1
  224. package/resources/users/tenants.d.ts +4 -21
  225. package/resources/users/tenants.d.ts.map +1 -1
  226. package/resources/users/tenants.js.map +1 -1
  227. package/resources/users/tenants.mjs.map +1 -1
  228. package/resources/users/tokens.d.mts +22 -23
  229. package/resources/users/tokens.d.mts.map +1 -1
  230. package/resources/users/tokens.d.ts +22 -23
  231. package/resources/users/tokens.d.ts.map +1 -1
  232. package/resources/users/tokens.js +14 -15
  233. package/resources/users/tokens.js.map +1 -1
  234. package/resources/users/tokens.mjs +14 -15
  235. package/resources/users/tokens.mjs.map +1 -1
  236. package/resources/users/users.d.mts +6 -6
  237. package/resources/users/users.d.mts.map +1 -1
  238. package/resources/users/users.d.ts +6 -6
  239. package/resources/users/users.d.ts.map +1 -1
  240. package/resources/users/users.js.map +1 -1
  241. package/resources/users/users.mjs.map +1 -1
  242. package/src/client.ts +81 -56
  243. package/src/internal/to-file.ts +1 -1
  244. package/src/resources/audiences.ts +45 -90
  245. package/src/resources/audit-events.ts +7 -13
  246. package/src/resources/auth.ts +2 -16
  247. package/src/resources/automations/automations.ts +6 -342
  248. package/src/resources/automations/index.ts +2 -12
  249. package/src/resources/automations/invoke.ts +163 -14
  250. package/src/resources/brands.ts +119 -53
  251. package/src/resources/bulk.ts +28 -148
  252. package/src/resources/inbound.ts +1 -1
  253. package/src/resources/index.ts +24 -30
  254. package/src/resources/lists/index.ts +9 -3
  255. package/src/resources/lists/lists.ts +27 -16
  256. package/src/resources/lists/subscriptions.ts +7 -65
  257. package/src/resources/messages.ts +10 -7
  258. package/src/resources/notifications/checks.ts +4 -17
  259. package/src/resources/notifications/index.ts +2 -4
  260. package/src/resources/notifications/notifications.ts +13 -14
  261. package/src/resources/profiles/index.ts +1 -0
  262. package/src/resources/profiles/lists.ts +5 -13
  263. package/src/resources/profiles/profiles.ts +9 -2
  264. package/src/resources/send.ts +122 -928
  265. package/src/resources/shared.ts +305 -0
  266. package/src/resources/tenants/index.ts +10 -0
  267. package/src/resources/tenants/templates.ts +124 -0
  268. package/src/resources/tenants/tenant-default-preferences/index.ts +4 -0
  269. package/src/resources/tenants/{default-preferences → tenant-default-preferences}/items.ts +5 -27
  270. package/src/resources/tenants/{default-preferences/default-preferences.ts → tenant-default-preferences/tenant-default-preferences.ts} +4 -12
  271. package/src/resources/tenants/tenant-default-preferences.ts +3 -0
  272. package/src/resources/tenants/tenants.ts +89 -8
  273. package/src/resources/users/index.ts +2 -4
  274. package/src/resources/users/preferences.ts +7 -12
  275. package/src/resources/users/tenants.ts +3 -23
  276. package/src/resources/users/tokens.ts +33 -34
  277. package/src/resources/users/users.ts +4 -8
  278. package/src/version.ts +1 -1
  279. package/version.d.mts +1 -1
  280. package/version.d.mts.map +1 -1
  281. package/version.d.ts +1 -1
  282. package/version.d.ts.map +1 -1
  283. package/version.js +1 -1
  284. package/version.js.map +1 -1
  285. package/version.mjs +1 -1
  286. package/version.mjs.map +1 -1
  287. package/resources/tenants/default-preferences/default-preferences.d.mts +0 -10
  288. package/resources/tenants/default-preferences/default-preferences.d.mts.map +0 -1
  289. package/resources/tenants/default-preferences/default-preferences.d.ts +0 -10
  290. package/resources/tenants/default-preferences/default-preferences.d.ts.map +0 -1
  291. package/resources/tenants/default-preferences/default-preferences.js.map +0 -1
  292. package/resources/tenants/default-preferences/default-preferences.mjs.map +0 -1
  293. package/resources/tenants/default-preferences/index.d.mts +0 -3
  294. package/resources/tenants/default-preferences/index.d.mts.map +0 -1
  295. package/resources/tenants/default-preferences/index.d.ts +0 -3
  296. package/resources/tenants/default-preferences/index.d.ts.map +0 -1
  297. package/resources/tenants/default-preferences/index.js +0 -9
  298. package/resources/tenants/default-preferences/index.js.map +0 -1
  299. package/resources/tenants/default-preferences/index.mjs +0 -4
  300. package/resources/tenants/default-preferences/index.mjs.map +0 -1
  301. package/resources/tenants/default-preferences/items.d.mts.map +0 -1
  302. package/resources/tenants/default-preferences/items.d.ts.map +0 -1
  303. package/resources/tenants/default-preferences/items.js.map +0 -1
  304. package/resources/tenants/default-preferences/items.mjs.map +0 -1
  305. package/resources/tenants/default-preferences.d.mts +0 -2
  306. package/resources/tenants/default-preferences.d.mts.map +0 -1
  307. package/resources/tenants/default-preferences.d.ts +0 -2
  308. package/resources/tenants/default-preferences.d.ts.map +0 -1
  309. package/resources/tenants/default-preferences.js.map +0 -1
  310. package/resources/tenants/default-preferences.mjs +0 -3
  311. package/resources/tenants/default-preferences.mjs.map +0 -1
  312. package/src/resources/tenants/default-preferences/index.ts +0 -10
@@ -1,54 +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
3
  import * as InvokeAPI from "./invoke.mjs";
4
- import { Invoke, } from "./invoke.mjs";
5
- import { path } from "../../internal/utils/path.mjs";
4
+ import { Invoke } from "./invoke.mjs";
6
5
  export class Automations extends APIResource {
7
6
  constructor() {
8
7
  super(...arguments);
9
8
  this.invoke = new InvokeAPI.Invoke(this._client);
10
9
  }
11
- /**
12
- * Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a
13
- * series of automation steps. For information about what steps are available,
14
- * checkout the ad hoc automation guide
15
- * [here](https://www.courier.com/docs/automations/steps/).
16
- *
17
- * @example
18
- * ```ts
19
- * const automationInvokeResponse =
20
- * await client.automations.invokeAdHoc({
21
- * automation: {
22
- * cancelation_token: 'delay-send--user-yes--abc-123',
23
- * steps: [
24
- * { action: 'delay', until: '20240408T080910.123' },
25
- * {
26
- * action: 'send',
27
- * template: '64TP5HKPFTM8VTK1Y75SJDQX9JK0',
28
- * },
29
- * ],
30
- * },
31
- * data: { name: 'Foo' },
32
- * profile: { tenant_id: 'abc-123' },
33
- * recipient: 'user-yes',
34
- * });
35
- * ```
36
- */
37
- invokeAdHoc(body, options) {
38
- return this._client.post('/automations/invoke', { body, ...options });
39
- }
40
- /**
41
- * Invoke an automation run from an automation template.
42
- *
43
- * @example
44
- * ```ts
45
- * const automationInvokeResponse =
46
- * await client.automations.invokeByTemplate('templateId');
47
- * ```
48
- */
49
- invokeByTemplate(templateID, body, options) {
50
- return this._client.post(path `/automations/${templateID}/invoke`, { body, ...options });
51
- }
52
10
  }
53
11
  Automations.Invoke = Invoke;
54
12
  //# sourceMappingURL=automations.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"automations.mjs","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,SAAS;OACd,EAIL,MAAM,GAEP;OAGM,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmDhE,CAAC;IAjDC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,WAAW,CACT,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;OAQG;IACH,gBAAgB,CACd,UAAkB,EAClB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,UAAU,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAqRD,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"automations.mjs","sourceRoot":"","sources":["../../src/resources/automations/automations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,MAAM,EAAyD;AAExE,MAAM,OAAO,WAAY,SAAQ,WAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;CAAA;AAMD,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC"}
@@ -1,3 +1,3 @@
1
- export { Automations, type AutomationInvokeAdHocParams, type AutomationInvokeByTemplateParams, } from "./automations.mjs";
2
- export { Invoke, type AutomationInvokeParams, type AutomationInvokeResponse, type AutomationStep, type MergeAlgorithm, } from "./invoke.mjs";
1
+ export { Automations, type AutomationInvokeResponse } from "./automations.mjs";
2
+ export { Invoke, type InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams } from "./invoke.mjs";
3
3
  //# sourceMappingURL=index.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,2BAA2B,EAChC,KAAK,gCAAgC,GACtC;OACM,EACL,MAAM,EACN,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EACnB,KAAK,cAAc,GACpB"}
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE,KAAK,wBAAwB,EAAE;OAC9C,EAAE,MAAM,EAAE,KAAK,uBAAuB,EAAE,KAAK,4BAA4B,EAAE"}
@@ -1,3 +1,3 @@
1
- export { Automations, type AutomationInvokeAdHocParams, type AutomationInvokeByTemplateParams, } from "./automations.js";
2
- export { Invoke, type AutomationInvokeParams, type AutomationInvokeResponse, type AutomationStep, type MergeAlgorithm, } from "./invoke.js";
1
+ export { Automations, type AutomationInvokeResponse } from "./automations.js";
2
+ export { Invoke, type InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams } from "./invoke.js";
3
3
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"OAEO,EACL,WAAW,EACX,KAAK,2BAA2B,EAChC,KAAK,gCAAgC,GACtC;OACM,EACL,MAAM,EACN,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EACnB,KAAK,cAAc,GACpB"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE,KAAK,wBAAwB,EAAE;OAC9C,EAAE,MAAM,EAAE,KAAK,uBAAuB,EAAE,KAAK,4BAA4B,EAAE"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAIuB;AAHrB,0GAAA,WAAW,OAAA;AAIb,sCAMkB;AALhB,gGAAA,MAAM,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA2E;AAAlE,0GAAA,WAAW,OAAA;AACpB,sCAAmG;AAA1F,gGAAA,MAAM,OAAA"}
@@ -1,4 +1,4 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
- export { Automations, } from "./automations.mjs";
3
- export { Invoke, } from "./invoke.mjs";
2
+ export { Automations } from "./automations.mjs";
3
+ export { Invoke } from "./invoke.mjs";
4
4
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,WAAW,GAGZ;OACM,EACL,MAAM,GAKP"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/automations/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAiC;OAC9C,EAAE,MAAM,EAAmE"}
@@ -1,24 +1,137 @@
1
1
  import { APIResource } from "../../core/resource.mjs";
2
+ import * as AutomationsAPI from "./automations.mjs";
3
+ import { APIPromise } from "../../core/api-promise.mjs";
4
+ import { RequestOptions } from "../../internal/request-options.mjs";
2
5
  export declare class Invoke extends APIResource {
6
+ /**
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/).
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const automationInvokeResponse =
15
+ * await client.automations.invoke.invokeAdHoc({
16
+ * automation: {
17
+ * cancelation_token: 'delay-send--user-yes--abc-123',
18
+ * steps: [
19
+ * { action: 'delay', until: '20240408T080910.123' },
20
+ * {
21
+ * action: 'send',
22
+ * template: '64TP5HKPFTM8VTK1Y75SJDQX9JK0',
23
+ * },
24
+ * ],
25
+ * },
26
+ * data: { name: 'Foo' },
27
+ * profile: { tenant_id: 'abc-123' },
28
+ * recipient: 'user-yes',
29
+ * });
30
+ * ```
31
+ */
32
+ invokeAdHoc(body: InvokeInvokeAdHocParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
33
+ /**
34
+ * Invoke an automation run from an automation template.
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * const automationInvokeResponse =
39
+ * await client.automations.invoke.invokeByTemplate(
40
+ * 'templateId',
41
+ * { recipient: 'recipient' },
42
+ * );
43
+ * ```
44
+ */
45
+ invokeByTemplate(templateID: string, body: InvokeInvokeByTemplateParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
3
46
  }
4
- export interface AutomationInvokeParams {
47
+ export interface InvokeInvokeAdHocParams {
48
+ automation: InvokeInvokeAdHocParams.Automation;
5
49
  brand?: string | null;
6
50
  data?: {
7
51
  [key: string]: unknown;
8
52
  } | null;
9
- profile?: unknown;
53
+ profile?: {
54
+ [key: string]: unknown;
55
+ } | null;
10
56
  recipient?: string | null;
11
57
  template?: string | null;
12
58
  }
13
- export interface AutomationInvokeResponse {
14
- runId: string;
59
+ export declare namespace InvokeInvokeAdHocParams {
60
+ interface Automation {
61
+ steps: Array<Automation.AutomationDelayStep | Automation.AutomationSendStep | Automation.AutomationSendListStep | Automation.AutomationUpdateProfileStep | Automation.AutomationCancelStep | Automation.AutomationFetchDataStep | Automation.AutomationInvokeStep>;
62
+ cancelation_token?: string | null;
63
+ }
64
+ namespace Automation {
65
+ interface AutomationDelayStep {
66
+ action: 'delay';
67
+ duration?: string | null;
68
+ until?: string | null;
69
+ }
70
+ interface AutomationSendStep {
71
+ action: 'send';
72
+ brand?: string | null;
73
+ data?: {
74
+ [key: string]: unknown;
75
+ } | null;
76
+ profile?: {
77
+ [key: string]: unknown;
78
+ } | null;
79
+ recipient?: string | null;
80
+ template?: string | null;
81
+ }
82
+ interface AutomationSendListStep {
83
+ action: 'send-list';
84
+ list: string;
85
+ brand?: string | null;
86
+ data?: {
87
+ [key: string]: unknown;
88
+ } | null;
89
+ }
90
+ interface AutomationUpdateProfileStep {
91
+ action: 'update-profile';
92
+ profile: {
93
+ [key: string]: unknown;
94
+ };
95
+ merge?: 'none' | 'overwrite' | 'soft-merge' | 'replace' | null;
96
+ recipient_id?: string | null;
97
+ }
98
+ interface AutomationCancelStep {
99
+ action: 'cancel';
100
+ cancelation_token: string;
101
+ }
102
+ interface AutomationFetchDataStep {
103
+ action: 'fetch-data';
104
+ webhook: AutomationFetchDataStep.Webhook;
105
+ merge_strategy?: 'replace' | 'overwrite' | 'soft-merge' | null;
106
+ }
107
+ namespace AutomationFetchDataStep {
108
+ interface Webhook {
109
+ method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
110
+ url: string;
111
+ body?: string | null;
112
+ headers?: {
113
+ [key: string]: string;
114
+ } | null;
115
+ }
116
+ }
117
+ interface AutomationInvokeStep {
118
+ action: 'invoke';
119
+ template: string;
120
+ }
121
+ }
15
122
  }
16
- export interface AutomationStep {
17
- if?: string | null;
18
- ref?: string | null;
123
+ export interface InvokeInvokeByTemplateParams {
124
+ recipient: string | null;
125
+ brand?: string | null;
126
+ data?: {
127
+ [key: string]: unknown;
128
+ } | null;
129
+ profile?: {
130
+ [key: string]: unknown;
131
+ } | null;
132
+ template?: string | null;
19
133
  }
20
- export type MergeAlgorithm = 'replace' | 'none' | 'overwrite' | 'soft-merge';
21
134
  export declare namespace Invoke {
22
- export { type AutomationInvokeParams as AutomationInvokeParams, type AutomationInvokeResponse as AutomationInvokeResponse, type AutomationStep as AutomationStep, type MergeAlgorithm as MergeAlgorithm, };
135
+ export { type InvokeInvokeAdHocParams as InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams as InvokeInvokeByTemplateParams, };
23
136
  }
24
137
  //# sourceMappingURL=invoke.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"invoke.d.mts","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,MAAO,SAAQ,WAAW;CAAG;AAE1C,MAAM,WAAW,sBAAsB;IACrC,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,OAAO,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,YAAY,CAAC;AAE7E,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
1
+ {"version":3,"file":"invoke.d.mts","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,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,24 +1,137 @@
1
1
  import { APIResource } from "../../core/resource.js";
2
+ import * as AutomationsAPI from "./automations.js";
3
+ import { APIPromise } from "../../core/api-promise.js";
4
+ import { RequestOptions } from "../../internal/request-options.js";
2
5
  export declare class Invoke extends APIResource {
6
+ /**
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/).
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const automationInvokeResponse =
15
+ * await client.automations.invoke.invokeAdHoc({
16
+ * automation: {
17
+ * cancelation_token: 'delay-send--user-yes--abc-123',
18
+ * steps: [
19
+ * { action: 'delay', until: '20240408T080910.123' },
20
+ * {
21
+ * action: 'send',
22
+ * template: '64TP5HKPFTM8VTK1Y75SJDQX9JK0',
23
+ * },
24
+ * ],
25
+ * },
26
+ * data: { name: 'Foo' },
27
+ * profile: { tenant_id: 'abc-123' },
28
+ * recipient: 'user-yes',
29
+ * });
30
+ * ```
31
+ */
32
+ invokeAdHoc(body: InvokeInvokeAdHocParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
33
+ /**
34
+ * Invoke an automation run from an automation template.
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * const automationInvokeResponse =
39
+ * await client.automations.invoke.invokeByTemplate(
40
+ * 'templateId',
41
+ * { recipient: 'recipient' },
42
+ * );
43
+ * ```
44
+ */
45
+ invokeByTemplate(templateID: string, body: InvokeInvokeByTemplateParams, options?: RequestOptions): APIPromise<AutomationsAPI.AutomationInvokeResponse>;
3
46
  }
4
- export interface AutomationInvokeParams {
47
+ export interface InvokeInvokeAdHocParams {
48
+ automation: InvokeInvokeAdHocParams.Automation;
5
49
  brand?: string | null;
6
50
  data?: {
7
51
  [key: string]: unknown;
8
52
  } | null;
9
- profile?: unknown;
53
+ profile?: {
54
+ [key: string]: unknown;
55
+ } | null;
10
56
  recipient?: string | null;
11
57
  template?: string | null;
12
58
  }
13
- export interface AutomationInvokeResponse {
14
- runId: string;
59
+ export declare namespace InvokeInvokeAdHocParams {
60
+ interface Automation {
61
+ steps: Array<Automation.AutomationDelayStep | Automation.AutomationSendStep | Automation.AutomationSendListStep | Automation.AutomationUpdateProfileStep | Automation.AutomationCancelStep | Automation.AutomationFetchDataStep | Automation.AutomationInvokeStep>;
62
+ cancelation_token?: string | null;
63
+ }
64
+ namespace Automation {
65
+ interface AutomationDelayStep {
66
+ action: 'delay';
67
+ duration?: string | null;
68
+ until?: string | null;
69
+ }
70
+ interface AutomationSendStep {
71
+ action: 'send';
72
+ brand?: string | null;
73
+ data?: {
74
+ [key: string]: unknown;
75
+ } | null;
76
+ profile?: {
77
+ [key: string]: unknown;
78
+ } | null;
79
+ recipient?: string | null;
80
+ template?: string | null;
81
+ }
82
+ interface AutomationSendListStep {
83
+ action: 'send-list';
84
+ list: string;
85
+ brand?: string | null;
86
+ data?: {
87
+ [key: string]: unknown;
88
+ } | null;
89
+ }
90
+ interface AutomationUpdateProfileStep {
91
+ action: 'update-profile';
92
+ profile: {
93
+ [key: string]: unknown;
94
+ };
95
+ merge?: 'none' | 'overwrite' | 'soft-merge' | 'replace' | null;
96
+ recipient_id?: string | null;
97
+ }
98
+ interface AutomationCancelStep {
99
+ action: 'cancel';
100
+ cancelation_token: string;
101
+ }
102
+ interface AutomationFetchDataStep {
103
+ action: 'fetch-data';
104
+ webhook: AutomationFetchDataStep.Webhook;
105
+ merge_strategy?: 'replace' | 'overwrite' | 'soft-merge' | null;
106
+ }
107
+ namespace AutomationFetchDataStep {
108
+ interface Webhook {
109
+ method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
110
+ url: string;
111
+ body?: string | null;
112
+ headers?: {
113
+ [key: string]: string;
114
+ } | null;
115
+ }
116
+ }
117
+ interface AutomationInvokeStep {
118
+ action: 'invoke';
119
+ template: string;
120
+ }
121
+ }
15
122
  }
16
- export interface AutomationStep {
17
- if?: string | null;
18
- ref?: string | null;
123
+ export interface InvokeInvokeByTemplateParams {
124
+ recipient: string | null;
125
+ brand?: string | null;
126
+ data?: {
127
+ [key: string]: unknown;
128
+ } | null;
129
+ profile?: {
130
+ [key: string]: unknown;
131
+ } | null;
132
+ template?: string | null;
19
133
  }
20
- export type MergeAlgorithm = 'replace' | 'none' | 'overwrite' | 'soft-merge';
21
134
  export declare namespace Invoke {
22
- export { type AutomationInvokeParams as AutomationInvokeParams, type AutomationInvokeResponse as AutomationInvokeResponse, type AutomationStep as AutomationStep, type MergeAlgorithm as MergeAlgorithm, };
135
+ export { type InvokeInvokeAdHocParams as InvokeInvokeAdHocParams, type InvokeInvokeByTemplateParams as InvokeInvokeByTemplateParams, };
23
136
  }
24
137
  //# sourceMappingURL=invoke.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"invoke.d.ts","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,MAAO,SAAQ,WAAW;CAAG;AAE1C,MAAM,WAAW,sBAAsB;IACrC,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,OAAO,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,YAAY,CAAC;AAE7E,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
1
+ {"version":3,"file":"invoke.d.ts","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,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"}
@@ -3,7 +3,52 @@
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 path_1 = require("../../internal/utils/path.js");
6
7
  class Invoke extends resource_1.APIResource {
8
+ /**
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
+ *
14
+ * @example
15
+ * ```ts
16
+ * const automationInvokeResponse =
17
+ * await client.automations.invoke.invokeAdHoc({
18
+ * automation: {
19
+ * cancelation_token: 'delay-send--user-yes--abc-123',
20
+ * steps: [
21
+ * { action: 'delay', until: '20240408T080910.123' },
22
+ * {
23
+ * action: 'send',
24
+ * template: '64TP5HKPFTM8VTK1Y75SJDQX9JK0',
25
+ * },
26
+ * ],
27
+ * },
28
+ * data: { name: 'Foo' },
29
+ * profile: { tenant_id: 'abc-123' },
30
+ * recipient: 'user-yes',
31
+ * });
32
+ * ```
33
+ */
34
+ invokeAdHoc(body, options) {
35
+ return this._client.post('/automations/invoke', { body, ...options });
36
+ }
37
+ /**
38
+ * Invoke an automation run from an automation template.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * const automationInvokeResponse =
43
+ * await client.automations.invoke.invokeByTemplate(
44
+ * 'templateId',
45
+ * { recipient: 'recipient' },
46
+ * );
47
+ * ```
48
+ */
49
+ invokeByTemplate(templateID, body, options) {
50
+ return this._client.post((0, path_1.path) `/automations/${templateID}/invoke`, { body, ...options });
51
+ }
7
52
  }
8
53
  exports.Invoke = Invoke;
9
54
  //# sourceMappingURL=invoke.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"invoke.js","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,MAAa,MAAO,SAAQ,sBAAW;CAAG;AAA1C,wBAA0C"}
1
+ {"version":3,"file":"invoke.js","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,WAAW,CACT,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,UAAkB,EAClB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,UAAU,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AArDD,wBAqDC"}
@@ -1,5 +1,50 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
  import { APIResource } from "../../core/resource.mjs";
3
+ import { path } from "../../internal/utils/path.mjs";
3
4
  export class Invoke extends APIResource {
5
+ /**
6
+ * Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a
7
+ * series of automation steps. For information about what steps are available,
8
+ * checkout the ad hoc automation guide
9
+ * [here](https://www.courier.com/docs/automations/steps/).
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const automationInvokeResponse =
14
+ * await client.automations.invoke.invokeAdHoc({
15
+ * automation: {
16
+ * cancelation_token: 'delay-send--user-yes--abc-123',
17
+ * steps: [
18
+ * { action: 'delay', until: '20240408T080910.123' },
19
+ * {
20
+ * action: 'send',
21
+ * template: '64TP5HKPFTM8VTK1Y75SJDQX9JK0',
22
+ * },
23
+ * ],
24
+ * },
25
+ * data: { name: 'Foo' },
26
+ * profile: { tenant_id: 'abc-123' },
27
+ * recipient: 'user-yes',
28
+ * });
29
+ * ```
30
+ */
31
+ invokeAdHoc(body, options) {
32
+ return this._client.post('/automations/invoke', { body, ...options });
33
+ }
34
+ /**
35
+ * Invoke an automation run from an automation template.
36
+ *
37
+ * @example
38
+ * ```ts
39
+ * const automationInvokeResponse =
40
+ * await client.automations.invoke.invokeByTemplate(
41
+ * 'templateId',
42
+ * { recipient: 'recipient' },
43
+ * );
44
+ * ```
45
+ */
46
+ invokeByTemplate(templateID, body, options) {
47
+ return this._client.post(path `/automations/${templateID}/invoke`, { body, ...options });
48
+ }
4
49
  }
5
50
  //# sourceMappingURL=invoke.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"invoke.mjs","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAEtB,MAAM,OAAO,MAAO,SAAQ,WAAW;CAAG"}
1
+ {"version":3,"file":"invoke.mjs","sourceRoot":"","sources":["../../src/resources/automations/invoke.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,WAAW,CACT,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,UAAkB,EAClB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,UAAU,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF"}