@knocklabs/node 1.0.0 → 1.1.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 (400) hide show
  1. package/CHANGELOG.md +24 -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 +5 -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/activities.d.mts +10 -0
  187. package/resources/messages/activities.d.mts.map +1 -1
  188. package/resources/messages/activities.d.ts +10 -0
  189. package/resources/messages/activities.d.ts.map +1 -1
  190. package/resources/messages/activities.js +10 -0
  191. package/resources/messages/activities.js.map +1 -1
  192. package/resources/messages/activities.mjs +10 -0
  193. package/resources/messages/activities.mjs.map +1 -1
  194. package/resources/messages/batch.d.mts +76 -0
  195. package/resources/messages/batch.d.mts.map +1 -1
  196. package/resources/messages/batch.d.ts +76 -0
  197. package/resources/messages/batch.d.ts.map +1 -1
  198. package/resources/messages/batch.js +76 -0
  199. package/resources/messages/batch.js.map +1 -1
  200. package/resources/messages/batch.mjs +76 -0
  201. package/resources/messages/batch.mjs.map +1 -1
  202. package/resources/messages/messages.d.mts +101 -0
  203. package/resources/messages/messages.d.mts.map +1 -1
  204. package/resources/messages/messages.d.ts +101 -0
  205. package/resources/messages/messages.d.ts.map +1 -1
  206. package/resources/messages/messages.js +104 -25
  207. package/resources/messages/messages.js.map +1 -1
  208. package/resources/messages/messages.mjs +101 -0
  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 +175 -4
  221. package/resources/objects/objects.d.mts.map +1 -1
  222. package/resources/objects/objects.d.ts +175 -4
  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/recipients.js +4 -26
  251. package/resources/recipients/recipients.js.map +1 -1
  252. package/resources/recipients.js +2 -15
  253. package/resources/recipients.js.map +1 -1
  254. package/resources/schedules/bulk.d.mts +30 -0
  255. package/resources/schedules/bulk.d.mts.map +1 -1
  256. package/resources/schedules/bulk.d.ts +30 -0
  257. package/resources/schedules/bulk.d.ts.map +1 -1
  258. package/resources/schedules/bulk.js +30 -0
  259. package/resources/schedules/bulk.js.map +1 -1
  260. package/resources/schedules/bulk.mjs +30 -0
  261. package/resources/schedules/bulk.mjs.map +1 -1
  262. package/resources/schedules/schedules.d.mts +74 -0
  263. package/resources/schedules/schedules.d.mts.map +1 -1
  264. package/resources/schedules/schedules.d.ts +74 -0
  265. package/resources/schedules/schedules.d.ts.map +1 -1
  266. package/resources/schedules/schedules.js +76 -24
  267. package/resources/schedules/schedules.js.map +1 -1
  268. package/resources/schedules/schedules.mjs +74 -0
  269. package/resources/schedules/schedules.mjs.map +1 -1
  270. package/resources/schedules.js +2 -15
  271. package/resources/schedules.js.map +1 -1
  272. package/resources/tenants/bulk.d.mts +14 -0
  273. package/resources/tenants/bulk.d.mts.map +1 -1
  274. package/resources/tenants/bulk.d.ts +14 -0
  275. package/resources/tenants/bulk.d.ts.map +1 -1
  276. package/resources/tenants/bulk.js +14 -0
  277. package/resources/tenants/bulk.js.map +1 -1
  278. package/resources/tenants/bulk.mjs +14 -0
  279. package/resources/tenants/bulk.mjs.map +1 -1
  280. package/resources/tenants/tenants.d.mts +33 -0
  281. package/resources/tenants/tenants.d.mts.map +1 -1
  282. package/resources/tenants/tenants.d.ts +33 -0
  283. package/resources/tenants/tenants.d.ts.map +1 -1
  284. package/resources/tenants/tenants.js +35 -24
  285. package/resources/tenants/tenants.js.map +1 -1
  286. package/resources/tenants/tenants.mjs +33 -0
  287. package/resources/tenants/tenants.mjs.map +1 -1
  288. package/resources/tenants.js +2 -15
  289. package/resources/tenants.js.map +1 -1
  290. package/resources/users/bulk.d.mts +41 -0
  291. package/resources/users/bulk.d.mts.map +1 -1
  292. package/resources/users/bulk.d.ts +41 -0
  293. package/resources/users/bulk.d.ts.map +1 -1
  294. package/resources/users/bulk.js +41 -0
  295. package/resources/users/bulk.js.map +1 -1
  296. package/resources/users/bulk.mjs +41 -0
  297. package/resources/users/bulk.mjs.map +1 -1
  298. package/resources/users/feeds.d.mts +19 -0
  299. package/resources/users/feeds.d.mts.map +1 -1
  300. package/resources/users/feeds.d.ts +19 -0
  301. package/resources/users/feeds.d.ts.map +1 -1
  302. package/resources/users/feeds.js +19 -0
  303. package/resources/users/feeds.js.map +1 -1
  304. package/resources/users/feeds.mjs +19 -0
  305. package/resources/users/feeds.mjs.map +1 -1
  306. package/resources/users/guides.d.mts +68 -0
  307. package/resources/users/guides.d.mts.map +1 -1
  308. package/resources/users/guides.d.ts +68 -0
  309. package/resources/users/guides.d.ts.map +1 -1
  310. package/resources/users/guides.js +68 -0
  311. package/resources/users/guides.js.map +1 -1
  312. package/resources/users/guides.mjs +68 -0
  313. package/resources/users/guides.mjs.map +1 -1
  314. package/resources/users/users.d.mts +169 -15
  315. package/resources/users/users.d.mts.map +1 -1
  316. package/resources/users/users.d.ts +169 -15
  317. package/resources/users/users.d.ts.map +1 -1
  318. package/resources/users/users.js +143 -26
  319. package/resources/users/users.js.map +1 -1
  320. package/resources/users/users.mjs +139 -0
  321. package/resources/users/users.mjs.map +1 -1
  322. package/resources/users.js +2 -15
  323. package/resources/users.js.map +1 -1
  324. package/resources/workflows.d.mts +30 -0
  325. package/resources/workflows.d.mts.map +1 -1
  326. package/resources/workflows.d.ts +30 -0
  327. package/resources/workflows.d.ts.map +1 -1
  328. package/resources/workflows.js +30 -0
  329. package/resources/workflows.js.map +1 -1
  330. package/resources/workflows.mjs +30 -0
  331. package/resources/workflows.mjs.map +1 -1
  332. package/resources.js +2 -15
  333. package/resources.js.map +1 -1
  334. package/src/client.ts +17 -0
  335. package/src/internal/headers.ts +1 -1
  336. package/src/internal/to-file.ts +4 -2
  337. package/src/internal/uploads.ts +16 -4
  338. package/src/internal/utils/uuid.ts +1 -3
  339. package/src/resources/audiences.ts +37 -0
  340. package/src/resources/bulk-operations.ts +7 -0
  341. package/src/resources/channels/bulk.ts +21 -0
  342. package/src/resources/messages/activities.ts +10 -0
  343. package/src/resources/messages/batch.ts +76 -0
  344. package/src/resources/messages/messages.ts +101 -0
  345. package/src/resources/objects/bulk.ts +49 -0
  346. package/src/resources/objects/objects.ts +175 -4
  347. package/src/resources/providers/ms-teams.ts +40 -0
  348. package/src/resources/providers/slack.ts +27 -0
  349. package/src/resources/schedules/bulk.ts +30 -0
  350. package/src/resources/schedules/schedules.ts +74 -0
  351. package/src/resources/tenants/bulk.ts +14 -0
  352. package/src/resources/tenants/tenants.ts +33 -0
  353. package/src/resources/users/bulk.ts +41 -0
  354. package/src/resources/users/feeds.ts +19 -0
  355. package/src/resources/users/guides.ts +68 -0
  356. package/src/resources/users/users.ts +172 -15
  357. package/src/resources/workflows.ts +30 -0
  358. package/src/version.ts +1 -1
  359. package/uploads.js +2 -15
  360. package/uploads.js.map +1 -1
  361. package/version.d.mts +1 -1
  362. package/version.d.ts +1 -1
  363. package/version.js +1 -1
  364. package/version.mjs +1 -1
  365. package/internal/shims/crypto.d.mts +0 -13
  366. package/internal/shims/crypto.d.mts.map +0 -1
  367. package/internal/shims/crypto.d.ts +0 -13
  368. package/internal/shims/crypto.d.ts.map +0 -1
  369. package/internal/shims/crypto.js +0 -13
  370. package/internal/shims/crypto.js.map +0 -1
  371. package/internal/shims/crypto.mjs +0 -9
  372. package/internal/shims/crypto.mjs.map +0 -1
  373. package/internal/shims/file.d.mts +0 -23
  374. package/internal/shims/file.d.mts.map +0 -1
  375. package/internal/shims/file.d.ts +0 -23
  376. package/internal/shims/file.d.ts.map +0 -1
  377. package/internal/shims/file.js +0 -16
  378. package/internal/shims/file.js.map +0 -1
  379. package/internal/shims/file.mjs +0 -12
  380. package/internal/shims/file.mjs.map +0 -1
  381. package/internal/shims/getBuiltinModule.d.mts +0 -11
  382. package/internal/shims/getBuiltinModule.d.mts.map +0 -1
  383. package/internal/shims/getBuiltinModule.d.ts +0 -11
  384. package/internal/shims/getBuiltinModule.d.ts.map +0 -1
  385. package/internal/shims/getBuiltinModule.js +0 -71
  386. package/internal/shims/getBuiltinModule.js.map +0 -1
  387. package/internal/shims/getBuiltinModule.mjs +0 -67
  388. package/internal/shims/getBuiltinModule.mjs.map +0 -1
  389. package/internal/shims/nullGetBuiltinModule.d.mts +0 -2
  390. package/internal/shims/nullGetBuiltinModule.d.mts.map +0 -1
  391. package/internal/shims/nullGetBuiltinModule.d.ts +0 -2
  392. package/internal/shims/nullGetBuiltinModule.d.ts.map +0 -1
  393. package/internal/shims/nullGetBuiltinModule.js +0 -5
  394. package/internal/shims/nullGetBuiltinModule.js.map +0 -1
  395. package/internal/shims/nullGetBuiltinModule.mjs +0 -2
  396. package/internal/shims/nullGetBuiltinModule.mjs.map +0 -1
  397. package/src/internal/shims/crypto.ts +0 -18
  398. package/src/internal/shims/file.ts +0 -32
  399. package/src/internal/shims/getBuiltinModule.ts +0 -66
  400. package/src/internal/shims/nullGetBuiltinModule.ts +0 -1
@@ -6,20 +6,60 @@ export declare class MsTeams extends APIResource {
6
6
  /**
7
7
  * Check if a connection to Microsoft Teams has been authorized for a given
8
8
  * Microsoft Teams tenant object.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const response = await client.providers.msTeams.checkAuth(
13
+ * 'channel_id',
14
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
15
+ * );
16
+ * ```
9
17
  */
10
18
  checkAuth(channelID: string, query: MsTeamCheckAuthParams, options?: RequestOptions): APIPromise<MsTeamCheckAuthResponse>;
11
19
  /**
12
20
  * List the Microsoft Teams channels within a team. By default, archived and
13
21
  * private channels are excluded from the results.
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * const response =
26
+ * await client.providers.msTeams.listChannels(
27
+ * 'channel_id',
28
+ * {
29
+ * ms_teams_tenant_object: 'ms_teams_tenant_object',
30
+ * team_id: 'team_id',
31
+ * },
32
+ * );
33
+ * ```
14
34
  */
15
35
  listChannels(channelID: string, query: MsTeamListChannelsParams, options?: RequestOptions): APIPromise<MsTeamListChannelsResponse>;
16
36
  /**
17
37
  * Get a list of teams belonging to the Microsoft Entra tenant. By default,
18
38
  * archived and private channels are excluded from the results.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * // Automatically fetches more pages as needed.
43
+ * for await (const msTeamListTeamsResponse of client.providers.msTeams.listTeams(
44
+ * 'channel_id',
45
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
46
+ * )) {
47
+ * // ...
48
+ * }
49
+ * ```
19
50
  */
20
51
  listTeams(channelID: string, query: MsTeamListTeamsParams, options?: RequestOptions): PagePromise<MsTeamListTeamsResponsesMsTeamsPagination, MsTeamListTeamsResponse>;
21
52
  /**
22
53
  * Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object.
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * const response =
58
+ * await client.providers.msTeams.revokeAccess(
59
+ * 'channel_id',
60
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
61
+ * );
62
+ * ```
23
63
  */
24
64
  revokeAccess(channelID: string, params: MsTeamRevokeAccessParams, options?: RequestOptions): APIPromise<MsTeamRevokeAccessResponse>;
25
65
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ms-teams.d.mts","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE,WAAW,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;OAGG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;OAGG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,uBAAuB,CAAC;IAQlF;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAO1C;AAED,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;CAChD;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,0BAA0B,CAAC,cAAc,CAAC,CAAC;CACrE;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,wBAAwB,CAAC,YAAY,CAAC;CACvD;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B,aAAa,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC;CACpD;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"ms-teams.d.mts","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE,WAAW,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,uBAAuB,CAAC;IAQlF;;;;;;;;;;;OAWG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAO1C;AAED,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;CAChD;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,0BAA0B,CAAC,cAAc,CAAC,CAAC;CACrE;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,wBAAwB,CAAC,YAAY,CAAC;CACvD;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B,aAAa,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC;CACpD;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -6,20 +6,60 @@ export declare class MsTeams extends APIResource {
6
6
  /**
7
7
  * Check if a connection to Microsoft Teams has been authorized for a given
8
8
  * Microsoft Teams tenant object.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const response = await client.providers.msTeams.checkAuth(
13
+ * 'channel_id',
14
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
15
+ * );
16
+ * ```
9
17
  */
10
18
  checkAuth(channelID: string, query: MsTeamCheckAuthParams, options?: RequestOptions): APIPromise<MsTeamCheckAuthResponse>;
11
19
  /**
12
20
  * List the Microsoft Teams channels within a team. By default, archived and
13
21
  * private channels are excluded from the results.
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * const response =
26
+ * await client.providers.msTeams.listChannels(
27
+ * 'channel_id',
28
+ * {
29
+ * ms_teams_tenant_object: 'ms_teams_tenant_object',
30
+ * team_id: 'team_id',
31
+ * },
32
+ * );
33
+ * ```
14
34
  */
15
35
  listChannels(channelID: string, query: MsTeamListChannelsParams, options?: RequestOptions): APIPromise<MsTeamListChannelsResponse>;
16
36
  /**
17
37
  * Get a list of teams belonging to the Microsoft Entra tenant. By default,
18
38
  * archived and private channels are excluded from the results.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * // Automatically fetches more pages as needed.
43
+ * for await (const msTeamListTeamsResponse of client.providers.msTeams.listTeams(
44
+ * 'channel_id',
45
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
46
+ * )) {
47
+ * // ...
48
+ * }
49
+ * ```
19
50
  */
20
51
  listTeams(channelID: string, query: MsTeamListTeamsParams, options?: RequestOptions): PagePromise<MsTeamListTeamsResponsesMsTeamsPagination, MsTeamListTeamsResponse>;
21
52
  /**
22
53
  * Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object.
54
+ *
55
+ * @example
56
+ * ```ts
57
+ * const response =
58
+ * await client.providers.msTeams.revokeAccess(
59
+ * 'channel_id',
60
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
61
+ * );
62
+ * ```
23
63
  */
24
64
  revokeAccess(channelID: string, params: MsTeamRevokeAccessParams, options?: RequestOptions): APIPromise<MsTeamRevokeAccessResponse>;
25
65
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ms-teams.d.ts","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE,WAAW,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;OAGG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;OAGG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,uBAAuB,CAAC;IAQlF;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAO1C;AAED,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;CAChD;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,0BAA0B,CAAC,cAAc,CAAC,CAAC;CACrE;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,wBAAwB,CAAC,YAAY,CAAC;CACvD;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B,aAAa,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC;CACpD;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"ms-teams.d.ts","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE,WAAW,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAIzC;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yCAAyC,EAAE,uBAAuB,CAAC;IAQlF;;;;;;;;;;;OAWG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAO1C;AAED,MAAM,MAAM,yCAAyC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAC,UAAU,CAAC;CAChD;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,OAAO,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,0BAA0B,CAAC,cAAc,CAAC,CAAC;CACrE;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,cAAc;QAC7B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,wBAAwB,CAAC,YAAY,CAAC;CACvD;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B,aAAa,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC;CACpD;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,YAAY;QAC3B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -9,6 +9,14 @@ class MsTeams extends resource_1.APIResource {
9
9
  /**
10
10
  * Check if a connection to Microsoft Teams has been authorized for a given
11
11
  * Microsoft Teams tenant object.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const response = await client.providers.msTeams.checkAuth(
16
+ * 'channel_id',
17
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
18
+ * );
19
+ * ```
12
20
  */
13
21
  checkAuth(channelID, query, options) {
14
22
  return this._client.get((0, path_1.path) `/v1/providers/ms-teams/${channelID}/auth_check`, { query, ...options });
@@ -16,6 +24,18 @@ class MsTeams extends resource_1.APIResource {
16
24
  /**
17
25
  * List the Microsoft Teams channels within a team. By default, archived and
18
26
  * private channels are excluded from the results.
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * const response =
31
+ * await client.providers.msTeams.listChannels(
32
+ * 'channel_id',
33
+ * {
34
+ * ms_teams_tenant_object: 'ms_teams_tenant_object',
35
+ * team_id: 'team_id',
36
+ * },
37
+ * );
38
+ * ```
19
39
  */
20
40
  listChannels(channelID, query, options) {
21
41
  return this._client.get((0, path_1.path) `/v1/providers/ms-teams/${channelID}/channels`, { query, ...options });
@@ -23,12 +43,32 @@ class MsTeams extends resource_1.APIResource {
23
43
  /**
24
44
  * Get a list of teams belonging to the Microsoft Entra tenant. By default,
25
45
  * archived and private channels are excluded from the results.
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * // Automatically fetches more pages as needed.
50
+ * for await (const msTeamListTeamsResponse of client.providers.msTeams.listTeams(
51
+ * 'channel_id',
52
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
53
+ * )) {
54
+ * // ...
55
+ * }
56
+ * ```
26
57
  */
27
58
  listTeams(channelID, query, options) {
28
59
  return this._client.getAPIList((0, path_1.path) `/v1/providers/ms-teams/${channelID}/teams`, (pagination_1.MsTeamsPagination), { query, ...options });
29
60
  }
30
61
  /**
31
62
  * Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object.
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * const response =
67
+ * await client.providers.msTeams.revokeAccess(
68
+ * 'channel_id',
69
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
70
+ * );
71
+ * ```
32
72
  */
33
73
  revokeAccess(channelID, params, options) {
34
74
  const { ms_teams_tenant_object } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"ms-teams.js","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAqG;AAErG,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;OAGG;IACH,SAAS,CACP,SAAiB,EACjB,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,SAAiB,EACjB,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,SAAS,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,SAAiB,EACjB,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,0BAA0B,SAAS,QAAQ,EAC/C,CAAA,8BAA0C,CAAA,EAC1C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,YAAY,CACV,SAAiB,EACjB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,SAAS,gBAAgB,EAAE;YAC/E,KAAK,EAAE,EAAE,sBAAsB,EAAE;YACjC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAvDD,0BAuDC"}
1
+ {"version":3,"file":"ms-teams.js","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAqG;AAErG,uDAAiD;AAEjD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,SAAiB,EACjB,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,SAAiB,EACjB,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,SAAS,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,SAAiB,EACjB,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,0BAA0B,SAAS,QAAQ,EAC/C,CAAA,8BAA0C,CAAA,EAC1C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,SAAiB,EACjB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,0BAA0B,SAAS,gBAAgB,EAAE;YAC/E,KAAK,EAAE,EAAE,sBAAsB,EAAE;YACjC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA/FD,0BA+FC"}
@@ -6,6 +6,14 @@ export class MsTeams extends APIResource {
6
6
  /**
7
7
  * Check if a connection to Microsoft Teams has been authorized for a given
8
8
  * Microsoft Teams tenant object.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const response = await client.providers.msTeams.checkAuth(
13
+ * 'channel_id',
14
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
15
+ * );
16
+ * ```
9
17
  */
10
18
  checkAuth(channelID, query, options) {
11
19
  return this._client.get(path `/v1/providers/ms-teams/${channelID}/auth_check`, { query, ...options });
@@ -13,6 +21,18 @@ export class MsTeams extends APIResource {
13
21
  /**
14
22
  * List the Microsoft Teams channels within a team. By default, archived and
15
23
  * private channels are excluded from the results.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const response =
28
+ * await client.providers.msTeams.listChannels(
29
+ * 'channel_id',
30
+ * {
31
+ * ms_teams_tenant_object: 'ms_teams_tenant_object',
32
+ * team_id: 'team_id',
33
+ * },
34
+ * );
35
+ * ```
16
36
  */
17
37
  listChannels(channelID, query, options) {
18
38
  return this._client.get(path `/v1/providers/ms-teams/${channelID}/channels`, { query, ...options });
@@ -20,12 +40,32 @@ export class MsTeams extends APIResource {
20
40
  /**
21
41
  * Get a list of teams belonging to the Microsoft Entra tenant. By default,
22
42
  * archived and private channels are excluded from the results.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * // Automatically fetches more pages as needed.
47
+ * for await (const msTeamListTeamsResponse of client.providers.msTeams.listTeams(
48
+ * 'channel_id',
49
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
50
+ * )) {
51
+ * // ...
52
+ * }
53
+ * ```
23
54
  */
24
55
  listTeams(channelID, query, options) {
25
56
  return this._client.getAPIList(path `/v1/providers/ms-teams/${channelID}/teams`, (MsTeamsPagination), { query, ...options });
26
57
  }
27
58
  /**
28
59
  * Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object.
60
+ *
61
+ * @example
62
+ * ```ts
63
+ * const response =
64
+ * await client.providers.msTeams.revokeAccess(
65
+ * 'channel_id',
66
+ * { ms_teams_tenant_object: 'ms_teams_tenant_object' },
67
+ * );
68
+ * ```
29
69
  */
30
70
  revokeAccess(channelID, params, options) {
31
71
  const { ms_teams_tenant_object } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"ms-teams.mjs","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,iBAAiB,EAA6C;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,SAAS,CACP,SAAiB,EACjB,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,SAAiB,EACjB,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,SAAS,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,SAAiB,EACjB,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,0BAA0B,SAAS,QAAQ,EAC/C,CAAA,iBAA0C,CAAA,EAC1C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,YAAY,CACV,SAAiB,EACjB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,SAAS,gBAAgB,EAAE;YAC/E,KAAK,EAAE,EAAE,sBAAsB,EAAE;YACjC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"ms-teams.mjs","sourceRoot":"","sources":["../../src/resources/providers/ms-teams.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,iBAAiB,EAA6C;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;OAWG;IACH,SAAS,CACP,SAAiB,EACjB,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,SAAS,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,SAAiB,EACjB,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,SAAS,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,SAAiB,EACjB,KAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,0BAA0B,SAAS,QAAQ,EAC/C,CAAA,iBAA0C,CAAA,EAC1C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,SAAiB,EACjB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,0BAA0B,SAAS,gBAAgB,EAAE;YAC/E,KAAK,EAAE,EAAE,sBAAsB,EAAE;YACjC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -1,34 +1,12 @@
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.Providers = void 0;
5
+ const tslib_1 = require("../../internal/tslib.js");
28
6
  const resource_1 = require("../../core/resource.js");
29
- const MsTeamsAPI = __importStar(require("./ms-teams.js"));
7
+ const MsTeamsAPI = tslib_1.__importStar(require("./ms-teams.js"));
30
8
  const ms_teams_1 = require("./ms-teams.js");
31
- const SlackAPI = __importStar(require("./slack.js"));
9
+ const SlackAPI = tslib_1.__importStar(require("./slack.js"));
32
10
  const slack_1 = require("./slack.js");
33
11
  class Providers extends resource_1.APIResource {
34
12
  constructor() {
@@ -1 +1 @@
1
- {"version":3,"file":"providers.js","sourceRoot":"","sources":["../../src/resources/providers/providers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,qDAAkD;AAClD,0DAAyC;AACzC,4CAWoB;AACpB,qDAAoC;AACpC,sCASiB;AAEjB,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;CAAA;AAHD,8BAGC;AAED,SAAS,CAAC,KAAK,GAAG,aAAK,CAAC;AACxB,SAAS,CAAC,OAAO,GAAG,kBAAO,CAAC"}
1
+ {"version":3,"file":"providers.js","sourceRoot":"","sources":["../../src/resources/providers/providers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,kEAAyC;AACzC,4CAWoB;AACpB,6DAAoC;AACpC,sCASiB;AAEjB,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;CAAA;AAHD,8BAGC;AAED,SAAS,CAAC,KAAK,GAAG,aAAK,CAAC;AACxB,SAAS,CAAC,OAAO,GAAG,kBAAO,CAAC"}
@@ -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"}
@@ -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"}