@knocklabs/node 1.0.0 → 1.2.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 (414) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +1 -1
  3. package/api-promise.js +2 -15
  4. package/api-promise.js.map +1 -1
  5. package/client.d.mts +4 -1
  6. package/client.d.mts.map +1 -1
  7. package/client.d.ts +4 -1
  8. package/client.d.ts.map +1 -1
  9. package/client.js +27 -44
  10. package/client.js.map +1 -1
  11. package/client.mjs +18 -12
  12. package/client.mjs.map +1 -1
  13. package/core/api-promise.d.mts +0 -1
  14. package/core/api-promise.d.mts.map +1 -1
  15. package/core/api-promise.d.ts +0 -1
  16. package/core/api-promise.d.ts.map +1 -1
  17. package/core/api-promise.js +4 -14
  18. package/core/api-promise.js.map +1 -1
  19. package/core/api-promise.mjs +1 -11
  20. package/core/api-promise.mjs.map +1 -1
  21. package/core/error.d.mts +0 -1
  22. package/core/error.d.mts.map +1 -1
  23. package/core/error.d.ts +0 -1
  24. package/core/error.d.ts.map +1 -1
  25. package/core/error.js.map +1 -1
  26. package/core/error.mjs.map +1 -1
  27. package/core/pagination.d.mts +0 -1
  28. package/core/pagination.d.mts.map +1 -1
  29. package/core/pagination.d.ts +0 -1
  30. package/core/pagination.d.ts.map +1 -1
  31. package/core/pagination.js +3 -13
  32. package/core/pagination.js.map +1 -1
  33. package/core/pagination.mjs +1 -11
  34. package/core/pagination.mjs.map +1 -1
  35. package/error.js +2 -15
  36. package/error.js.map +1 -1
  37. package/internal/builtin-types.d.mts +0 -2
  38. package/internal/builtin-types.d.mts.map +1 -1
  39. package/internal/builtin-types.d.ts +0 -2
  40. package/internal/builtin-types.d.ts.map +1 -1
  41. package/internal/detect-platform.js.map +1 -1
  42. package/internal/detect-platform.mjs.map +1 -1
  43. package/internal/errors.d.mts.map +1 -1
  44. package/internal/errors.d.ts.map +1 -1
  45. package/internal/errors.js +2 -2
  46. package/internal/errors.js.map +1 -1
  47. package/internal/errors.mjs.map +1 -1
  48. package/internal/headers.d.mts +0 -1
  49. package/internal/headers.d.mts.map +1 -1
  50. package/internal/headers.d.ts +0 -1
  51. package/internal/headers.d.ts.map +1 -1
  52. package/internal/headers.js +1 -1
  53. package/internal/headers.js.map +1 -1
  54. package/internal/headers.mjs +1 -1
  55. package/internal/headers.mjs.map +1 -1
  56. package/internal/parse.d.mts +0 -1
  57. package/internal/parse.d.mts.map +1 -1
  58. package/internal/parse.d.ts +0 -1
  59. package/internal/parse.d.ts.map +1 -1
  60. package/internal/parse.js +1 -2
  61. package/internal/parse.js.map +1 -1
  62. package/internal/parse.mjs.map +1 -1
  63. package/internal/qs/stringify.js +1 -2
  64. package/internal/qs/stringify.js.map +1 -1
  65. package/internal/qs/stringify.mjs.map +1 -1
  66. package/internal/qs/utils.js +9 -9
  67. package/internal/qs/utils.js.map +1 -1
  68. package/internal/qs/utils.mjs.map +1 -1
  69. package/internal/request-options.d.mts +0 -1
  70. package/internal/request-options.d.mts.map +1 -1
  71. package/internal/request-options.d.ts +0 -1
  72. package/internal/request-options.d.ts.map +1 -1
  73. package/internal/shims.js +5 -6
  74. package/internal/shims.js.map +1 -1
  75. package/internal/shims.mjs.map +1 -1
  76. package/internal/to-file.d.mts +0 -1
  77. package/internal/to-file.d.mts.map +1 -1
  78. package/internal/to-file.d.ts +0 -1
  79. package/internal/to-file.d.ts.map +1 -1
  80. package/internal/to-file.js +4 -4
  81. package/internal/to-file.js.map +1 -1
  82. package/internal/to-file.mjs +3 -2
  83. package/internal/to-file.mjs.map +1 -1
  84. package/internal/tslib.js +81 -0
  85. package/internal/tslib.mjs +17 -0
  86. package/internal/types.d.mts +0 -1
  87. package/internal/types.d.mts.map +1 -1
  88. package/internal/types.d.ts +0 -1
  89. package/internal/types.d.ts.map +1 -1
  90. package/internal/uploads.d.mts +1 -3
  91. package/internal/uploads.d.mts.map +1 -1
  92. package/internal/uploads.d.ts +1 -3
  93. package/internal/uploads.d.ts.map +1 -1
  94. package/internal/uploads.js +16 -6
  95. package/internal/uploads.js.map +1 -1
  96. package/internal/uploads.mjs +12 -3
  97. package/internal/uploads.mjs.map +1 -1
  98. package/internal/utils/base64.d.mts.map +1 -1
  99. package/internal/utils/base64.d.ts.map +1 -1
  100. package/internal/utils/base64.js.map +1 -1
  101. package/internal/utils/base64.mjs.map +1 -1
  102. package/internal/utils/bytes.d.mts +1 -1
  103. package/internal/utils/bytes.d.mts.map +1 -1
  104. package/internal/utils/bytes.d.ts +1 -1
  105. package/internal/utils/bytes.d.ts.map +1 -1
  106. package/internal/utils/bytes.js +3 -4
  107. package/internal/utils/bytes.js.map +1 -1
  108. package/internal/utils/bytes.mjs.map +1 -1
  109. package/internal/utils/env.d.mts.map +1 -1
  110. package/internal/utils/env.d.ts.map +1 -1
  111. package/internal/utils/env.js.map +1 -1
  112. package/internal/utils/env.mjs.map +1 -1
  113. package/internal/utils/log.d.mts +0 -1
  114. package/internal/utils/log.d.mts.map +1 -1
  115. package/internal/utils/log.d.ts +0 -1
  116. package/internal/utils/log.d.ts.map +1 -1
  117. package/internal/utils/log.js +2 -2
  118. package/internal/utils/log.js.map +1 -1
  119. package/internal/utils/log.mjs.map +1 -1
  120. package/internal/utils/path.d.mts.map +1 -1
  121. package/internal/utils/path.d.ts.map +1 -1
  122. package/internal/utils/path.js +2 -2
  123. package/internal/utils/path.js.map +1 -1
  124. package/internal/utils/path.mjs.map +1 -1
  125. package/internal/utils/sleep.d.mts.map +1 -1
  126. package/internal/utils/sleep.d.ts.map +1 -1
  127. package/internal/utils/uuid.d.mts +1 -1
  128. package/internal/utils/uuid.d.mts.map +1 -1
  129. package/internal/utils/uuid.d.ts +1 -1
  130. package/internal/utils/uuid.d.ts.map +1 -1
  131. package/internal/utils/uuid.js +1 -2
  132. package/internal/utils/uuid.js.map +1 -1
  133. package/internal/utils/uuid.mjs +1 -2
  134. package/internal/utils/uuid.mjs.map +1 -1
  135. package/internal/utils/values.d.mts.map +1 -1
  136. package/internal/utils/values.d.ts.map +1 -1
  137. package/internal/utils/values.js +5 -5
  138. package/internal/utils/values.js.map +1 -1
  139. package/internal/utils/values.mjs.map +1 -1
  140. package/internal/utils.js +7 -20
  141. package/internal/utils.js.map +1 -1
  142. package/lib/index.js +3 -16
  143. package/lib/index.js.map +1 -1
  144. package/lib/tokenSigner.js +5 -28
  145. package/lib/tokenSigner.js.map +1 -1
  146. package/lib/tokenSigner.mjs.map +1 -1
  147. package/lib/userTokens.js +1 -1
  148. package/lib/userTokens.js.map +1 -1
  149. package/package.json +2 -6
  150. package/pagination.js +2 -15
  151. package/pagination.js.map +1 -1
  152. package/resource.js +2 -15
  153. package/resource.js.map +1 -1
  154. package/resources/audiences.d.mts +37 -0
  155. package/resources/audiences.d.mts.map +1 -1
  156. package/resources/audiences.d.ts +37 -0
  157. package/resources/audiences.d.ts.map +1 -1
  158. package/resources/audiences.js +25 -0
  159. package/resources/audiences.js.map +1 -1
  160. package/resources/audiences.mjs +25 -0
  161. package/resources/audiences.mjs.map +1 -1
  162. package/resources/bulk-operations.d.mts +7 -0
  163. package/resources/bulk-operations.d.mts.map +1 -1
  164. package/resources/bulk-operations.d.ts +7 -0
  165. package/resources/bulk-operations.d.ts.map +1 -1
  166. package/resources/bulk-operations.js +7 -0
  167. package/resources/bulk-operations.js.map +1 -1
  168. package/resources/bulk-operations.mjs +7 -0
  169. package/resources/bulk-operations.mjs.map +1 -1
  170. package/resources/channels/bulk.d.mts +21 -0
  171. package/resources/channels/bulk.d.mts.map +1 -1
  172. package/resources/channels/bulk.d.ts +21 -0
  173. package/resources/channels/bulk.d.ts.map +1 -1
  174. package/resources/channels/bulk.js +21 -0
  175. package/resources/channels/bulk.js.map +1 -1
  176. package/resources/channels/bulk.mjs +21 -0
  177. package/resources/channels/bulk.mjs.map +1 -1
  178. package/resources/channels/channels.js +2 -24
  179. package/resources/channels/channels.js.map +1 -1
  180. package/resources/channels.js +2 -15
  181. package/resources/channels.js.map +1 -1
  182. package/resources/integrations/integrations.js +3 -25
  183. package/resources/integrations/integrations.js.map +1 -1
  184. package/resources/integrations.js +2 -15
  185. package/resources/integrations.js.map +1 -1
  186. package/resources/messages/batch.d.mts +76 -0
  187. package/resources/messages/batch.d.mts.map +1 -1
  188. package/resources/messages/batch.d.ts +76 -0
  189. package/resources/messages/batch.d.ts.map +1 -1
  190. package/resources/messages/batch.js +76 -0
  191. package/resources/messages/batch.js.map +1 -1
  192. package/resources/messages/batch.mjs +76 -0
  193. package/resources/messages/batch.mjs.map +1 -1
  194. package/resources/messages/index.d.mts +0 -1
  195. package/resources/messages/index.d.mts.map +1 -1
  196. package/resources/messages/index.d.ts +0 -1
  197. package/resources/messages/index.d.ts.map +1 -1
  198. package/resources/messages/index.js +1 -3
  199. package/resources/messages/index.js.map +1 -1
  200. package/resources/messages/index.mjs +0 -1
  201. package/resources/messages/index.mjs.map +1 -1
  202. package/resources/messages/messages.d.mts +101 -4
  203. package/resources/messages/messages.d.mts.map +1 -1
  204. package/resources/messages/messages.d.ts +101 -4
  205. package/resources/messages/messages.d.ts.map +1 -1
  206. package/resources/messages/messages.js +103 -28
  207. package/resources/messages/messages.js.map +1 -1
  208. package/resources/messages/messages.mjs +101 -4
  209. package/resources/messages/messages.mjs.map +1 -1
  210. package/resources/messages.js +2 -15
  211. package/resources/messages.js.map +1 -1
  212. package/resources/objects/bulk.d.mts +49 -0
  213. package/resources/objects/bulk.d.mts.map +1 -1
  214. package/resources/objects/bulk.d.ts +49 -0
  215. package/resources/objects/bulk.d.ts.map +1 -1
  216. package/resources/objects/bulk.js +49 -0
  217. package/resources/objects/bulk.js.map +1 -1
  218. package/resources/objects/bulk.mjs +49 -0
  219. package/resources/objects/bulk.mjs.map +1 -1
  220. package/resources/objects/objects.d.mts +179 -5
  221. package/resources/objects/objects.d.mts.map +1 -1
  222. package/resources/objects/objects.d.ts +179 -5
  223. package/resources/objects/objects.d.ts.map +1 -1
  224. package/resources/objects/objects.js +173 -24
  225. package/resources/objects/objects.js.map +1 -1
  226. package/resources/objects/objects.mjs +171 -0
  227. package/resources/objects/objects.mjs.map +1 -1
  228. package/resources/objects.js +2 -15
  229. package/resources/objects.js.map +1 -1
  230. package/resources/providers/ms-teams.d.mts +40 -0
  231. package/resources/providers/ms-teams.d.mts.map +1 -1
  232. package/resources/providers/ms-teams.d.ts +40 -0
  233. package/resources/providers/ms-teams.d.ts.map +1 -1
  234. package/resources/providers/ms-teams.js +40 -0
  235. package/resources/providers/ms-teams.js.map +1 -1
  236. package/resources/providers/ms-teams.mjs +40 -0
  237. package/resources/providers/ms-teams.mjs.map +1 -1
  238. package/resources/providers/providers.js +3 -25
  239. package/resources/providers/providers.js.map +1 -1
  240. package/resources/providers/slack.d.mts +27 -0
  241. package/resources/providers/slack.d.mts.map +1 -1
  242. package/resources/providers/slack.d.ts +27 -0
  243. package/resources/providers/slack.d.ts.map +1 -1
  244. package/resources/providers/slack.js +27 -0
  245. package/resources/providers/slack.js.map +1 -1
  246. package/resources/providers/slack.mjs +27 -0
  247. package/resources/providers/slack.mjs.map +1 -1
  248. package/resources/providers.js +2 -15
  249. package/resources/providers.js.map +1 -1
  250. package/resources/recipients/channel-data.d.mts +1 -1
  251. package/resources/recipients/channel-data.d.mts.map +1 -1
  252. package/resources/recipients/channel-data.d.ts +1 -1
  253. package/resources/recipients/channel-data.d.ts.map +1 -1
  254. package/resources/recipients/recipients.js +4 -26
  255. package/resources/recipients/recipients.js.map +1 -1
  256. package/resources/recipients.js +2 -15
  257. package/resources/recipients.js.map +1 -1
  258. package/resources/schedules/bulk.d.mts +30 -0
  259. package/resources/schedules/bulk.d.mts.map +1 -1
  260. package/resources/schedules/bulk.d.ts +30 -0
  261. package/resources/schedules/bulk.d.ts.map +1 -1
  262. package/resources/schedules/bulk.js +30 -0
  263. package/resources/schedules/bulk.js.map +1 -1
  264. package/resources/schedules/bulk.mjs +30 -0
  265. package/resources/schedules/bulk.mjs.map +1 -1
  266. package/resources/schedules/schedules.d.mts +75 -2
  267. package/resources/schedules/schedules.d.mts.map +1 -1
  268. package/resources/schedules/schedules.d.ts +75 -2
  269. package/resources/schedules/schedules.d.ts.map +1 -1
  270. package/resources/schedules/schedules.js +76 -24
  271. package/resources/schedules/schedules.js.map +1 -1
  272. package/resources/schedules/schedules.mjs +74 -0
  273. package/resources/schedules/schedules.mjs.map +1 -1
  274. package/resources/schedules.js +2 -15
  275. package/resources/schedules.js.map +1 -1
  276. package/resources/tenants/bulk.d.mts +14 -0
  277. package/resources/tenants/bulk.d.mts.map +1 -1
  278. package/resources/tenants/bulk.d.ts +14 -0
  279. package/resources/tenants/bulk.d.ts.map +1 -1
  280. package/resources/tenants/bulk.js +14 -0
  281. package/resources/tenants/bulk.js.map +1 -1
  282. package/resources/tenants/bulk.mjs +14 -0
  283. package/resources/tenants/bulk.mjs.map +1 -1
  284. package/resources/tenants/tenants.d.mts +33 -0
  285. package/resources/tenants/tenants.d.mts.map +1 -1
  286. package/resources/tenants/tenants.d.ts +33 -0
  287. package/resources/tenants/tenants.d.ts.map +1 -1
  288. package/resources/tenants/tenants.js +35 -24
  289. package/resources/tenants/tenants.js.map +1 -1
  290. package/resources/tenants/tenants.mjs +33 -0
  291. package/resources/tenants/tenants.mjs.map +1 -1
  292. package/resources/tenants.js +2 -15
  293. package/resources/tenants.js.map +1 -1
  294. package/resources/users/bulk.d.mts +41 -0
  295. package/resources/users/bulk.d.mts.map +1 -1
  296. package/resources/users/bulk.d.ts +41 -0
  297. package/resources/users/bulk.d.ts.map +1 -1
  298. package/resources/users/bulk.js +41 -0
  299. package/resources/users/bulk.js.map +1 -1
  300. package/resources/users/bulk.mjs +41 -0
  301. package/resources/users/bulk.mjs.map +1 -1
  302. package/resources/users/feeds.d.mts +19 -0
  303. package/resources/users/feeds.d.mts.map +1 -1
  304. package/resources/users/feeds.d.ts +19 -0
  305. package/resources/users/feeds.d.ts.map +1 -1
  306. package/resources/users/feeds.js +19 -0
  307. package/resources/users/feeds.js.map +1 -1
  308. package/resources/users/feeds.mjs +19 -0
  309. package/resources/users/feeds.mjs.map +1 -1
  310. package/resources/users/guides.d.mts +68 -0
  311. package/resources/users/guides.d.mts.map +1 -1
  312. package/resources/users/guides.d.ts +68 -0
  313. package/resources/users/guides.d.ts.map +1 -1
  314. package/resources/users/guides.js +68 -0
  315. package/resources/users/guides.js.map +1 -1
  316. package/resources/users/guides.mjs +68 -0
  317. package/resources/users/guides.mjs.map +1 -1
  318. package/resources/users/users.d.mts +182 -15
  319. package/resources/users/users.d.mts.map +1 -1
  320. package/resources/users/users.d.ts +182 -15
  321. package/resources/users/users.d.ts.map +1 -1
  322. package/resources/users/users.js +143 -26
  323. package/resources/users/users.js.map +1 -1
  324. package/resources/users/users.mjs +139 -0
  325. package/resources/users/users.mjs.map +1 -1
  326. package/resources/users.js +2 -15
  327. package/resources/users.js.map +1 -1
  328. package/resources/workflows.d.mts +30 -0
  329. package/resources/workflows.d.mts.map +1 -1
  330. package/resources/workflows.d.ts +30 -0
  331. package/resources/workflows.d.ts.map +1 -1
  332. package/resources/workflows.js +30 -0
  333. package/resources/workflows.js.map +1 -1
  334. package/resources/workflows.mjs +30 -0
  335. package/resources/workflows.mjs.map +1 -1
  336. package/resources.js +2 -15
  337. package/resources.js.map +1 -1
  338. package/src/client.ts +17 -0
  339. package/src/internal/headers.ts +1 -1
  340. package/src/internal/to-file.ts +4 -2
  341. package/src/internal/uploads.ts +16 -4
  342. package/src/internal/utils/uuid.ts +1 -3
  343. package/src/resources/audiences.ts +37 -0
  344. package/src/resources/bulk-operations.ts +7 -0
  345. package/src/resources/channels/bulk.ts +21 -0
  346. package/src/resources/messages/batch.ts +76 -0
  347. package/src/resources/messages/index.ts +0 -1
  348. package/src/resources/messages/messages.ts +101 -6
  349. package/src/resources/objects/bulk.ts +49 -0
  350. package/src/resources/objects/objects.ts +179 -5
  351. package/src/resources/providers/ms-teams.ts +40 -0
  352. package/src/resources/providers/slack.ts +27 -0
  353. package/src/resources/recipients/channel-data.ts +4 -1
  354. package/src/resources/schedules/bulk.ts +30 -0
  355. package/src/resources/schedules/schedules.ts +75 -2
  356. package/src/resources/tenants/bulk.ts +14 -0
  357. package/src/resources/tenants/tenants.ts +33 -0
  358. package/src/resources/users/bulk.ts +41 -0
  359. package/src/resources/users/feeds.ts +19 -0
  360. package/src/resources/users/guides.ts +68 -0
  361. package/src/resources/users/users.ts +188 -15
  362. package/src/resources/workflows.ts +30 -0
  363. package/src/version.ts +1 -1
  364. package/uploads.js +2 -15
  365. package/uploads.js.map +1 -1
  366. package/version.d.mts +1 -1
  367. package/version.d.ts +1 -1
  368. package/version.js +1 -1
  369. package/version.mjs +1 -1
  370. package/internal/shims/crypto.d.mts +0 -13
  371. package/internal/shims/crypto.d.mts.map +0 -1
  372. package/internal/shims/crypto.d.ts +0 -13
  373. package/internal/shims/crypto.d.ts.map +0 -1
  374. package/internal/shims/crypto.js +0 -13
  375. package/internal/shims/crypto.js.map +0 -1
  376. package/internal/shims/crypto.mjs +0 -9
  377. package/internal/shims/crypto.mjs.map +0 -1
  378. package/internal/shims/file.d.mts +0 -23
  379. package/internal/shims/file.d.mts.map +0 -1
  380. package/internal/shims/file.d.ts +0 -23
  381. package/internal/shims/file.d.ts.map +0 -1
  382. package/internal/shims/file.js +0 -16
  383. package/internal/shims/file.js.map +0 -1
  384. package/internal/shims/file.mjs +0 -12
  385. package/internal/shims/file.mjs.map +0 -1
  386. package/internal/shims/getBuiltinModule.d.mts +0 -11
  387. package/internal/shims/getBuiltinModule.d.mts.map +0 -1
  388. package/internal/shims/getBuiltinModule.d.ts +0 -11
  389. package/internal/shims/getBuiltinModule.d.ts.map +0 -1
  390. package/internal/shims/getBuiltinModule.js +0 -71
  391. package/internal/shims/getBuiltinModule.js.map +0 -1
  392. package/internal/shims/getBuiltinModule.mjs +0 -67
  393. package/internal/shims/getBuiltinModule.mjs.map +0 -1
  394. package/internal/shims/nullGetBuiltinModule.d.mts +0 -2
  395. package/internal/shims/nullGetBuiltinModule.d.mts.map +0 -1
  396. package/internal/shims/nullGetBuiltinModule.d.ts +0 -2
  397. package/internal/shims/nullGetBuiltinModule.d.ts.map +0 -1
  398. package/internal/shims/nullGetBuiltinModule.js +0 -5
  399. package/internal/shims/nullGetBuiltinModule.js.map +0 -1
  400. package/internal/shims/nullGetBuiltinModule.mjs +0 -2
  401. package/internal/shims/nullGetBuiltinModule.mjs.map +0 -1
  402. package/resources/messages/activities.d.mts +0 -22
  403. package/resources/messages/activities.d.mts.map +0 -1
  404. package/resources/messages/activities.d.ts +0 -22
  405. package/resources/messages/activities.d.ts.map +0 -1
  406. package/resources/messages/activities.js +0 -17
  407. package/resources/messages/activities.js.map +0 -1
  408. package/resources/messages/activities.mjs +0 -13
  409. package/resources/messages/activities.mjs.map +0 -1
  410. package/src/internal/shims/crypto.ts +0 -18
  411. package/src/internal/shims/file.ts +0 -32
  412. package/src/internal/shims/getBuiltinModule.ts +0 -66
  413. package/src/internal/shims/nullGetBuiltinModule.ts +0 -1
  414. package/src/resources/messages/activities.ts +0 -38
@@ -5,14 +5,41 @@ import { RequestOptions } from "../../internal/request-options.mjs";
5
5
  export declare class Slack extends APIResource {
6
6
  /**
7
7
  * Check if a Slack channel is authenticated.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const response = await client.providers.slack.checkAuth(
12
+ * 'channel_id',
13
+ * { access_token_object: 'access_token_object' },
14
+ * );
15
+ * ```
8
16
  */
9
17
  checkAuth(channelID: string, query: SlackCheckAuthParams, options?: RequestOptions): APIPromise<SlackCheckAuthResponse>;
10
18
  /**
11
19
  * List Slack channels for a Slack workspace.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * // Automatically fetches more pages as needed.
24
+ * for await (const slackListChannelsResponse of client.providers.slack.listChannels(
25
+ * 'channel_id',
26
+ * { access_token_object: 'access_token_object' },
27
+ * )) {
28
+ * // ...
29
+ * }
30
+ * ```
12
31
  */
13
32
  listChannels(channelID: string, query: SlackListChannelsParams, options?: RequestOptions): PagePromise<SlackListChannelsResponsesSlackChannelsCursor, SlackListChannelsResponse>;
14
33
  /**
15
34
  * Revoke access for a Slack channel.
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * const response = await client.providers.slack.revokeAccess(
39
+ * 'channel_id',
40
+ * { access_token_object: 'access_token_object' },
41
+ * );
42
+ * ```
16
43
  */
17
44
  revokeAccess(channelID: string, params: SlackRevokeAccessParams, options?: RequestOptions): APIPromise<SlackRevokeAccessResponse>;
18
45
  }
@@ -1 +1 @@
1
- {"version":3,"file":"slack.d.mts","sourceRoot":"","sources":["../../src/resources/providers/slack.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,mBAAmB,EAAE,KAAK,yBAAyB,EAAE;OACpE,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,yBAAyB,CAAC;IAQxF;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAOzC;AAED,MAAM,MAAM,6CAA6C,GAAG,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;AAE3G;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC,UAAU,CAAC;CAC/C;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,aAAa,CAAC,EAAE,uBAAuB,CAAC,YAAY,CAAC;CACtD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B;;;;WAIG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
1
+ {"version":3,"file":"slack.d.mts","sourceRoot":"","sources":["../../src/resources/providers/slack.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,mBAAmB,EAAE,KAAK,yBAAyB,EAAE;OACpE,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,yBAAyB,CAAC;IAQxF;;;;;;;;;;OAUG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAOzC;AAED,MAAM,MAAM,6CAA6C,GAAG,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;AAE3G;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC,UAAU,CAAC;CAC/C;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,aAAa,CAAC,EAAE,uBAAuB,CAAC,YAAY,CAAC;CACtD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B;;;;WAIG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
@@ -5,14 +5,41 @@ import { RequestOptions } from "../../internal/request-options.js";
5
5
  export declare class Slack extends APIResource {
6
6
  /**
7
7
  * Check if a Slack channel is authenticated.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const response = await client.providers.slack.checkAuth(
12
+ * 'channel_id',
13
+ * { access_token_object: 'access_token_object' },
14
+ * );
15
+ * ```
8
16
  */
9
17
  checkAuth(channelID: string, query: SlackCheckAuthParams, options?: RequestOptions): APIPromise<SlackCheckAuthResponse>;
10
18
  /**
11
19
  * List Slack channels for a Slack workspace.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * // Automatically fetches more pages as needed.
24
+ * for await (const slackListChannelsResponse of client.providers.slack.listChannels(
25
+ * 'channel_id',
26
+ * { access_token_object: 'access_token_object' },
27
+ * )) {
28
+ * // ...
29
+ * }
30
+ * ```
12
31
  */
13
32
  listChannels(channelID: string, query: SlackListChannelsParams, options?: RequestOptions): PagePromise<SlackListChannelsResponsesSlackChannelsCursor, SlackListChannelsResponse>;
14
33
  /**
15
34
  * Revoke access for a Slack channel.
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * const response = await client.providers.slack.revokeAccess(
39
+ * 'channel_id',
40
+ * { access_token_object: 'access_token_object' },
41
+ * );
42
+ * ```
16
43
  */
17
44
  revokeAccess(channelID: string, params: SlackRevokeAccessParams, options?: RequestOptions): APIPromise<SlackRevokeAccessResponse>;
18
45
  }
@@ -1 +1 @@
1
- {"version":3,"file":"slack.d.ts","sourceRoot":"","sources":["../../src/resources/providers/slack.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,mBAAmB,EAAE,KAAK,yBAAyB,EAAE;OACpE,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,yBAAyB,CAAC;IAQxF;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAOzC;AAED,MAAM,MAAM,6CAA6C,GAAG,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;AAE3G;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC,UAAU,CAAC;CAC/C;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,aAAa,CAAC,EAAE,uBAAuB,CAAC,YAAY,CAAC;CACtD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B;;;;WAIG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
1
+ {"version":3,"file":"slack.d.ts","sourceRoot":"","sources":["../../src/resources/providers/slack.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,mBAAmB,EAAE,KAAK,yBAAyB,EAAE;OACpE,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,yBAAyB,CAAC;IAQxF;;;;;;;;;;OAUG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAOzC;AAED,MAAM,MAAM,6CAA6C,GAAG,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;AAE3G;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC,UAAU,CAAC;CAC/C;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B,aAAa,CAAC,EAAE,uBAAuB,CAAC,YAAY,CAAC;CACtD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B;;;;WAIG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
@@ -8,18 +8,45 @@ const path_1 = require("../../internal/utils/path.js");
8
8
  class Slack extends resource_1.APIResource {
9
9
  /**
10
10
  * Check if a Slack channel is authenticated.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const response = await client.providers.slack.checkAuth(
15
+ * 'channel_id',
16
+ * { access_token_object: 'access_token_object' },
17
+ * );
18
+ * ```
11
19
  */
12
20
  checkAuth(channelID, query, options) {
13
21
  return this._client.get((0, path_1.path) `/v1/providers/slack/${channelID}/auth_check`, { query, ...options });
14
22
  }
15
23
  /**
16
24
  * List Slack channels for a Slack workspace.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * // Automatically fetches more pages as needed.
29
+ * for await (const slackListChannelsResponse of client.providers.slack.listChannels(
30
+ * 'channel_id',
31
+ * { access_token_object: 'access_token_object' },
32
+ * )) {
33
+ * // ...
34
+ * }
35
+ * ```
17
36
  */
18
37
  listChannels(channelID, query, options) {
19
38
  return this._client.getAPIList((0, path_1.path) `/v1/providers/slack/${channelID}/channels`, (pagination_1.SlackChannelsCursor), { query, ...options });
20
39
  }
21
40
  /**
22
41
  * Revoke access for a Slack channel.
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * const response = await client.providers.slack.revokeAccess(
46
+ * 'channel_id',
47
+ * { access_token_object: 'access_token_object' },
48
+ * );
49
+ * ```
23
50
  */
24
51
  revokeAccess(channelID, params, options) {
25
52
  const { access_token_object } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"slack.js","sourceRoot":"","sources":["../../src/resources/providers/slack.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAyG;AAEzG,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;OAEG;IACH,SAAS,CACP,SAAiB,EACjB,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;OAEG;IACH,YAAY,CACV,SAAiB,EACjB,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,uBAAuB,SAAS,WAAW,EAC/C,CAAA,gCAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,YAAY,CACV,SAAiB,EACjB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,gBAAgB,EAAE;YAC5E,KAAK,EAAE,EAAE,mBAAmB,EAAE;YAC9B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAzCD,sBAyCC"}
1
+ {"version":3,"file":"slack.js","sourceRoot":"","sources":["../../src/resources/providers/slack.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAyG;AAEzG,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,SAAS,CACP,SAAiB,EACjB,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,SAAiB,EACjB,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,uBAAuB,SAAS,WAAW,EAC/C,CAAA,gCAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,SAAiB,EACjB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,gBAAgB,EAAE;YAC5E,KAAK,EAAE,EAAE,mBAAmB,EAAE;YAC9B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AApED,sBAoEC"}
@@ -5,18 +5,45 @@ import { path } from "../../internal/utils/path.mjs";
5
5
  export class Slack extends APIResource {
6
6
  /**
7
7
  * Check if a Slack channel is authenticated.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const response = await client.providers.slack.checkAuth(
12
+ * 'channel_id',
13
+ * { access_token_object: 'access_token_object' },
14
+ * );
15
+ * ```
8
16
  */
9
17
  checkAuth(channelID, query, options) {
10
18
  return this._client.get(path `/v1/providers/slack/${channelID}/auth_check`, { query, ...options });
11
19
  }
12
20
  /**
13
21
  * List Slack channels for a Slack workspace.
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * // Automatically fetches more pages as needed.
26
+ * for await (const slackListChannelsResponse of client.providers.slack.listChannels(
27
+ * 'channel_id',
28
+ * { access_token_object: 'access_token_object' },
29
+ * )) {
30
+ * // ...
31
+ * }
32
+ * ```
14
33
  */
15
34
  listChannels(channelID, query, options) {
16
35
  return this._client.getAPIList(path `/v1/providers/slack/${channelID}/channels`, (SlackChannelsCursor), { query, ...options });
17
36
  }
18
37
  /**
19
38
  * Revoke access for a Slack channel.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * const response = await client.providers.slack.revokeAccess(
43
+ * 'channel_id',
44
+ * { access_token_object: 'access_token_object' },
45
+ * );
46
+ * ```
20
47
  */
21
48
  revokeAccess(channelID, params, options) {
22
49
  const { access_token_object } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"slack.mjs","sourceRoot":"","sources":["../../src/resources/providers/slack.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,mBAAmB,EAAkC;OAEpE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,SAAS,CACP,SAAiB,EACjB,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;OAEG;IACH,YAAY,CACV,SAAiB,EACjB,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,uBAAuB,SAAS,WAAW,EAC/C,CAAA,mBAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,YAAY,CACV,SAAiB,EACjB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,SAAS,gBAAgB,EAAE;YAC5E,KAAK,EAAE,EAAE,mBAAmB,EAAE;YAC9B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"slack.mjs","sourceRoot":"","sources":["../../src/resources/providers/slack.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,mBAAmB,EAAkC;OAEpE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,SAAS,CACP,SAAiB,EACjB,KAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,SAAiB,EACjB,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,uBAAuB,SAAS,WAAW,EAC/C,CAAA,mBAA8C,CAAA,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,SAAiB,EACjB,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,SAAS,gBAAgB,EAAE;YAC5E,KAAK,EAAE,EAAE,mBAAmB,EAAE;YAC9B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -1,19 +1,6 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
- if (k2 === undefined) k2 = k;
5
- var desc = Object.getOwnPropertyDescriptor(m, k);
6
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
- desc = { enumerable: true, get: function() { return m[k]; } };
8
- }
9
- Object.defineProperty(o, k2, desc);
10
- }) : (function(o, m, k, k2) {
11
- if (k2 === undefined) k2 = k;
12
- o[k2] = m[k];
13
- }));
14
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16
- };
17
3
  Object.defineProperty(exports, "__esModule", { value: true });
18
- __exportStar(require("./providers/index.js"), exports);
4
+ const tslib_1 = require("../internal/tslib.js");
5
+ tslib_1.__exportStar(require("./providers/index.js"), exports);
19
6
  //# sourceMappingURL=providers.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"providers.js","sourceRoot":"","sources":["../src/resources/providers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;AAEtF,uDAAkC"}
1
+ {"version":3,"file":"providers.js","sourceRoot":"","sources":["../src/resources/providers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,+DAAkC"}
@@ -74,7 +74,7 @@ export declare namespace DiscordChannelData {
74
74
  /**
75
75
  * A request to set channel data for a type of channel inline.
76
76
  */
77
- export type InlineChannelDataRequest = Record<string, ChannelDataRequest>;
77
+ export type InlineChannelDataRequest = Record<string, PushChannelData | OneSignalChannelData | SlackChannelData | MsTeamsChannelData | DiscordChannelData>;
78
78
  /**
79
79
  * Microsoft Teams channel connection.
80
80
  */
@@ -1 +1 @@
1
- {"version":3,"file":"channel-data.d.mts","sourceRoot":"","sources":["../../src/resources/recipients/channel-data.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,WAAY,SAAQ,WAAW;CAAG;AAE/C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE1G;;OAEG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,YAAY,GACZ,eAAe,GACf,cAAc,GACd,oBAAoB,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,oBAAoB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;CAC3G;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,wBAAwB,GAAG,kBAAkB,CAAC,gCAAgC,CAClG,CAAC;CACH;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,sBAAsB,GAAG,kBAAkB,CAAC,gCAAgC,CAChG,CAAC;IAEF;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;IAE5G;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"channel-data.d.mts","sourceRoot":"","sources":["../../src/resources/recipients/channel-data.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,WAAY,SAAQ,WAAW;CAAG;AAE/C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE1G;;OAEG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,YAAY,GACZ,eAAe,GACf,cAAc,GACd,oBAAoB,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,oBAAoB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;CAC3G;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,wBAAwB,GAAG,kBAAkB,CAAC,gCAAgC,CAClG,CAAC;CACH;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAC3C,MAAM,EACN,eAAe,GAAG,oBAAoB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,CACpG,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,sBAAsB,GAAG,kBAAkB,CAAC,gCAAgC,CAChG,CAAC;IAEF;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;IAE5G;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -74,7 +74,7 @@ export declare namespace DiscordChannelData {
74
74
  /**
75
75
  * A request to set channel data for a type of channel inline.
76
76
  */
77
- export type InlineChannelDataRequest = Record<string, ChannelDataRequest>;
77
+ export type InlineChannelDataRequest = Record<string, PushChannelData | OneSignalChannelData | SlackChannelData | MsTeamsChannelData | DiscordChannelData>;
78
78
  /**
79
79
  * Microsoft Teams channel connection.
80
80
  */
@@ -1 +1 @@
1
- {"version":3,"file":"channel-data.d.ts","sourceRoot":"","sources":["../../src/resources/recipients/channel-data.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,WAAY,SAAQ,WAAW;CAAG;AAE/C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE1G;;OAEG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,YAAY,GACZ,eAAe,GACf,cAAc,GACd,oBAAoB,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,oBAAoB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;CAC3G;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,wBAAwB,GAAG,kBAAkB,CAAC,gCAAgC,CAClG,CAAC;CACH;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,sBAAsB,GAAG,kBAAkB,CAAC,gCAAgC,CAChG,CAAC;IAEF;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;IAE5G;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
1
+ {"version":3,"file":"channel-data.d.ts","sourceRoot":"","sources":["../../src/resources/recipients/channel-data.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;AAEtB,qBAAa,WAAY,SAAQ,WAAW;CAAG;AAE/C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE1G;;OAEG;IACH,QAAQ,CAAC,EACL,UAAU,GACV,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,YAAY,GACZ,eAAe,GACf,cAAc,GACd,oBAAoB,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,eAAe,GAAG,oBAAoB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;CAC3G;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,wBAAwB,GAAG,kBAAkB,CAAC,gCAAgC,CAClG,CAAC;CACH;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAC3C,MAAM,EACN,eAAe,GAAG,oBAAoB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,CACpG,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAChB,kBAAkB,CAAC,sBAAsB,GAAG,kBAAkB,CAAC,gCAAgC,CAChG,CAAC;IAEF;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED;;OAEG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,gBAAgB,EAAE,gCAAgC,CAAC,eAAe,CAAC;KACpE;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,eAAe;YAC9B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;IAE5G;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,8BAA8B;QAC7C;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
@@ -1,35 +1,13 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
- if (k2 === undefined) k2 = k;
5
- var desc = Object.getOwnPropertyDescriptor(m, k);
6
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
- desc = { enumerable: true, get: function() { return m[k]; } };
8
- }
9
- Object.defineProperty(o, k2, desc);
10
- }) : (function(o, m, k, k2) {
11
- if (k2 === undefined) k2 = k;
12
- o[k2] = m[k];
13
- }));
14
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
- Object.defineProperty(o, "default", { enumerable: true, value: v });
16
- }) : function(o, v) {
17
- o["default"] = v;
18
- });
19
- var __importStar = (this && this.__importStar) || function (mod) {
20
- if (mod && mod.__esModule) return mod;
21
- var result = {};
22
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
23
- __setModuleDefault(result, mod);
24
- return result;
25
- };
26
3
  Object.defineProperty(exports, "__esModule", { value: true });
27
4
  exports.Recipients = void 0;
5
+ const tslib_1 = require("../../internal/tslib.js");
28
6
  const resource_1 = require("../../core/resource.js");
29
- const ChannelDataAPI = __importStar(require("./channel-data.js"));
30
- const PreferencesAPI = __importStar(require("./preferences.js"));
7
+ const ChannelDataAPI = tslib_1.__importStar(require("./channel-data.js"));
8
+ const PreferencesAPI = tslib_1.__importStar(require("./preferences.js"));
31
9
  const preferences_1 = require("./preferences.js");
32
- const SubscriptionsAPI = __importStar(require("./subscriptions.js"));
10
+ const SubscriptionsAPI = tslib_1.__importStar(require("./subscriptions.js"));
33
11
  const subscriptions_1 = require("./subscriptions.js");
34
12
  class Recipients extends resource_1.APIResource {
35
13
  constructor() {
@@ -1 +1 @@
1
- {"version":3,"file":"recipients.js","sourceRoot":"","sources":["../../src/resources/recipients/recipients.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,qDAAkD;AAElD,kEAAiD;AAWjD,iEAAgD;AAChD,kDAOuB;AACvB,qEAAoD;AACpD,sDAA8D;AAG9D,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACzF,CAAC;CAAA;AAJD,gCAIC;AAqCD,UAAU,CAAC,aAAa,GAAG,6BAAa,CAAC;AACzC,UAAU,CAAC,WAAW,GAAG,yBAAW,CAAC"}
1
+ {"version":3,"file":"recipients.js","sourceRoot":"","sources":["../../src/resources/recipients/recipients.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,0EAAiD;AAWjD,yEAAgD;AAChD,kDAOuB;AACvB,6EAAoD;AACpD,sDAA8D;AAG9D,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACzF,CAAC;CAAA;AAJD,gCAIC;AAqCD,UAAU,CAAC,aAAa,GAAG,6BAAa,CAAC;AACzC,UAAU,CAAC,WAAW,GAAG,yBAAW,CAAC"}
@@ -1,19 +1,6 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
- if (k2 === undefined) k2 = k;
5
- var desc = Object.getOwnPropertyDescriptor(m, k);
6
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
- desc = { enumerable: true, get: function() { return m[k]; } };
8
- }
9
- Object.defineProperty(o, k2, desc);
10
- }) : (function(o, m, k, k2) {
11
- if (k2 === undefined) k2 = k;
12
- o[k2] = m[k];
13
- }));
14
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16
- };
17
3
  Object.defineProperty(exports, "__esModule", { value: true });
18
- __exportStar(require("./recipients/index.js"), exports);
4
+ const tslib_1 = require("../internal/tslib.js");
5
+ tslib_1.__exportStar(require("./recipients/index.js"), exports);
19
6
  //# sourceMappingURL=recipients.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"recipients.js","sourceRoot":"","sources":["../src/resources/recipients.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;AAEtF,wDAAmC"}
1
+ {"version":3,"file":"recipients.js","sourceRoot":"","sources":["../src/resources/recipients.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gEAAmC"}
@@ -10,6 +10,36 @@ export declare class Bulk extends APIResource {
10
10
  * Bulk creates up to 1,000 schedules at a time. This endpoint also handles
11
11
  * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
12
12
  * for the `actor`, `recipient`, and `tenant` fields.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const bulkOperation = await client.schedules.bulk.create({
17
+ * schedules: [
18
+ * {
19
+ * data: { ... },
20
+ * ending_at: null,
21
+ * recipient: 'dnedry',
22
+ * repeats: [
23
+ * { ... },
24
+ * ],
25
+ * scheduled_at: null,
26
+ * tenant: 'acme_corp',
27
+ * workflow: 'comment-created',
28
+ * },
29
+ * {
30
+ * data: { ... },
31
+ * ending_at: null,
32
+ * recipient: 'esattler',
33
+ * repeats: [
34
+ * { ... },
35
+ * ],
36
+ * scheduled_at: null,
37
+ * tenant: 'acme_corp',
38
+ * workflow: 'comment-created',
39
+ * },
40
+ * ],
41
+ * });
42
+ * ```
13
43
  */
14
44
  create(body: BulkCreateParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
15
45
  }
@@ -1 +1 @@
1
- {"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,aAAa;OAClB,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGtG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;;WAIG;QACH,SAAS,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAEjD;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;KAChD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACtD"}
1
+ {"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,aAAa;OAClB,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGtG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;;WAIG;QACH,SAAS,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAEjD;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;KAChD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACtD"}
@@ -10,6 +10,36 @@ export declare class Bulk extends APIResource {
10
10
  * Bulk creates up to 1,000 schedules at a time. This endpoint also handles
11
11
  * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
12
12
  * for the `actor`, `recipient`, and `tenant` fields.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const bulkOperation = await client.schedules.bulk.create({
17
+ * schedules: [
18
+ * {
19
+ * data: { ... },
20
+ * ending_at: null,
21
+ * recipient: 'dnedry',
22
+ * repeats: [
23
+ * { ... },
24
+ * ],
25
+ * scheduled_at: null,
26
+ * tenant: 'acme_corp',
27
+ * workflow: 'comment-created',
28
+ * },
29
+ * {
30
+ * data: { ... },
31
+ * ending_at: null,
32
+ * recipient: 'esattler',
33
+ * repeats: [
34
+ * { ... },
35
+ * ],
36
+ * scheduled_at: null,
37
+ * tenant: 'acme_corp',
38
+ * workflow: 'comment-created',
39
+ * },
40
+ * ],
41
+ * });
42
+ * ```
13
43
  */
14
44
  create(body: BulkCreateParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
15
45
  }
@@ -1 +1 @@
1
- {"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,aAAa;OAClB,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGtG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;;WAIG;QACH,SAAS,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAEjD;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;KAChD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACtD"}
1
+ {"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,aAAa;OAClB,KAAK,YAAY;OACjB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAGtG;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,KAAK,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;;WAIG;QACH,SAAS,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAEjD;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC;KAChD;CACF;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CACtD"}
@@ -8,6 +8,36 @@ class Bulk extends resource_1.APIResource {
8
8
  * Bulk creates up to 1,000 schedules at a time. This endpoint also handles
9
9
  * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
10
10
  * for the `actor`, `recipient`, and `tenant` fields.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const bulkOperation = await client.schedules.bulk.create({
15
+ * schedules: [
16
+ * {
17
+ * data: { ... },
18
+ * ending_at: null,
19
+ * recipient: 'dnedry',
20
+ * repeats: [
21
+ * { ... },
22
+ * ],
23
+ * scheduled_at: null,
24
+ * tenant: 'acme_corp',
25
+ * workflow: 'comment-created',
26
+ * },
27
+ * {
28
+ * data: { ... },
29
+ * ending_at: null,
30
+ * recipient: 'esattler',
31
+ * repeats: [
32
+ * { ... },
33
+ * ],
34
+ * scheduled_at: null,
35
+ * tenant: 'acme_corp',
36
+ * workflow: 'comment-created',
37
+ * },
38
+ * ],
39
+ * });
40
+ * ```
11
41
  */
12
42
  create(body, options) {
13
43
  return this._client.post('/v1/schedules/bulk/create', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAQlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;OAIG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AATD,oBASC"}
1
+ {"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAQlD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AAvCD,oBAuCC"}
@@ -5,6 +5,36 @@ export class Bulk extends APIResource {
5
5
  * Bulk creates up to 1,000 schedules at a time. This endpoint also handles
6
6
  * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
7
7
  * for the `actor`, `recipient`, and `tenant` fields.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const bulkOperation = await client.schedules.bulk.create({
12
+ * schedules: [
13
+ * {
14
+ * data: { ... },
15
+ * ending_at: null,
16
+ * recipient: 'dnedry',
17
+ * repeats: [
18
+ * { ... },
19
+ * ],
20
+ * scheduled_at: null,
21
+ * tenant: 'acme_corp',
22
+ * workflow: 'comment-created',
23
+ * },
24
+ * {
25
+ * data: { ... },
26
+ * ending_at: null,
27
+ * recipient: 'esattler',
28
+ * repeats: [
29
+ * { ... },
30
+ * ],
31
+ * scheduled_at: null,
32
+ * tenant: 'acme_corp',
33
+ * workflow: 'comment-created',
34
+ * },
35
+ * ],
36
+ * });
37
+ * ```
8
38
  */
9
39
  create(body, options) {
10
40
  return this._client.post('/v1/schedules/bulk/create', { body, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAQtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;OAIG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}
1
+ {"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/schedules/bulk.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAQtB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}