slack-ruby-client 0.15.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (264) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +6 -1
  3. data/.rubocop_todo.yml +75 -43
  4. data/.travis.yml +2 -4
  5. data/CHANGELOG.md +32 -0
  6. data/CONTRIBUTING.md +6 -13
  7. data/LICENSE.md +1 -1
  8. data/README.md +19 -36
  9. data/RELEASING.md +1 -1
  10. data/UPGRADING.md +56 -2
  11. data/bin/commands/admin_analytics.rb +16 -0
  12. data/bin/commands/admin_apps.rb +26 -2
  13. data/bin/commands/admin_apps_requests.rb +1 -0
  14. data/bin/commands/admin_auth_policy.rb +39 -0
  15. data/bin/commands/admin_barriers.rb +47 -0
  16. data/bin/commands/admin_conversations.rb +154 -2
  17. data/bin/commands/admin_conversations_ekm.rb +17 -0
  18. data/bin/commands/admin_conversations_restrictAccess.rb +3 -3
  19. data/bin/commands/admin_conversations_whitelist.rb +1 -1
  20. data/bin/commands/admin_emoji.rb +1 -1
  21. data/bin/commands/admin_teams.rb +1 -1
  22. data/bin/commands/admin_usergroups.rb +2 -2
  23. data/bin/commands/admin_users.rb +3 -2
  24. data/bin/commands/admin_users_session.rb +62 -0
  25. data/bin/commands/api.rb +0 -1
  26. data/bin/commands/apps_connections.rb +13 -0
  27. data/bin/commands/apps_event_authorizations.rb +16 -0
  28. data/bin/commands/apps_manifest.rb +51 -0
  29. data/bin/commands/auth_teams.rb +16 -0
  30. data/bin/commands/bots.rb +1 -0
  31. data/bin/commands/channels.rb +1 -155
  32. data/bin/commands/chat.rb +12 -7
  33. data/bin/commands/chat_scheduledMessages.rb +1 -0
  34. data/bin/commands/conversations.rb +71 -2
  35. data/bin/commands/dnd.rb +2 -0
  36. data/bin/commands/files.rb +6 -4
  37. data/bin/commands/files_remote.rb +2 -2
  38. data/bin/commands/groups.rb +1 -162
  39. data/bin/commands/im.rb +1 -63
  40. data/bin/commands/migration.rb +1 -0
  41. data/bin/commands/mpim.rb +1 -61
  42. data/bin/commands/oauth.rb +0 -13
  43. data/bin/commands/oauth_v2.rb +13 -1
  44. data/bin/commands/openid_connect.rb +27 -0
  45. data/bin/commands/pins.rb +2 -4
  46. data/bin/commands/reactions.rb +1 -0
  47. data/bin/commands/reminders.rb +6 -0
  48. data/bin/commands/rtm.rb +2 -2
  49. data/bin/commands/search.rb +4 -0
  50. data/bin/commands/stars.rb +7 -6
  51. data/bin/commands/team.rb +3 -0
  52. data/bin/commands/team_billing.rb +13 -0
  53. data/bin/commands/team_preferences.rb +13 -0
  54. data/bin/commands/tooling_tokens.rb +14 -0
  55. data/bin/commands/usergroups.rb +5 -0
  56. data/bin/commands/usergroups_users.rb +2 -0
  57. data/bin/commands/users.rb +4 -2
  58. data/bin/commands/users_profile.rb +5 -5
  59. data/bin/commands/views.rb +2 -2
  60. data/bin/commands/workflows.rb +38 -0
  61. data/bin/commands.rb +13 -9
  62. data/lib/slack/config.rb +1 -2
  63. data/lib/slack/events/request.rb +10 -4
  64. data/lib/slack/real_time/client.rb +6 -6
  65. data/lib/slack/real_time/concurrency/async.rb +6 -8
  66. data/lib/slack/real_time/concurrency.rb +0 -2
  67. data/lib/slack/real_time/config.rb +5 -14
  68. data/lib/slack/real_time/socket.rb +1 -2
  69. data/lib/slack/real_time/stores/base.rb +1 -6
  70. data/lib/slack/real_time/stores/starter.rb +6 -3
  71. data/lib/slack/real_time/stores/store.rb +5 -0
  72. data/lib/slack/version.rb +1 -1
  73. data/lib/slack/web/api/endpoints/admin_analytics.rb +28 -0
  74. data/lib/slack/web/api/endpoints/admin_apps.rb +42 -6
  75. data/lib/slack/web/api/endpoints/admin_apps_approved.rb +2 -2
  76. data/lib/slack/web/api/endpoints/admin_apps_requests.rb +4 -2
  77. data/lib/slack/web/api/endpoints/admin_apps_restricted.rb +2 -2
  78. data/lib/slack/web/api/endpoints/admin_auth_policy.rb +72 -0
  79. data/lib/slack/web/api/endpoints/admin_barriers.rb +82 -0
  80. data/lib/slack/web/api/endpoints/admin_conversations.rb +233 -3
  81. data/lib/slack/web/api/endpoints/admin_conversations_ekm.rb +35 -0
  82. data/lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb +3 -3
  83. data/lib/slack/web/api/endpoints/admin_conversations_whitelist.rb +3 -3
  84. data/lib/slack/web/api/endpoints/admin_emoji.rb +10 -10
  85. data/lib/slack/web/api/endpoints/admin_inviteRequests.rb +7 -7
  86. data/lib/slack/web/api/endpoints/admin_inviteRequests_approved.rb +3 -3
  87. data/lib/slack/web/api/endpoints/admin_inviteRequests_denied.rb +2 -2
  88. data/lib/slack/web/api/endpoints/admin_teams.rb +7 -7
  89. data/lib/slack/web/api/endpoints/admin_teams_admins.rb +2 -2
  90. data/lib/slack/web/api/endpoints/admin_teams_owners.rb +2 -2
  91. data/lib/slack/web/api/endpoints/admin_teams_settings.rb +5 -5
  92. data/lib/slack/web/api/endpoints/admin_usergroups.rb +11 -11
  93. data/lib/slack/web/api/endpoints/admin_users.rb +23 -23
  94. data/lib/slack/web/api/endpoints/admin_users_session.rb +97 -3
  95. data/lib/slack/web/api/endpoints/api.rb +1 -3
  96. data/lib/slack/web/api/endpoints/apps.rb +2 -2
  97. data/lib/slack/web/api/endpoints/apps_connections.rb +21 -0
  98. data/lib/slack/web/api/endpoints/apps_event_authorizations.rb +34 -0
  99. data/lib/slack/web/api/endpoints/apps_manifest.rb +75 -0
  100. data/lib/slack/web/api/endpoints/auth.rb +1 -1
  101. data/lib/slack/web/api/endpoints/auth_teams.rb +33 -0
  102. data/lib/slack/web/api/endpoints/bots.rb +3 -1
  103. data/lib/slack/web/api/endpoints/calls.rb +15 -15
  104. data/lib/slack/web/api/endpoints/calls_participants.rb +4 -4
  105. data/lib/slack/web/api/endpoints/channels.rb +0 -259
  106. data/lib/slack/web/api/endpoints/chat.rb +65 -55
  107. data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +4 -2
  108. data/lib/slack/web/api/endpoints/conversations.rb +134 -24
  109. data/lib/slack/web/api/endpoints/dialog.rb +2 -2
  110. data/lib/slack/web/api/endpoints/dnd.rb +6 -3
  111. data/lib/slack/web/api/endpoints/files.rb +19 -15
  112. data/lib/slack/web/api/endpoints/files_comments.rb +1 -1
  113. data/lib/slack/web/api/endpoints/files_remote.rb +22 -22
  114. data/lib/slack/web/api/endpoints/groups.rb +0 -269
  115. data/lib/slack/web/api/endpoints/im.rb +0 -107
  116. data/lib/slack/web/api/endpoints/migration.rb +4 -2
  117. data/lib/slack/web/api/endpoints/mpim.rb +0 -102
  118. data/lib/slack/web/api/endpoints/oauth.rb +5 -27
  119. data/lib/slack/web/api/endpoints/oauth_v2.rb +24 -6
  120. data/lib/slack/web/api/endpoints/openid_connect.rb +42 -0
  121. data/lib/slack/web/api/endpoints/pins.rb +4 -9
  122. data/lib/slack/web/api/endpoints/reactions.rb +13 -11
  123. data/lib/slack/web/api/endpoints/reminders.rb +17 -5
  124. data/lib/slack/web/api/endpoints/rtm.rb +10 -10
  125. data/lib/slack/web/api/endpoints/search.rb +27 -13
  126. data/lib/slack/web/api/endpoints/stars.rb +11 -9
  127. data/lib/slack/web/api/endpoints/team.rb +11 -5
  128. data/lib/slack/web/api/endpoints/team_billing.rb +21 -0
  129. data/lib/slack/web/api/endpoints/team_preferences.rb +21 -0
  130. data/lib/slack/web/api/endpoints/team_profile.rb +1 -1
  131. data/lib/slack/web/api/endpoints/tooling_tokens.rb +24 -0
  132. data/lib/slack/web/api/endpoints/usergroups.rb +26 -16
  133. data/lib/slack/web/api/endpoints/usergroups_users.rb +9 -5
  134. data/lib/slack/web/api/endpoints/users.rb +20 -18
  135. data/lib/slack/web/api/endpoints/users_profile.rb +7 -7
  136. data/lib/slack/web/api/endpoints/views.rb +13 -13
  137. data/lib/slack/web/api/endpoints/workflows.rb +61 -0
  138. data/lib/slack/web/api/endpoints.rb +26 -20
  139. data/lib/slack/web/api/errors/server_error.rb +37 -0
  140. data/lib/slack/web/api/errors/too_many_requests_error.rb +1 -4
  141. data/lib/slack/web/api/errors.rb +394 -10
  142. data/lib/slack/web/api/mixins/conversations.id.rb +1 -3
  143. data/lib/slack/web/api/mixins/ids.id.rb +2 -2
  144. data/lib/slack/web/api/mixins/users.id.rb +1 -3
  145. data/lib/slack/web/api/mixins.rb +0 -2
  146. data/lib/slack/web/api/patches/chat.1.patch +6 -8
  147. data/lib/slack/web/api/templates/endpoints.erb +1 -2
  148. data/lib/slack/web/api/templates/method_spec.erb +1 -1
  149. data/lib/slack/web/config.rb +2 -0
  150. data/lib/slack/web/faraday/connection.rb +2 -2
  151. data/lib/slack/web/faraday/request.rb +2 -1
  152. data/lib/slack/web/faraday/response/raise_error.rb +12 -1
  153. data/lib/slack/web/faraday/response/wrap_error.rb +24 -0
  154. data/lib/slack/web/pagination/cursor.rb +1 -5
  155. data/lib/slack-ruby-client.rb +2 -0
  156. data/lib/tasks/web.rake +11 -3
  157. data/slack-ruby-client.gemspec +2 -3
  158. data/spec/fixtures/slack/web/429_error.yml +50 -54
  159. data/spec/fixtures/slack/web/auth_test_error.yml +51 -18
  160. data/spec/fixtures/slack/web/auth_test_success.yml +50 -26
  161. data/spec/fixtures/slack/web/conversations_info.yml +167 -0
  162. data/spec/fixtures/slack/web/conversations_setTopic.yml +84 -0
  163. data/spec/fixtures/slack/web/conversations_setTopic_one_page.yml +172 -0
  164. data/spec/fixtures/slack/web/conversations_setTopic_paginated.yml +253 -0
  165. data/spec/fixtures/slack/web/paginated_users_list.yml +501 -69
  166. data/spec/fixtures/slack/web/rtm_connect.yml +267 -30
  167. data/spec/fixtures/slack/web/rtm_start.yml +771 -60
  168. data/spec/fixtures/slack/web/users_info.yml +153 -69
  169. data/spec/fixtures/slack/web/users_list.yml +102 -41
  170. data/spec/fixtures/slack/web/views_open_error.yml +49 -42
  171. data/spec/slack/events/request_spec.rb +13 -8
  172. data/spec/slack/real_time/client_spec.rb +35 -22
  173. data/spec/slack/real_time/concurrency/with_concurrency_spec.rb +10 -0
  174. data/spec/slack/real_time/concurrency/without_concurrency_spec.rb +10 -0
  175. data/spec/slack/real_time/event_handlers/bot_spec.rb +1 -1
  176. data/spec/slack/real_time/event_handlers/channel_spec.rb +1 -1
  177. data/spec/slack/real_time/event_handlers/im_spec.rb +5 -5
  178. data/spec/slack/real_time/event_handlers/user_spec.rb +2 -2
  179. data/spec/slack/real_time/rtm_connect_spec.rb +1 -1
  180. data/spec/slack/real_time/rtm_start_spec.rb +1 -1
  181. data/spec/slack/slack_spec.rb +3 -1
  182. data/spec/slack/web/api/endpoints/admin_analytics_spec.rb +13 -0
  183. data/spec/slack/web/api/endpoints/admin_apps_spec.rb +10 -0
  184. data/spec/slack/web/api/endpoints/admin_auth_policy_spec.rb +35 -0
  185. data/spec/slack/web/api/endpoints/admin_barriers_spec.rb +38 -0
  186. data/spec/slack/web/api/endpoints/{apps_permissions_scopes_spec.rb → admin_conversations_ekm_spec.rb} +1 -1
  187. data/spec/slack/web/api/endpoints/admin_conversations_restrictAccess_spec.rb +5 -5
  188. data/spec/slack/web/api/endpoints/admin_conversations_spec.rb +85 -0
  189. data/spec/slack/web/api/endpoints/admin_emoji_spec.rb +6 -6
  190. data/spec/slack/web/api/endpoints/admin_teams_settings_spec.rb +10 -10
  191. data/spec/slack/web/api/endpoints/admin_teams_spec.rb +2 -2
  192. data/spec/slack/web/api/endpoints/admin_usergroups_spec.rb +6 -6
  193. data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +28 -0
  194. data/spec/slack/web/api/endpoints/admin_users_spec.rb +15 -23
  195. data/spec/slack/web/api/endpoints/{apps_permissions_resources_spec.rb → apps_connections_spec.rb} +1 -1
  196. data/spec/slack/web/api/endpoints/apps_event_authorizations_spec.rb +13 -0
  197. data/spec/slack/web/api/endpoints/apps_manifest_spec.rb +36 -0
  198. data/spec/slack/web/api/endpoints/apps_spec.rb +2 -2
  199. data/spec/slack/web/api/endpoints/auth_teams_spec.rb +8 -0
  200. data/spec/slack/web/api/endpoints/calls_participants_spec.rb +4 -4
  201. data/spec/slack/web/api/endpoints/calls_spec.rb +2 -2
  202. data/spec/slack/web/api/endpoints/custom_specs/auth_spec.rb +4 -6
  203. data/spec/slack/web/api/endpoints/custom_specs/conversations_spec.rb +13 -0
  204. data/spec/slack/web/api/endpoints/custom_specs/users_spec.rb +2 -2
  205. data/spec/slack/web/api/endpoints/dnd_spec.rb +0 -5
  206. data/spec/slack/web/api/endpoints/files_comments_spec.rb +2 -2
  207. data/spec/slack/web/api/endpoints/files_remote_spec.rb +3 -3
  208. data/spec/slack/web/api/endpoints/files_spec.rb +4 -4
  209. data/spec/slack/web/api/endpoints/oauth_spec.rb +0 -11
  210. data/spec/slack/web/api/endpoints/oauth_v2_spec.rb +6 -3
  211. data/spec/slack/web/api/endpoints/openid_connect_spec.rb +8 -0
  212. data/spec/slack/web/api/endpoints/pins_spec.rb +1 -4
  213. data/spec/slack/web/api/endpoints/reactions_spec.rb +3 -3
  214. data/spec/slack/web/api/endpoints/reminders_spec.rb +2 -2
  215. data/spec/slack/web/api/endpoints/team_billing_spec.rb +8 -0
  216. data/spec/slack/web/api/endpoints/team_preferences_spec.rb +8 -0
  217. data/spec/slack/web/api/endpoints/tooling_tokens_spec.rb +13 -0
  218. data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +2 -2
  219. data/spec/slack/web/api/endpoints/workflows_spec.rb +26 -0
  220. data/spec/slack/web/api/error_spec.rb +5 -7
  221. data/spec/slack/web/api/errors/slack_error_spec.rb +21 -26
  222. data/spec/slack/web/api/mixins/conversations_list_spec.rb +21 -0
  223. data/spec/slack/web/api/mixins/conversations_spec.rb +11 -9
  224. data/spec/slack/web/api/mixins/users_spec.rb +1 -1
  225. data/spec/slack/web/api/pagination/cursor_spec.rb +1 -3
  226. data/spec/slack/web/client_spec.rb +112 -16
  227. data/spec/slack/web/faraday/request_spec.rb +80 -0
  228. data/spec/slack/web/faraday/response/raise_error_spec.rb +8 -6
  229. data/spec/spec_helper.rb +1 -1
  230. data/spec/support/real_time/connected_client.rb +1 -7
  231. data/spec/support/vcr.rb +36 -1
  232. metadata +58 -155
  233. data/examples/hi_real_time/Gemfile +0 -6
  234. data/examples/hi_real_time/hi.gif +0 -0
  235. data/examples/hi_real_time/hi.rb +0 -41
  236. data/examples/hi_real_time_async_celluloid/Gemfile +0 -7
  237. data/examples/hi_real_time_async_celluloid/Procfile +0 -2
  238. data/examples/hi_real_time_async_celluloid/hi.rb +0 -39
  239. data/examples/hi_real_time_async_eventmachine/Gemfile +0 -7
  240. data/examples/hi_real_time_async_eventmachine/Procfile +0 -2
  241. data/examples/hi_real_time_async_eventmachine/hi.rb +0 -39
  242. data/lib/slack/real_time/concurrency/celluloid.rb +0 -142
  243. data/lib/slack/real_time/concurrency/eventmachine.rb +0 -85
  244. data/lib/slack/web/api/mixins/channels.id.json +0 -20
  245. data/lib/slack/web/api/mixins/channels.id.rb +0 -27
  246. data/lib/slack/web/api/mixins/groups.id.json +0 -20
  247. data/lib/slack/web/api/mixins/groups.id.rb +0 -27
  248. data/spec/fixtures/slack/web/503_error.yml +0 -14
  249. data/spec/fixtures/slack/web/channels_info.yml +0 -139
  250. data/spec/fixtures/slack/web/groups_info.yml +0 -43
  251. data/spec/slack/real_time/concurrency/celluloid_spec.rb +0 -116
  252. data/spec/slack/real_time/concurrency/eventmachine_spec.rb +0 -57
  253. data/spec/slack/web/api/endpoints/admin_conversations_whitelist_spec.rb +0 -32
  254. data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +0 -16
  255. data/spec/slack/web/api/endpoints/apps_permissions_users_spec.rb +0 -19
  256. data/spec/slack/web/api/endpoints/conversations_spec.rb +0 -101
  257. data/spec/slack/web/api/endpoints/custom_specs/channels_spec.rb +0 -13
  258. data/spec/slack/web/api/endpoints/custom_specs/groups_spec.rb +0 -13
  259. data/spec/slack/web/api/endpoints/im_spec.rb +0 -39
  260. data/spec/slack/web/api/endpoints/mpim_spec.rb +0 -39
  261. data/spec/slack/web/api/endpoints/views_spec.rb +0 -29
  262. data/spec/slack/web/api/errors/service_unavailable_spec.rb +0 -17
  263. data/spec/slack/web/api/mixins/channels_spec.rb +0 -43
  264. data/spec/slack/web/api/mixins/groups_spec.rb +0 -43
data/bin/commands/im.rb CHANGED
@@ -1,68 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
  # This file was auto-generated by lib/tasks/web.rake
3
3
 
4
- desc 'Im methods.'
4
+ desc 'Get info on your direct messages.'
5
5
  command 'im' do |g|
6
- g.desc 'Close a direct message channel.'
7
- g.long_desc %( Close a direct message channel. )
8
- g.command 'close' do |c|
9
- c.flag 'channel', desc: 'Direct message channel to close.'
10
- c.action do |_global_options, options, _args|
11
- puts JSON.dump($client.im_close(options))
12
- end
13
- end
14
-
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. )
17
- g.command 'history' do |c|
18
- c.flag 'channel', desc: 'Direct message channel to fetch history for.'
19
- c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
20
- c.flag 'latest', desc: 'End of time range of messages to include in results.'
21
- c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
22
- c.flag 'unreads', desc: 'Include unread_count_display in the output?.'
23
- c.action do |_global_options, options, _args|
24
- puts JSON.dump($client.im_history(options))
25
- end
26
- end
27
-
28
- g.desc 'Lists direct message channels for the calling user.'
29
- g.long_desc %( Lists direct message channels for the calling user. )
30
- g.command 'list' do |c|
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."
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."
33
- c.action do |_global_options, options, _args|
34
- puts JSON.dump($client.im_list(options))
35
- end
36
- end
37
-
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. )
40
- g.command 'mark' do |c|
41
- c.flag 'channel', desc: 'Direct message channel to set reading cursor in.'
42
- c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
43
- c.action do |_global_options, options, _args|
44
- puts JSON.dump($client.im_mark(options))
45
- end
46
- end
47
-
48
- g.desc 'Opens a direct message channel.'
49
- g.long_desc %( Opens a direct message channel. )
50
- g.command 'open' do |c|
51
- c.flag 'user', desc: 'User to open a direct message channel with.'
52
- c.flag 'include_locale', desc: 'Set this to true to receive the locale for this im. Defaults to false.'
53
- c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
54
- c.action do |_global_options, options, _args|
55
- puts JSON.dump($client.im_open(options))
56
- end
57
- end
58
-
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 )
61
- g.command 'replies' do |c|
62
- c.flag 'channel', desc: 'Direct message channel to fetch thread from.'
63
- c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
64
- c.action do |_global_options, options, _args|
65
- puts JSON.dump($client.im_replies(options))
66
- end
67
- end
68
6
  end
@@ -7,6 +7,7 @@ command 'migration' do |g|
7
7
  g.long_desc %( For Enterprise Grid workspaces, map local user IDs to global user IDs )
8
8
  g.command 'exchange' do |c|
9
9
  c.flag 'users', desc: 'A comma-separated list of user ids, up to 400 per request.'
10
+ c.flag 'team_id', desc: 'Specify team_id starts with T in case of Org Token.'
10
11
  c.flag 'to_old', desc: 'Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.'
11
12
  c.action do |_global_options, options, _args|
12
13
  puts JSON.dump($client.migration_exchange(options))
data/bin/commands/mpim.rb CHANGED
@@ -1,66 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
  # This file was auto-generated by lib/tasks/web.rake
3
3
 
4
- desc 'Mpim methods.'
4
+ desc 'Get info on your multiparty direct messages.'
5
5
  command 'mpim' do |g|
6
- g.desc 'Closes a multiparty direct message channel.'
7
- g.long_desc %( Closes a multiparty direct message channel. )
8
- g.command 'close' do |c|
9
- c.flag 'channel', desc: 'MPIM to close.'
10
- c.action do |_global_options, options, _args|
11
- puts JSON.dump($client.mpim_close(options))
12
- end
13
- end
14
-
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. )
17
- g.command 'history' do |c|
18
- c.flag 'channel', desc: 'Multiparty direct message to fetch history for.'
19
- c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
20
- c.flag 'latest', desc: 'End of time range of messages to include in results.'
21
- c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
22
- c.flag 'unreads', desc: 'Include unread_count_display in the output?.'
23
- c.action do |_global_options, options, _args|
24
- puts JSON.dump($client.mpim_history(options))
25
- end
26
- end
27
-
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. )
30
- g.command 'list' do |c|
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."
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."
33
- c.action do |_global_options, options, _args|
34
- puts JSON.dump($client.mpim_list(options))
35
- end
36
- end
37
-
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. )
40
- g.command 'mark' do |c|
41
- c.flag 'channel', desc: 'multiparty direct message channel to set reading cursor in.'
42
- c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
43
- c.action do |_global_options, options, _args|
44
- puts JSON.dump($client.mpim_mark(options))
45
- end
46
- end
47
-
48
- g.desc 'This method opens a multiparty direct message.'
49
- g.long_desc %( This method opens a multiparty direct message. )
50
- g.command 'open' do |c|
51
- c.flag 'users', desc: 'Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.'
52
- c.action do |_global_options, options, _args|
53
- puts JSON.dump($client.mpim_open(options))
54
- end
55
- end
56
-
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. )
59
- g.command 'replies' do |c|
60
- c.flag 'channel', desc: 'Multiparty direct message channel to fetch thread from.'
61
- c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
62
- c.action do |_global_options, options, _args|
63
- puts JSON.dump($client.mpim_replies(options))
64
- end
65
- end
66
6
  end
@@ -15,17 +15,4 @@ command 'oauth' do |g|
15
15
  puts JSON.dump($client.oauth_access(options))
16
16
  end
17
17
  end
18
-
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. )
21
- g.command 'token' do |c|
22
- c.flag 'client_id', desc: 'Issued when you created your application.'
23
- c.flag 'client_secret', desc: 'Issued when you created your application.'
24
- c.flag 'code', desc: 'The code param returned via the OAuth callback.'
25
- c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
26
- c.flag 'single_channel', desc: 'Request the user to add your app only to a single channel.'
27
- c.action do |_global_options, options, _args|
28
- puts JSON.dump($client.oauth_token(options))
29
- end
30
- end
31
18
  end
@@ -6,12 +6,24 @@ command 'oauth_v2' do |g|
6
6
  g.desc 'Exchanges a temporary OAuth verifier code for an access token.'
7
7
  g.long_desc %( Exchanges a temporary OAuth verifier code for an access token. )
8
8
  g.command 'access' do |c|
9
- c.flag 'code', desc: 'The code param returned via the OAuth callback.'
10
9
  c.flag 'client_id', desc: 'Issued when you created your application.'
11
10
  c.flag 'client_secret', desc: 'Issued when you created your application.'
11
+ c.flag 'code', desc: 'The code param returned via the OAuth callback.'
12
+ c.flag 'grant_type', desc: 'The grant_type param as described in the OAuth spec.'
12
13
  c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
14
+ c.flag 'refresh_token', desc: 'The refresh_token param as described in the OAuth spec.'
13
15
  c.action do |_global_options, options, _args|
14
16
  puts JSON.dump($client.oauth_v2_access(options))
15
17
  end
16
18
  end
19
+
20
+ g.desc 'Exchanges a legacy access token for a new expiring access token and refresh token'
21
+ g.long_desc %( Exchanges a legacy access token for a new expiring access token and refresh token )
22
+ g.command 'exchange' do |c|
23
+ c.flag 'client_id', desc: 'Issued when you created your application.'
24
+ c.flag 'client_secret', desc: 'Issued when you created your application.'
25
+ c.action do |_global_options, options, _args|
26
+ puts JSON.dump($client.oauth_v2_exchange(options))
27
+ end
28
+ end
17
29
  end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'OpenidConnect methods.'
5
+ command 'openid_connect' do |g|
6
+ g.desc 'Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack.'
7
+ g.long_desc %( Exchanges a temporary OAuth verifier code for an access token for Sign in with Slack. )
8
+ g.command 'token' do |c|
9
+ c.flag 'client_id', desc: 'Issued when you created your application.'
10
+ c.flag 'client_secret', desc: 'Issued when you created your application.'
11
+ c.flag 'code', desc: 'The code param returned via the OAuth callback.'
12
+ c.flag 'grant_type', desc: 'The grant_type param as described in the OAuth spec.'
13
+ c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
14
+ c.flag 'refresh_token', desc: 'The refresh_token param as described in the OAuth spec.'
15
+ c.action do |_global_options, options, _args|
16
+ puts JSON.dump($client.openid_connect_token(options))
17
+ end
18
+ end
19
+
20
+ g.desc 'Get the identity of a user who has authorized Sign in with Slack.'
21
+ g.long_desc %( Get the identity of a user who has authorized Sign in with Slack. )
22
+ g.command 'userInfo' do |c|
23
+ c.action do |_global_options, options, _args|
24
+ puts JSON.dump($client.openid_connect_userInfo(options))
25
+ end
26
+ end
27
+ end
data/bin/commands/pins.rb CHANGED
@@ -6,8 +6,8 @@ command 'pins' do |g|
6
6
  g.desc 'Pins an item to a channel.'
7
7
  g.long_desc %( Pins an item to a channel. )
8
8
  g.command 'add' do |c|
9
- c.flag 'channel', desc: 'Channel to pin the item in.'
10
- c.flag 'timestamp', desc: 'Timestamp of the message to pin.'
9
+ c.flag 'channel', desc: 'Channel to pin the messsage to. You must also include a timestamp when pinning messages.'
10
+ c.flag 'timestamp', desc: 'Timestamp of the message to pin. You must also include the channel.'
11
11
  c.action do |_global_options, options, _args|
12
12
  puts JSON.dump($client.pins_add(options))
13
13
  end
@@ -26,8 +26,6 @@ command 'pins' do |g|
26
26
  g.long_desc %( Un-pins an item from a channel. )
27
27
  g.command 'remove' do |c|
28
28
  c.flag 'channel', desc: 'Channel where the item is pinned to.'
29
- c.flag 'file', desc: 'File to un-pin.'
30
- c.flag 'file_comment', desc: 'File comment to un-pin.'
31
29
  c.flag 'timestamp', desc: 'Timestamp of the message to un-pin.'
32
30
  c.action do |_global_options, options, _args|
33
31
  puts JSON.dump($client.pins_remove(options))
@@ -33,6 +33,7 @@ command 'reactions' do |g|
33
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."
34
34
  c.flag 'full', desc: 'If true always return the complete reaction list.'
35
35
  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."
36
+ c.flag 'team_id', desc: 'encoded team id to list reactions in, required if org token is used.'
36
37
  c.flag 'user', desc: 'Show reactions made by this user. Defaults to the authed user.'
37
38
  c.action do |_global_options, options, _args|
38
39
  puts JSON.dump($client.reactions_list(options))
@@ -8,6 +8,8 @@ command 'reminders' do |g|
8
8
  g.command 'add' do |c|
9
9
  c.flag 'text', desc: 'The content of the reminder.'
10
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").'
11
+ c.flag 'recurrence', desc: 'Specify the repeating behavior of a reminder. Available options: daily, weekly, monthly, or yearly. If weekly, may further specify the days of the week.'
12
+ c.flag 'team_id', desc: 'Encoded team id, required if org token is used.'
11
13
  c.flag 'user', desc: 'The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.'
12
14
  c.action do |_global_options, options, _args|
13
15
  puts JSON.dump($client.reminders_add(options))
@@ -18,6 +20,7 @@ command 'reminders' do |g|
18
20
  g.long_desc %( Marks a reminder as complete. )
19
21
  g.command 'complete' do |c|
20
22
  c.flag 'reminder', desc: 'The ID of the reminder to be marked as complete.'
23
+ c.flag 'team_id', desc: 'Encoded team id, required if org token is used.'
21
24
  c.action do |_global_options, options, _args|
22
25
  puts JSON.dump($client.reminders_complete(options))
23
26
  end
@@ -27,6 +30,7 @@ command 'reminders' do |g|
27
30
  g.long_desc %( Deletes a reminder. )
28
31
  g.command 'delete' do |c|
29
32
  c.flag 'reminder', desc: 'The ID of the reminder.'
33
+ c.flag 'team_id', desc: 'Encoded team id, required if org token is used.'
30
34
  c.action do |_global_options, options, _args|
31
35
  puts JSON.dump($client.reminders_delete(options))
32
36
  end
@@ -36,6 +40,7 @@ command 'reminders' do |g|
36
40
  g.long_desc %( Gets information about a reminder. )
37
41
  g.command 'info' do |c|
38
42
  c.flag 'reminder', desc: 'The ID of the reminder.'
43
+ c.flag 'team_id', desc: 'Encoded team id, required if org token is passed.'
39
44
  c.action do |_global_options, options, _args|
40
45
  puts JSON.dump($client.reminders_info(options))
41
46
  end
@@ -44,6 +49,7 @@ command 'reminders' do |g|
44
49
  g.desc 'Lists all reminders created by or for a given user.'
45
50
  g.long_desc %( Lists all reminders created by or for a given user. )
46
51
  g.command 'list' do |c|
52
+ c.flag 'team_id', desc: 'Encoded team id, required if org token is passed.'
47
53
  c.action do |_global_options, options, _args|
48
54
  puts JSON.dump($client.reminders_list(options))
49
55
  end
data/bin/commands/rtm.rb CHANGED
@@ -13,8 +13,8 @@ command 'rtm' do |g|
13
13
  end
14
14
  end
15
15
 
16
- g.desc 'Starts a Real Time Messaging session.'
17
- g.long_desc %( Starts a Real Time Messaging session. )
16
+ g.desc 'Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.'
17
+ g.long_desc %( Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead. )
18
18
  g.command 'start' do |c|
19
19
  c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
20
20
  c.flag 'include_locale', desc: 'Set this to true to receive the locale for users and channels. Defaults to false.'
@@ -10,6 +10,7 @@ command 'search' do |g|
10
10
  c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
11
11
  c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
12
12
  c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
13
+ c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
13
14
  c.action do |_global_options, options, _args|
14
15
  puts JSON.dump($client.search_all(options))
15
16
  end
@@ -22,6 +23,7 @@ command 'search' do |g|
22
23
  c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
23
24
  c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
24
25
  c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
26
+ c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
25
27
  c.action do |_global_options, options, _args|
26
28
  puts JSON.dump($client.search_files(options))
27
29
  end
@@ -31,9 +33,11 @@ command 'search' do |g|
31
33
  g.long_desc %( Searches for messages matching a query. )
32
34
  g.command 'messages' do |c|
33
35
  c.flag 'query', desc: 'Search query.'
36
+ c.flag 'cursor', desc: "Use this when getting results with cursormark pagination. For first call send * for subsequent calls, send the value of next_cursor returned in the previous call's results."
34
37
  c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
35
38
  c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
36
39
  c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
40
+ c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
37
41
  c.action do |_global_options, options, _args|
38
42
  puts JSON.dump($client.search_messages(options))
39
43
  end
@@ -3,8 +3,8 @@
3
3
 
4
4
  desc 'Stars methods.'
5
5
  command 'stars' do |g|
6
- g.desc 'Adds a star to an item.'
7
- g.long_desc %( Adds a star to an item. )
6
+ g.desc 'Save an item for later. Formerly known as _adding a star_.'
7
+ g.long_desc %( Save an item for later. Formerly known as _adding a star_. )
8
8
  g.command 'add' do |c|
9
9
  c.flag 'channel', desc: 'Channel to add star to, or channel where the message to add star to was posted (used with timestamp).'
10
10
  c.flag 'file', desc: 'File to add star to.'
@@ -15,18 +15,19 @@ command 'stars' do |g|
15
15
  end
16
16
  end
17
17
 
18
- g.desc 'Lists stars for a user.'
19
- g.long_desc %( Lists stars for a user. )
18
+ g.desc "List a user's saved items, formerly known as _stars_."
19
+ g.long_desc %( List a user's saved items, formerly known as _stars_. )
20
20
  g.command 'list' do |c|
21
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."
22
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."
23
+ c.flag 'team_id', desc: 'encoded team id to list stars in, required if org token is used.'
23
24
  c.action do |_global_options, options, _args|
24
25
  puts JSON.dump($client.stars_list(options))
25
26
  end
26
27
  end
27
28
 
28
- g.desc 'Removes a star from an item.'
29
- g.long_desc %( Removes a star from an item. )
29
+ g.desc 'Removes a saved item (star) from an item.'
30
+ g.long_desc %( Removes a saved item (star) from an item. )
30
31
  g.command 'remove' do |c|
31
32
  c.flag 'channel', desc: 'Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).'
32
33
  c.flag 'file', desc: 'File to remove star from.'
data/bin/commands/team.rb CHANGED
@@ -7,6 +7,7 @@ command 'team' do |g|
7
7
  g.long_desc %( Gets the access logs for the current team. )
8
8
  g.command 'accessLogs' do |c|
9
9
  c.flag 'before', desc: 'End of time range of logs to include in results (inclusive).'
10
+ c.flag 'team_id', desc: 'encoded team id to get logs from, required if org token is used.'
10
11
  c.action do |_global_options, options, _args|
11
12
  puts JSON.dump($client.team_accessLogs(options))
12
13
  end
@@ -15,6 +16,7 @@ command 'team' do |g|
15
16
  g.desc 'Gets billable users information for the current team.'
16
17
  g.long_desc %( Gets billable users information for the current team. )
17
18
  g.command 'billableInfo' do |c|
19
+ c.flag 'team_id', desc: 'encoded team id to get the billable information from, required if org token is used.'
18
20
  c.flag 'user', desc: 'A user to retrieve the billable information for. Defaults to all users.'
19
21
  c.action do |_global_options, options, _args|
20
22
  puts JSON.dump($client.team_billableInfo(options))
@@ -36,6 +38,7 @@ command 'team' do |g|
36
38
  c.flag 'app_id', desc: 'Filter logs to this Slack app. Defaults to all logs.'
37
39
  c.flag 'change_type', desc: 'Filter logs with this change type. Defaults to all logs.'
38
40
  c.flag 'service_id', desc: 'Filter logs to this service. Defaults to all logs.'
41
+ c.flag 'team_id', desc: 'encoded team id to get logs from, required if org token is used.'
39
42
  c.flag 'user', desc: "Filter logs generated by this user's actions. Defaults to all logs."
40
43
  c.action do |_global_options, options, _args|
41
44
  puts JSON.dump($client.team_integrationLogs(options))
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'TeamBilling methods.'
5
+ command 'team_billing' do |g|
6
+ g.desc "Reads a workspace's billing plan information."
7
+ g.long_desc %( Reads a workspace's billing plan information. )
8
+ g.command 'info' do |c|
9
+ c.action do |_global_options, options, _args|
10
+ puts JSON.dump($client.team_billing_info(options))
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'TeamPreferences methods.'
5
+ command 'team_preferences' do |g|
6
+ g.desc "Retrieve a list of a workspace's team preferences."
7
+ g.long_desc %( Retrieve a list of a workspace's team preferences. )
8
+ g.command 'list' do |c|
9
+ c.action do |_global_options, options, _args|
10
+ puts JSON.dump($client.team_preferences_list(options))
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'ToolingTokens methods.'
5
+ command 'tooling_tokens' do |g|
6
+ g.desc 'Exchanges a refresh token for a new app configuration token.'
7
+ g.long_desc %( Exchanges a refresh token for a new app configuration token. )
8
+ g.command 'rotate' do |c|
9
+ c.flag 'refresh_token', desc: 'The xoxe refresh token that was issued along with the old app configuration token.'
10
+ c.action do |_global_options, options, _args|
11
+ puts JSON.dump($client.tooling_tokens_rotate(options))
12
+ end
13
+ end
14
+ end
@@ -11,6 +11,7 @@ command 'usergroups' do |g|
11
11
  c.flag 'description', desc: 'A short description of the User Group.'
12
12
  c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
13
13
  c.flag 'include_count', desc: 'Include the number of users in each User Group.'
14
+ c.flag 'team_id', desc: 'Encoded team id where the user group has to be created, required if org token is used.'
14
15
  c.action do |_global_options, options, _args|
15
16
  puts JSON.dump($client.usergroups_create(options))
16
17
  end
@@ -21,6 +22,7 @@ command 'usergroups' do |g|
21
22
  g.command 'disable' do |c|
22
23
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to disable.'
23
24
  c.flag 'include_count', desc: 'Include the number of users in the User Group.'
25
+ c.flag 'team_id', desc: 'Encoded team id where the user group is, required if org token is used.'
24
26
  c.action do |_global_options, options, _args|
25
27
  puts JSON.dump($client.usergroups_disable(options))
26
28
  end
@@ -31,6 +33,7 @@ command 'usergroups' do |g|
31
33
  g.command 'enable' do |c|
32
34
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to enable.'
33
35
  c.flag 'include_count', desc: 'Include the number of users in the User Group.'
36
+ c.flag 'team_id', desc: 'Encoded team id where the user group is, required if org token is used.'
34
37
  c.action do |_global_options, options, _args|
35
38
  puts JSON.dump($client.usergroups_enable(options))
36
39
  end
@@ -42,6 +45,7 @@ command 'usergroups' do |g|
42
45
  c.flag 'include_count', desc: 'Include the number of users in each User Group.'
43
46
  c.flag 'include_disabled', desc: 'Include disabled User Groups.'
44
47
  c.flag 'include_users', desc: 'Include the list of users for each User Group.'
48
+ c.flag 'team_id', desc: 'encoded team id to list user groups in, required if org token is used.'
45
49
  c.action do |_global_options, options, _args|
46
50
  puts JSON.dump($client.usergroups_list(options))
47
51
  end
@@ -56,6 +60,7 @@ command 'usergroups' do |g|
56
60
  c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
57
61
  c.flag 'include_count', desc: 'Include the number of users in the User Group.'
58
62
  c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
63
+ c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
59
64
  c.action do |_global_options, options, _args|
60
65
  puts JSON.dump($client.usergroups_update(options))
61
66
  end
@@ -8,6 +8,7 @@ command 'usergroups_users' do |g|
8
8
  g.command 'list' do |c|
9
9
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
10
10
  c.flag 'include_disabled', desc: 'Allow results that involve disabled User Groups.'
11
+ c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
11
12
  c.action do |_global_options, options, _args|
12
13
  puts JSON.dump($client.usergroups_users_list(options))
13
14
  end
@@ -19,6 +20,7 @@ command 'usergroups_users' do |g|
19
20
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
20
21
  c.flag 'users', desc: 'A comma separated string of encoded user IDs that represent the entire list of users for the User Group.'
21
22
  c.flag 'include_count', desc: 'Include the number of users in the User Group.'
23
+ c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
22
24
  c.action do |_global_options, options, _args|
23
25
  puts JSON.dump($client.usergroups_users_update(options))
24
26
  end
@@ -9,6 +9,7 @@ command 'users' do |g|
9
9
  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."
10
10
  c.flag 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
11
11
  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."
12
+ c.flag 'team_id', desc: 'encoded team id to list conversations in, required if org token is used.'
12
13
  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.'
13
14
  c.flag 'user', desc: "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership."
14
15
  c.action do |_global_options, options, _args|
@@ -65,7 +66,8 @@ command 'users' do |g|
65
66
  g.command 'list' do |c|
66
67
  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."
67
68
  c.flag 'include_locale', desc: 'Set this to true to receive the locale for users. Defaults to false.'
68
- 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."
69
+ 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. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors."
70
+ c.flag 'team_id', desc: 'encoded team id to list users in, required if org token is used.'
69
71
  c.action do |_global_options, options, _args|
70
72
  puts JSON.dump($client.users_list(options))
71
73
  end
@@ -100,10 +102,10 @@ command 'users' do |g|
100
102
  g.desc 'Set the user profile photo'
101
103
  g.long_desc %( Set the user profile photo )
102
104
  g.command 'setPhoto' do |c|
103
- c.flag 'image', desc: 'File contents via multipart/form-data.'
104
105
  c.flag 'crop_w', desc: 'Width/height of crop box (always square).'
105
106
  c.flag 'crop_x', desc: 'X coordinate of top-left corner of crop box.'
106
107
  c.flag 'crop_y', desc: 'Y coordinate of top-left corner of crop box.'
108
+ c.flag 'image', desc: 'File contents via multipart/form-data.'
107
109
  c.action do |_global_options, options, _args|
108
110
  puts JSON.dump($client.users_setPhoto(options))
109
111
  end
@@ -3,18 +3,18 @@
3
3
 
4
4
  desc 'UsersProfile methods.'
5
5
  command 'users_profile' do |g|
6
- g.desc "Retrieves a user's profile information."
7
- g.long_desc %( Retrieves a user's profile information. )
6
+ g.desc "Retrieve a user's profile information, including their custom status."
7
+ g.long_desc %( Retrieve a user's profile information, including their custom status. )
8
8
  g.command 'get' do |c|
9
- c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields.'
9
+ c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.'
10
10
  c.flag 'user', desc: 'User to retrieve profile info for.'
11
11
  c.action do |_global_options, options, _args|
12
12
  puts JSON.dump($client.users_profile_get(options))
13
13
  end
14
14
  end
15
15
 
16
- g.desc 'Set the profile information for a user.'
17
- g.long_desc %( Set the profile information for a user. )
16
+ g.desc "Set a user's profile information, including custom status."
17
+ g.long_desc %( Set a user's profile information, including custom status. )
18
18
  g.command 'set' do |c|
19
19
  c.flag 'name', desc: 'Name of a single key to set. Usable only if profile is not passed.'
20
20
  c.flag 'profile', desc: 'Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.'
@@ -37,10 +37,10 @@ command 'views' do |g|
37
37
  g.desc 'Update an existing view.'
38
38
  g.long_desc %( Update an existing view. )
39
39
  g.command 'update' do |c|
40
- c.flag 'view', desc: 'A view payload This must be a JSON-encoded string.'
40
+ c.flag 'view', desc: 'A view object. This must be a JSON-encoded string.'
41
41
  c.flag 'external_id', desc: 'A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either view_id or external_id is required.'
42
- c.flag 'hash', desc: 'A string that represents view state to protect against possible race conditions.'
43
42
  c.flag 'view_id', desc: 'A unique identifier of the view to be updated. Either view_id or external_id is required.'
43
+ c.flag 'hash', desc: 'A string that represents view state to protect against possible race conditions.'
44
44
  c.action do |_global_options, options, _args|
45
45
  puts JSON.dump($client.views_update(options))
46
46
  end
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'Workflows methods.'
5
+ command 'workflows' do |g|
6
+ g.desc "Indicate that an app's step in a workflow completed execution."
7
+ g.long_desc %( Indicate that an app's step in a workflow completed execution. )
8
+ g.command 'stepCompleted' do |c|
9
+ c.flag 'workflow_step_execute_id', desc: 'Context identifier that maps to the correct workflow step execution.'
10
+ c.flag 'outputs', desc: 'Key-value object of outputs from your step. Keys of this object reflect the configured key properties of your outputs array from your workflow_step object.'
11
+ c.action do |_global_options, options, _args|
12
+ puts JSON.dump($client.workflows_stepCompleted(options))
13
+ end
14
+ end
15
+
16
+ g.desc "Indicate that an app's step in a workflow failed to execute."
17
+ g.long_desc %( Indicate that an app's step in a workflow failed to execute. )
18
+ g.command 'stepFailed' do |c|
19
+ c.flag 'error', desc: 'A JSON-based object with a message property that should contain a human readable error message.'
20
+ c.flag 'workflow_step_execute_id', desc: 'Context identifier that maps to the correct workflow step execution.'
21
+ c.action do |_global_options, options, _args|
22
+ puts JSON.dump($client.workflows_stepFailed(options))
23
+ end
24
+ end
25
+
26
+ g.desc 'Update the configuration for a workflow step.'
27
+ g.long_desc %( Update the configuration for a workflow step. )
28
+ g.command 'updateStep' do |c|
29
+ c.flag 'workflow_step_edit_id', desc: 'A context identifier provided with view_submission payloads used to call back to workflows.updateStep.'
30
+ c.flag 'inputs', desc: 'A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. Please note: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. Read more about variables in workflow steps here.'
31
+ c.flag 'outputs', desc: 'An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.'
32
+ c.flag 'step_image_url', desc: 'An optional field that can be used to override app image that is shown in the Workflow Builder.'
33
+ c.flag 'step_name', desc: 'An optional field that can be used to override the step name that is shown in the Workflow Builder.'
34
+ c.action do |_global_options, options, _args|
35
+ puts JSON.dump($client.workflows_updateStep(options))
36
+ end
37
+ end
38
+ end