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
@@ -0,0 +1,253 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'Conversations methods.'
5
+ command 'conversations' do |g|
6
+ g.desc 'Accepts an invitation to a Slack Connect channel.'
7
+ g.long_desc %( Accepts an invitation to a Slack Connect channel. )
8
+ g.command 'acceptSharedInvite' do |c|
9
+ c.flag 'channel_name', desc: 'Name of the channel. If the channel does not exist already in your workspace, this name is the one that the channel will take.'
10
+ c.flag 'channel_id', desc: "ID of the channel that you'd like to accept. Must provide either invite_id or channel_id."
11
+ c.flag 'free_trial_accepted', desc: "Whether you'd like to use your workspace's free trial to begin using Slack Connect."
12
+ c.flag 'invite_id', desc: 'See the shared_channel_invite_received event payload for more details on how to retrieve the ID of the invitation.'
13
+ c.flag 'is_private', desc: 'Whether the channel should be private.'
14
+ c.flag 'team_id', desc: 'The ID of the workspace to accept the channel in. If an org-level token is used to call this method, the team_id argument is required.'
15
+ c.action do |_global_options, options, _args|
16
+ puts JSON.dump($client.conversations_acceptSharedInvite(options))
17
+ end
18
+ end
19
+
20
+ g.desc 'Approves an invitation to a Slack Connect channel'
21
+ g.long_desc %( Approves an invitation to a Slack Connect channel )
22
+ g.command 'approveSharedInvite' do |c|
23
+ c.flag 'invite_id', desc: 'ID of the shared channel invite to approve.'
24
+ c.flag 'target_team', desc: 'The team or enterprise id of the other party involved in the invitation you are approving.'
25
+ c.action do |_global_options, options, _args|
26
+ puts JSON.dump($client.conversations_approveSharedInvite(options))
27
+ end
28
+ end
29
+
30
+ g.desc 'Archives a conversation.'
31
+ g.long_desc %( Archives a conversation. )
32
+ g.command 'archive' do |c|
33
+ c.flag 'channel', desc: 'ID of conversation to archive.'
34
+ c.action do |_global_options, options, _args|
35
+ puts JSON.dump($client.conversations_archive(options))
36
+ end
37
+ end
38
+
39
+ g.desc 'Closes a direct message or multi-person direct message.'
40
+ g.long_desc %( Closes a direct message or multi-person direct message. )
41
+ g.command 'close' do |c|
42
+ c.flag 'channel', desc: 'Conversation to close.'
43
+ c.action do |_global_options, options, _args|
44
+ puts JSON.dump($client.conversations_close(options))
45
+ end
46
+ end
47
+
48
+ g.desc 'Initiates a public or private channel-based conversation'
49
+ g.long_desc %( Initiates a public or private channel-based conversation )
50
+ g.command 'create' do |c|
51
+ c.flag 'name', desc: 'Name of the public or private channel to create.'
52
+ c.flag 'is_private', desc: 'Create a private channel instead of a public one.'
53
+ c.flag 'team_id', desc: 'encoded team id to create the channel in, required if org token is used.'
54
+ c.action do |_global_options, options, _args|
55
+ puts JSON.dump($client.conversations_create(options))
56
+ end
57
+ end
58
+
59
+ g.desc 'Declines a Slack Connect channel invite.'
60
+ g.long_desc %( Declines a Slack Connect channel invite. )
61
+ g.command 'declineSharedInvite' do |c|
62
+ c.flag 'invite_id', desc: 'ID of the Slack Connect invite to decline. Subscribe to the shared_channel_invite_accepted event to receive IDs of Slack Connect channel invites that have been accepted and are awaiting approval.'
63
+ c.flag 'target_team', desc: 'The team or enterprise id of the other party involved in the invitation you are declining.'
64
+ c.action do |_global_options, options, _args|
65
+ puts JSON.dump($client.conversations_declineSharedInvite(options))
66
+ end
67
+ end
68
+
69
+ g.desc "Fetches a conversation's history of messages and events."
70
+ g.long_desc %( Fetches a conversation's history of messages and events. )
71
+ g.command 'history' do |c|
72
+ c.flag 'channel', desc: 'Conversation ID to fetch history for.'
73
+ c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
74
+ c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.'
75
+ c.flag 'latest', desc: 'End of time range of messages to include in results. Default is the current time.'
76
+ c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
77
+ c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
78
+ c.action do |_global_options, options, _args|
79
+ puts JSON.dump($client.conversations_history(options))
80
+ end
81
+ end
82
+
83
+ g.desc 'Retrieve information about a conversation.'
84
+ g.long_desc %( Retrieve information about a conversation. )
85
+ g.command 'info' do |c|
86
+ c.flag 'channel', desc: 'Conversation ID to learn more about.'
87
+ c.flag 'include_locale', desc: 'Set this to true to receive the locale for this conversation. Defaults to false.'
88
+ c.flag 'include_num_members', desc: 'Set to true to include the member count for the specified conversation. Defaults to false.'
89
+ c.action do |_global_options, options, _args|
90
+ puts JSON.dump($client.conversations_info(options))
91
+ end
92
+ end
93
+
94
+ g.desc 'Invites users to a channel.'
95
+ g.long_desc %( Invites users to a channel. )
96
+ g.command 'invite' do |c|
97
+ c.flag 'channel', desc: 'The ID of the public or private channel to invite user(s) to.'
98
+ c.flag 'users', desc: 'A comma separated list of user IDs. Up to 1000 users may be listed.'
99
+ c.action do |_global_options, options, _args|
100
+ puts JSON.dump($client.conversations_invite(options))
101
+ end
102
+ end
103
+
104
+ g.desc 'Sends an invitation to a Slack Connect channel'
105
+ g.long_desc %( Sends an invitation to a Slack Connect channel )
106
+ g.command 'inviteShared' do |c|
107
+ c.flag 'channel', desc: "ID of the channel on your team that you'd like to share."
108
+ c.flag 'emails', desc: 'Optional email to receive this invite. Either emails or user_ids must be provided.'
109
+ c.flag 'external_limited', desc: 'Optional boolean on whether invite is to a external limited member. Defaults to true.'
110
+ c.flag 'user_ids', desc: 'Optional user_id to receive this invite. Either emails or user_ids must be provided.'
111
+ c.action do |_global_options, options, _args|
112
+ puts JSON.dump($client.conversations_inviteShared(options))
113
+ end
114
+ end
115
+
116
+ g.desc 'Joins an existing conversation.'
117
+ g.long_desc %( Joins an existing conversation. )
118
+ g.command 'join' do |c|
119
+ c.flag 'channel', desc: 'ID of conversation to join.'
120
+ c.action do |_global_options, options, _args|
121
+ puts JSON.dump($client.conversations_join(options))
122
+ end
123
+ end
124
+
125
+ g.desc 'Removes a user from a conversation.'
126
+ g.long_desc %( Removes a user from a conversation. )
127
+ g.command 'kick' do |c|
128
+ c.flag 'channel', desc: 'ID of conversation to remove user from.'
129
+ c.flag 'user', desc: 'User ID to be removed.'
130
+ c.action do |_global_options, options, _args|
131
+ puts JSON.dump($client.conversations_kick(options))
132
+ end
133
+ end
134
+
135
+ g.desc 'Leaves a conversation.'
136
+ g.long_desc %( Leaves a conversation. )
137
+ g.command 'leave' do |c|
138
+ c.flag 'channel', desc: 'Conversation to leave.'
139
+ c.action do |_global_options, options, _args|
140
+ puts JSON.dump($client.conversations_leave(options))
141
+ end
142
+ end
143
+
144
+ g.desc 'Lists all channels in a Slack team.'
145
+ g.long_desc %( Lists all channels in a Slack team. )
146
+ g.command 'list' do |c|
147
+ c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
148
+ c.flag 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
149
+ c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000."
150
+ c.flag 'team_id', desc: 'encoded team id to list channels in, required if token belongs to org-wide app.'
151
+ c.flag 'types', desc: 'Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.'
152
+ c.action do |_global_options, options, _args|
153
+ puts JSON.dump($client.conversations_list(options))
154
+ end
155
+ end
156
+
157
+ g.desc 'Lists shared channel invites that have been generated or received but have not been approved by all parties'
158
+ g.long_desc %( Lists shared channel invites that have been generated or received but have not been approved by all parties )
159
+ g.command 'listConnectInvites' do |c|
160
+ c.flag 'cursor', desc: 'Set to next_cursor returned by previous call to list items in subsequent page.'
161
+ c.flag 'team_id', desc: 'Encoded team id for the workspace to retrieve invites for, required if org token is used.'
162
+ c.action do |_global_options, options, _args|
163
+ puts JSON.dump($client.conversations_listConnectInvites(options))
164
+ end
165
+ end
166
+
167
+ g.desc 'Sets the read cursor in a channel.'
168
+ g.long_desc %( Sets the read cursor in a channel. )
169
+ g.command 'mark' do |c|
170
+ c.flag 'channel', desc: 'Channel or conversation to set the read cursor for.'
171
+ c.flag 'ts', desc: 'Unique identifier of message you want marked as most recently seen in this conversation.'
172
+ c.action do |_global_options, options, _args|
173
+ puts JSON.dump($client.conversations_mark(options))
174
+ end
175
+ end
176
+
177
+ g.desc 'Retrieve members of a conversation.'
178
+ g.long_desc %( Retrieve members of a conversation. )
179
+ g.command 'members' do |c|
180
+ c.flag 'channel', desc: 'ID of the conversation to retrieve members for.'
181
+ c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
182
+ c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
183
+ c.action do |_global_options, options, _args|
184
+ puts JSON.dump($client.conversations_members(options))
185
+ end
186
+ end
187
+
188
+ g.desc 'Opens or resumes a direct message or multi-person direct message.'
189
+ g.long_desc %( Opens or resumes a direct message or multi-person direct message. )
190
+ g.command 'open' do |c|
191
+ c.flag 'channel', desc: "Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead."
192
+ c.flag 'prevent_creation', desc: 'Do not create a direct message or multi-person direct message. This is used to see if there is an existing dm or mpdm.'
193
+ c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
194
+ c.flag 'users', desc: 'Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.'
195
+ c.action do |_global_options, options, _args|
196
+ puts JSON.dump($client.conversations_open(options))
197
+ end
198
+ end
199
+
200
+ g.desc 'Renames a conversation.'
201
+ g.long_desc %( Renames a conversation. )
202
+ g.command 'rename' do |c|
203
+ c.flag 'channel', desc: 'ID of conversation to rename.'
204
+ c.flag 'name', desc: 'New name for conversation.'
205
+ c.action do |_global_options, options, _args|
206
+ puts JSON.dump($client.conversations_rename(options))
207
+ end
208
+ end
209
+
210
+ g.desc 'Retrieve a thread of messages posted to a conversation'
211
+ g.long_desc %( Retrieve a thread of messages posted to a conversation )
212
+ g.command 'replies' do |c|
213
+ c.flag 'channel', desc: 'Conversation ID to fetch thread from.'
214
+ c.flag 'ts', desc: "Unique identifier of either a thread's parent message or a message in the thread. ts must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message."
215
+ c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
216
+ c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.'
217
+ c.flag 'latest', desc: 'End of time range of messages to include in results.'
218
+ c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
219
+ c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
220
+ c.action do |_global_options, options, _args|
221
+ puts JSON.dump($client.conversations_replies(options))
222
+ end
223
+ end
224
+
225
+ g.desc 'Sets the purpose for a conversation.'
226
+ g.long_desc %( Sets the purpose for a conversation. )
227
+ g.command 'setPurpose' do |c|
228
+ c.flag 'channel', desc: 'Conversation to set the purpose of.'
229
+ c.flag 'purpose', desc: 'A new, specialer purpose.'
230
+ c.action do |_global_options, options, _args|
231
+ puts JSON.dump($client.conversations_setPurpose(options))
232
+ end
233
+ end
234
+
235
+ g.desc 'Sets the topic for a conversation.'
236
+ g.long_desc %( Sets the topic for a conversation. )
237
+ g.command 'setTopic' do |c|
238
+ c.flag 'channel', desc: 'Conversation to set the topic of.'
239
+ c.flag 'topic', desc: 'The new topic string. Does not support formatting or linkification.'
240
+ c.action do |_global_options, options, _args|
241
+ puts JSON.dump($client.conversations_setTopic(options))
242
+ end
243
+ end
244
+
245
+ g.desc 'Reverses conversation archival.'
246
+ g.long_desc %( Reverses conversation archival. )
247
+ g.command 'unarchive' do |c|
248
+ c.flag 'channel', desc: 'ID of conversation to unarchive.'
249
+ c.action do |_global_options, options, _args|
250
+ puts JSON.dump($client.conversations_unarchive(options))
251
+ end
252
+ end
253
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'Dialog methods.'
5
+ command 'dialog' do |g|
6
+ g.desc 'Open a dialog with a user'
7
+ g.long_desc %( Open a dialog with a user )
8
+ g.command 'open' do |c|
9
+ c.flag 'dialog', desc: 'The dialog definition. This must be a JSON-encoded string.'
10
+ c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
11
+ c.action do |_global_options, options, _args|
12
+ puts JSON.dump($client.dialog_open(options))
13
+ end
14
+ end
15
+ end
data/bin/commands/dnd.rb CHANGED
@@ -1,9 +1,10 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
- desc 'Adjust and view Do Not Disturb settings for team members'
4
+ desc 'Dnd methods.'
4
5
  command 'dnd' do |g|
5
- g.desc "Ends the user's currently scheduled Do Not Disturb session immediately."
6
- g.long_desc %( Ends the user's currently scheduled Do Not Disturb session immediately. )
6
+ g.desc "Ends the current user's Do Not Disturb session immediately."
7
+ g.long_desc %( Ends the current user's Do Not Disturb session immediately. )
7
8
  g.command 'endDnd' do |c|
8
9
  c.action do |_global_options, options, _args|
9
10
  puts JSON.dump($client.dnd_endDnd(options))
@@ -18,17 +19,18 @@ command 'dnd' do |g|
18
19
  end
19
20
  end
20
21
 
21
- g.desc "Provides information about a user's current Do Not Disturb settings."
22
- g.long_desc %( Provides information about a user's current Do Not Disturb settings. )
22
+ g.desc "Retrieves a user's current Do Not Disturb status."
23
+ g.long_desc %( Retrieves a user's current Do Not Disturb status. )
23
24
  g.command 'info' do |c|
25
+ c.flag 'team_id', desc: 'Encoded team id where passed in user param belongs, required if org token is used. If no user param is passed, then a team which has access to the app should be passed.'
24
26
  c.flag 'user', desc: 'User to fetch status for (defaults to current user).'
25
27
  c.action do |_global_options, options, _args|
26
28
  puts JSON.dump($client.dnd_info(options))
27
29
  end
28
30
  end
29
31
 
30
- g.desc "Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration."
31
- g.long_desc %( Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration. )
32
+ g.desc 'Turns on Do Not Disturb mode for the current user, or changes its duration.'
33
+ g.long_desc %( Turns on Do Not Disturb mode for the current user, or changes its duration. )
32
34
  g.command 'setSnooze' do |c|
33
35
  c.flag 'num_minutes', desc: 'Number of minutes, from now, to snooze until.'
34
36
  c.action do |_global_options, options, _args|
@@ -36,10 +38,11 @@ command 'dnd' do |g|
36
38
  end
37
39
  end
38
40
 
39
- g.desc 'Provides information about the current Do Not Disturb settings for users of a Slack team.'
40
- g.long_desc %( Provides information about the current Do Not Disturb settings for users of a Slack team. )
41
+ g.desc 'Retrieves the Do Not Disturb status for up to 50 users on a team.'
42
+ g.long_desc %( Retrieves the Do Not Disturb status for up to 50 users on a team. )
41
43
  g.command 'teamInfo' do |c|
42
44
  c.flag 'users', desc: 'Comma-separated list of users to fetch Do Not Disturb status for.'
45
+ c.flag 'team_id', desc: 'Encoded team id where passed in users belong, required if org token is used.'
43
46
  c.action do |_global_options, options, _args|
44
47
  puts JSON.dump($client.dnd_teamInfo(options))
45
48
  end
@@ -1,9 +1,10 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Emoji methods.'
4
5
  command 'emoji' do |g|
5
- g.desc 'This method lists the custom emoji for a team.'
6
- g.long_desc %( This method lists the custom emoji for a team. )
6
+ g.desc 'Lists custom emoji for a team.'
7
+ g.long_desc %( Lists custom emoji for a team. )
7
8
  g.command 'list' do |c|
8
9
  c.action do |_global_options, options, _args|
9
10
  puts JSON.dump($client.emoji_list(options))
@@ -1,9 +1,10 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
- desc 'Get info on files uploaded to Slack, upload new files to Slack.'
4
+ desc 'Files methods.'
4
5
  command 'files' do |g|
5
- g.desc 'This method deletes a file from your team.'
6
- g.long_desc %( This method deletes a file from your team. )
6
+ g.desc 'Deletes a file.'
7
+ g.long_desc %( Deletes a file. )
7
8
  g.command 'delete' do |c|
8
9
  c.flag 'file', desc: 'ID of file to delete.'
9
10
  c.action do |_global_options, options, _args|
@@ -11,42 +12,46 @@ command 'files' do |g|
11
12
  end
12
13
  end
13
14
 
14
- g.desc 'This method returns information about a file in your team.'
15
- g.long_desc %( This method returns information about a file in your team. )
15
+ g.desc 'Change the properties of a file (undocumented)'
16
+ g.long_desc %( Change the properties of a file )
17
+ g.command 'edit' do |c|
18
+ c.flag 'file', desc: 'ID of the file to be edited'
19
+ c.flag 'title', desc: 'New title of the file'
20
+ c.flag 'filetype', desc: 'New filetype of the file. See https://api.slack.com/types/file#file_types for a list of all supported types.'
21
+ c.action do |_global_options, options, _args|
22
+ puts JSON.dump($client.files_edit(options))
23
+ end
24
+ end
25
+
26
+ g.desc 'Gets information about a file.'
27
+ g.long_desc %( Gets information about a file. )
16
28
  g.command 'info' do |c|
17
29
  c.flag 'file', desc: 'Specify a file by providing its ID.'
30
+ c.flag 'cursor', desc: "Parameter for pagination. File comments are paginated for a single file. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection of comments. See pagination for more details."
31
+ c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached."
18
32
  c.action do |_global_options, options, _args|
19
33
  puts JSON.dump($client.files_info(options))
20
34
  end
21
35
  end
22
36
 
23
- g.desc 'This method returns a list of files within the team. It can be filtered and sliced in various ways.'
24
- g.long_desc %( This method returns a list of files within the team. It can be filtered and sliced in various ways. )
37
+ g.desc 'List for a team, in a channel, or from a user with applied filters.'
38
+ g.long_desc %( List for a team, in a channel, or from a user with applied filters. )
25
39
  g.command 'list' do |c|
26
- c.flag 'user', desc: 'Filter files created by a single user.'
27
40
  c.flag 'channel', desc: 'Filter files appearing in a specific channel, indicated by its ID.'
41
+ c.flag 'files', desc: '.'
42
+ c.flag 'show_files_hidden_by_limit', desc: 'Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.'
43
+ c.flag 'team_id', desc: 'encoded team id to list files in, required if org token is used.'
28
44
  c.flag 'ts_from', desc: 'Filter files created after this timestamp (inclusive).'
29
45
  c.flag 'ts_to', desc: 'Filter files created before this timestamp (inclusive).'
30
- c.flag 'types', desc: 'Filter files by type:
31
-
32
- all - All files
33
- posts - Posts
34
- snippets - Snippets
35
- images - Image files
36
- gdocs - Google docs
37
- zips - Zip files
38
- pdfs - PDF files
39
-
40
-
41
- You can pass multiple values in the types argument, like types=posts,snippets.The default value is all, which does not filter the list.
42
- .'
46
+ c.flag 'types', desc: 'Filter files by type (see below). You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.'
47
+ c.flag 'user', desc: 'Filter files created by a single user.'
43
48
  c.action do |_global_options, options, _args|
44
49
  puts JSON.dump($client.files_list(options))
45
50
  end
46
51
  end
47
52
 
48
- g.desc 'This method disables public/external sharing for a file.'
49
- g.long_desc %( This method disables public/external sharing for a file. )
53
+ g.desc 'Revokes public/external sharing access for a file'
54
+ g.long_desc %( Revokes public/external sharing access for a file )
50
55
  g.command 'revokePublicURL' do |c|
51
56
  c.flag 'file', desc: 'File to revoke.'
52
57
  c.action do |_global_options, options, _args|
@@ -54,8 +59,18 @@ You can pass multiple values in the types argument, like types=posts,snippets.Th
54
59
  end
55
60
  end
56
61
 
57
- g.desc 'This method enables public/external sharing for a file.'
58
- g.long_desc %( This method enables public/external sharing for a file. )
62
+ g.desc 'Share an existing file in a channel (undocumented)'
63
+ g.long_desc %( Share an existing file in a channel )
64
+ g.command 'share' do |c|
65
+ c.flag 'file', desc: 'ID of the file to be shared'
66
+ c.flag 'channel', desc: 'Channel to share the file in. Works with both public (channel ID) and private channels (group ID).'
67
+ c.action do |_global_options, options, _args|
68
+ puts JSON.dump($client.files_share(options))
69
+ end
70
+ end
71
+
72
+ g.desc 'Enables a file for public/external sharing.'
73
+ g.long_desc %( Enables a file for public/external sharing. )
59
74
  g.command 'sharedPublicURL' do |c|
60
75
  c.flag 'file', desc: 'File to share.'
61
76
  c.action do |_global_options, options, _args|
@@ -63,16 +78,17 @@ You can pass multiple values in the types argument, like types=posts,snippets.Th
63
78
  end
64
79
  end
65
80
 
66
- g.desc 'This method allows you to create or upload an existing file.'
67
- g.long_desc %( This method allows you to create or upload an existing file. )
81
+ g.desc 'Uploads or creates a file.'
82
+ g.long_desc %( Uploads or creates a file. )
68
83
  g.command 'upload' do |c|
69
- c.flag 'file', desc: 'File contents via multipart/form-data. If omitting this parameter, you must submit content.'
84
+ c.flag 'channels', desc: 'Comma-separated list of channel names or IDs where the file will be shared.'
70
85
  c.flag 'content', desc: 'File contents via a POST variable. If omitting this parameter, you must provide a file.'
71
- c.flag 'filetype', desc: 'A file type identifier.'
86
+ c.flag 'file', desc: 'File contents via multipart/form-data. If omitting this parameter, you must submit content.'
72
87
  c.flag 'filename', desc: 'Filename of file.'
88
+ c.flag 'filetype', desc: 'A file type identifier.'
89
+ c.flag 'initial_comment', desc: 'The message text introducing the file in specified channels.'
90
+ c.flag 'thread_ts', desc: "Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead."
73
91
  c.flag 'title', desc: 'Title of file.'
74
- c.flag 'initial_comment', desc: 'Initial comment to add to file.'
75
- c.flag 'channels', desc: 'Comma-separated list of channel names or IDs where the file will be shared.'
76
92
  c.action do |_global_options, options, _args|
77
93
  puts JSON.dump($client.files_upload(options))
78
94
  end
@@ -1,19 +1,10 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'FilesComments methods.'
4
5
  command 'files_comments' do |g|
5
- g.desc 'Add a comment to an existing file.'
6
- g.long_desc %( Add a comment to an existing file. )
7
- g.command 'add' do |c|
8
- c.flag 'file', desc: 'File to add a comment to.'
9
- c.flag 'comment', desc: 'Text of the comment to add.'
10
- c.action do |_global_options, options, _args|
11
- puts JSON.dump($client.files_comments_add(options))
12
- end
13
- end
14
-
15
- g.desc 'Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment.'
16
- g.long_desc %( Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment. )
6
+ g.desc 'Deletes an existing comment on a file.'
7
+ g.long_desc %( Deletes an existing comment on a file. )
17
8
  g.command 'delete' do |c|
18
9
  c.flag 'file', desc: 'File to delete a comment from.'
19
10
  c.flag 'id', desc: 'The comment to delete.'
@@ -21,15 +12,4 @@ command 'files_comments' do |g|
21
12
  puts JSON.dump($client.files_comments_delete(options))
22
13
  end
23
14
  end
24
-
25
- g.desc 'Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.'
26
- g.long_desc %( Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed. )
27
- g.command 'edit' do |c|
28
- c.flag 'file', desc: 'File containing the comment to edit.'
29
- c.flag 'id', desc: 'The comment to edit.'
30
- c.flag 'comment', desc: 'Text of the comment to edit.'
31
- c.action do |_global_options, options, _args|
32
- puts JSON.dump($client.files_comments_edit(options))
33
- end
34
- end
35
15
  end
@@ -0,0 +1,78 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'FilesRemote methods.'
5
+ command 'files_remote' do |g|
6
+ g.desc 'Adds a file from a remote service'
7
+ g.long_desc %( Adds a file from a remote service )
8
+ g.command 'add' do |c|
9
+ c.flag 'external_id', desc: 'Creator defined GUID for the file.'
10
+ c.flag 'external_url', desc: 'URL of the remote file.'
11
+ c.flag 'title', desc: 'Title of the file being shared.'
12
+ c.flag 'filetype', desc: 'type of file.'
13
+ c.flag 'indexable_file_contents', desc: 'A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.'
14
+ c.flag 'preview_image', desc: 'Preview of the document via multipart/form-data.'
15
+ c.action do |_global_options, options, _args|
16
+ puts JSON.dump($client.files_remote_add(options))
17
+ end
18
+ end
19
+
20
+ g.desc 'Retrieve information about a remote file added to Slack'
21
+ g.long_desc %( Retrieve information about a remote file added to Slack )
22
+ g.command 'info' do |c|
23
+ c.flag 'external_id', desc: 'Creator defined GUID for the file.'
24
+ c.flag 'file', desc: 'Specify a file by providing its ID.'
25
+ c.action do |_global_options, options, _args|
26
+ puts JSON.dump($client.files_remote_info(options))
27
+ end
28
+ end
29
+
30
+ g.desc 'Retrieve information about a remote file added to Slack'
31
+ g.long_desc %( Retrieve information about a remote file added to Slack )
32
+ g.command 'list' do |c|
33
+ c.flag 'channel', desc: 'Filter files appearing in a specific channel, indicated by its ID.'
34
+ c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
35
+ c.flag 'limit', desc: 'The maximum number of items to return.'
36
+ c.flag 'ts_from', desc: 'Filter files created after this timestamp (inclusive).'
37
+ c.flag 'ts_to', desc: 'Filter files created before this timestamp (inclusive).'
38
+ c.action do |_global_options, options, _args|
39
+ puts JSON.dump($client.files_remote_list(options))
40
+ end
41
+ end
42
+
43
+ g.desc 'Remove a remote file.'
44
+ g.long_desc %( Remove a remote file. )
45
+ g.command 'remove' do |c|
46
+ c.flag 'external_id', desc: 'Creator defined GUID for the file.'
47
+ c.flag 'file', desc: 'Specify a file by providing its ID.'
48
+ c.action do |_global_options, options, _args|
49
+ puts JSON.dump($client.files_remote_remove(options))
50
+ end
51
+ end
52
+
53
+ g.desc 'Share a remote file into a channel.'
54
+ g.long_desc %( Share a remote file into a channel. )
55
+ g.command 'share' do |c|
56
+ c.flag 'channels', desc: 'Comma-separated list of channel IDs where the file will be shared.'
57
+ c.flag 'external_id', desc: 'The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or file or both are required.'
58
+ c.flag 'file', desc: 'Specify a file registered with Slack by providing its ID. Either this field or external_id or both are required.'
59
+ c.action do |_global_options, options, _args|
60
+ puts JSON.dump($client.files_remote_share(options))
61
+ end
62
+ end
63
+
64
+ g.desc 'Updates an existing remote file.'
65
+ g.long_desc %( Updates an existing remote file. )
66
+ g.command 'update' do |c|
67
+ c.flag 'external_id', desc: 'Creator defined GUID for the file.'
68
+ c.flag 'external_url', desc: 'URL of the remote file.'
69
+ c.flag 'file', desc: 'Specify a file by providing its ID.'
70
+ c.flag 'filetype', desc: 'type of file.'
71
+ c.flag 'indexable_file_contents', desc: 'File containing contents that can be used to improve searchability for the remote file.'
72
+ c.flag 'preview_image', desc: 'Preview of the document via multipart/form-data.'
73
+ c.flag 'title', desc: 'Title of the file being shared.'
74
+ c.action do |_global_options, options, _args|
75
+ puts JSON.dump($client.files_remote_update(options))
76
+ end
77
+ end
78
+ end