slack-ruby-client 0.14.4 → 0.14.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (255) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +19 -11
  3. data/.rubocop_todo.yml +66 -47
  4. data/CHANGELOG.md +8 -0
  5. data/Dangerfile +1 -0
  6. data/Gemfile +1 -0
  7. data/README.md +16 -9
  8. data/Rakefile +1 -0
  9. data/bin/commands.rb +6 -0
  10. data/bin/commands/admin_apps.rb +27 -0
  11. data/bin/commands/admin_apps_requests.rb +16 -0
  12. data/bin/commands/admin_users_session.rb +3 -2
  13. data/bin/commands/api.rb +3 -2
  14. data/bin/commands/apps.rb +3 -2
  15. data/bin/commands/apps_permissions.rb +5 -4
  16. data/bin/commands/apps_permissions_resources.rb +3 -2
  17. data/bin/commands/apps_permissions_scopes.rb +3 -2
  18. data/bin/commands/apps_permissions_users.rb +5 -4
  19. data/bin/commands/auth.rb +5 -4
  20. data/bin/commands/bots.rb +3 -2
  21. data/bin/commands/channels.rb +31 -30
  22. data/bin/commands/chat.rb +19 -18
  23. data/bin/commands/chat_scheduledMessages.rb +3 -2
  24. data/bin/commands/conversations.rb +35 -34
  25. data/bin/commands/dialog.rb +3 -2
  26. data/bin/commands/dnd.rb +9 -8
  27. data/bin/commands/emoji.rb +3 -2
  28. data/bin/commands/files.rb +13 -12
  29. data/bin/commands/files_comments.rb +3 -2
  30. data/bin/commands/files_remote.rb +78 -0
  31. data/bin/commands/groups.rb +33 -32
  32. data/bin/commands/im.rb +13 -12
  33. data/bin/commands/migration.rb +3 -2
  34. data/bin/commands/mpim.rb +11 -10
  35. data/bin/commands/oauth.rb +5 -4
  36. data/bin/commands/oauth_v2.rb +17 -0
  37. data/bin/commands/pins.rb +7 -8
  38. data/bin/commands/reactions.rb +10 -11
  39. data/bin/commands/reminders.rb +11 -10
  40. data/bin/commands/rtm.rb +5 -4
  41. data/bin/commands/search.rb +7 -6
  42. data/bin/commands/stars.rb +7 -6
  43. data/bin/commands/team.rb +9 -8
  44. data/bin/commands/team_profile.rb +3 -2
  45. data/bin/commands/usergroups.rb +11 -10
  46. data/bin/commands/usergroups_users.rb +5 -4
  47. data/bin/commands/users.rb +21 -20
  48. data/bin/commands/users_admin.rb +1 -0
  49. data/bin/commands/users_prefs.rb +1 -0
  50. data/bin/commands/users_profile.rb +5 -4
  51. data/bin/commands/views.rb +48 -0
  52. data/bin/slack +1 -2
  53. data/examples/hi_real_time/Gemfile +1 -0
  54. data/examples/hi_real_time/hi.rb +7 -3
  55. data/examples/hi_real_time_and_web/Gemfile +1 -0
  56. data/examples/hi_real_time_and_web/hi.rb +7 -3
  57. data/examples/hi_real_time_async_async/Gemfile +1 -0
  58. data/examples/hi_real_time_async_async/hi.rb +6 -2
  59. data/examples/hi_real_time_async_celluloid/Gemfile +1 -0
  60. data/examples/hi_real_time_async_celluloid/hi.rb +7 -3
  61. data/examples/hi_real_time_async_eventmachine/Gemfile +1 -0
  62. data/examples/hi_real_time_async_eventmachine/hi.rb +7 -3
  63. data/examples/hi_web/Gemfile +1 -0
  64. data/examples/hi_web/hi.rb +1 -0
  65. data/examples/new_ticket/Gemfile +1 -0
  66. data/examples/new_ticket/new_ticket.rb +1 -0
  67. data/lib/slack-ruby-client.rb +3 -2
  68. data/lib/slack.rb +1 -0
  69. data/lib/slack/config.rb +1 -0
  70. data/lib/slack/events/config.rb +1 -0
  71. data/lib/slack/events/request.rb +3 -1
  72. data/lib/slack/logger.rb +6 -5
  73. data/lib/slack/messages/formatting.rb +1 -0
  74. data/lib/slack/messages/message.rb +1 -0
  75. data/lib/slack/real_time/api/message.rb +3 -1
  76. data/lib/slack/real_time/api/message_id.rb +1 -0
  77. data/lib/slack/real_time/api/ping.rb +5 -2
  78. data/lib/slack/real_time/api/typing.rb +3 -1
  79. data/lib/slack/real_time/client.rb +19 -12
  80. data/lib/slack/real_time/concurrency.rb +1 -0
  81. data/lib/slack/real_time/concurrency/async.rb +15 -7
  82. data/lib/slack/real_time/concurrency/celluloid.rb +9 -3
  83. data/lib/slack/real_time/concurrency/eventmachine.rb +7 -4
  84. data/lib/slack/real_time/config.rb +6 -1
  85. data/lib/slack/real_time/models.rb +1 -0
  86. data/lib/slack/real_time/models/base.rb +1 -0
  87. data/lib/slack/real_time/models/bot.rb +1 -0
  88. data/lib/slack/real_time/models/channel.rb +1 -0
  89. data/lib/slack/real_time/models/group.rb +1 -0
  90. data/lib/slack/real_time/models/im.rb +1 -0
  91. data/lib/slack/real_time/models/team.rb +1 -0
  92. data/lib/slack/real_time/models/user.rb +1 -0
  93. data/lib/slack/real_time/socket.rb +14 -11
  94. data/lib/slack/real_time/stores.rb +1 -0
  95. data/lib/slack/real_time/stores/base.rb +1 -0
  96. data/lib/slack/real_time/stores/starter.rb +1 -0
  97. data/lib/slack/real_time/stores/store.rb +16 -25
  98. data/lib/slack/version.rb +2 -1
  99. data/lib/slack/web/api/endpoints.rb +11 -0
  100. data/lib/slack/web/api/endpoints/admin_apps.rb +42 -0
  101. data/lib/slack/web/api/endpoints/admin_apps_requests.rb +33 -0
  102. data/lib/slack/web/api/endpoints/admin_users_session.rb +2 -1
  103. data/lib/slack/web/api/endpoints/api.rb +2 -1
  104. data/lib/slack/web/api/endpoints/apps.rb +2 -1
  105. data/lib/slack/web/api/endpoints/apps_permissions.rb +3 -2
  106. data/lib/slack/web/api/endpoints/apps_permissions_resources.rb +2 -1
  107. data/lib/slack/web/api/endpoints/apps_permissions_scopes.rb +2 -1
  108. data/lib/slack/web/api/endpoints/apps_permissions_users.rb +3 -2
  109. data/lib/slack/web/api/endpoints/auth.rb +3 -2
  110. data/lib/slack/web/api/endpoints/bots.rb +2 -1
  111. data/lib/slack/web/api/endpoints/channels.rb +16 -16
  112. data/lib/slack/web/api/endpoints/chat.rb +10 -9
  113. data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +2 -1
  114. data/lib/slack/web/api/endpoints/conversations.rb +18 -17
  115. data/lib/slack/web/api/endpoints/dialog.rb +2 -1
  116. data/lib/slack/web/api/endpoints/dnd.rb +5 -4
  117. data/lib/slack/web/api/endpoints/emoji.rb +2 -1
  118. data/lib/slack/web/api/endpoints/files.rb +7 -6
  119. data/lib/slack/web/api/endpoints/files_comments.rb +2 -1
  120. data/lib/slack/web/api/endpoints/files_remote.rb +127 -0
  121. data/lib/slack/web/api/endpoints/groups.rb +17 -22
  122. data/lib/slack/web/api/endpoints/im.rb +7 -8
  123. data/lib/slack/web/api/endpoints/migration.rb +2 -1
  124. data/lib/slack/web/api/endpoints/mpim.rb +6 -7
  125. data/lib/slack/web/api/endpoints/oauth.rb +3 -2
  126. data/lib/slack/web/api/endpoints/oauth_v2.rb +30 -0
  127. data/lib/slack/web/api/endpoints/pins.rb +5 -9
  128. data/lib/slack/web/api/endpoints/reactions.rb +9 -12
  129. data/lib/slack/web/api/endpoints/reminders.rb +6 -5
  130. data/lib/slack/web/api/endpoints/rtm.rb +3 -2
  131. data/lib/slack/web/api/endpoints/search.rb +4 -3
  132. data/lib/slack/web/api/endpoints/stars.rb +4 -5
  133. data/lib/slack/web/api/endpoints/team.rb +5 -5
  134. data/lib/slack/web/api/endpoints/team_profile.rb +2 -1
  135. data/lib/slack/web/api/endpoints/usergroups.rb +6 -5
  136. data/lib/slack/web/api/endpoints/usergroups_users.rb +3 -2
  137. data/lib/slack/web/api/endpoints/users.rb +11 -16
  138. data/lib/slack/web/api/endpoints/users_admin.rb +1 -0
  139. data/lib/slack/web/api/endpoints/users_prefs.rb +1 -0
  140. data/lib/slack/web/api/endpoints/users_profile.rb +3 -2
  141. data/lib/slack/web/api/endpoints/views.rb +97 -0
  142. data/lib/slack/web/api/error.rb +1 -0
  143. data/lib/slack/web/api/errors/slack_error.rb +2 -1
  144. data/lib/slack/web/api/errors/too_many_requests_error.rb +1 -0
  145. data/lib/slack/web/api/mixins.rb +1 -0
  146. data/lib/slack/web/api/mixins/channels.id.rb +1 -0
  147. data/lib/slack/web/api/mixins/groups.id.rb +1 -0
  148. data/lib/slack/web/api/mixins/ids.id.rb +4 -1
  149. data/lib/slack/web/api/mixins/users.id.rb +1 -0
  150. data/lib/slack/web/api/mixins/users.search.rb +1 -0
  151. data/lib/slack/web/api/patches/views.1.view-json.patch +40 -0
  152. data/lib/slack/web/api/patches/views.1.views-published.patch +16 -0
  153. data/lib/slack/web/api/templates/command.erb +1 -0
  154. data/lib/slack/web/api/templates/commands.erb +1 -0
  155. data/lib/slack/web/api/templates/endpoints.erb +1 -0
  156. data/lib/slack/web/api/templates/method.erb +1 -0
  157. data/lib/slack/web/api/templates/method_spec.erb +1 -0
  158. data/lib/slack/web/client.rb +1 -0
  159. data/lib/slack/web/config.rb +1 -0
  160. data/lib/slack/web/faraday/connection.rb +1 -0
  161. data/lib/slack/web/faraday/request.rb +1 -0
  162. data/lib/slack/web/faraday/response/raise_error.rb +7 -6
  163. data/lib/slack/web/pagination/cursor.rb +1 -0
  164. data/lib/slack_ruby_client.rb +1 -0
  165. data/lib/tasks/git.rake +1 -0
  166. data/lib/tasks/real_time.rake +12 -4
  167. data/lib/tasks/update.rake +1 -0
  168. data/lib/tasks/web.rake +17 -6
  169. data/screenshots/create-app.png +0 -0
  170. data/slack-ruby-client.gemspec +4 -1
  171. data/spec/integration/integration_spec.rb +16 -17
  172. data/spec/slack/config_spec.rb +2 -0
  173. data/spec/slack/events/config_spec.rb +8 -4
  174. data/spec/slack/events/request_spec.rb +67 -37
  175. data/spec/slack/messages/formatting_spec.rb +25 -13
  176. data/spec/slack/real_time/api/message_spec.rb +6 -1
  177. data/spec/slack/real_time/api/ping_spec.rb +2 -0
  178. data/spec/slack/real_time/api/typing_spec.rb +5 -1
  179. data/spec/slack/real_time/client_spec.rb +137 -39
  180. data/spec/slack/real_time/concurrency/celluloid_spec.rb +11 -6
  181. data/spec/slack/real_time/concurrency/eventmachine_spec.rb +9 -1
  182. data/spec/slack/real_time/concurrency/it_behaves_like_a_realtime_socket.rb +2 -0
  183. data/spec/slack/real_time/event_handlers/bot_spec.rb +2 -1
  184. data/spec/slack/real_time/event_handlers/channel_spec.rb +9 -6
  185. data/spec/slack/real_time/event_handlers/event_handlers_spec.rb +2 -1
  186. data/spec/slack/real_time/event_handlers/group_spec.rb +5 -4
  187. data/spec/slack/real_time/event_handlers/im_spec.rb +4 -3
  188. data/spec/slack/real_time/event_handlers/team_spec.rb +3 -1
  189. data/spec/slack/real_time/event_handlers/user_spec.rb +1 -0
  190. data/spec/slack/real_time/rtm_connect_spec.rb +1 -0
  191. data/spec/slack/real_time/rtm_start_spec.rb +1 -0
  192. data/spec/slack/real_time/store_spec.rb +2 -1
  193. data/spec/slack/slack_spec.rb +37 -5
  194. data/spec/slack/version_spec.rb +2 -1
  195. data/spec/slack/web/api/endpoints/admin_apps_requests_spec.rb +8 -0
  196. data/spec/slack/web/api/endpoints/admin_apps_spec.rb +8 -0
  197. data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +1 -0
  198. data/spec/slack/web/api/endpoints/api_spec.rb +1 -0
  199. data/spec/slack/web/api/endpoints/apps_permissions_resources_spec.rb +1 -0
  200. data/spec/slack/web/api/endpoints/apps_permissions_scopes_spec.rb +1 -0
  201. data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +1 -0
  202. data/spec/slack/web/api/endpoints/apps_permissions_users_spec.rb +1 -0
  203. data/spec/slack/web/api/endpoints/apps_spec.rb +1 -0
  204. data/spec/slack/web/api/endpoints/bots_spec.rb +1 -0
  205. data/spec/slack/web/api/endpoints/chat_scheduledMessages_spec.rb +1 -0
  206. data/spec/slack/web/api/endpoints/conversations_spec.rb +1 -0
  207. data/spec/slack/web/api/endpoints/custom_specs/auth_spec.rb +5 -1
  208. data/spec/slack/web/api/endpoints/custom_specs/channels_spec.rb +2 -0
  209. data/spec/slack/web/api/endpoints/custom_specs/chat_spec.rb +80 -25
  210. data/spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb +12 -4
  211. data/spec/slack/web/api/endpoints/custom_specs/groups_spec.rb +2 -0
  212. data/spec/slack/web/api/endpoints/custom_specs/users_spec.rb +6 -1
  213. data/spec/slack/web/api/endpoints/custom_specs/views_spec.rb +95 -0
  214. data/spec/slack/web/api/endpoints/dnd_spec.rb +1 -0
  215. data/spec/slack/web/api/endpoints/emoji_spec.rb +1 -0
  216. data/spec/slack/web/api/endpoints/files_comments_spec.rb +1 -0
  217. data/spec/slack/web/api/endpoints/files_remote_spec.rb +24 -0
  218. data/spec/slack/web/api/endpoints/files_spec.rb +1 -0
  219. data/spec/slack/web/api/endpoints/im_spec.rb +1 -0
  220. data/spec/slack/web/api/endpoints/migration_spec.rb +1 -0
  221. data/spec/slack/web/api/endpoints/mpim_spec.rb +1 -0
  222. data/spec/slack/web/api/endpoints/oauth_spec.rb +1 -0
  223. data/spec/slack/web/api/endpoints/oauth_v2_spec.rb +13 -0
  224. data/spec/slack/web/api/endpoints/pins_spec.rb +5 -1
  225. data/spec/slack/web/api/endpoints/reactions_spec.rb +8 -1
  226. data/spec/slack/web/api/endpoints/reminders_spec.rb +1 -0
  227. data/spec/slack/web/api/endpoints/rtm_spec.rb +1 -0
  228. data/spec/slack/web/api/endpoints/search_spec.rb +1 -0
  229. data/spec/slack/web/api/endpoints/stars_spec.rb +1 -0
  230. data/spec/slack/web/api/endpoints/team_profile_spec.rb +1 -0
  231. data/spec/slack/web/api/endpoints/team_spec.rb +1 -0
  232. data/spec/slack/web/api/endpoints/usergroups_spec.rb +1 -0
  233. data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +1 -0
  234. data/spec/slack/web/api/endpoints/users_admin_spec.rb +1 -0
  235. data/spec/slack/web/api/endpoints/users_prefs_spec.rb +1 -0
  236. data/spec/slack/web/api/endpoints/users_profile_spec.rb +1 -0
  237. data/spec/slack/web/api/endpoints/views_spec.rb +29 -0
  238. data/spec/slack/web/api/error_spec.rb +4 -2
  239. data/spec/slack/web/api/errors/service_unavailable_spec.rb +6 -3
  240. data/spec/slack/web/api/errors/slack_error_spec.rb +4 -2
  241. data/spec/slack/web/api/mixins/channels_spec.rb +17 -7
  242. data/spec/slack/web/api/mixins/groups_spec.rb +17 -7
  243. data/spec/slack/web/api/mixins/users_spec.rb +17 -8
  244. data/spec/slack/web/api/pagination/cursor_spec.rb +40 -10
  245. data/spec/slack/web/client_spec.rb +45 -18
  246. data/spec/slack/web/faraday/response/raise_error_spec.rb +16 -5
  247. data/spec/spec_helper.rb +2 -1
  248. data/spec/support/queue_with_timeout.rb +1 -0
  249. data/spec/support/real_time/concurrency/mock.rb +1 -0
  250. data/spec/support/real_time/connected_client.rb +9 -3
  251. data/spec/support/real_time/event.rb +1 -0
  252. data/spec/support/token.rb +1 -0
  253. data/spec/support/vcr.rb +1 -0
  254. metadata +59 -7
  255. data/screenshots/register-bot.png +0 -0
@@ -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 'Migration methods.'
4
5
  command 'migration' do |g|
5
- g.desc 'Easily convert your vintage user IDs to Enterprise Grid-friendly global user IDs.'
6
- g.long_desc %( Easily convert your vintage user IDs to Enterprise Grid-friendly global user IDs. )
6
+ g.desc 'For Enterprise Grid workspaces, map local user IDs to global user IDs'
7
+ g.long_desc %( For Enterprise Grid workspaces, map local user IDs to global user IDs )
7
8
  g.command 'exchange' do |c|
8
9
  c.flag 'users', desc: 'A comma-separated list of user ids, up to 400 per request.'
9
10
  c.flag 'to_old', desc: 'Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.'
data/bin/commands/mpim.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
4
  desc 'Mpim methods.'
4
5
  command 'mpim' do |g|
5
- g.desc 'This method closes a multiparty direct message channel.'
6
- g.long_desc %( This method closes a multiparty direct message channel. )
6
+ g.desc 'Closes a multiparty direct message channel.'
7
+ g.long_desc %( Closes a multiparty direct message channel. )
7
8
  g.command 'close' do |c|
8
9
  c.flag 'channel', desc: 'MPIM to close.'
9
10
  c.action do |_global_options, options, _args|
@@ -11,8 +12,8 @@ command 'mpim' do |g|
11
12
  end
12
13
  end
13
14
 
14
- g.desc 'This method returns a portion of messages/events from the specified multiparty direct message channel.'
15
- g.long_desc %( This method returns a portion of messages/events from the specified multiparty direct message channel. To read the entire history for a multiparty direct message, call the method with no latest or oldest arguments, and then continue paging using the instructions below. )
15
+ g.desc 'Fetches history of messages and events from a multiparty direct message.'
16
+ g.long_desc %( Fetches history of messages and events from a multiparty direct message. )
16
17
  g.command 'history' do |c|
17
18
  c.flag 'channel', desc: 'Multiparty direct message to fetch history for.'
18
19
  c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
@@ -24,8 +25,8 @@ command 'mpim' do |g|
24
25
  end
25
26
  end
26
27
 
27
- g.desc "Don't use this method. Use conversations.list instead."
28
- g.long_desc %( Don't use this method. Use conversations.list instead. )
28
+ g.desc 'Lists multiparty direct message channels for the calling user.'
29
+ g.long_desc %( Lists multiparty direct message channels for the calling user. )
29
30
  g.command 'list' do |c|
30
31
  c.flag 'cursor', desc: "Parameter for pagination. 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. See pagination for more details."
31
32
  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."
@@ -34,8 +35,8 @@ command 'mpim' do |g|
34
35
  end
35
36
  end
36
37
 
37
- g.desc 'This method moves the read cursor in a multiparty direct message channel.'
38
- g.long_desc %( This method moves the read cursor in a multiparty direct message channel. )
38
+ g.desc 'Sets the read cursor in a multiparty direct message channel.'
39
+ g.long_desc %( Sets the read cursor in a multiparty direct message channel. )
39
40
  g.command 'mark' do |c|
40
41
  c.flag 'channel', desc: 'multiparty direct message channel to set reading cursor in.'
41
42
  c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -53,8 +54,8 @@ command 'mpim' do |g|
53
54
  end
54
55
  end
55
56
 
56
- g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
57
- g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
57
+ g.desc 'Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.'
58
+ g.long_desc %( Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message. )
58
59
  g.command 'replies' do |c|
59
60
  c.flag 'channel', desc: 'Multiparty direct message channel to fetch thread from.'
60
61
  c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
@@ -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 'Oauth methods.'
4
5
  command 'oauth' do |g|
5
- g.desc 'This method allows you to exchange a temporary OAuth code for an API access token.'
6
- g.long_desc %( This method allows you to exchange a temporary OAuth code for an API access token. )
6
+ g.desc 'Exchanges a temporary OAuth verifier code for an access token.'
7
+ g.long_desc %( Exchanges a temporary OAuth verifier code for an access token. )
7
8
  g.command 'access' do |c|
8
9
  c.flag 'client_id', desc: 'Issued when you created your application.'
9
10
  c.flag 'client_secret', desc: 'Issued when you created your application.'
@@ -15,8 +16,8 @@ command 'oauth' do |g|
15
16
  end
16
17
  end
17
18
 
18
- g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
19
- g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
19
+ g.desc 'Exchanges a temporary OAuth verifier code for a workspace token.'
20
+ g.long_desc %( Exchanges a temporary OAuth verifier code for a workspace token. )
20
21
  g.command 'token' do |c|
21
22
  c.flag 'client_id', desc: 'Issued when you created your application.'
22
23
  c.flag 'client_secret', desc: 'Issued when you created your application.'
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'OauthV2 methods.'
5
+ command 'oauth_v2' do |g|
6
+ g.desc 'Exchanges a temporary OAuth verifier code for an access token.'
7
+ g.long_desc %( Exchanges a temporary OAuth verifier code for an access token. )
8
+ g.command 'access' do |c|
9
+ c.flag 'code', desc: 'The code param returned via the OAuth callback.'
10
+ c.flag 'client_id', desc: 'Issued when you created your application.'
11
+ c.flag 'client_secret', desc: 'Issued when you created your application.'
12
+ c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
13
+ c.action do |_global_options, options, _args|
14
+ puts JSON.dump($client.oauth_v2_access(options))
15
+ end
16
+ end
17
+ end
data/bin/commands/pins.rb CHANGED
@@ -1,21 +1,20 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Pins methods.'
4
5
  command 'pins' do |g|
5
- g.desc 'This method pins a channel message or group message to a particular channel.'
6
- g.long_desc %( This method pins a channel message or group message to a particular channel. The channel argument is required and timestamp must also be specified. )
6
+ g.desc 'Pins an item to a channel.'
7
+ g.long_desc %( Pins an item to a channel. )
7
8
  g.command 'add' do |c|
8
9
  c.flag 'channel', desc: 'Channel to pin the item in.'
9
- c.flag 'file', desc: 'File to pin.'
10
- c.flag 'file_comment', desc: 'File comment to pin.'
11
10
  c.flag 'timestamp', desc: 'Timestamp of the message to pin.'
12
11
  c.action do |_global_options, options, _args|
13
12
  puts JSON.dump($client.pins_add(options))
14
13
  end
15
14
  end
16
15
 
17
- g.desc 'This method lists the items pinned to a channel.'
18
- g.long_desc %( This method lists the items pinned to a channel. )
16
+ g.desc 'Lists items pinned to a channel.'
17
+ g.long_desc %( Lists items pinned to a channel. )
19
18
  g.command 'list' do |c|
20
19
  c.flag 'channel', desc: 'Channel to get pinned items for.'
21
20
  c.action do |_global_options, options, _args|
@@ -23,8 +22,8 @@ command 'pins' do |g|
23
22
  end
24
23
  end
25
24
 
26
- g.desc 'This method un-pins an item (file, file comment, channel message, or group message) from a channel.'
27
- g.long_desc %( This method un-pins an item (file, file comment, channel message, or group message) from a channel. The channel argument is required and one of file, file_comment, or timestamp must also be specified. )
25
+ g.desc 'Un-pins an item from a channel.'
26
+ g.long_desc %( Un-pins an item from a channel. )
28
27
  g.command 'remove' do |c|
29
28
  c.flag 'channel', desc: 'Channel where the item is pinned to.'
30
29
  c.flag 'file', desc: 'File to un-pin.'
@@ -1,22 +1,21 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Reactions methods.'
4
5
  command 'reactions' do |g|
5
- g.desc 'This method adds a reaction (emoji) to a message.'
6
- g.long_desc %( This method adds a reaction (emoji) to a message. Now that file threads work the way you'd expect, the file and file_comment arguments are deprecated. Specify channel and timestamp instead. )
6
+ g.desc 'Adds a reaction to an item.'
7
+ g.long_desc %( Adds a reaction to an item. )
7
8
  g.command 'add' do |c|
8
- c.flag 'name', desc: 'Reaction (emoji) name.'
9
9
  c.flag 'channel', desc: 'Channel where the message to add reaction to was posted.'
10
- c.flag 'file', desc: "File to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead."
11
- c.flag 'file_comment', desc: "File comment to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead."
10
+ c.flag 'name', desc: 'Reaction (emoji) name.'
12
11
  c.flag 'timestamp', desc: 'Timestamp of the message to add reaction to.'
13
12
  c.action do |_global_options, options, _args|
14
13
  puts JSON.dump($client.reactions_add(options))
15
14
  end
16
15
  end
17
16
 
18
- g.desc 'This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).'
19
- g.long_desc %( This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message). )
17
+ g.desc 'Gets reactions for an item.'
18
+ g.long_desc %( Gets reactions for an item. )
20
19
  g.command 'get' do |c|
21
20
  c.flag 'channel', desc: 'Channel where the message to get reactions for was posted.'
22
21
  c.flag 'file', desc: 'File to get reactions for.'
@@ -28,8 +27,8 @@ command 'reactions' do |g|
28
27
  end
29
28
  end
30
29
 
31
- g.desc 'This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.'
32
- g.long_desc %( This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user. )
30
+ g.desc 'Lists reactions made by a user.'
31
+ g.long_desc %( Lists reactions made by a user. )
33
32
  g.command 'list' do |c|
34
33
  c.flag 'cursor', desc: "Parameter for pagination. 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. See pagination for more details."
35
34
  c.flag 'full', desc: 'If true always return the complete reaction list.'
@@ -40,8 +39,8 @@ command 'reactions' do |g|
40
39
  end
41
40
  end
42
41
 
43
- g.desc 'This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message).'
44
- g.long_desc %( This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message). One of file, file_comment, or the combination of channel and timestamp must be specified. )
42
+ g.desc 'Removes a reaction from an item.'
43
+ g.long_desc %( Removes a reaction from an item. )
45
44
  g.command 'remove' do |c|
46
45
  c.flag 'name', desc: 'Reaction (emoji) name.'
47
46
  c.flag 'channel', desc: 'Channel where the message to remove reaction from was posted.'
@@ -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 'Reminders methods.'
4
5
  command 'reminders' do |g|
5
- g.desc 'This method creates a reminder.'
6
- g.long_desc %( This method creates a reminder. )
6
+ g.desc 'Creates a reminder.'
7
+ g.long_desc %( Creates a reminder. )
7
8
  g.command 'add' do |c|
8
9
  c.flag 'text', desc: 'The content of the reminder.'
9
10
  c.flag 'time', desc: 'When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday").'
@@ -13,8 +14,8 @@ command 'reminders' do |g|
13
14
  end
14
15
  end
15
16
 
16
- g.desc 'This method completes a reminder.'
17
- g.long_desc %( This method completes a reminder. )
17
+ g.desc 'Marks a reminder as complete.'
18
+ g.long_desc %( Marks a reminder as complete. )
18
19
  g.command 'complete' do |c|
19
20
  c.flag 'reminder', desc: 'The ID of the reminder to be marked as complete.'
20
21
  c.action do |_global_options, options, _args|
@@ -22,8 +23,8 @@ command 'reminders' do |g|
22
23
  end
23
24
  end
24
25
 
25
- g.desc 'This method deletes a reminder.'
26
- g.long_desc %( This method deletes a reminder. )
26
+ g.desc 'Deletes a reminder.'
27
+ g.long_desc %( Deletes a reminder. )
27
28
  g.command 'delete' do |c|
28
29
  c.flag 'reminder', desc: 'The ID of the reminder.'
29
30
  c.action do |_global_options, options, _args|
@@ -31,8 +32,8 @@ command 'reminders' do |g|
31
32
  end
32
33
  end
33
34
 
34
- g.desc 'This method returns information about a reminder.'
35
- g.long_desc %( This method returns information about a reminder. )
35
+ g.desc 'Gets information about a reminder.'
36
+ g.long_desc %( Gets information about a reminder. )
36
37
  g.command 'info' do |c|
37
38
  c.flag 'reminder', desc: 'The ID of the reminder.'
38
39
  c.action do |_global_options, options, _args|
@@ -40,8 +41,8 @@ command 'reminders' do |g|
40
41
  end
41
42
  end
42
43
 
43
- g.desc 'This method lists all reminders created by or for a given user.'
44
- g.long_desc %( This method lists all reminders created by or for a given user. )
44
+ g.desc 'Lists all reminders created by or for a given user.'
45
+ g.long_desc %( Lists all reminders created by or for a given user. )
45
46
  g.command 'list' do |c|
46
47
  c.action do |_global_options, options, _args|
47
48
  puts JSON.dump($client.reminders_list(options))
data/bin/commands/rtm.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
4
  desc 'Rtm methods.'
4
5
  command 'rtm' do |g|
5
- g.desc 'This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.'
6
- g.long_desc %( This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket. )
6
+ g.desc 'Starts a Real Time Messaging session.'
7
+ g.long_desc %( Starts a Real Time Messaging session. )
7
8
  g.command 'connect' do |c|
8
9
  c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
9
10
  c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
@@ -12,8 +13,8 @@ command 'rtm' do |g|
12
13
  end
13
14
  end
14
15
 
15
- g.desc 'This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.'
16
- g.long_desc %( This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket. )
16
+ g.desc 'Starts a Real Time Messaging session.'
17
+ g.long_desc %( Starts a Real Time Messaging session. )
17
18
  g.command 'start' do |c|
18
19
  c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
19
20
  c.flag 'include_locale', desc: 'Set this to true to receive the locale for users and channels. Defaults to false.'
@@ -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 'Search methods.'
4
5
  command 'search' do |g|
5
- g.desc 'This method allows users and applications to search both messages and files in a single call.'
6
- g.long_desc %( This method allows users and applications to search both messages and files in a single call. )
6
+ g.desc 'Searches for messages and files matching a query.'
7
+ g.long_desc %( Searches for messages and files matching a query. )
7
8
  g.command 'all' do |c|
8
9
  c.flag 'query', desc: 'Search query. May contains booleans, etc.'
9
10
  c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
@@ -14,8 +15,8 @@ command 'search' do |g|
14
15
  end
15
16
  end
16
17
 
17
- g.desc 'This method returns files matching a search query.'
18
- g.long_desc %( This method returns files matching a search query. )
18
+ g.desc 'Searches for files matching a query.'
19
+ g.long_desc %( Searches for files matching a query. )
19
20
  g.command 'files' do |c|
20
21
  c.flag 'query', desc: 'Search query.'
21
22
  c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
@@ -26,8 +27,8 @@ command 'search' do |g|
26
27
  end
27
28
  end
28
29
 
29
- g.desc 'This method returns messages matching a search query.'
30
- g.long_desc %( This method returns messages matching a search query. )
30
+ g.desc 'Searches for messages matching a query.'
31
+ g.long_desc %( Searches for messages matching a query. )
31
32
  g.command 'messages' do |c|
32
33
  c.flag 'query', desc: 'Search query.'
33
34
  c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
@@ -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 'Stars methods.'
4
5
  command 'stars' do |g|
5
- g.desc 'This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.'
6
- g.long_desc %( This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified. )
6
+ g.desc 'Adds a star to an item.'
7
+ g.long_desc %( Adds a star to an item. )
7
8
  g.command 'add' do |c|
8
9
  c.flag 'channel', desc: 'Channel to add star to, or channel where the message to add star to was posted (used with timestamp).'
9
10
  c.flag 'file', desc: 'File to add star to.'
@@ -14,8 +15,8 @@ command 'stars' do |g|
14
15
  end
15
16
  end
16
17
 
17
- g.desc 'This method lists the items starred by the authed user.'
18
- g.long_desc %( This method lists the items starred by the authed user. )
18
+ g.desc 'Lists stars for a user.'
19
+ g.long_desc %( Lists stars for a user. )
19
20
  g.command 'list' do |c|
20
21
  c.flag 'cursor', desc: "Parameter for pagination. 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. See pagination for more details."
21
22
  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."
@@ -24,8 +25,8 @@ command 'stars' do |g|
24
25
  end
25
26
  end
26
27
 
27
- g.desc 'This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.'
28
- g.long_desc %( This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified. )
28
+ g.desc 'Removes a star from an item.'
29
+ g.long_desc %( Removes a star from an item. )
29
30
  g.command 'remove' do |c|
30
31
  c.flag 'channel', desc: 'Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).'
31
32
  c.flag 'file', desc: 'File to remove star from.'
data/bin/commands/team.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
4
  desc 'Team methods.'
4
5
  command 'team' do |g|
5
- g.desc 'This method is used to retrieve the "access logs" for users on a workspace.'
6
- g.long_desc %( This method is used to retrieve the "access logs" for users on a workspace. )
6
+ g.desc 'Gets the access logs for the current team.'
7
+ g.long_desc %( Gets the access logs for the current team. )
7
8
  g.command 'accessLogs' do |c|
8
9
  c.flag 'before', desc: 'End of time range of logs to include in results (inclusive).'
9
10
  c.action do |_global_options, options, _args|
@@ -11,8 +12,8 @@ command 'team' do |g|
11
12
  end
12
13
  end
13
14
 
14
- g.desc 'This method lists billable information for each user on the team. Currently this consists solely of whether the user is'
15
- g.long_desc %( This method lists billable information for each user on the team. Currently this consists solely of whether the user is subject to billing per Slack's Fair Billing policy. )
15
+ g.desc 'Gets billable users information for the current team.'
16
+ g.long_desc %( Gets billable users information for the current team. )
16
17
  g.command 'billableInfo' do |c|
17
18
  c.flag 'user', desc: 'A user to retrieve the billable information for. Defaults to all users.'
18
19
  c.action do |_global_options, options, _args|
@@ -20,8 +21,8 @@ command 'team' do |g|
20
21
  end
21
22
  end
22
23
 
23
- g.desc 'This method provides information about your team.'
24
- g.long_desc %( This method provides information about your team. )
24
+ g.desc 'Gets information about the current team.'
25
+ g.long_desc %( Gets information about the current team. )
25
26
  g.command 'info' do |c|
26
27
  c.flag 'team', desc: 'Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels.'
27
28
  c.action do |_global_options, options, _args|
@@ -29,8 +30,8 @@ command 'team' do |g|
29
30
  end
30
31
  end
31
32
 
32
- g.desc 'This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.'
33
- g.long_desc %( This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins. )
33
+ g.desc 'Gets the integration logs for the current team.'
34
+ g.long_desc %( Gets the integration logs for the current team. )
34
35
  g.command 'integrationLogs' do |c|
35
36
  c.flag 'app_id', desc: 'Filter logs to this Slack app. Defaults to all logs.'
36
37
  c.flag 'change_type', desc: 'Filter logs with this change type. Defaults to all logs.'
@@ -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 'TeamProfile methods.'
4
5
  command 'team_profile' do |g|
5
- g.desc 'This method is used to get the profile field definitions for this team.'
6
- g.long_desc %( This method is used to get the profile field definitions for this team. )
6
+ g.desc "Retrieve a team's profile."
7
+ g.long_desc %( Retrieve a team's profile. )
7
8
  g.command 'get' do |c|
8
9
  c.flag 'visibility', desc: 'Filter by visibility.'
9
10
  c.action do |_global_options, options, _args|
@@ -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 'Usergroups methods.'
4
5
  command 'usergroups' do |g|
5
- g.desc 'This method is used to create a User Group.'
6
- g.long_desc %( This method is used to create a User Group. )
6
+ g.desc 'Create a User Group'
7
+ g.long_desc %( Create a User Group )
7
8
  g.command 'create' do |c|
8
9
  c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
9
10
  c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'
@@ -15,8 +16,8 @@ command 'usergroups' do |g|
15
16
  end
16
17
  end
17
18
 
18
- g.desc 'This method disables an existing User Group.'
19
- g.long_desc %( This method disables an existing User Group. )
19
+ g.desc 'Disable an existing User Group'
20
+ g.long_desc %( Disable an existing User Group )
20
21
  g.command 'disable' do |c|
21
22
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to disable.'
22
23
  c.flag 'include_count', desc: 'Include the number of users in the User Group.'
@@ -25,8 +26,8 @@ command 'usergroups' do |g|
25
26
  end
26
27
  end
27
28
 
28
- g.desc 'This method enables a User Group which was previously disabled.'
29
- g.long_desc %( This method enables a User Group which was previously disabled. )
29
+ g.desc 'Enable a User Group'
30
+ g.long_desc %( Enable a User Group )
30
31
  g.command 'enable' do |c|
31
32
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to enable.'
32
33
  c.flag 'include_count', desc: 'Include the number of users in the User Group.'
@@ -35,8 +36,8 @@ command 'usergroups' do |g|
35
36
  end
36
37
  end
37
38
 
38
- g.desc 'This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.'
39
- g.long_desc %( This method returns a list of all User Groups in the team. This can optionally include disabled User Groups. )
39
+ g.desc 'List all User Groups for a team'
40
+ g.long_desc %( List all User Groups for a team )
40
41
  g.command 'list' do |c|
41
42
  c.flag 'include_count', desc: 'Include the number of users in each User Group.'
42
43
  c.flag 'include_disabled', desc: 'Include disabled User Groups.'
@@ -46,8 +47,8 @@ command 'usergroups' do |g|
46
47
  end
47
48
  end
48
49
 
49
- g.desc 'This method updates the properties of an existing User Group.'
50
- g.long_desc %( This method updates the properties of an existing User Group. )
50
+ g.desc 'Update an existing User Group'
51
+ g.long_desc %( Update an existing User Group )
51
52
  g.command 'update' do |c|
52
53
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
53
54
  c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'