slack-ruby-client 0.14.1 → 0.14.2

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -0,0 +1,17 @@
1
+ # This file was auto-generated by lib/tasks/web.rake
2
+
3
+ desc 'ChatScheduledmessages methods.'
4
+ command 'chat_scheduledMessages' do |g|
5
+ g.desc 'This method returns a list of pending scheduled messages.'
6
+ g.long_desc %( This method returns a list of pending scheduled messages. )
7
+ g.command 'list' do |c|
8
+ c.flag 'channel', desc: 'The channel of the scheduled messages.'
9
+ c.flag 'cursor', desc: 'For pagination purposes, this is the cursor value returned from a previous call to chat.scheduledmessages.list indicating where you want to start this call from.'
10
+ c.flag 'latest', desc: 'A UNIX timestamp of the latest value in the time range.'
11
+ c.flag 'limit', desc: 'Maximum number of original entries to return.'
12
+ c.flag 'oldest', desc: 'A UNIX timestamp of the oldest value in the time range.'
13
+ c.action do |_global_options, options, _args|
14
+ puts JSON.dump($client.chat_scheduledMessages_list(options))
15
+ end
16
+ end
17
+ end
@@ -1,9 +1,9 @@
1
1
  # This file was auto-generated by lib/tasks/web.rake
2
2
 
3
- desc "Interface with all kinds of conversations the same way, whether they're public or private channels, direct messages, or otherwise."
3
+ desc 'Conversations methods.'
4
4
  command 'conversations' do |g|
5
- g.desc 'Archives a conversation.'
6
- g.long_desc %( Archives a conversation. )
5
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
6
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
7
7
  g.command 'archive' do |c|
8
8
  c.flag 'channel', desc: 'ID of conversation to archive.'
9
9
  c.action do |_global_options, options, _args|
@@ -11,8 +11,8 @@ command 'conversations' do |g|
11
11
  end
12
12
  end
13
13
 
14
- g.desc 'Closes a direct message or multi-person direct message.'
15
- g.long_desc %( Closes a direct message or multi-person direct message. )
14
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
15
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
16
16
  g.command 'close' do |c|
17
17
  c.flag 'channel', desc: 'Conversation to close.'
18
18
  c.action do |_global_options, options, _args|
@@ -20,8 +20,8 @@ command 'conversations' do |g|
20
20
  end
21
21
  end
22
22
 
23
- g.desc 'Initiates a public or private channel-based conversation'
24
- g.long_desc %( Initiates a public or private channel-based conversation )
23
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
24
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
25
25
  g.command 'create' do |c|
26
26
  c.flag 'name', desc: 'Name of the public or private channel to create.'
27
27
  c.flag 'is_private', desc: 'Create a private channel instead of a public one.'
@@ -31,8 +31,8 @@ command 'conversations' do |g|
31
31
  end
32
32
  end
33
33
 
34
- g.desc "Fetches a conversation's history of messages and events."
35
- g.long_desc %( Fetches a conversation's history of messages and events. )
34
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
35
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
36
36
  g.command 'history' do |c|
37
37
  c.flag 'channel', desc: 'Conversation ID to fetch history for.'
38
38
  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."
@@ -45,8 +45,8 @@ command 'conversations' do |g|
45
45
  end
46
46
  end
47
47
 
48
- g.desc 'Retrieve information about a conversation.'
49
- g.long_desc %( Retrieve information about a conversation. )
48
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
49
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
50
50
  g.command 'info' do |c|
51
51
  c.flag 'channel', desc: 'Conversation ID to learn more about.'
52
52
  c.flag 'include_locale', desc: 'Set this to true to receive the locale for this conversation. Defaults to false.'
@@ -56,8 +56,8 @@ command 'conversations' do |g|
56
56
  end
57
57
  end
58
58
 
59
- g.desc 'Invites users to a channel.'
60
- g.long_desc %( Invites users to a channel. )
59
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
60
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
61
61
  g.command 'invite' do |c|
62
62
  c.flag 'channel', desc: 'The ID of the public or private channel to invite user(s) to.'
63
63
  c.flag 'users', desc: 'A comma separated list of user IDs. Up to 30 users may be listed.'
@@ -66,8 +66,8 @@ command 'conversations' do |g|
66
66
  end
67
67
  end
68
68
 
69
- g.desc 'Joins an existing conversation.'
70
- g.long_desc %( Joins an existing conversation. )
69
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
70
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
71
71
  g.command 'join' do |c|
72
72
  c.flag 'channel', desc: 'ID of conversation to join.'
73
73
  c.action do |_global_options, options, _args|
@@ -75,8 +75,8 @@ command 'conversations' do |g|
75
75
  end
76
76
  end
77
77
 
78
- g.desc 'Removes a user from a conversation.'
79
- g.long_desc %( Removes a user from a conversation. )
78
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
79
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
80
80
  g.command 'kick' do |c|
81
81
  c.flag 'channel', desc: 'ID of conversation to remove user from.'
82
82
  c.flag 'user', desc: 'User ID to be removed.'
@@ -85,8 +85,8 @@ command 'conversations' do |g|
85
85
  end
86
86
  end
87
87
 
88
- g.desc 'Leaves a conversation.'
89
- g.long_desc %( Leaves a conversation. )
88
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
89
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
90
90
  g.command 'leave' do |c|
91
91
  c.flag 'channel', desc: 'Conversation to leave.'
92
92
  c.action do |_global_options, options, _args|
@@ -94,8 +94,8 @@ command 'conversations' do |g|
94
94
  end
95
95
  end
96
96
 
97
- g.desc 'Lists all channels in a Slack team.'
98
- g.long_desc %( Lists all channels in a Slack team. )
97
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
98
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
99
99
  g.command 'list' do |c|
100
100
  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."
101
101
  c.flag 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
@@ -106,8 +106,8 @@ command 'conversations' do |g|
106
106
  end
107
107
  end
108
108
 
109
- g.desc 'Retrieve members of a conversation.'
110
- g.long_desc %( Retrieve members of a conversation. )
109
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
110
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
111
111
  g.command 'members' do |c|
112
112
  c.flag 'channel', desc: 'ID of the conversation to retrieve members for.'
113
113
  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."
@@ -117,8 +117,8 @@ command 'conversations' do |g|
117
117
  end
118
118
  end
119
119
 
120
- g.desc 'Opens or resumes a direct message or multi-person direct message.'
121
- g.long_desc %( Opens or resumes a direct message or multi-person direct message. )
120
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
121
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
122
122
  g.command 'open' do |c|
123
123
  c.flag 'channel', desc: "Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead."
124
124
  c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
@@ -128,8 +128,8 @@ command 'conversations' do |g|
128
128
  end
129
129
  end
130
130
 
131
- g.desc 'Renames a conversation.'
132
- g.long_desc %( Renames a conversation. )
131
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
132
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
133
133
  g.command 'rename' do |c|
134
134
  c.flag 'channel', desc: 'ID of conversation to rename.'
135
135
  c.flag 'name', desc: 'New name for conversation.'
@@ -138,8 +138,8 @@ command 'conversations' do |g|
138
138
  end
139
139
  end
140
140
 
141
- g.desc 'Retrieve a thread of messages posted to a conversation'
142
- g.long_desc %( Retrieve a thread of messages posted to a conversation )
141
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
142
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
143
143
  g.command 'replies' do |c|
144
144
  c.flag 'channel', desc: 'Conversation ID to fetch thread from.'
145
145
  c.flag 'ts', desc: "Unique identifier of a thread's parent message."
@@ -153,8 +153,8 @@ command 'conversations' do |g|
153
153
  end
154
154
  end
155
155
 
156
- g.desc 'Sets the purpose for a conversation.'
157
- g.long_desc %( Sets the purpose for a conversation. )
156
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
157
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
158
158
  g.command 'setPurpose' do |c|
159
159
  c.flag 'channel', desc: 'Conversation to set the purpose of.'
160
160
  c.flag 'purpose', desc: 'A new, specialer purpose.'
@@ -163,8 +163,8 @@ command 'conversations' do |g|
163
163
  end
164
164
  end
165
165
 
166
- g.desc 'Sets the topic for a conversation.'
167
- g.long_desc %( Sets the topic for a conversation. )
166
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
167
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
168
168
  g.command 'setTopic' do |c|
169
169
  c.flag 'channel', desc: 'Conversation to set the topic of.'
170
170
  c.flag 'topic', desc: 'The new topic string. Does not support formatting or linkification.'
@@ -173,8 +173,8 @@ command 'conversations' do |g|
173
173
  end
174
174
  end
175
175
 
176
- g.desc 'Reverses conversation archival.'
177
- g.long_desc %( Reverses conversation archival. )
176
+ g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
177
+ g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
178
178
  g.command 'unarchive' do |c|
179
179
  c.flag 'channel', desc: 'ID of conversation to unarchive.'
180
180
  c.action do |_global_options, options, _args|
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Dialog methods.'
4
4
  command 'dialog' do |g|
5
- g.desc 'Open a dialog with a user'
6
- g.long_desc %( Open a dialog with a user )
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. )
7
7
  g.command 'open' do |c|
8
8
  c.flag 'dialog', desc: 'The dialog definition. This must be a JSON-encoded string.'
9
9
  c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
@@ -1,9 +1,9 @@
1
1
  # This file was auto-generated by lib/tasks/web.rake
2
2
 
3
- desc 'Adjust and view Do Not Disturb settings for team members.'
3
+ desc 'Dnd methods.'
4
4
  command 'dnd' do |g|
5
- g.desc "Ends the current user's Do Not Disturb session immediately."
6
- g.long_desc %( Ends the current user's Do Not Disturb session immediately. )
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. )
7
7
  g.command 'endDnd' do |c|
8
8
  c.action do |_global_options, options, _args|
9
9
  puts JSON.dump($client.dnd_endDnd(options))
@@ -18,8 +18,8 @@ command 'dnd' do |g|
18
18
  end
19
19
  end
20
20
 
21
- g.desc "Retrieves a user's current Do Not Disturb status."
22
- g.long_desc %( Retrieves a user's current Do Not Disturb status. )
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. )
23
23
  g.command 'info' do |c|
24
24
  c.flag 'user', desc: 'User to fetch status for (defaults to current user).'
25
25
  c.action do |_global_options, options, _args|
@@ -27,8 +27,8 @@ command 'dnd' do |g|
27
27
  end
28
28
  end
29
29
 
30
- g.desc 'Turns on Do Not Disturb mode for the current user, or changes its duration.'
31
- g.long_desc %( Turns on Do Not Disturb mode for the current user, or changes its duration. )
30
+ g.desc "Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration."
31
+ g.long_desc %( Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration. )
32
32
  g.command 'setSnooze' do |c|
33
33
  c.flag 'num_minutes', desc: 'Number of minutes, from now, to snooze until.'
34
34
  c.action do |_global_options, options, _args|
@@ -36,8 +36,8 @@ command 'dnd' do |g|
36
36
  end
37
37
  end
38
38
 
39
- g.desc 'Retrieves the Do Not Disturb status for users on a team.'
40
- g.long_desc %( Retrieves the Do Not Disturb status for users on a team. )
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. )
41
41
  g.command 'teamInfo' do |c|
42
42
  c.flag 'users', desc: 'Comma-separated list of users to fetch Do Not Disturb status for.'
43
43
  c.action do |_global_options, options, _args|
@@ -2,8 +2,8 @@
2
2
 
3
3
  desc 'Emoji methods.'
4
4
  command 'emoji' do |g|
5
- g.desc 'Lists custom emoji for a team.'
6
- g.long_desc %( Lists custom emoji for a team. )
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. )
7
7
  g.command 'list' do |c|
8
8
  c.action do |_global_options, options, _args|
9
9
  puts JSON.dump($client.emoji_list(options))
@@ -1,9 +1,9 @@
1
1
  # This file was auto-generated by lib/tasks/web.rake
2
2
 
3
- desc 'Get info on files uploaded to Slack, upload new files to Slack.'
3
+ desc 'Files methods.'
4
4
  command 'files' do |g|
5
- g.desc 'Deletes a file.'
6
- g.long_desc %( Deletes a file. )
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. )
7
7
  g.command 'delete' do |c|
8
8
  c.flag 'file', desc: 'ID of file to delete.'
9
9
  c.action do |_global_options, options, _args|
@@ -22,8 +22,8 @@ command 'files' do |g|
22
22
  end
23
23
  end
24
24
 
25
- g.desc 'Gets information about a team file.'
26
- g.long_desc %( Gets information about a team file. )
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. )
27
27
  g.command 'info' do |c|
28
28
  c.flag 'file', desc: 'Specify a file by providing its ID.'
29
29
  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,32 +33,21 @@ command 'files' do |g|
33
33
  end
34
34
  end
35
35
 
36
- g.desc 'Lists & filters team files.'
37
- g.long_desc %( Lists & filters team files. )
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. )
38
38
  g.command 'list' do |c|
39
39
  c.flag 'channel', desc: 'Filter files appearing in a specific channel, indicated by its ID.'
40
40
  c.flag 'ts_from', desc: 'Filter files created after this timestamp (inclusive).'
41
41
  c.flag 'ts_to', desc: 'Filter files created before this timestamp (inclusive).'
42
- c.flag 'types', desc: 'Filter files by type:
43
- * `all` - All files
44
- * `spaces` - Posts
45
- * `snippets` - Snippets
46
- * `images` - Image files
47
- * `gdocs` - Google docs
48
- * `zips` - Zip files
49
- * `pdfs` - PDF files
50
-
51
- You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list.
52
-
53
- .'
42
+ c.flag 'types', desc: 'Filter files by type (see below). You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.'
54
43
  c.flag 'user', desc: 'Filter files created by a single user.'
55
44
  c.action do |_global_options, options, _args|
56
45
  puts JSON.dump($client.files_list(options))
57
46
  end
58
47
  end
59
48
 
60
- g.desc 'Revokes public/external sharing access for a file'
61
- g.long_desc %( Revokes public/external sharing access for a file )
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. )
62
51
  g.command 'revokePublicURL' do |c|
63
52
  c.flag 'file', desc: 'File to revoke.'
64
53
  c.action do |_global_options, options, _args|
@@ -76,8 +65,8 @@ You can pass multiple values in the types argument, like `types=spaces,snippets`
76
65
  end
77
66
  end
78
67
 
79
- g.desc 'Enables a file for public/external sharing.'
80
- g.long_desc %( Enables a file for public/external sharing. )
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. )
81
70
  g.command 'sharedPublicURL' do |c|
82
71
  c.flag 'file', desc: 'File to share.'
83
72
  c.action do |_global_options, options, _args|
@@ -85,8 +74,8 @@ You can pass multiple values in the types argument, like `types=spaces,snippets`
85
74
  end
86
75
  end
87
76
 
88
- g.desc 'Uploads or creates a file.'
89
- g.long_desc %( Uploads or creates a file. )
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. )
90
79
  g.command 'upload' do |c|
91
80
  c.flag 'channels', desc: 'Comma-separated list of channel names or IDs where the file will be shared.'
92
81
  c.flag 'content', desc: 'File contents via a POST variable. If omitting this parameter, you must provide a file.'
@@ -2,18 +2,8 @@
2
2
 
3
3
  desc 'FilesComments methods.'
4
4
  command 'files_comments' do |g|
5
- g.desc 'Add a comment to an existing file.'
6
- g.long_desc %( Add a comment to an existing file. )
7
- g.command 'add' do |c|
8
- c.flag 'comment', desc: 'Text of the comment to add.'
9
- c.flag 'file', desc: 'File to add a comment to.'
10
- c.action do |_global_options, options, _args|
11
- puts JSON.dump($client.files_comments_add(options))
12
- end
13
- end
14
-
15
- g.desc 'Deletes an existing comment on a file.'
16
- g.long_desc %( Deletes an existing comment on a file. )
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. )
17
7
  g.command 'delete' do |c|
18
8
  c.flag 'file', desc: 'File to delete a comment from.'
19
9
  c.flag 'id', desc: 'The comment to delete.'
@@ -21,15 +11,4 @@ command 'files_comments' do |g|
21
11
  puts JSON.dump($client.files_comments_delete(options))
22
12
  end
23
13
  end
24
-
25
- g.desc 'Edit an existing file comment.'
26
- g.long_desc %( Edit an existing file comment. )
27
- g.command 'edit' do |c|
28
- c.flag 'comment', desc: 'Text of the comment to edit.'
29
- c.flag 'file', desc: 'File containing the comment to edit.'
30
- c.flag 'id', desc: 'The comment to edit.'
31
- c.action do |_global_options, options, _args|
32
- puts JSON.dump($client.files_comments_edit(options))
33
- end
34
- end
35
14
  end
@@ -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 private channels."
3
+ desc 'Groups methods.'
4
4
  command 'groups' do |g|
5
- g.desc 'Archives a private channel.'
6
- g.long_desc %( Archives a private channel. )
5
+ g.desc 'This method archives a private channel.'
6
+ g.long_desc %( This method archives a private channel. )
7
7
  g.command 'archive' do |c|
8
8
  c.flag 'channel', desc: 'Private channel to archive.'
9
9
  c.action do |_global_options, options, _args|
@@ -11,8 +11,8 @@ command 'groups' do |g|
11
11
  end
12
12
  end
13
13
 
14
- g.desc 'Creates a private channel.'
15
- g.long_desc %( Creates a private channel. )
14
+ g.desc 'This method creates a private channel.'
15
+ g.long_desc %( This method creates a private channel. )
16
16
  g.command 'create' do |c|
17
17
  c.flag 'name', desc: 'Name of private channel to create.'
18
18
  c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
@@ -21,8 +21,8 @@ command 'groups' do |g|
21
21
  end
22
22
  end
23
23
 
24
- g.desc 'Clones and archives a private channel.'
25
- g.long_desc %( Clones and archives a private channel. )
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: )
26
26
  g.command 'createChild' do |c|
27
27
  c.flag 'channel', desc: 'Private channel to clone and archive.'
28
28
  c.action do |_global_options, options, _args|
@@ -30,8 +30,8 @@ command 'groups' do |g|
30
30
  end
31
31
  end
32
32
 
33
- g.desc 'Fetches history of messages and events from a private channel.'
34
- g.long_desc %( Fetches history of messages and events from a private channel. )
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. )
35
35
  g.command 'history' do |c|
36
36
  c.flag 'channel', desc: 'Private channel to fetch history for.'
37
37
  c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
@@ -52,8 +52,8 @@ command 'groups' do |g|
52
52
  end
53
53
  end
54
54
 
55
- g.desc 'Gets information about a private channel.'
56
- g.long_desc %( Gets information about a private channel. )
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. )
57
57
  g.command 'info' do |c|
58
58
  c.flag 'channel', desc: 'Private channel to get info on.'
59
59
  c.flag 'include_locale', desc: 'Set this to true to receive the locale for this group. Defaults to false.'
@@ -62,8 +62,8 @@ command 'groups' do |g|
62
62
  end
63
63
  end
64
64
 
65
- g.desc 'Invites a user to a private channel.'
66
- g.long_desc %( Invites a user to a private channel. )
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. )
67
67
  g.command 'invite' do |c|
68
68
  c.flag 'channel', desc: 'Private channel to invite user to.'
69
69
  c.flag 'user', desc: 'User to invite.'
@@ -72,8 +72,8 @@ command 'groups' do |g|
72
72
  end
73
73
  end
74
74
 
75
- g.desc 'Removes a user from a private channel.'
76
- g.long_desc %( Removes a user from a private channel. )
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. )
77
77
  g.command 'kick' do |c|
78
78
  c.flag 'channel', desc: 'Private channel to remove user from.'
79
79
  c.flag 'user', desc: 'User to remove from private channel.'
@@ -82,8 +82,8 @@ command 'groups' do |g|
82
82
  end
83
83
  end
84
84
 
85
- g.desc 'Leaves a private channel.'
86
- g.long_desc %( Leaves a private channel. )
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. )
87
87
  g.command 'leave' do |c|
88
88
  c.flag 'channel', desc: 'Private channel to leave.'
89
89
  c.action do |_global_options, options, _args|
@@ -91,8 +91,8 @@ command 'groups' do |g|
91
91
  end
92
92
  end
93
93
 
94
- g.desc 'Lists private channels that the calling user has access to.'
95
- g.long_desc %( Lists private channels that the calling user has access to. )
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. )
96
96
  g.command 'list' do |c|
97
97
  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
98
  c.flag 'exclude_archived', desc: "Don't return archived private channels."
@@ -103,8 +103,8 @@ command 'groups' do |g|
103
103
  end
104
104
  end
105
105
 
106
- g.desc 'Sets the read cursor in a private channel.'
107
- g.long_desc %( Sets the read cursor in a private channel. )
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. )
108
108
  g.command 'mark' do |c|
109
109
  c.flag 'channel', desc: 'Private channel to set reading cursor in.'
110
110
  c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -113,8 +113,8 @@ command 'groups' do |g|
113
113
  end
114
114
  end
115
115
 
116
- g.desc 'Opens a private channel.'
117
- g.long_desc %( Opens a private channel. )
116
+ g.desc 'This method opens a private channel.'
117
+ g.long_desc %( This method opens a private channel. )
118
118
  g.command 'open' do |c|
119
119
  c.flag 'channel', desc: 'Private channel to open.'
120
120
  c.action do |_global_options, options, _args|
@@ -122,8 +122,8 @@ command 'groups' do |g|
122
122
  end
123
123
  end
124
124
 
125
- g.desc 'Renames a private channel.'
126
- g.long_desc %( Renames a private channel. )
125
+ g.desc 'This method renames a private channel.'
126
+ g.long_desc %( This method renames a private channel. )
127
127
  g.command 'rename' do |c|
128
128
  c.flag 'channel', desc: 'Private channel to rename.'
129
129
  c.flag 'name', desc: 'New name for private channel.'
@@ -133,8 +133,8 @@ command 'groups' do |g|
133
133
  end
134
134
  end
135
135
 
136
- g.desc 'Retrieve a thread of messages posted to a private channel'
137
- g.long_desc %( Retrieve a thread of messages posted to a private channel )
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). )
138
138
  g.command 'replies' do |c|
139
139
  c.flag 'channel', desc: 'Private channel to fetch thread from.'
140
140
  c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
@@ -143,8 +143,8 @@ command 'groups' do |g|
143
143
  end
144
144
  end
145
145
 
146
- g.desc 'Sets the purpose for a private channel.'
147
- g.long_desc %( Sets the purpose for a private channel. )
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. )
148
148
  g.command 'setPurpose' do |c|
149
149
  c.flag 'channel', desc: 'Private channel to set the purpose of.'
150
150
  c.flag 'purpose', desc: 'The new purpose.'
@@ -153,8 +153,8 @@ command 'groups' do |g|
153
153
  end
154
154
  end
155
155
 
156
- g.desc 'Sets the topic for a private channel.'
157
- g.long_desc %( Sets the topic for a private channel. )
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. )
158
158
  g.command 'setTopic' do |c|
159
159
  c.flag 'channel', desc: 'Private channel to set the topic of.'
160
160
  c.flag 'topic', desc: 'The new topic.'
@@ -163,8 +163,8 @@ command 'groups' do |g|
163
163
  end
164
164
  end
165
165
 
166
- g.desc 'Unarchives a private channel.'
167
- g.long_desc %( Unarchives a private channel. )
166
+ g.desc 'This method unarchives a private channel.'
167
+ g.long_desc %( This method unarchives a private channel. )
168
168
  g.command 'unarchive' do |c|
169
169
  c.flag 'channel', desc: 'Private channel to unarchive.'
170
170
  c.action do |_global_options, options, _args|