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 'Dialog methods.'
4
5
  command 'dialog' do |g|
5
- g.desc 'Open a dialog with a user by exchanging a trigger_id received from another interaction. See the dialogs documentation to learn how to obtain triggers define form elements.'
6
- g.long_desc %( Open a dialog with a user by exchanging a trigger_id received from another interaction. See the dialogs documentation to learn how to obtain triggers define form elements. )
6
+ g.desc 'Open a dialog with a user'
7
+ g.long_desc %( Open a dialog with a user )
7
8
  g.command 'open' do |c|
8
9
  c.flag 'dialog', desc: 'The dialog definition. This must be a JSON-encoded string.'
9
10
  c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
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
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,8 +19,8 @@ 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|
24
25
  c.flag 'user', desc: 'User to fetch status for (defaults to current user).'
25
26
  c.action do |_global_options, options, _args|
@@ -27,8 +28,8 @@ command 'dnd' do |g|
27
28
  end
28
29
  end
29
30
 
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. )
31
+ g.desc 'Turns on Do Not Disturb mode for the current user, or changes its duration.'
32
+ g.long_desc %( Turns on Do Not Disturb mode for the current user, or changes its duration. )
32
33
  g.command 'setSnooze' do |c|
33
34
  c.flag 'num_minutes', desc: 'Number of minutes, from now, to snooze until.'
34
35
  c.action do |_global_options, options, _args|
@@ -36,8 +37,8 @@ command 'dnd' do |g|
36
37
  end
37
38
  end
38
39
 
39
- g.desc 'Provides information about the current Do Not Disturb settings for a list of users in a Slack team.'
40
- g.long_desc %( Provides information about the current Do Not Disturb settings for a list of users in a Slack team. )
40
+ g.desc 'Retrieves the Do Not Disturb status for up to 50 users on a team.'
41
+ g.long_desc %( Retrieves the Do Not Disturb status for up to 50 users on a team. )
41
42
  g.command 'teamInfo' do |c|
42
43
  c.flag 'users', desc: 'Comma-separated list of users to fetch Do Not Disturb status for.'
43
44
  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 '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
4
  desc 'Files methods.'
4
5
  command 'files' do |g|
5
- g.desc "A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments."
6
- g.long_desc %( A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments. )
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|
@@ -22,8 +23,8 @@ command 'files' do |g|
22
23
  end
23
24
  end
24
25
 
25
- g.desc "A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments."
26
- g.long_desc %( A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments. )
26
+ g.desc 'Gets information about a team file.'
27
+ g.long_desc %( Gets information about a team file. )
27
28
  g.command 'info' do |c|
28
29
  c.flag 'file', desc: 'Specify a file by providing its ID.'
29
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."
@@ -33,8 +34,8 @@ command 'files' do |g|
33
34
  end
34
35
  end
35
36
 
36
- g.desc "A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments."
37
- g.long_desc %( A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments. )
37
+ g.desc 'Lists & filters team files.'
38
+ g.long_desc %( Lists & filters team files. )
38
39
  g.command 'list' do |c|
39
40
  c.flag 'channel', desc: 'Filter files appearing in a specific channel, indicated by its ID.'
40
41
  c.flag 'ts_from', desc: 'Filter files created after this timestamp (inclusive).'
@@ -46,8 +47,8 @@ command 'files' do |g|
46
47
  end
47
48
  end
48
49
 
49
- g.desc "A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments."
50
- g.long_desc %( A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments. )
50
+ g.desc 'Revokes public/external sharing access for a file'
51
+ g.long_desc %( Revokes public/external sharing access for a file )
51
52
  g.command 'revokePublicURL' do |c|
52
53
  c.flag 'file', desc: 'File to revoke.'
53
54
  c.action do |_global_options, options, _args|
@@ -65,8 +66,8 @@ command 'files' do |g|
65
66
  end
66
67
  end
67
68
 
68
- g.desc "A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments."
69
- g.long_desc %( A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments. )
69
+ g.desc 'Enables a file for public/external sharing.'
70
+ g.long_desc %( Enables a file for public/external sharing. )
70
71
  g.command 'sharedPublicURL' do |c|
71
72
  c.flag 'file', desc: 'File to share.'
72
73
  c.action do |_global_options, options, _args|
@@ -74,8 +75,8 @@ command 'files' do |g|
74
75
  end
75
76
  end
76
77
 
77
- g.desc "A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments."
78
- g.long_desc %( A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments. )
78
+ g.desc 'Uploads or creates a file.'
79
+ g.long_desc %( Uploads or creates a file. )
79
80
  g.command 'upload' do |c|
80
81
  c.flag 'channels', desc: 'Comma-separated list of channel names or IDs where the file will be shared.'
81
82
  c.flag 'content', desc: 'File contents via a POST variable. If omitting this parameter, you must provide a file.'
@@ -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 'FilesComments methods.'
4
5
  command 'files_comments' do |g|
5
- g.desc "A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments."
6
- g.long_desc %( A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments. )
6
+ g.desc 'Deletes an existing comment on a file.'
7
+ g.long_desc %( Deletes an existing comment on a file. )
7
8
  g.command 'delete' do |c|
8
9
  c.flag 'file', desc: 'File to delete a comment from.'
9
10
  c.flag 'id', desc: 'The comment to delete.'
@@ -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: 'File containing contents that can be used to improve searchability for 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: 'Creator defined GUID for the file.'
58
+ c.flag 'file', desc: 'Specify a file by providing its ID.'
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
@@ -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 'Groups methods.'
4
5
  command 'groups' do |g|
5
- g.desc 'This method archives a private channel.'
6
- g.long_desc %( This method archives a private channel. )
6
+ g.desc 'Archives a private channel.'
7
+ g.long_desc %( Archives a private channel. )
7
8
  g.command 'archive' do |c|
8
9
  c.flag 'channel', desc: 'Private channel to archive.'
9
10
  c.action do |_global_options, options, _args|
@@ -11,8 +12,8 @@ command 'groups' do |g|
11
12
  end
12
13
  end
13
14
 
14
- g.desc 'This method creates a private channel.'
15
- g.long_desc %( This method creates a private channel. )
15
+ g.desc 'Creates a private channel.'
16
+ g.long_desc %( Creates a private channel. )
16
17
  g.command 'create' do |c|
17
18
  c.flag 'name', desc: 'Name of private channel to create.'
18
19
  c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
@@ -21,8 +22,8 @@ command 'groups' do |g|
21
22
  end
22
23
  end
23
24
 
24
- g.desc 'This method takes an existing private channel and performs the following steps:'
25
- g.long_desc %( This method takes an existing private channel and performs the following steps: - Renames the existing private channel (from "example" to "example-archived"). - Archives the existing private channel. - Creates a new private channel with the name of the existing private channel. - Adds all members of the existing private channel to the new private channel. )
25
+ g.desc 'Clones and archives a private channel.'
26
+ g.long_desc %( Clones and archives a private channel. )
26
27
  g.command 'createChild' do |c|
27
28
  c.flag 'channel', desc: 'Private channel to clone and archive.'
28
29
  c.action do |_global_options, options, _args|
@@ -30,8 +31,8 @@ command 'groups' do |g|
30
31
  end
31
32
  end
32
33
 
33
- g.desc 'This method returns a portion of messages/events from the specified private channel.'
34
- g.long_desc %( This method returns a portion of messages/events from the specified private channel. To read the entire history for a private channel, call the method with no latest or oldest arguments, and then continue paging using the instructions below. )
34
+ g.desc 'Fetches history of messages and events from a private channel.'
35
+ g.long_desc %( Fetches history of messages and events from a private channel. )
35
36
  g.command 'history' do |c|
36
37
  c.flag 'channel', desc: 'Private channel to fetch history for.'
37
38
  c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
@@ -52,8 +53,8 @@ command 'groups' do |g|
52
53
  end
53
54
  end
54
55
 
55
- g.desc "Don't use this method. Use conversations.info instead."
56
- g.long_desc %( Don't use this method. Use conversations.info instead. )
56
+ g.desc 'Gets information about a private channel.'
57
+ g.long_desc %( Gets information about a private channel. )
57
58
  g.command 'info' do |c|
58
59
  c.flag 'channel', desc: 'Private channel to get info on.'
59
60
  c.flag 'include_locale', desc: 'Set this to true to receive the locale for this group. Defaults to false.'
@@ -62,8 +63,8 @@ command 'groups' do |g|
62
63
  end
63
64
  end
64
65
 
65
- g.desc 'This method is used to invite a user to a private channel. The calling user must be a member of the private channel.'
66
- g.long_desc %( This method is used to invite a user to a private channel. The calling user must be a member of the private channel. )
66
+ g.desc 'Invites a user to a private channel.'
67
+ g.long_desc %( Invites a user to a private channel. )
67
68
  g.command 'invite' do |c|
68
69
  c.flag 'channel', desc: 'Private channel to invite user to.'
69
70
  c.flag 'user', desc: 'User to invite.'
@@ -72,8 +73,8 @@ command 'groups' do |g|
72
73
  end
73
74
  end
74
75
 
75
- g.desc 'This method allows a user to remove another member from a private channel.'
76
- g.long_desc %( This method allows a user to remove another member from a private channel. )
76
+ g.desc 'Removes a user from a private channel.'
77
+ g.long_desc %( Removes a user from a private channel. )
77
78
  g.command 'kick' do |c|
78
79
  c.flag 'channel', desc: 'Private channel to remove user from.'
79
80
  c.flag 'user', desc: 'User to remove from private channel.'
@@ -82,8 +83,8 @@ command 'groups' do |g|
82
83
  end
83
84
  end
84
85
 
85
- g.desc 'This method is used to leave a private channel.'
86
- g.long_desc %( This method is used to leave a private channel. )
86
+ g.desc 'Leaves a private channel.'
87
+ g.long_desc %( Leaves a private channel. )
87
88
  g.command 'leave' do |c|
88
89
  c.flag 'channel', desc: 'Private channel to leave.'
89
90
  c.action do |_global_options, options, _args|
@@ -91,8 +92,8 @@ command 'groups' do |g|
91
92
  end
92
93
  end
93
94
 
94
- g.desc "Don't use this method. Use conversations.list instead."
95
- g.long_desc %( Don't use this method. Use conversations.list instead. )
95
+ g.desc 'Lists private channels that the calling user has access to.'
96
+ g.long_desc %( Lists private channels that the calling user has access to. )
96
97
  g.command 'list' do |c|
97
98
  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."
98
99
  c.flag 'exclude_archived', desc: "Don't return archived private channels."
@@ -103,8 +104,8 @@ command 'groups' do |g|
103
104
  end
104
105
  end
105
106
 
106
- g.desc 'This method moves the read cursor in a private channel.'
107
- g.long_desc %( This method moves the read cursor in a private channel. )
107
+ g.desc 'Sets the read cursor in a private channel.'
108
+ g.long_desc %( Sets the read cursor in a private channel. )
108
109
  g.command 'mark' do |c|
109
110
  c.flag 'channel', desc: 'Private channel to set reading cursor in.'
110
111
  c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -113,8 +114,8 @@ command 'groups' do |g|
113
114
  end
114
115
  end
115
116
 
116
- g.desc 'This method opens a private channel.'
117
- g.long_desc %( This method opens a private channel. )
117
+ g.desc 'Opens a private channel.'
118
+ g.long_desc %( Opens a private channel. )
118
119
  g.command 'open' do |c|
119
120
  c.flag 'channel', desc: 'Private channel to open.'
120
121
  c.action do |_global_options, options, _args|
@@ -122,8 +123,8 @@ command 'groups' do |g|
122
123
  end
123
124
  end
124
125
 
125
- g.desc 'This method renames a private channel.'
126
- g.long_desc %( This method renames a private channel. )
126
+ g.desc 'Renames a private channel.'
127
+ g.long_desc %( Renames a private channel. )
127
128
  g.command 'rename' do |c|
128
129
  c.flag 'channel', desc: 'Private channel to rename.'
129
130
  c.flag 'name', desc: 'New name for private channel.'
@@ -133,8 +134,8 @@ command 'groups' do |g|
133
134
  end
134
135
  end
135
136
 
136
- g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
137
- g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
137
+ g.desc 'Retrieve a thread of messages posted to a private channel'
138
+ g.long_desc %( Retrieve a thread of messages posted to a private channel )
138
139
  g.command 'replies' do |c|
139
140
  c.flag 'channel', desc: 'Private channel to fetch thread from.'
140
141
  c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
@@ -143,8 +144,8 @@ command 'groups' do |g|
143
144
  end
144
145
  end
145
146
 
146
- g.desc 'This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.'
147
- g.long_desc %( This method is used to change the purpose of a private channel. The calling user must be a member of the private channel. )
147
+ g.desc 'Sets the purpose for a private channel.'
148
+ g.long_desc %( Sets the purpose for a private channel. )
148
149
  g.command 'setPurpose' do |c|
149
150
  c.flag 'channel', desc: 'Private channel to set the purpose of.'
150
151
  c.flag 'purpose', desc: 'The new purpose.'
@@ -153,8 +154,8 @@ command 'groups' do |g|
153
154
  end
154
155
  end
155
156
 
156
- g.desc 'This method is used to change the topic of a private channel. The calling user must be a member of the private channel.'
157
- g.long_desc %( This method is used to change the topic of a private channel. The calling user must be a member of the private channel. )
157
+ g.desc 'Sets the topic for a private channel.'
158
+ g.long_desc %( Sets the topic for a private channel. )
158
159
  g.command 'setTopic' do |c|
159
160
  c.flag 'channel', desc: 'Private channel to set the topic of.'
160
161
  c.flag 'topic', desc: 'The new topic.'
@@ -163,8 +164,8 @@ command 'groups' do |g|
163
164
  end
164
165
  end
165
166
 
166
- g.desc 'This method unarchives a private channel.'
167
- g.long_desc %( This method unarchives a private channel. )
167
+ g.desc 'Unarchives a private channel.'
168
+ g.long_desc %( Unarchives a private channel. )
168
169
  g.command 'unarchive' do |c|
169
170
  c.flag 'channel', desc: 'Private channel to unarchive.'
170
171
  c.action do |_global_options, options, _args|
data/bin/commands/im.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 'Im methods.'
4
5
  command 'im' do |g|
5
- g.desc 'This method closes a direct message channel.'
6
- g.long_desc %( This method closes a direct message channel. )
6
+ g.desc 'Close a direct message channel.'
7
+ g.long_desc %( Close a direct message channel. )
7
8
  g.command 'close' do |c|
8
9
  c.flag 'channel', desc: 'Direct message channel to close.'
9
10
  c.action do |_global_options, options, _args|
@@ -11,8 +12,8 @@ command 'im' do |g|
11
12
  end
12
13
  end
13
14
 
14
- g.desc 'This method returns a portion of messages/events from the specified direct message channel.'
15
- g.long_desc %( This method returns a portion of messages/events from the specified direct message channel. To read the entire history for a direct message channel, 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 direct message channel.'
16
+ g.long_desc %( Fetches history of messages and events from direct message channel. )
16
17
  g.command 'history' do |c|
17
18
  c.flag 'channel', desc: 'Direct message channel to fetch history for.'
18
19
  c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
@@ -24,8 +25,8 @@ command 'im' 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 direct message channels for the calling user.'
29
+ g.long_desc %( Lists direct message channels for the calling user. )
29
30
  g.command 'list' do |c|
30
31
  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."
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 users list hasn't been reached."
@@ -34,8 +35,8 @@ command 'im' do |g|
34
35
  end
35
36
  end
36
37
 
37
- g.desc 'This method moves the read cursor in a direct message channel.'
38
- g.long_desc %( This method moves the read cursor in a direct message channel. )
38
+ g.desc 'Sets the read cursor in a direct message channel.'
39
+ g.long_desc %( Sets the read cursor in a direct message channel. )
39
40
  g.command 'mark' do |c|
40
41
  c.flag 'channel', desc: 'Direct message channel to set reading cursor in.'
41
42
  c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -44,8 +45,8 @@ command 'im' do |g|
44
45
  end
45
46
  end
46
47
 
47
- g.desc 'This method opens a direct message channel with another member of your Slack team.'
48
- g.long_desc %( This method opens a direct message channel with another member of your Slack team. )
48
+ g.desc 'Opens a direct message channel.'
49
+ g.long_desc %( Opens a direct message channel. )
49
50
  g.command 'open' do |c|
50
51
  c.flag 'user', desc: 'User to open a direct message channel with.'
51
52
  c.flag 'include_locale', desc: 'Set this to true to receive the locale for this im. Defaults to false.'
@@ -55,8 +56,8 @@ command 'im' do |g|
55
56
  end
56
57
  end
57
58
 
58
- g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
59
- g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
59
+ g.desc 'Retrieve a thread of messages posted to a direct message conversation'
60
+ g.long_desc %( Retrieve a thread of messages posted to a direct message conversation )
60
61
  g.command 'replies' do |c|
61
62
  c.flag 'channel', desc: 'Direct message channel to fetch thread from.'
62
63
  c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."