slack-ruby-client 0.14.1 → 0.14.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.rubocop_todo.yml +15 -4
  4. data/CHANGELOG.md +7 -0
  5. data/README.md +8 -1
  6. data/Rakefile +1 -1
  7. data/bin/commands.rb +1 -0
  8. data/bin/commands/api.rb +2 -2
  9. data/bin/commands/apps.rb +2 -2
  10. data/bin/commands/apps_permissions.rb +4 -4
  11. data/bin/commands/apps_permissions_resources.rb +2 -2
  12. data/bin/commands/apps_permissions_scopes.rb +2 -2
  13. data/bin/commands/apps_permissions_users.rb +4 -4
  14. data/bin/commands/auth.rb +4 -4
  15. data/bin/commands/bots.rb +2 -2
  16. data/bin/commands/channels.rb +32 -31
  17. data/bin/commands/chat.rb +48 -17
  18. data/bin/commands/chat_scheduledMessages.rb +17 -0
  19. data/bin/commands/conversations.rb +35 -35
  20. data/bin/commands/dialog.rb +2 -2
  21. data/bin/commands/dnd.rb +9 -9
  22. data/bin/commands/emoji.rb +2 -2
  23. data/bin/commands/files.rb +14 -25
  24. data/bin/commands/files_comments.rb +2 -23
  25. data/bin/commands/groups.rb +33 -33
  26. data/bin/commands/im.rb +13 -13
  27. data/bin/commands/migration.rb +2 -2
  28. data/bin/commands/mpim.rb +11 -11
  29. data/bin/commands/oauth.rb +4 -4
  30. data/bin/commands/pins.rb +6 -6
  31. data/bin/commands/reactions.rb +8 -8
  32. data/bin/commands/reminders.rb +10 -10
  33. data/bin/commands/rtm.rb +4 -4
  34. data/bin/commands/search.rb +7 -7
  35. data/bin/commands/stars.rb +6 -6
  36. data/bin/commands/team.rb +8 -8
  37. data/bin/commands/team_profile.rb +2 -2
  38. data/bin/commands/usergroups.rb +11 -11
  39. data/bin/commands/usergroups_users.rb +4 -4
  40. data/bin/commands/users.rb +21 -22
  41. data/bin/commands/users_profile.rb +4 -4
  42. data/lib/slack/events/request.rb +9 -5
  43. data/lib/slack/real_time/client.rb +23 -6
  44. data/lib/slack/real_time/concurrency/async.rb +55 -23
  45. data/lib/slack/real_time/concurrency/celluloid.rb +0 -1
  46. data/lib/slack/real_time/concurrency/eventmachine.rb +0 -5
  47. data/lib/slack/real_time/socket.rb +16 -9
  48. data/lib/slack/version.rb +1 -1
  49. data/lib/slack/web/api/endpoints.rb +2 -0
  50. data/lib/slack/web/api/endpoints/api.rb +1 -1
  51. data/lib/slack/web/api/endpoints/apps.rb +1 -1
  52. data/lib/slack/web/api/endpoints/apps_permissions.rb +2 -2
  53. data/lib/slack/web/api/endpoints/apps_permissions_resources.rb +1 -1
  54. data/lib/slack/web/api/endpoints/apps_permissions_scopes.rb +1 -1
  55. data/lib/slack/web/api/endpoints/apps_permissions_users.rb +2 -2
  56. data/lib/slack/web/api/endpoints/auth.rb +2 -2
  57. data/lib/slack/web/api/endpoints/bots.rb +1 -1
  58. data/lib/slack/web/api/endpoints/channels.rb +18 -15
  59. data/lib/slack/web/api/endpoints/chat.rb +63 -9
  60. data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +37 -0
  61. data/lib/slack/web/api/endpoints/conversations.rb +17 -17
  62. data/lib/slack/web/api/endpoints/dialog.rb +1 -1
  63. data/lib/slack/web/api/endpoints/dnd.rb +4 -4
  64. data/lib/slack/web/api/endpoints/emoji.rb +1 -1
  65. data/lib/slack/web/api/endpoints/files.rb +7 -18
  66. data/lib/slack/web/api/endpoints/files_comments.rb +1 -34
  67. data/lib/slack/web/api/endpoints/groups.rb +18 -16
  68. data/lib/slack/web/api/endpoints/im.rb +8 -6
  69. data/lib/slack/web/api/endpoints/migration.rb +1 -1
  70. data/lib/slack/web/api/endpoints/mpim.rb +7 -5
  71. data/lib/slack/web/api/endpoints/oauth.rb +2 -2
  72. data/lib/slack/web/api/endpoints/pins.rb +5 -3
  73. data/lib/slack/web/api/endpoints/reactions.rb +6 -4
  74. data/lib/slack/web/api/endpoints/reminders.rb +5 -5
  75. data/lib/slack/web/api/endpoints/rtm.rb +2 -2
  76. data/lib/slack/web/api/endpoints/search.rb +3 -3
  77. data/lib/slack/web/api/endpoints/stars.rb +5 -3
  78. data/lib/slack/web/api/endpoints/team.rb +5 -4
  79. data/lib/slack/web/api/endpoints/team_profile.rb +1 -1
  80. data/lib/slack/web/api/endpoints/usergroups.rb +5 -5
  81. data/lib/slack/web/api/endpoints/usergroups_users.rb +2 -2
  82. data/lib/slack/web/api/endpoints/users.rb +12 -12
  83. data/lib/slack/web/api/endpoints/users_profile.rb +2 -2
  84. data/spec/integration/integration_spec.rb +43 -36
  85. data/spec/slack/events/request_spec.rb +29 -1
  86. data/spec/slack/real_time/concurrency/celluloid_spec.rb +5 -0
  87. data/spec/slack/real_time/concurrency/eventmachine_spec.rb +1 -0
  88. data/spec/slack/web/api/endpoints/chat_scheduledMessages_spec.rb +7 -0
  89. data/spec/slack/web/api/endpoints/files_comments_spec.rb +0 -19
  90. data/spec/spec_helper.rb +5 -0
  91. metadata +6 -2
@@ -1,9 +1,9 @@
1
1
  # This file was auto-generated by lib/tasks/web.rake
2
2
 
3
- desc 'Get info on your direct messages.'
3
+ desc 'Im methods.'
4
4
  command 'im' do |g|
5
- g.desc 'Close a direct message channel.'
6
- g.long_desc %( Close a direct message channel. )
5
+ g.desc 'This method closes a direct message channel.'
6
+ g.long_desc %( This method closes a direct message channel. )
7
7
  g.command 'close' do |c|
8
8
  c.flag 'channel', desc: 'Direct message channel to close.'
9
9
  c.action do |_global_options, options, _args|
@@ -11,8 +11,8 @@ command 'im' do |g|
11
11
  end
12
12
  end
13
13
 
14
- g.desc 'Fetches history of messages and events from direct message channel.'
15
- g.long_desc %( Fetches history of messages and events from direct message channel. )
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. )
16
16
  g.command 'history' do |c|
17
17
  c.flag 'channel', desc: 'Direct message channel to fetch history for.'
18
18
  c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
@@ -24,8 +24,8 @@ command 'im' do |g|
24
24
  end
25
25
  end
26
26
 
27
- g.desc 'Lists direct message channels for the calling user.'
28
- g.long_desc %( Lists direct message channels for the calling user. )
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. )
29
29
  g.command 'list' do |c|
30
30
  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
31
  c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
@@ -34,8 +34,8 @@ command 'im' do |g|
34
34
  end
35
35
  end
36
36
 
37
- g.desc 'Sets the read cursor in a direct message channel.'
38
- g.long_desc %( Sets the read cursor in a direct message channel. )
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. )
39
39
  g.command 'mark' do |c|
40
40
  c.flag 'channel', desc: 'Direct message channel to set reading cursor in.'
41
41
  c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -44,8 +44,8 @@ command 'im' do |g|
44
44
  end
45
45
  end
46
46
 
47
- g.desc 'Opens a direct message channel.'
48
- g.long_desc %( Opens a direct message channel. )
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. )
49
49
  g.command 'open' do |c|
50
50
  c.flag 'user', desc: 'User to open a direct message channel with.'
51
51
  c.flag 'include_locale', desc: 'Set this to true to receive the locale for this im. Defaults to false.'
@@ -55,8 +55,8 @@ command 'im' do |g|
55
55
  end
56
56
  end
57
57
 
58
- g.desc 'Retrieve a thread of messages posted to a direct message conversation'
59
- g.long_desc %( Retrieve a thread of messages posted to a direct message conversation )
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). )
60
60
  g.command 'replies' do |c|
61
61
  c.flag 'channel', desc: 'Direct message channel to fetch thread from.'
62
62
  c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Migration methods.'
4
4
  command 'migration' do |g|
5
- g.desc 'For Enterprise Grid workspaces, map local user IDs to global user IDs'
6
- g.long_desc %( For Enterprise Grid workspaces, map local user IDs to global user IDs )
5
+ g.desc 'Easily convert your vintage user IDs to Enterprise Grid-friendly global user IDs.'
6
+ g.long_desc %( Easily convert your vintage user IDs to Enterprise Grid-friendly global user IDs. )
7
7
  g.command 'exchange' do |c|
8
8
  c.flag 'users', desc: 'A comma-separated list of user ids, up to 400 per request.'
9
9
  c.flag 'to_old', desc: 'Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.'
@@ -1,9 +1,9 @@
1
1
  # This file was auto-generated by lib/tasks/web.rake
2
2
 
3
- desc 'Get info on your multiparty direct messages.'
3
+ desc 'Mpim methods.'
4
4
  command 'mpim' do |g|
5
- g.desc 'Closes a multiparty direct message channel.'
6
- g.long_desc %( Closes a multiparty direct message channel. )
5
+ g.desc 'This method closes a multiparty direct message channel.'
6
+ g.long_desc %( This method closes a multiparty direct message channel. )
7
7
  g.command 'close' do |c|
8
8
  c.flag 'channel', desc: 'MPIM to close.'
9
9
  c.action do |_global_options, options, _args|
@@ -11,8 +11,8 @@ command 'mpim' do |g|
11
11
  end
12
12
  end
13
13
 
14
- g.desc 'Fetches history of messages and events from a multiparty direct message.'
15
- g.long_desc %( Fetches history of messages and events from a multiparty direct message. )
14
+ g.desc 'This method returns a portion of messages/events from the specified multiparty direct message channel.'
15
+ g.long_desc %( This method returns a portion of messages/events from the specified multiparty direct message channel. To read the entire history for a multiparty direct message, call the method with no latest or oldest arguments, and then continue paging using the instructions below. )
16
16
  g.command 'history' do |c|
17
17
  c.flag 'channel', desc: 'Multiparty direct message to fetch history for.'
18
18
  c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
@@ -24,8 +24,8 @@ command 'mpim' do |g|
24
24
  end
25
25
  end
26
26
 
27
- g.desc 'Lists multiparty direct message channels for the calling user.'
28
- g.long_desc %( Lists multiparty direct message channels for the calling user. )
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. )
29
29
  g.command 'list' do |c|
30
30
  c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
31
31
  c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached."
@@ -34,8 +34,8 @@ command 'mpim' do |g|
34
34
  end
35
35
  end
36
36
 
37
- g.desc 'Sets the read cursor in a multiparty direct message channel.'
38
- g.long_desc %( Sets the read cursor in a multiparty direct message channel. )
37
+ g.desc 'This method moves the read cursor in a multiparty direct message channel.'
38
+ g.long_desc %( This method moves the read cursor in a multiparty direct message channel. )
39
39
  g.command 'mark' do |c|
40
40
  c.flag 'channel', desc: 'multiparty direct message channel to set reading cursor in.'
41
41
  c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -53,8 +53,8 @@ command 'mpim' do |g|
53
53
  end
54
54
  end
55
55
 
56
- g.desc 'Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.'
57
- g.long_desc %( Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message. )
56
+ g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
57
+ g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
58
58
  g.command 'replies' do |c|
59
59
  c.flag 'channel', desc: 'Multiparty direct message channel to fetch thread from.'
60
60
  c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Oauth methods.'
4
4
  command 'oauth' do |g|
5
- g.desc 'Exchanges a temporary OAuth verifier code for an access token.'
6
- g.long_desc %( Exchanges a temporary OAuth verifier code for an access token. )
5
+ g.desc 'This method allows you to exchange a temporary OAuth code for an API access token.'
6
+ g.long_desc %( This method allows you to exchange a temporary OAuth code for an API access token. )
7
7
  g.command 'access' do |c|
8
8
  c.flag 'client_id', desc: 'Issued when you created your application.'
9
9
  c.flag 'client_secret', desc: 'Issued when you created your application.'
@@ -15,8 +15,8 @@ command 'oauth' do |g|
15
15
  end
16
16
  end
17
17
 
18
- g.desc 'Exchanges a temporary OAuth verifier code for a workspace token.'
19
- g.long_desc %( Exchanges a temporary OAuth verifier code for a workspace token. )
18
+ g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
19
+ g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
20
20
  g.command 'token' do |c|
21
21
  c.flag 'client_id', desc: 'Issued when you created your application.'
22
22
  c.flag 'client_secret', desc: 'Issued when you created your application.'
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Pins methods.'
4
4
  command 'pins' do |g|
5
- g.desc 'Pins an item to a channel.'
6
- g.long_desc %( Pins an item to a channel. )
5
+ g.desc 'This method pins an item (file, file comment, channel message, or group message) to a particular channel.'
6
+ g.long_desc %( This method pins an item (file, file comment, channel message, or group message) to a particular channel. The channel argument is required and one of file, file_comment, or timestamp must also be specified. )
7
7
  g.command 'add' do |c|
8
8
  c.flag 'channel', desc: 'Channel to pin the item in.'
9
9
  c.flag 'file', desc: 'File to pin.'
@@ -14,8 +14,8 @@ command 'pins' do |g|
14
14
  end
15
15
  end
16
16
 
17
- g.desc 'Lists items pinned to a channel.'
18
- g.long_desc %( Lists items pinned to a channel. )
17
+ g.desc 'This method lists the items pinned to a channel.'
18
+ g.long_desc %( This method lists the items pinned to a channel. )
19
19
  g.command 'list' do |c|
20
20
  c.flag 'channel', desc: 'Channel to get pinned items for.'
21
21
  c.action do |_global_options, options, _args|
@@ -23,8 +23,8 @@ command 'pins' do |g|
23
23
  end
24
24
  end
25
25
 
26
- g.desc 'Un-pins an item from a channel.'
27
- g.long_desc %( Un-pins an item from a channel. )
26
+ g.desc 'This method un-pins an item (file, file comment, channel message, or group message) from a channel.'
27
+ g.long_desc %( This method un-pins an item (file, file comment, channel message, or group message) from a channel. The channel argument is required and one of file, file_comment, or timestamp must also be specified. )
28
28
  g.command 'remove' do |c|
29
29
  c.flag 'channel', desc: 'Channel where the item is pinned to.'
30
30
  c.flag 'file', desc: 'File to un-pin.'
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Reactions methods.'
4
4
  command 'reactions' do |g|
5
- g.desc 'Adds a reaction to an item.'
6
- g.long_desc %( Adds a reaction to an item. )
5
+ g.desc 'This method adds a reaction (emoji) to a message.'
6
+ g.long_desc %( This method adds a reaction (emoji) to a message. Now that file threads work the way you'd expect, the file and file_comment arguments are deprecated. Specify channel and timestamp instead. )
7
7
  g.command 'add' do |c|
8
8
  c.flag 'name', desc: 'Reaction (emoji) name.'
9
9
  c.flag 'channel', desc: 'Channel where the message to add reaction to was posted.'
@@ -15,8 +15,8 @@ command 'reactions' do |g|
15
15
  end
16
16
  end
17
17
 
18
- g.desc 'Gets reactions for an item.'
19
- g.long_desc %( Gets reactions for an item. )
18
+ g.desc 'This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).'
19
+ g.long_desc %( This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message). )
20
20
  g.command 'get' do |c|
21
21
  c.flag 'channel', desc: 'Channel where the message to get reactions for was posted.'
22
22
  c.flag 'file', desc: 'File to get reactions for.'
@@ -28,8 +28,8 @@ command 'reactions' do |g|
28
28
  end
29
29
  end
30
30
 
31
- g.desc 'Lists reactions made by a user.'
32
- g.long_desc %( Lists reactions made by a user. )
31
+ g.desc 'This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.'
32
+ g.long_desc %( This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user. )
33
33
  g.command 'list' do |c|
34
34
  c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
35
35
  c.flag 'full', desc: 'If true always return the complete reaction list.'
@@ -40,8 +40,8 @@ command 'reactions' do |g|
40
40
  end
41
41
  end
42
42
 
43
- g.desc 'Removes a reaction from an item.'
44
- g.long_desc %( Removes a reaction from an item. )
43
+ g.desc 'This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message).'
44
+ g.long_desc %( This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message). One of file, file_comment, or the combination of channel and timestamp must be specified. )
45
45
  g.command 'remove' do |c|
46
46
  c.flag 'name', desc: 'Reaction (emoji) name.'
47
47
  c.flag 'channel', desc: 'Channel where the message to remove reaction from was posted.'
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Reminders methods.'
4
4
  command 'reminders' do |g|
5
- g.desc 'Creates a reminder.'
6
- g.long_desc %( Creates a reminder. )
5
+ g.desc 'This method creates a reminder.'
6
+ g.long_desc %( This method creates a reminder. )
7
7
  g.command 'add' do |c|
8
8
  c.flag 'text', desc: 'The content of the reminder.'
9
9
  c.flag 'time', desc: 'When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday").'
@@ -13,8 +13,8 @@ command 'reminders' do |g|
13
13
  end
14
14
  end
15
15
 
16
- g.desc 'Marks a reminder as complete.'
17
- g.long_desc %( Marks a reminder as complete. )
16
+ g.desc 'This method completes a reminder.'
17
+ g.long_desc %( This method completes a reminder. )
18
18
  g.command 'complete' do |c|
19
19
  c.flag 'reminder', desc: 'The ID of the reminder to be marked as complete.'
20
20
  c.action do |_global_options, options, _args|
@@ -22,8 +22,8 @@ command 'reminders' do |g|
22
22
  end
23
23
  end
24
24
 
25
- g.desc 'Deletes a reminder.'
26
- g.long_desc %( Deletes a reminder. )
25
+ g.desc 'This method deletes a reminder.'
26
+ g.long_desc %( This method deletes a reminder. )
27
27
  g.command 'delete' do |c|
28
28
  c.flag 'reminder', desc: 'The ID of the reminder.'
29
29
  c.action do |_global_options, options, _args|
@@ -31,8 +31,8 @@ command 'reminders' do |g|
31
31
  end
32
32
  end
33
33
 
34
- g.desc 'Gets information about a reminder.'
35
- g.long_desc %( Gets information about a reminder. )
34
+ g.desc 'This method returns information about a reminder.'
35
+ g.long_desc %( This method returns information about a reminder. )
36
36
  g.command 'info' do |c|
37
37
  c.flag 'reminder', desc: 'The ID of the reminder.'
38
38
  c.action do |_global_options, options, _args|
@@ -40,8 +40,8 @@ command 'reminders' do |g|
40
40
  end
41
41
  end
42
42
 
43
- g.desc 'Lists all reminders created by or for a given user.'
44
- g.long_desc %( Lists all reminders created by or for a given user. )
43
+ g.desc 'This method lists all reminders created by or for a given user.'
44
+ g.long_desc %( This method lists all reminders created by or for a given user. )
45
45
  g.command 'list' do |c|
46
46
  c.action do |_global_options, options, _args|
47
47
  puts JSON.dump($client.reminders_list(options))
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Rtm methods.'
4
4
  command 'rtm' do |g|
5
- g.desc 'Starts a Real Time Messaging session.'
6
- g.long_desc %( Starts a Real Time Messaging session. )
5
+ g.desc 'This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.'
6
+ g.long_desc %( This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket. )
7
7
  g.command 'connect' do |c|
8
8
  c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
9
9
  c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
@@ -12,8 +12,8 @@ command 'rtm' do |g|
12
12
  end
13
13
  end
14
14
 
15
- g.desc 'Starts a Real Time Messaging session.'
16
- g.long_desc %( Starts a Real Time Messaging session. )
15
+ g.desc 'This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.'
16
+ g.long_desc %( This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket. )
17
17
  g.command 'start' do |c|
18
18
  c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
19
19
  c.flag 'include_locale', desc: 'Set this to true to receive the locale for users and channels. Defaults to false.'
@@ -1,9 +1,9 @@
1
1
  # This file was auto-generated by lib/tasks/web.rake
2
2
 
3
- desc "Search your team's files and messages."
3
+ desc 'Search methods.'
4
4
  command 'search' do |g|
5
- g.desc 'Searches for messages and files matching a query.'
6
- g.long_desc %( Searches for messages and files matching a query. )
5
+ g.desc 'This method allows users and applications to search both messages and files in a single call.'
6
+ g.long_desc %( This method allows users and applications to search both messages and files in a single call. )
7
7
  g.command 'all' do |c|
8
8
  c.flag 'query', desc: 'Search query. May contains booleans, etc.'
9
9
  c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
@@ -14,8 +14,8 @@ command 'search' do |g|
14
14
  end
15
15
  end
16
16
 
17
- g.desc 'Searches for files matching a query.'
18
- g.long_desc %( Searches for files matching a query. )
17
+ g.desc 'This method returns files matching a search query.'
18
+ g.long_desc %( This method returns files matching a search query. )
19
19
  g.command 'files' do |c|
20
20
  c.flag 'query', desc: 'Search query.'
21
21
  c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
@@ -26,8 +26,8 @@ command 'search' do |g|
26
26
  end
27
27
  end
28
28
 
29
- g.desc 'Searches for messages matching a query.'
30
- g.long_desc %( Searches for messages matching a query. )
29
+ g.desc 'This method returns messages matching a search query.'
30
+ g.long_desc %( This method returns messages matching a search query. )
31
31
  g.command 'messages' do |c|
32
32
  c.flag 'query', desc: 'Search query.'
33
33
  c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Stars methods.'
4
4
  command 'stars' do |g|
5
- g.desc 'Adds a star to an item.'
6
- g.long_desc %( Adds a star to an item. )
5
+ g.desc 'This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.'
6
+ g.long_desc %( This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified. )
7
7
  g.command 'add' do |c|
8
8
  c.flag 'channel', desc: 'Channel to add star to, or channel where the message to add star to was posted (used with timestamp).'
9
9
  c.flag 'file', desc: 'File to add star to.'
@@ -14,8 +14,8 @@ command 'stars' do |g|
14
14
  end
15
15
  end
16
16
 
17
- g.desc 'Lists stars for a user.'
18
- g.long_desc %( Lists stars for a user. )
17
+ g.desc 'This method lists the items starred by the authed user.'
18
+ g.long_desc %( This method lists the items starred by the authed user. )
19
19
  g.command 'list' do |c|
20
20
  c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
21
21
  c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached."
@@ -24,8 +24,8 @@ command 'stars' do |g|
24
24
  end
25
25
  end
26
26
 
27
- g.desc 'Removes a star from an item.'
28
- g.long_desc %( Removes a star from an item. )
27
+ g.desc 'This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.'
28
+ g.long_desc %( This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified. )
29
29
  g.command 'remove' do |c|
30
30
  c.flag 'channel', desc: 'Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).'
31
31
  c.flag 'file', desc: 'File to remove star from.'
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Team methods.'
4
4
  command 'team' do |g|
5
- g.desc 'Gets the access logs for the current team.'
6
- g.long_desc %( Gets the access logs for the current team. )
5
+ g.desc 'This method is used to retrieve the "access logs" for users on a workspace.'
6
+ g.long_desc %( This method is used to retrieve the "access logs" for users on a workspace. )
7
7
  g.command 'accessLogs' do |c|
8
8
  c.flag 'before', desc: 'End of time range of logs to include in results (inclusive).'
9
9
  c.action do |_global_options, options, _args|
@@ -11,8 +11,8 @@ command 'team' do |g|
11
11
  end
12
12
  end
13
13
 
14
- g.desc 'Gets billable users information for the current team.'
15
- g.long_desc %( Gets billable users information for the current team. )
14
+ g.desc 'This method lists billable information for each user on the team. Currently this consists solely of whether the user is'
15
+ g.long_desc %( This method lists billable information for each user on the team. Currently this consists solely of whether the user is subject to billing per Slack's Fair Billing policy. )
16
16
  g.command 'billableInfo' do |c|
17
17
  c.flag 'user', desc: 'A user to retrieve the billable information for. Defaults to all users.'
18
18
  c.action do |_global_options, options, _args|
@@ -20,16 +20,16 @@ command 'team' do |g|
20
20
  end
21
21
  end
22
22
 
23
- g.desc 'Gets information about the current team.'
24
- g.long_desc %( Gets information about the current team. )
23
+ g.desc 'This method provides information about your team.'
24
+ g.long_desc %( This method provides information about your team. )
25
25
  g.command 'info' do |c|
26
26
  c.action do |_global_options, options, _args|
27
27
  puts JSON.dump($client.team_info(options))
28
28
  end
29
29
  end
30
30
 
31
- g.desc 'Gets the integration logs for the current team.'
32
- g.long_desc %( Gets the integration logs for the current team. )
31
+ g.desc 'This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.'
32
+ g.long_desc %( This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins. )
33
33
  g.command 'integrationLogs' do |c|
34
34
  c.flag 'app_id', desc: 'Filter logs to this Slack app. Defaults to all logs.'
35
35
  c.flag 'change_type', desc: 'Filter logs with this change type. Defaults to all logs.'
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'TeamProfile methods.'
4
4
  command 'team_profile' do |g|
5
- g.desc "Retrieve a team's profile."
6
- g.long_desc %( Retrieve a team's profile. )
5
+ g.desc 'This method is used to get the profile field definitions for this team.'
6
+ g.long_desc %( This method is used to get the profile field definitions for this team. )
7
7
  g.command 'get' do |c|
8
8
  c.flag 'visibility', desc: 'Filter by visibility.'
9
9
  c.action do |_global_options, options, _args|
@@ -1,9 +1,9 @@
1
1
  # This file was auto-generated by lib/tasks/web.rake
2
2
 
3
- desc "Get info on your team's User Groups."
3
+ desc 'Usergroups methods.'
4
4
  command 'usergroups' do |g|
5
- g.desc 'Create a User Group'
6
- g.long_desc %( Create a User Group )
5
+ g.desc 'This method is used to create a User Group.'
6
+ g.long_desc %( This method is used to create a User Group. )
7
7
  g.command 'create' do |c|
8
8
  c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
9
9
  c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'
@@ -15,8 +15,8 @@ command 'usergroups' do |g|
15
15
  end
16
16
  end
17
17
 
18
- g.desc 'Disable an existing User Group'
19
- g.long_desc %( Disable an existing User Group )
18
+ g.desc 'This method disables an existing User Group.'
19
+ g.long_desc %( This method disables an existing User Group. )
20
20
  g.command 'disable' do |c|
21
21
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to disable.'
22
22
  c.flag 'include_count', desc: 'Include the number of users in the User Group.'
@@ -25,8 +25,8 @@ command 'usergroups' do |g|
25
25
  end
26
26
  end
27
27
 
28
- g.desc 'Enable a User Group'
29
- g.long_desc %( Enable a User Group )
28
+ g.desc 'This method enables a User Group which was previously disabled.'
29
+ g.long_desc %( This method enables a User Group which was previously disabled. )
30
30
  g.command 'enable' do |c|
31
31
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to enable.'
32
32
  c.flag 'include_count', desc: 'Include the number of users in the User Group.'
@@ -35,8 +35,8 @@ command 'usergroups' do |g|
35
35
  end
36
36
  end
37
37
 
38
- g.desc 'List all User Groups for a team'
39
- g.long_desc %( List all User Groups for a team )
38
+ g.desc 'This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.'
39
+ g.long_desc %( This method returns a list of all User Groups in the team. This can optionally include disabled User Groups. )
40
40
  g.command 'list' do |c|
41
41
  c.flag 'include_count', desc: 'Include the number of users in each User Group.'
42
42
  c.flag 'include_disabled', desc: 'Include disabled User Groups.'
@@ -46,8 +46,8 @@ command 'usergroups' do |g|
46
46
  end
47
47
  end
48
48
 
49
- g.desc 'Update an existing User Group'
50
- g.long_desc %( Update an existing User Group )
49
+ g.desc 'This method updates the properties of an existing User Group.'
50
+ g.long_desc %( This method updates the properties of an existing User Group. )
51
51
  g.command 'update' do |c|
52
52
  c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
53
53
  c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'