slack-ruby-client 0.7.2 → 1.0.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 (383) hide show
  1. checksums.yaml +5 -5
  2. data/.github/FUNDING.yml +1 -0
  3. data/.gitignore +2 -0
  4. data/.gitmodules +1 -1
  5. data/.rubocop.yml +37 -1
  6. data/.rubocop_todo.yml +130 -47
  7. data/.travis.yml +17 -13
  8. data/CHANGELOG.md +254 -43
  9. data/CONTRIBUTING.md +26 -15
  10. data/Dangerfile +3 -0
  11. data/Gemfile +13 -2
  12. data/LICENSE.md +1 -1
  13. data/README.md +287 -63
  14. data/RELEASING.md +22 -14
  15. data/Rakefile +2 -1
  16. data/UPGRADING.md +129 -5
  17. data/bin/commands/admin_analytics.rb +16 -0
  18. data/bin/commands/admin_apps.rb +51 -0
  19. data/bin/commands/admin_apps_approved.rb +17 -0
  20. data/bin/commands/admin_apps_requests.rb +17 -0
  21. data/bin/commands/admin_apps_restricted.rb +17 -0
  22. data/bin/commands/admin_auth_policy.rb +39 -0
  23. data/bin/commands/admin_barriers.rb +47 -0
  24. data/bin/commands/admin_conversations.rb +169 -0
  25. data/bin/commands/admin_conversations_ekm.rb +17 -0
  26. data/bin/commands/admin_conversations_restrictAccess.rb +37 -0
  27. data/bin/commands/admin_conversations_whitelist.rb +37 -0
  28. data/bin/commands/admin_emoji.rb +54 -0
  29. data/bin/commands/admin_inviteRequests.rb +36 -0
  30. data/bin/commands/admin_inviteRequests_approved.rb +16 -0
  31. data/bin/commands/admin_inviteRequests_denied.rb +16 -0
  32. data/bin/commands/admin_teams.rb +27 -0
  33. data/bin/commands/admin_teams_admins.rb +16 -0
  34. data/bin/commands/admin_teams_owners.rb +16 -0
  35. data/bin/commands/admin_teams_settings.rb +64 -0
  36. data/bin/commands/admin_usergroups.rb +48 -0
  37. data/bin/commands/admin_users.rb +98 -0
  38. data/bin/commands/admin_users_session.rb +78 -0
  39. data/bin/commands/api.rb +3 -3
  40. data/bin/commands/apps.rb +15 -0
  41. data/bin/commands/apps_connections.rb +13 -0
  42. data/bin/commands/apps_event_authorizations.rb +16 -0
  43. data/bin/commands/apps_manifest.rb +51 -0
  44. data/bin/commands/apps_permissions.rb +23 -0
  45. data/bin/commands/apps_permissions_resources.rb +15 -0
  46. data/bin/commands/apps_permissions_scopes.rb +13 -0
  47. data/bin/commands/apps_permissions_users.rb +26 -0
  48. data/bin/commands/auth.rb +12 -2
  49. data/bin/commands/auth_teams.rb +16 -0
  50. data/bin/commands/bots.rb +15 -0
  51. data/bin/commands/calls.rb +52 -0
  52. data/bin/commands/calls_participants.rb +25 -0
  53. data/bin/commands/channels.rb +6 -132
  54. data/bin/commands/chat.rb +127 -20
  55. data/bin/commands/chat_scheduledMessages.rb +19 -0
  56. data/bin/commands/conversations.rb +253 -0
  57. data/bin/commands/dialog.rb +15 -0
  58. data/bin/commands/dnd.rb +12 -9
  59. data/bin/commands/emoji.rb +3 -2
  60. data/bin/commands/files.rb +47 -31
  61. data/bin/commands/files_comments.rb +3 -23
  62. data/bin/commands/files_remote.rb +78 -0
  63. data/bin/commands/groups.rb +1 -154
  64. data/bin/commands/im.rb +1 -48
  65. data/bin/commands/migration.rb +16 -0
  66. data/bin/commands/mpim.rb +1 -48
  67. data/bin/commands/oauth.rb +4 -2
  68. data/bin/commands/oauth_v2.rb +29 -0
  69. data/bin/commands/openid_connect.rb +27 -0
  70. data/bin/commands/pins.rb +9 -12
  71. data/bin/commands/reactions.rb +17 -15
  72. data/bin/commands/reminders.rb +17 -10
  73. data/bin/commands/rtm.rb +19 -4
  74. data/bin/commands/search.rb +17 -12
  75. data/bin/commands/stars.rb +12 -9
  76. data/bin/commands/team.rb +23 -8
  77. data/bin/commands/team_billing.rb +13 -0
  78. data/bin/commands/team_preferences.rb +13 -0
  79. data/bin/commands/team_profile.rb +14 -0
  80. data/bin/commands/tooling_tokens.rb +14 -0
  81. data/bin/commands/usergroups.rb +23 -17
  82. data/bin/commands/usergroups_users.rb +7 -4
  83. data/bin/commands/users.rb +83 -27
  84. data/bin/commands/users_admin.rb +29 -0
  85. data/bin/commands/users_prefs.rb +13 -0
  86. data/bin/commands/users_profile.rb +27 -0
  87. data/bin/commands/views.rb +48 -0
  88. data/bin/commands/workflows.rb +38 -0
  89. data/bin/commands.rb +47 -5
  90. data/bin/slack +3 -4
  91. data/examples/hi_real_time_and_web/Gemfile +1 -0
  92. data/examples/hi_real_time_and_web/hi.rb +8 -4
  93. data/examples/{hi_real_time_async_celluloid → hi_real_time_async_async}/Gemfile +2 -1
  94. data/examples/{hi_real_time_async_celluloid → hi_real_time_async_async}/Procfile +0 -0
  95. data/examples/{hi_real_time_async_celluloid → hi_real_time_async_async}/hi.rb +13 -8
  96. data/examples/hi_web/Gemfile +1 -0
  97. data/examples/hi_web/hi.rb +2 -1
  98. data/examples/new_ticket/Gemfile +1 -0
  99. data/examples/new_ticket/new_ticket.rb +3 -2
  100. data/lib/slack/config.rb +2 -2
  101. data/lib/slack/events/config.rb +32 -0
  102. data/lib/slack/events/request.rb +72 -0
  103. data/lib/slack/logger.rb +6 -5
  104. data/lib/slack/messages/formatting.rb +4 -4
  105. data/lib/slack/messages/message.rb +6 -4
  106. data/lib/slack/real_time/api/message.rb +3 -1
  107. data/lib/slack/real_time/api/message_id.rb +1 -0
  108. data/lib/slack/real_time/api/ping.rb +5 -2
  109. data/lib/slack/real_time/api/templates/event_handler.erb +1 -1
  110. data/lib/slack/real_time/api/typing.rb +3 -1
  111. data/lib/slack/real_time/client.rb +116 -36
  112. data/lib/slack/real_time/concurrency/async.rb +138 -0
  113. data/lib/slack/real_time/concurrency.rb +2 -2
  114. data/lib/slack/real_time/config.rb +17 -19
  115. data/lib/slack/real_time/models/base.rb +3 -3
  116. data/lib/slack/real_time/models/bot.rb +1 -0
  117. data/lib/slack/real_time/models/channel.rb +1 -0
  118. data/lib/slack/real_time/models/group.rb +1 -0
  119. data/lib/slack/real_time/models/im.rb +1 -0
  120. data/lib/slack/real_time/models/team.rb +1 -0
  121. data/lib/slack/real_time/models/user.rb +1 -0
  122. data/lib/slack/real_time/models.rb +8 -7
  123. data/lib/slack/real_time/socket.rb +51 -23
  124. data/lib/slack/real_time/stores/base.rb +6 -9
  125. data/lib/slack/real_time/stores/starter.rb +143 -69
  126. data/lib/slack/real_time/stores/store.rb +160 -82
  127. data/lib/slack/real_time/stores.rb +4 -3
  128. data/lib/slack/version.rb +2 -1
  129. data/lib/slack/web/api/endpoints/admin_analytics.rb +28 -0
  130. data/lib/slack/web/api/endpoints/admin_apps.rb +78 -0
  131. data/lib/slack/web/api/endpoints/admin_apps_approved.rb +35 -0
  132. data/lib/slack/web/api/endpoints/admin_apps_requests.rb +35 -0
  133. data/lib/slack/web/api/endpoints/admin_apps_restricted.rb +35 -0
  134. data/lib/slack/web/api/endpoints/admin_auth_policy.rb +72 -0
  135. data/lib/slack/web/api/endpoints/admin_barriers.rb +82 -0
  136. data/lib/slack/web/api/endpoints/admin_conversations.rb +260 -0
  137. data/lib/slack/web/api/endpoints/admin_conversations_ekm.rb +35 -0
  138. data/lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb +61 -0
  139. data/lib/slack/web/api/endpoints/admin_conversations_whitelist.rb +64 -0
  140. data/lib/slack/web/api/endpoints/admin_emoji.rb +88 -0
  141. data/lib/slack/web/api/endpoints/admin_inviteRequests.rb +61 -0
  142. data/lib/slack/web/api/endpoints/admin_inviteRequests_approved.rb +33 -0
  143. data/lib/slack/web/api/endpoints/admin_inviteRequests_denied.rb +33 -0
  144. data/lib/slack/web/api/endpoints/admin_teams.rb +50 -0
  145. data/lib/slack/web/api/endpoints/admin_teams_admins.rb +34 -0
  146. data/lib/slack/web/api/endpoints/admin_teams_owners.rb +34 -0
  147. data/lib/slack/web/api/endpoints/admin_teams_settings.rb +99 -0
  148. data/lib/slack/web/api/endpoints/admin_usergroups.rb +77 -0
  149. data/lib/slack/web/api/endpoints/admin_users.rb +163 -0
  150. data/lib/slack/web/api/endpoints/admin_users_session.rb +122 -0
  151. data/lib/slack/web/api/endpoints/api.rb +4 -5
  152. data/lib/slack/web/api/endpoints/apps.rb +27 -0
  153. data/lib/slack/web/api/endpoints/apps_connections.rb +21 -0
  154. data/lib/slack/web/api/endpoints/apps_event_authorizations.rb +34 -0
  155. data/lib/slack/web/api/endpoints/apps_manifest.rb +75 -0
  156. data/lib/slack/web/api/endpoints/apps_permissions.rb +36 -0
  157. data/lib/slack/web/api/endpoints/apps_permissions_resources.rb +31 -0
  158. data/lib/slack/web/api/endpoints/apps_permissions_scopes.rb +21 -0
  159. data/lib/slack/web/api/endpoints/apps_permissions_users.rb +50 -0
  160. data/lib/slack/web/api/endpoints/auth.rb +14 -2
  161. data/lib/slack/web/api/endpoints/auth_teams.rb +33 -0
  162. data/lib/slack/web/api/endpoints/bots.rb +25 -0
  163. data/lib/slack/web/api/endpoints/calls.rb +83 -0
  164. data/lib/slack/web/api/endpoints/calls_participants.rb +42 -0
  165. data/lib/slack/web/api/endpoints/channels.rb +8 -201
  166. data/lib/slack/web/api/endpoints/chat.rb +252 -42
  167. data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +40 -0
  168. data/lib/slack/web/api/endpoints/conversations.rb +422 -0
  169. data/lib/slack/web/api/endpoints/dialog.rb +33 -0
  170. data/lib/slack/web/api/endpoints/dnd.rb +17 -12
  171. data/lib/slack/web/api/endpoints/emoji.rb +3 -2
  172. data/lib/slack/web/api/endpoints/files.rb +82 -43
  173. data/lib/slack/web/api/endpoints/files_comments.rb +4 -36
  174. data/lib/slack/web/api/endpoints/files_remote.rb +127 -0
  175. data/lib/slack/web/api/endpoints/groups.rb +1 -235
  176. data/lib/slack/web/api/endpoints/im.rb +1 -73
  177. data/lib/slack/web/api/endpoints/migration.rb +28 -0
  178. data/lib/slack/web/api/endpoints/mpim.rb +1 -72
  179. data/lib/slack/web/api/endpoints/oauth.rb +9 -10
  180. data/lib/slack/web/api/endpoints/oauth_v2.rb +48 -0
  181. data/lib/slack/web/api/endpoints/openid_connect.rb +42 -0
  182. data/lib/slack/web/api/endpoints/pins.rb +14 -23
  183. data/lib/slack/web/api/endpoints/presence.rb +1 -1
  184. data/lib/slack/web/api/endpoints/reactions.rb +43 -34
  185. data/lib/slack/web/api/endpoints/reminders.rb +28 -15
  186. data/lib/slack/web/api/endpoints/rtm.rb +29 -8
  187. data/lib/slack/web/api/endpoints/search.rb +39 -24
  188. data/lib/slack/web/api/endpoints/stars.rb +30 -22
  189. data/lib/slack/web/api/endpoints/team.rb +34 -11
  190. data/lib/slack/web/api/endpoints/team_billing.rb +21 -0
  191. data/lib/slack/web/api/endpoints/team_preferences.rb +21 -0
  192. data/lib/slack/web/api/endpoints/team_profile.rb +23 -0
  193. data/lib/slack/web/api/endpoints/tooling_tokens.rb +24 -0
  194. data/lib/slack/web/api/endpoints/usergroups.rb +43 -32
  195. data/lib/slack/web/api/endpoints/usergroups_users.rb +14 -9
  196. data/lib/slack/web/api/endpoints/users.rb +104 -19
  197. data/lib/slack/web/api/endpoints/users_admin.rb +49 -0
  198. data/lib/slack/web/api/endpoints/users_prefs.rb +21 -0
  199. data/lib/slack/web/api/endpoints/users_profile.rb +44 -0
  200. data/lib/slack/web/api/endpoints/views.rb +97 -0
  201. data/lib/slack/web/api/endpoints/workflows.rb +61 -0
  202. data/lib/slack/web/api/endpoints.rb +111 -29
  203. data/lib/slack/web/api/error.rb +2 -8
  204. data/lib/slack/web/api/errors/server_error.rb +37 -0
  205. data/lib/slack/web/api/errors/slack_error.rb +29 -0
  206. data/lib/slack/web/api/errors/too_many_requests_error.rb +21 -0
  207. data/lib/slack/web/api/errors.rb +1040 -0
  208. data/lib/slack/web/api/mixins/conversations.id.rb +25 -0
  209. data/lib/slack/web/api/mixins/ids.id.rb +24 -0
  210. data/lib/slack/web/api/mixins/users.id.rb +6 -7
  211. data/lib/slack/web/api/mixins/users.search.rb +39 -36
  212. data/lib/slack/web/api/mixins.rb +4 -4
  213. data/lib/slack/web/api/patches/chat.1.patch +70 -0
  214. data/lib/slack/web/api/patches/dialog.1.open-json-support.patch +17 -0
  215. data/lib/slack/web/api/patches/views.1.view-json.patch +40 -0
  216. data/lib/slack/web/api/patches/views.1.views-published.patch +16 -0
  217. data/lib/slack/web/api/templates/command.erb +5 -3
  218. data/lib/slack/web/api/templates/commands.erb +2 -1
  219. data/lib/slack/web/api/templates/endpoints.erb +5 -5
  220. data/lib/slack/web/api/templates/errors.erb +20 -0
  221. data/lib/slack/web/api/templates/method.erb +26 -4
  222. data/lib/slack/web/api/templates/method_spec.erb +3 -2
  223. data/lib/slack/web/client.rb +2 -1
  224. data/lib/slack/web/config.rb +21 -10
  225. data/lib/slack/web/faraday/connection.rb +25 -16
  226. data/lib/slack/web/faraday/request.rb +4 -1
  227. data/lib/slack/web/faraday/response/raise_error.rb +19 -1
  228. data/lib/slack/web/faraday/response/wrap_error.rb +24 -0
  229. data/lib/slack/web/pagination/cursor.rb +48 -0
  230. data/lib/slack-ruby-client.rb +40 -26
  231. data/lib/slack.rb +1 -0
  232. data/lib/slack_ruby_client.rb +1 -0
  233. data/lib/tasks/git.rake +2 -1
  234. data/lib/tasks/real_time.rake +16 -6
  235. data/lib/tasks/update.rake +1 -0
  236. data/lib/tasks/web.rake +42 -10
  237. data/screenshots/create-app.png +0 -0
  238. data/slack-ruby-client.gemspec +11 -9
  239. data/spec/fixtures/slack/web/429_error.yml +50 -52
  240. data/spec/fixtures/slack/web/auth_test_error.yml +51 -18
  241. data/spec/fixtures/slack/web/auth_test_success.yml +50 -26
  242. data/spec/fixtures/slack/web/conversations_info.yml +167 -0
  243. data/spec/fixtures/slack/web/conversations_setTopic.yml +84 -0
  244. data/spec/fixtures/slack/web/conversations_setTopic_one_page.yml +172 -0
  245. data/spec/fixtures/slack/web/conversations_setTopic_paginated.yml +253 -0
  246. data/spec/fixtures/slack/web/paginated_users_list.yml +613 -0
  247. data/spec/fixtures/slack/web/rtm_connect.yml +307 -0
  248. data/spec/fixtures/slack/web/rtm_start.yml +771 -60
  249. data/spec/fixtures/slack/web/users_info.yml +153 -69
  250. data/spec/fixtures/slack/web/users_list.yml +102 -41
  251. data/spec/fixtures/slack/web/views_open_error.yml +83 -0
  252. data/spec/integration/integration_spec.rb +116 -48
  253. data/spec/slack/config_spec.rb +2 -0
  254. data/spec/slack/events/config_spec.rb +33 -0
  255. data/spec/slack/events/request_spec.rb +184 -0
  256. data/spec/slack/messages/formatting_spec.rb +25 -14
  257. data/spec/slack/real_time/api/message_spec.rb +6 -1
  258. data/spec/slack/real_time/api/ping_spec.rb +2 -0
  259. data/spec/slack/real_time/api/typing_spec.rb +5 -1
  260. data/spec/slack/real_time/client_spec.rb +465 -141
  261. data/spec/slack/real_time/concurrency/it_behaves_like_a_realtime_socket.rb +21 -0
  262. data/spec/slack/real_time/concurrency/with_concurrency_spec.rb +10 -0
  263. data/spec/slack/real_time/concurrency/without_concurrency_spec.rb +10 -0
  264. data/spec/slack/real_time/event_handlers/bot_spec.rb +7 -4
  265. data/spec/slack/real_time/event_handlers/channel_spec.rb +10 -7
  266. data/spec/slack/real_time/event_handlers/event_handlers_spec.rb +3 -2
  267. data/spec/slack/real_time/event_handlers/group_spec.rb +5 -4
  268. data/spec/slack/real_time/event_handlers/im_spec.rb +9 -8
  269. data/spec/slack/real_time/event_handlers/team_spec.rb +8 -4
  270. data/spec/slack/real_time/event_handlers/user_spec.rb +7 -4
  271. data/spec/slack/real_time/rtm_connect_spec.rb +14 -0
  272. data/spec/slack/real_time/rtm_start_spec.rb +2 -1
  273. data/spec/slack/real_time/store_spec.rb +2 -1
  274. data/spec/slack/slack_spec.rb +42 -8
  275. data/spec/slack/version_spec.rb +2 -1
  276. data/spec/slack/web/api/endpoints/admin_analytics_spec.rb +13 -0
  277. data/spec/slack/web/api/endpoints/admin_apps_approved_spec.rb +8 -0
  278. data/spec/slack/web/api/endpoints/admin_apps_requests_spec.rb +8 -0
  279. data/spec/slack/web/api/endpoints/admin_apps_restricted_spec.rb +8 -0
  280. data/spec/slack/web/api/endpoints/admin_apps_spec.rb +18 -0
  281. data/spec/slack/web/api/endpoints/admin_auth_policy_spec.rb +35 -0
  282. data/spec/slack/web/api/endpoints/admin_barriers_spec.rb +38 -0
  283. data/spec/slack/web/api/endpoints/admin_conversations_ekm_spec.rb +8 -0
  284. data/spec/slack/web/api/endpoints/admin_conversations_restrictAccess_spec.rb +32 -0
  285. data/spec/slack/web/api/endpoints/admin_conversations_spec.rb +98 -0
  286. data/spec/slack/web/api/endpoints/admin_emoji_spec.rb +37 -0
  287. data/spec/slack/web/api/endpoints/admin_inviteRequests_approved_spec.rb +8 -0
  288. data/spec/slack/web/api/endpoints/admin_inviteRequests_denied_spec.rb +8 -0
  289. data/spec/slack/web/api/endpoints/admin_inviteRequests_spec.rb +18 -0
  290. data/spec/slack/web/api/endpoints/admin_teams_admins_spec.rb +13 -0
  291. data/spec/slack/web/api/endpoints/admin_teams_owners_spec.rb +13 -0
  292. data/spec/slack/web/api/endpoints/admin_teams_settings_spec.rb +53 -0
  293. data/spec/slack/web/api/endpoints/admin_teams_spec.rb +16 -0
  294. data/spec/slack/web/api/endpoints/admin_usergroups_spec.rb +37 -0
  295. data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +41 -0
  296. data/spec/slack/web/api/endpoints/admin_users_spec.rb +67 -0
  297. data/spec/slack/web/api/endpoints/api_spec.rb +1 -0
  298. data/spec/slack/web/api/endpoints/apps_connections_spec.rb +8 -0
  299. data/spec/slack/web/api/endpoints/apps_event_authorizations_spec.rb +13 -0
  300. data/spec/slack/web/api/endpoints/apps_manifest_spec.rb +36 -0
  301. data/spec/slack/web/api/endpoints/apps_spec.rb +16 -0
  302. data/spec/slack/web/api/endpoints/auth_teams_spec.rb +8 -0
  303. data/spec/slack/web/api/endpoints/bots_spec.rb +8 -0
  304. data/spec/slack/web/api/endpoints/calls_participants_spec.rb +24 -0
  305. data/spec/slack/web/api/endpoints/calls_spec.rb +31 -0
  306. data/spec/slack/web/api/endpoints/chat_scheduledMessages_spec.rb +8 -0
  307. data/spec/slack/web/api/endpoints/custom_specs/auth_spec.rb +11 -4
  308. data/spec/slack/web/api/endpoints/custom_specs/chat_spec.rb +140 -24
  309. data/spec/slack/web/api/endpoints/custom_specs/conversations_spec.rb +13 -0
  310. data/spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb +36 -0
  311. data/spec/slack/web/api/endpoints/custom_specs/users_spec.rb +22 -7
  312. data/spec/slack/web/api/endpoints/custom_specs/views_spec.rb +95 -0
  313. data/spec/slack/web/api/endpoints/dnd_spec.rb +4 -3
  314. data/spec/slack/web/api/endpoints/emoji_spec.rb +1 -0
  315. data/spec/slack/web/api/endpoints/files_comments_spec.rb +3 -21
  316. data/spec/slack/web/api/endpoints/files_remote_spec.rb +24 -0
  317. data/spec/slack/web/api/endpoints/files_spec.rb +17 -5
  318. data/spec/slack/web/api/endpoints/migration_spec.rb +13 -0
  319. data/spec/slack/web/api/endpoints/oauth_spec.rb +1 -11
  320. data/spec/slack/web/api/endpoints/oauth_v2_spec.rb +16 -0
  321. data/spec/slack/web/api/endpoints/openid_connect_spec.rb +8 -0
  322. data/spec/slack/web/api/endpoints/pins_spec.rb +1 -0
  323. data/spec/slack/web/api/endpoints/reactions_spec.rb +8 -1
  324. data/spec/slack/web/api/endpoints/reminders_spec.rb +3 -2
  325. data/spec/slack/web/api/endpoints/rtm_spec.rb +1 -0
  326. data/spec/slack/web/api/endpoints/search_spec.rb +1 -0
  327. data/spec/slack/web/api/endpoints/stars_spec.rb +1 -0
  328. data/spec/slack/web/api/endpoints/team_billing_spec.rb +8 -0
  329. data/spec/slack/web/api/endpoints/team_preferences_spec.rb +8 -0
  330. data/spec/slack/web/api/endpoints/team_profile_spec.rb +8 -0
  331. data/spec/slack/web/api/endpoints/team_spec.rb +1 -0
  332. data/spec/slack/web/api/endpoints/tooling_tokens_spec.rb +13 -0
  333. data/spec/slack/web/api/endpoints/usergroups_spec.rb +1 -0
  334. data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +3 -2
  335. data/spec/slack/web/api/endpoints/users_admin_spec.rb +18 -0
  336. data/spec/slack/web/api/endpoints/users_prefs_spec.rb +8 -0
  337. data/spec/slack/web/api/endpoints/users_profile_spec.rb +8 -0
  338. data/spec/slack/web/api/endpoints/workflows_spec.rb +26 -0
  339. data/spec/slack/web/api/error_spec.rb +7 -7
  340. data/spec/slack/web/api/errors/slack_error_spec.rb +33 -0
  341. data/spec/slack/web/api/mixins/conversations_list_spec.rb +21 -0
  342. data/spec/slack/web/api/mixins/conversations_spec.rb +43 -0
  343. data/spec/slack/web/api/mixins/users_spec.rb +30 -17
  344. data/spec/slack/web/api/pagination/cursor_spec.rb +98 -0
  345. data/spec/slack/web/client_spec.rb +211 -14
  346. data/spec/slack/web/faraday/request_spec.rb +80 -0
  347. data/spec/slack/web/faraday/response/raise_error_spec.rb +86 -0
  348. data/spec/spec_helper.rb +9 -2
  349. data/spec/support/queue_with_timeout.rb +6 -5
  350. data/spec/support/real_time/concurrency/mock.rb +2 -2
  351. data/spec/support/real_time/connected_client.rb +7 -2
  352. data/spec/support/real_time/event.rb +1 -0
  353. data/spec/support/token.rb +1 -0
  354. data/spec/support/vcr.rb +37 -1
  355. metadata +250 -130
  356. data/examples/hi_real_time/Gemfile +0 -5
  357. data/examples/hi_real_time/hi.gif +0 -0
  358. data/examples/hi_real_time/hi.rb +0 -37
  359. data/examples/hi_real_time_async/Gemfile +0 -5
  360. data/examples/hi_real_time_async/hi.rb +0 -29
  361. data/examples/hi_real_time_async_eventmachine/Gemfile +0 -6
  362. data/examples/hi_real_time_async_eventmachine/Procfile +0 -2
  363. data/examples/hi_real_time_async_eventmachine/hi.rb +0 -36
  364. data/lib/slack/real_time/concurrency/celluloid.rb +0 -100
  365. data/lib/slack/real_time/concurrency/eventmachine.rb +0 -60
  366. data/lib/slack/web/api/mixins/channels.id.json +0 -20
  367. data/lib/slack/web/api/mixins/channels.id.rb +0 -26
  368. data/lib/slack/web/api/mixins/groups.id.json +0 -20
  369. data/lib/slack/web/api/mixins/groups.id.rb +0 -26
  370. data/lib/slack/web/api/patches/chat.1.text-attachments-required.patch +0 -13
  371. data/lib/slack/web/api/patches/chat.2.attachments-json.patch +0 -17
  372. data/lib/slack/web/api/patches/chat.3.update-attachments-support.patch +0 -20
  373. data/screenshots/register-bot.png +0 -0
  374. data/spec/fixtures/slack/web/channels_info.yml +0 -46
  375. data/spec/fixtures/slack/web/groups_info.yml +0 -43
  376. data/spec/slack/real_time/concurrency/celluloid_spec.rb +0 -35
  377. data/spec/slack/real_time/concurrency/eventmachine_spec.rb +0 -50
  378. data/spec/slack/web/api/endpoints/custom_specs/channels_spec.rb +0 -11
  379. data/spec/slack/web/api/endpoints/custom_specs/groups_spec.rb +0 -11
  380. data/spec/slack/web/api/endpoints/im_spec.rb +0 -30
  381. data/spec/slack/web/api/endpoints/mpim_spec.rb +0 -30
  382. data/spec/slack/web/api/mixins/channels_spec.rb +0 -31
  383. data/spec/slack/web/api/mixins/groups_spec.rb +0 -31
data/UPGRADING.md CHANGED
@@ -1,6 +1,132 @@
1
1
  Upgrading Slack-Ruby-Client
2
2
  ===========================
3
3
 
4
+ ### Upgrading to >= 1.0.0
5
+
6
+ #### Deprecated Methods
7
+
8
+ Slack has deprecated all `channel` and `group` methods, which have been removed from the library.
9
+
10
+ See [this announcement from Slack](https://api.slack.com/changelog/2020-01-deprecating-antecedents-to-the-conversations-api) for details.
11
+
12
+ #### Error Handling
13
+
14
+ As of 1.0.0 `Slack::Web::Api::Errors::ServerError` and its subclasses (introduced in 0.16.0) no longer extend `Slack::Web::Api::Errors::InternalError` or its parent `Slack::Web::Api::Errors::SlackError`. If you are rescuing `SlackError` or `InternalError` with the intention of including `ServerError` and its subclasses you should adjust your code to explicitly rescue `Slack::Web::Api::Errors::ServerError`.
15
+
16
+ ```ruby
17
+ # Before
18
+ begin
19
+ client.auth_test
20
+ rescue Slack::Web::Api::Errors::SlackError
21
+ # Includes all server errors
22
+ end
23
+
24
+ # After
25
+ begin
26
+ client.auth_test
27
+ rescue Slack::Web::Api::Errors::SlackError, Slack::Web::Api::Errors::ServerError
28
+ # Need to rescue the server errors separately from SlackError
29
+ end
30
+ ```
31
+
32
+ Additionally the `initialize` method for `ParsingError`, `TimeoutError`, and `UnavailableError` have changed from `new(message, response)` to `new(response)`. The `message` is now built into the definition of these classes. If you are instantiating or raising these errors in your code (perhaps in tests) you will need to update your code.
33
+
34
+ ```ruby
35
+ # Before
36
+ error = Slack::Web::Api::Errors::TimeoutError.new('timeout_error', response)
37
+ error.message
38
+ # => 'timeout_error'
39
+
40
+ # After
41
+ error = Slack::Web::Api::Errors::TimeoutError.new(response)
42
+ error.message
43
+ # => 'timeout_error'
44
+ ```
45
+
46
+ ### Upgrading to >= 0.16.0
47
+
48
+ #### Removed Celluloid and Faye-Websocket Concurrency Support
49
+
50
+ Concurrency support for `celluloid-io` and `faye-websocket` has been removed. If you are running a RealTime bot on Celluloid or Faye, you must upgrade to `async-websocket`. Please note that RealTime bots are deprecated by Slack, and we generally recommend you [migrate your classic, RealTime bot, to granular permissions](https://code.dblock.org/2020/11/30/migrating-classic-slack-ruby-bots-to-granular-permissions.html).
51
+
52
+ See [#338](https://github.com/slack-ruby/slack-ruby-client/issues/338) for more information.
53
+
54
+ #### Error Handling
55
+
56
+ As of 0.16.0 `Faraday::Error` exceptions sans `Faraday::ClientError` are wrapped into `Slack::Web::Api::Errors::ServerError`, so if you're rescuing `Faraday::Error` — you should adjust your code to use `Slack::Web::Api::Errors::ServerError` and use `exception.cause` if underlying `Faraday::Error` is needed.
57
+
58
+ See [README#other-errors](README.md#other-errors) and [#350](https://github.com/slack-ruby/slack-ruby-client/pull/350) for more information.
59
+
60
+ ### Upgrading to >= 0.15.0
61
+
62
+ As of 0.15.0, `activesupport` is no longer required. Add `gem 'activesupport'` to your Gemfile if you required ActiveSupport via this library.
63
+
64
+ See [#325](https://github.com/slack-ruby/slack-ruby-client/pull/325) for more information.
65
+
66
+ ### Upgrading to >= 0.14.0
67
+
68
+ If you are using async-websocket, lock down its version to 0.8.0 as newer versions are currently incompatible.
69
+
70
+ ```
71
+ gem 'async-websocket', '~> 0.8.0'
72
+ ```
73
+
74
+ See [#282](https://github.com/slack-ruby/slack-ruby-client/issues/282) for more information.
75
+
76
+ ### Upgrading to >= 0.13.0
77
+
78
+ #### Recommended Async Library
79
+
80
+ The RealTime client now supports [async-websocket](https://github.com/socketry/async-websocket), which is actively maintained and is now the recommended library.
81
+
82
+ See [#219](https://github.com/slack-ruby/slack-ruby-client/pull/219) for implementation details.
83
+
84
+ #### Async Library Threading and Reactor Changes
85
+
86
+ The RealTime celluloid-io implementation now uses a `Thread` per client. Previous versions used an `Actor`.
87
+
88
+ The faye-websocket implementation with EventMachine will attempt to shutdown EventMachine via `EventMachine.stop` upon shutdown if a reactor wasn't already running.
89
+
90
+ See [#224](https://github.com/slack-ruby/slack-ruby-client/pull/224) for more information.
91
+
92
+ ### Upgrading to >= 0.9.0
93
+
94
+ #### Changes in How the RTM Client Connects
95
+
96
+ The RealTime client now automatically chooses either [rtm.start](https://api.slack.com/methods/rtm.start) or [rtm.connect](https://api.slack.com/methods/rtm.connect) to open a connection. The `rtm.connect` method is a newer, preferred method, which serves connection purposes and returns some basic team info. The `rtm.start` method additionally returns a lot of data about the team, its channels, and members, and is required to use the full `Slack::RealTime::Stores::Store` storage class.
97
+
98
+ Prior versions always used `rtm.start`, to restore this behavior, configure `start_method`.
99
+
100
+ ```ruby
101
+ Slack::RealTime::Client.config do |config|
102
+ config.start_method = :rtm_start
103
+ end
104
+ ```
105
+
106
+ See [#145](https://github.com/slack-ruby/slack-ruby-client/pull/145) for more information.
107
+
108
+ ### Upgrading to >= 0.8.0
109
+
110
+ The default timeout for `rtm.start` has been increased from 60 to 180 seconds via `Slack::RealTime::Client.config.start_options[:request][:timeout]`. If you're explicitly setting `start_options` in your application, preserve the value by merging settings instead of replacing the entire `start_options` value.
111
+
112
+ Before:
113
+
114
+ ```ruby
115
+ Slack::RealTime::Client.config do |config|
116
+ config.start_options = { no_unreads: true }
117
+ end
118
+ ```
119
+
120
+ After:
121
+
122
+ ```ruby
123
+ Slack::RealTime::Client.config do |config|
124
+ config.start_options[:no_unreads] = true # keeps config.start_options[:request] intact
125
+ end
126
+ ```
127
+
128
+ See [#136](https://github.com/slack-ruby/slack-ruby-client/pull/136) for more information.
129
+
4
130
  ### Upgrading to >= 0.6.0
5
131
 
6
132
  #### Changes to API Response Data
@@ -19,7 +145,7 @@ After:
19
145
  puts "Welcome #{client.self.name} to the #{client.team.name} team."
20
146
  ```
21
147
 
22
- See [#56](https://github.com/dblock/slack-ruby-client/issues/56) for more information.
148
+ See [#56](https://github.com/slack-ruby/slack-ruby-client/issues/56) for more information.
23
149
 
24
150
  #### Changes to RealTime Local Store
25
151
 
@@ -37,7 +163,7 @@ The `client.team` object is now a `Slack::RealTime::Models::Team`, which is a ch
37
163
 
38
164
  The `client.users`, `.channels`, `.groups` and `.ims` collections have been changed from `Array` to `Hash`, with object ID as key. Replace any code iterating over the array, eg. `client.users.values.each` or `client.channels.each_pair { |id, channel| ... }`.
39
165
 
40
- See [#55](https://github.com/dblock/slack-ruby-client/issues/55) for more information.
166
+ See [#55](https://github.com/slack-ruby/slack-ruby-client/issues/55) for more information.
41
167
 
42
168
  ### Upgrading to >= 0.5.0
43
169
 
@@ -59,6 +185,4 @@ gem 'celluloid-io'
59
185
 
60
186
  When in doubt, use `faye-websocket`.
61
187
 
62
- See [#5](https://github.com/dblock/slack-ruby-client/issues/5) for more information.
63
-
64
-
188
+ See [#5](https://github.com/slack-ruby/slack-ruby-client/issues/5) for more information.
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminAnalytics methods.'
5
+ command 'admin_analytics' do |g|
6
+ g.desc 'Retrieve analytics data for a given date, presented as a compressed JSON file'
7
+ g.long_desc %( Retrieve analytics data for a given date, presented as a compressed JSON file )
8
+ g.command 'getFile' do |c|
9
+ c.flag 'type', desc: 'The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).'
10
+ c.flag 'date', desc: 'Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.'
11
+ c.flag 'metadata_only', desc: 'Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.'
12
+ c.action do |_global_options, options, _args|
13
+ puts JSON.dump($client.admin_analytics_getFile(options))
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminApps methods.'
5
+ command 'admin_apps' do |g|
6
+ g.desc 'Approve an app for installation on a workspace.'
7
+ g.long_desc %( Approve an app for installation on a workspace. )
8
+ g.command 'approve' do |c|
9
+ c.flag 'app_id', desc: 'The id of the app to approve.'
10
+ c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
11
+ c.flag 'request_id', desc: 'The id of the request to approve.'
12
+ c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
13
+ c.action do |_global_options, options, _args|
14
+ puts JSON.dump($client.admin_apps_approve(options))
15
+ end
16
+ end
17
+
18
+ g.desc 'Clear an app resolution'
19
+ g.long_desc %( Clear an app resolution )
20
+ g.command 'clearResolution' do |c|
21
+ c.flag 'app_id', desc: 'The id of the app whose resolution you want to clear/undo.'
22
+ c.flag 'enterprise_id', desc: 'The enterprise to clear the app resolution from.'
23
+ c.flag 'team_id', desc: 'The workspace to clear the app resolution from.'
24
+ c.action do |_global_options, options, _args|
25
+ puts JSON.dump($client.admin_apps_clearResolution(options))
26
+ end
27
+ end
28
+
29
+ g.desc 'Restrict an app for installation on a workspace.'
30
+ g.long_desc %( Restrict an app for installation on a workspace. )
31
+ g.command 'restrict' do |c|
32
+ c.flag 'app_id', desc: 'The id of the app to restrict.'
33
+ c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
34
+ c.flag 'request_id', desc: 'The id of the request to restrict.'
35
+ c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
36
+ c.action do |_global_options, options, _args|
37
+ puts JSON.dump($client.admin_apps_restrict(options))
38
+ end
39
+ end
40
+
41
+ g.desc 'Uninstall an app from one or many workspaces, or an entire enterprise organization.'
42
+ g.long_desc %( Uninstall an app from one or many workspaces, or an entire enterprise organization. )
43
+ g.command 'uninstall' do |c|
44
+ c.flag 'app_id', desc: 'The ID of the app to uninstall.'
45
+ c.flag 'enterprise_id', desc: 'The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.'
46
+ c.flag 'team_ids', desc: 'IDs of the teams to uninstall from (max 100). With an org-level token, this or enterprise_id is required.'
47
+ c.action do |_global_options, options, _args|
48
+ puts JSON.dump($client.admin_apps_uninstall(options))
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminAppsApproved methods.'
5
+ command 'admin_apps_approved' do |g|
6
+ g.desc 'List approved apps for an org or workspace.'
7
+ g.long_desc %( List approved apps for an org or workspace. )
8
+ g.command 'list' do |c|
9
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
10
+ c.flag 'enterprise_id', desc: '.'
11
+ c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
12
+ c.flag 'team_id', desc: '.'
13
+ c.action do |_global_options, options, _args|
14
+ puts JSON.dump($client.admin_apps_approved_list(options))
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminAppsRequests methods.'
5
+ command 'admin_apps_requests' do |g|
6
+ g.desc 'List app requests for a team/workspace.'
7
+ g.long_desc %( List app requests for a team/workspace. )
8
+ g.command 'list' do |c|
9
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
10
+ c.flag 'enterprise_id', desc: '.'
11
+ c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
12
+ c.flag 'team_id', desc: '.'
13
+ c.action do |_global_options, options, _args|
14
+ puts JSON.dump($client.admin_apps_requests_list(options))
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminAppsRestricted methods.'
5
+ command 'admin_apps_restricted' do |g|
6
+ g.desc 'List restricted apps for an org or workspace.'
7
+ g.long_desc %( List restricted apps for an org or workspace. )
8
+ g.command 'list' do |c|
9
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
10
+ c.flag 'enterprise_id', desc: '.'
11
+ c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
12
+ c.flag 'team_id', desc: '.'
13
+ c.action do |_global_options, options, _args|
14
+ puts JSON.dump($client.admin_apps_restricted_list(options))
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminAuthPolicy methods.'
5
+ command 'admin_auth_policy' do |g|
6
+ g.desc 'Assign entities to a particular authentication policy.'
7
+ g.long_desc %( Assign entities to a particular authentication policy. )
8
+ g.command 'assignEntities' do |c|
9
+ c.flag 'entity_ids', desc: 'Array of IDs to assign to the policy.'
10
+ c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
11
+ c.flag 'policy_name', desc: 'The name of the authentication policy to assign the entities to. Currently, email_password is the only policy that may be used with this method.'
12
+ c.action do |_global_options, options, _args|
13
+ puts JSON.dump($client.admin_auth_policy_assignEntities(options))
14
+ end
15
+ end
16
+
17
+ g.desc 'Fetch all the entities assigned to a particular authentication policy by name.'
18
+ g.long_desc %( Fetch all the entities assigned to a particular authentication policy by name. )
19
+ g.command 'getEntities' do |c|
20
+ c.flag 'policy_name', desc: 'The name of the policy to fetch entities for. Currently, email_password is the only policy that may be used with this method.'
21
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
22
+ c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
23
+ c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 and 1000, both inclusive.'
24
+ c.action do |_global_options, options, _args|
25
+ puts JSON.dump($client.admin_auth_policy_getEntities(options))
26
+ end
27
+ end
28
+
29
+ g.desc 'Remove specified entities from a specified authentication policy.'
30
+ g.long_desc %( Remove specified entities from a specified authentication policy. )
31
+ g.command 'removeEntities' do |c|
32
+ c.flag 'entity_ids', desc: "Encoded IDs of the entities you'd like to remove from the policy."
33
+ c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
34
+ c.flag 'policy_name', desc: 'The name of the policy to remove entities from. Currently, email_password is the only policy that may be used with this method.'
35
+ c.action do |_global_options, options, _args|
36
+ puts JSON.dump($client.admin_auth_policy_removeEntities(options))
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminBarriers methods.'
5
+ command 'admin_barriers' do |g|
6
+ g.desc 'Create an Information Barrier'
7
+ g.long_desc %( Create an Information Barrier )
8
+ g.command 'create' do |c|
9
+ c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
10
+ c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
11
+ c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
12
+ c.action do |_global_options, options, _args|
13
+ puts JSON.dump($client.admin_barriers_create(options))
14
+ end
15
+ end
16
+
17
+ g.desc 'Delete an existing Information Barrier'
18
+ g.long_desc %( Delete an existing Information Barrier )
19
+ g.command 'delete' do |c|
20
+ c.flag 'barrier_id', desc: "The ID of the barrier you're trying to delete."
21
+ c.action do |_global_options, options, _args|
22
+ puts JSON.dump($client.admin_barriers_delete(options))
23
+ end
24
+ end
25
+
26
+ g.desc 'Get all Information Barriers for your organization'
27
+ g.long_desc %( Get all Information Barriers for your organization )
28
+ g.command 'list' do |c|
29
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
30
+ c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
31
+ c.action do |_global_options, options, _args|
32
+ puts JSON.dump($client.admin_barriers_list(options))
33
+ end
34
+ end
35
+
36
+ g.desc 'Update an existing Information Barrier'
37
+ g.long_desc %( Update an existing Information Barrier )
38
+ g.command 'update' do |c|
39
+ c.flag 'barrier_id', desc: "The ID of the barrier you're trying to modify."
40
+ c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
41
+ c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
42
+ c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
43
+ c.action do |_global_options, options, _args|
44
+ puts JSON.dump($client.admin_barriers_update(options))
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,169 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminConversations methods.'
5
+ command 'admin_conversations' do |g|
6
+ g.desc 'Archive a public or private channel.'
7
+ g.long_desc %( Archive a public or private channel. )
8
+ g.command 'archive' do |c|
9
+ c.flag 'channel_id', desc: 'The channel to archive.'
10
+ c.action do |_global_options, options, _args|
11
+ puts JSON.dump($client.admin_conversations_archive(options))
12
+ end
13
+ end
14
+
15
+ g.desc 'Convert a public channel to a private channel.'
16
+ g.long_desc %( Convert a public channel to a private channel. )
17
+ g.command 'convertToPrivate' do |c|
18
+ c.flag 'channel_id', desc: 'The channel to convert to private.'
19
+ c.action do |_global_options, options, _args|
20
+ puts JSON.dump($client.admin_conversations_convertToPrivate(options))
21
+ end
22
+ end
23
+
24
+ g.desc 'Create a public or private channel-based conversation.'
25
+ g.long_desc %( Create a public or private channel-based conversation. )
26
+ g.command 'create' do |c|
27
+ c.flag 'is_private', desc: 'When true, creates a private channel instead of a public channel.'
28
+ c.flag 'name', desc: 'Name of the public or private channel to create.'
29
+ c.flag 'description', desc: 'Description of the public or private channel to create.'
30
+ c.flag 'org_wide', desc: 'When true, the channel will be available org-wide. Note: if the channel is not org_wide=true, you must specify a team_id for this channel.'
31
+ c.flag 'team_id', desc: 'The workspace to create the channel in. Note: this argument is required unless you set org_wide=true.'
32
+ c.action do |_global_options, options, _args|
33
+ puts JSON.dump($client.admin_conversations_create(options))
34
+ end
35
+ end
36
+
37
+ g.desc 'Delete a public or private channel.'
38
+ g.long_desc %( Delete a public or private channel. )
39
+ g.command 'delete' do |c|
40
+ c.flag 'channel_id', desc: 'The channel to delete.'
41
+ c.action do |_global_options, options, _args|
42
+ puts JSON.dump($client.admin_conversations_delete(options))
43
+ end
44
+ end
45
+
46
+ g.desc 'Disconnect a connected channel from one or more workspaces.'
47
+ g.long_desc %( Disconnect a connected channel from one or more workspaces. )
48
+ g.command 'disconnectShared' do |c|
49
+ c.flag 'channel_id', desc: 'The channel to be disconnected from some workspaces.'
50
+ c.flag 'leaving_team_ids', desc: 'team IDs getting removed from the channel, optional if there are only two teams in the channel.'
51
+ c.action do |_global_options, options, _args|
52
+ puts JSON.dump($client.admin_conversations_disconnectShared(options))
53
+ end
54
+ end
55
+
56
+ g.desc 'Get conversation preferences for a public or private channel.'
57
+ g.long_desc %( Get conversation preferences for a public or private channel. )
58
+ g.command 'getConversationPrefs' do |c|
59
+ c.flag 'channel_id', desc: 'The channel to get preferences for.'
60
+ c.action do |_global_options, options, _args|
61
+ puts JSON.dump($client.admin_conversations_getConversationPrefs(options))
62
+ end
63
+ end
64
+
65
+ g.desc "This API endpoint can be used by any admin to get a channel's retention policy."
66
+ g.long_desc %( This API endpoint can be used by any admin to get a channel's retention policy. )
67
+ g.command 'getCustomRetention' do |c|
68
+ c.flag 'channel_id', desc: 'The channel to get the retention policy for.'
69
+ c.action do |_global_options, options, _args|
70
+ puts JSON.dump($client.admin_conversations_getCustomRetention(options))
71
+ end
72
+ end
73
+
74
+ g.desc 'Get all the workspaces a given public or private channel is connected to within this Enterprise org.'
75
+ g.long_desc %( Get all the workspaces a given public or private channel is connected to within this Enterprise org. )
76
+ g.command 'getTeams' do |c|
77
+ c.flag 'channel_id', desc: 'The channel to determine connected workspaces within the organization for.'
78
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
79
+ c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
80
+ c.action do |_global_options, options, _args|
81
+ puts JSON.dump($client.admin_conversations_getTeams(options))
82
+ end
83
+ end
84
+
85
+ g.desc 'Invite a user to a public or private channel.'
86
+ g.long_desc %( Invite a user to a public or private channel. )
87
+ g.command 'invite' do |c|
88
+ c.flag 'channel_id', desc: 'The channel that the users will be invited to.'
89
+ c.flag 'user_ids', desc: 'The users to invite.'
90
+ c.action do |_global_options, options, _args|
91
+ puts JSON.dump($client.admin_conversations_invite(options))
92
+ end
93
+ end
94
+
95
+ g.desc "This API endpoint can be used by any admin to remove a channel's retention policy."
96
+ g.long_desc %( This API endpoint can be used by any admin to remove a channel's retention policy. )
97
+ g.command 'removeCustomRetention' do |c|
98
+ c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
99
+ c.action do |_global_options, options, _args|
100
+ puts JSON.dump($client.admin_conversations_removeCustomRetention(options))
101
+ end
102
+ end
103
+
104
+ g.desc 'Rename a public or private channel.'
105
+ g.long_desc %( Rename a public or private channel. )
106
+ g.command 'rename' do |c|
107
+ c.flag 'channel_id', desc: 'The channel to rename.'
108
+ c.flag 'name', desc: '.'
109
+ c.action do |_global_options, options, _args|
110
+ puts JSON.dump($client.admin_conversations_rename(options))
111
+ end
112
+ end
113
+
114
+ g.desc 'Search for public or private channels in an Enterprise organization.'
115
+ g.long_desc %( Search for public or private channels in an Enterprise organization. )
116
+ g.command 'search' do |c|
117
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
118
+ c.flag 'limit', desc: 'Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.'
119
+ c.flag 'query', desc: 'Name of the the channel to query by.'
120
+ c.flag 'search_channel_types', desc: 'The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section.'
121
+ c.flag 'sort', desc: 'Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted.'
122
+ c.flag 'sort_dir', desc: 'Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a).'
123
+ c.flag 'team_ids', desc: 'Comma separated string of team IDs, signifying the workspaces to search through.'
124
+ c.action do |_global_options, options, _args|
125
+ puts JSON.dump($client.admin_conversations_search(options))
126
+ end
127
+ end
128
+
129
+ g.desc 'Set the posting permissions for a public or private channel.'
130
+ g.long_desc %( Set the posting permissions for a public or private channel. )
131
+ g.command 'setConversationPrefs' do |c|
132
+ c.flag 'channel_id', desc: 'The channel to set the prefs for.'
133
+ c.flag 'prefs', desc: 'The prefs for this channel in a stringified JSON format.'
134
+ c.action do |_global_options, options, _args|
135
+ puts JSON.dump($client.admin_conversations_setConversationPrefs(options))
136
+ end
137
+ end
138
+
139
+ g.desc "This API endpoint can be used by any admin to set a channel's retention policy."
140
+ g.long_desc %( This API endpoint can be used by any admin to set a channel's retention policy. )
141
+ g.command 'setCustomRetention' do |c|
142
+ c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
143
+ c.flag 'duration_days', desc: 'The message retention duration in days to set for this channel.'
144
+ c.action do |_global_options, options, _args|
145
+ puts JSON.dump($client.admin_conversations_setCustomRetention(options))
146
+ end
147
+ end
148
+
149
+ g.desc 'Set the workspaces in an Enterprise grid org that connect to a public or private channel.'
150
+ g.long_desc %( Set the workspaces in an Enterprise grid org that connect to a public or private channel. )
151
+ g.command 'setTeams' do |c|
152
+ c.flag 'channel_id', desc: 'The encoded channel_id to add or remove to workspaces.'
153
+ c.flag 'org_channel', desc: 'True if channel has to be converted to an org channel.'
154
+ c.flag 'target_team_ids', desc: 'A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.'
155
+ c.flag 'team_id', desc: 'The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.'
156
+ c.action do |_global_options, options, _args|
157
+ puts JSON.dump($client.admin_conversations_setTeams(options))
158
+ end
159
+ end
160
+
161
+ g.desc 'Unarchive a public or private channel.'
162
+ g.long_desc %( Unarchive a public or private channel. )
163
+ g.command 'unarchive' do |c|
164
+ c.flag 'channel_id', desc: 'The channel to unarchive.'
165
+ c.action do |_global_options, options, _args|
166
+ puts JSON.dump($client.admin_conversations_unarchive(options))
167
+ end
168
+ end
169
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminConversationsEkm methods.'
5
+ command 'admin_conversations_ekm' do |g|
6
+ g.desc 'List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.'
7
+ g.long_desc %( List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM. )
8
+ g.command 'listOriginalConnectedChannelInfo' do |c|
9
+ c.flag 'channel_ids', desc: 'A comma-separated list of channels to filter to.'
10
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
11
+ c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
12
+ c.flag 'team_ids', desc: 'A comma-separated list of the workspaces to which the channels you would like returned belong.'
13
+ c.action do |_global_options, options, _args|
14
+ puts JSON.dump($client.admin_conversations_ekm_listOriginalConnectedChannelInfo(options))
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminConversationsRestrictaccess methods.'
5
+ command 'admin_conversations_restrictAccess' do |g|
6
+ g.desc 'Add an allowlist of IDP groups for accessing a channel'
7
+ g.long_desc %( Add an allowlist of IDP groups for accessing a channel )
8
+ g.command 'addGroup' do |c|
9
+ c.flag 'channel_id', desc: 'The channel to link this group to.'
10
+ c.flag 'group_id', desc: 'The IDP Group ID to be an allowlist for the private channel.'
11
+ c.flag 'team_id', desc: 'The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.'
12
+ c.action do |_global_options, options, _args|
13
+ puts JSON.dump($client.admin_conversations_restrictAccess_addGroup(options))
14
+ end
15
+ end
16
+
17
+ g.desc 'List all IDP Groups linked to a channel'
18
+ g.long_desc %( List all IDP Groups linked to a channel )
19
+ g.command 'listGroups' do |c|
20
+ c.flag 'channel_id', desc: '.'
21
+ c.flag 'team_id', desc: 'The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.'
22
+ c.action do |_global_options, options, _args|
23
+ puts JSON.dump($client.admin_conversations_restrictAccess_listGroups(options))
24
+ end
25
+ end
26
+
27
+ g.desc 'Remove a linked IDP group linked from a private channel'
28
+ g.long_desc %( Remove a linked IDP group linked from a private channel )
29
+ g.command 'removeGroup' do |c|
30
+ c.flag 'channel_id', desc: 'The channel to remove the linked group from.'
31
+ c.flag 'group_id', desc: 'The IDP Group ID to remove from the private channel.'
32
+ c.flag 'team_id', desc: 'The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.'
33
+ c.action do |_global_options, options, _args|
34
+ puts JSON.dump($client.admin_conversations_restrictAccess_removeGroup(options))
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'Add and remove user groups from conversations. Use admin.conversations.* equivalents instead.'
5
+ command 'admin_conversations_whitelist' do |g|
6
+ g.desc 'Add an allowlist of IDP groups for accessing a channel'
7
+ g.long_desc %( Add an allowlist of IDP groups for accessing a channel )
8
+ g.command 'add' do |c|
9
+ c.flag 'channel_id', desc: 'The channel to whitelist a group for.'
10
+ c.flag 'group_id', desc: 'The IDP Group ID to whitelist for the private channel.'
11
+ c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
12
+ c.action do |_global_options, options, _args|
13
+ puts JSON.dump($client.admin_conversations_whitelist_add(options))
14
+ end
15
+ end
16
+
17
+ g.desc 'List all IDP Groups linked to a channel'
18
+ g.long_desc %( List all IDP Groups linked to a channel )
19
+ g.command 'listGroupsLinkedToChannel' do |c|
20
+ c.flag 'channel_id', desc: '.'
21
+ c.flag 'team_id', desc: 'The workspace where the channele exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.'
22
+ c.action do |_global_options, options, _args|
23
+ puts JSON.dump($client.admin_conversations_whitelist_listGroupsLinkedToChannel(options))
24
+ end
25
+ end
26
+
27
+ g.desc 'Remove an allowlisted IDP group linked to a private channel'
28
+ g.long_desc %( Remove an allowlisted IDP group linked to a private channel )
29
+ g.command 'remove' do |c|
30
+ c.flag 'channel_id', desc: 'The channel to remove a whitelisted group for.'
31
+ c.flag 'group_id', desc: 'The IDP Group ID to remove from the private channel whitelist.'
32
+ c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
33
+ c.action do |_global_options, options, _args|
34
+ puts JSON.dump($client.admin_conversations_whitelist_remove(options))
35
+ end
36
+ end
37
+ end