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
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Api
8
8
  #
9
- # Checks API calling code.
9
+ # This method helps you test your calling code.
10
10
  #
11
11
  # @option options [Object] :error
12
12
  # Error response to return.
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Apps
8
8
  #
9
- # Uninstalls your app from a workspace.
9
+ # This method uninstalls a workspace app. Unlike auth.revoke, which revokes a single token, this method revokes all tokens associated with a single installation of a workspace app.
10
10
  #
11
11
  # @option options [Object] :client_id
12
12
  # Issued when you created your application.
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module AppsPermissions
8
8
  #
9
- # Returns list of permissions this app has on a team.
9
+ # 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.
10
10
  #
11
11
  # @see https://api.slack.com/methods/apps.permissions.info
12
12
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions/apps.permissions.info.json
@@ -15,7 +15,7 @@ module Slack
15
15
  end
16
16
 
17
17
  #
18
- # Allows an app to request additional scopes
18
+ # 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
19
  #
20
20
  # @option options [Object] :scopes
21
21
  # A comma separated list of scopes to request for.
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module AppsPermissionsResources
8
8
  #
9
- # Returns list of resource grants this app has on a team.
9
+ # 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.
10
10
  #
11
11
  # @option options [Object] :cursor
12
12
  # 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.
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module AppsPermissionsScopes
8
8
  #
9
- # Returns list of scopes this app has on a team.
9
+ # 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.
10
10
  #
11
11
  # @see https://api.slack.com/methods/apps.permissions.scopes.list
12
12
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.scopes/apps.permissions.scopes.list.json
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module AppsPermissionsUsers
8
8
  #
9
- # Returns list of user grants and corresponding scopes this app has on a team.
9
+ # 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.
10
10
  #
11
11
  # @option options [Object] :cursor
12
12
  # 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.
@@ -25,7 +25,7 @@ module Slack
25
25
  end
26
26
 
27
27
  #
28
- # Enables an app to trigger a permissions modal to grant an app access to a user access scope.
28
+ # 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.
29
29
  #
30
30
  # @option options [Object] :scopes
31
31
  # A comma separated list of user scopes to request for.
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Auth
8
8
  #
9
- # Revokes a token.
9
+ # This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.
10
10
  #
11
11
  # @option options [Object] :test
12
12
  # Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
@@ -17,7 +17,7 @@ module Slack
17
17
  end
18
18
 
19
19
  #
20
- # Checks authentication & identity.
20
+ # This method checks authentication and tells "you" who you are, even if you might be a bot.
21
21
  #
22
22
  # @see https://api.slack.com/methods/auth.test
23
23
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth/auth.test.json
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Bots
8
8
  #
9
- # Gets information about a bot user.
9
+ # This method returns extended information about a bot user.
10
10
  #
11
11
  # @option options [Object] :bot
12
12
  # Bot user to get info on.
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Channels
8
8
  #
9
- # Archives a channel.
9
+ # This method archives a channel.
10
10
  #
11
11
  # @option options [channel] :channel
12
12
  # Channel to archive.
@@ -19,7 +19,7 @@ module Slack
19
19
  end
20
20
 
21
21
  #
22
- # Creates a channel.
22
+ # This method is used to create a channel.
23
23
  #
24
24
  # @option options [Object] :name
25
25
  # Name of channel to create.
@@ -46,7 +46,7 @@ module Slack
46
46
  end
47
47
 
48
48
  #
49
- # Fetches history of messages and events from a channel.
49
+ # This method returns a portion of message events from the specified public channel.
50
50
  #
51
51
  # @option options [channel] :channel
52
52
  # Channel to fetch history for.
@@ -67,7 +67,7 @@ module Slack
67
67
  end
68
68
 
69
69
  #
70
- # Gets information about a channel.
70
+ # This method returns information about a team channel.
71
71
  #
72
72
  # @option options [channel] :channel
73
73
  # Channel to get info on.
@@ -82,7 +82,7 @@ module Slack
82
82
  end
83
83
 
84
84
  #
85
- # Invites a user to a channel.
85
+ # This method is used to invite a user to a channel. The calling user must be a member of the channel.
86
86
  #
87
87
  # @option options [channel] :channel
88
88
  # Channel to invite user to.
@@ -99,7 +99,8 @@ module Slack
99
99
  end
100
100
 
101
101
  #
102
- # Joins a channel, creating it if needed.
102
+ # This method is used to join a channel. If the channel does not exist, it is
103
+ # created.
103
104
  #
104
105
  # @option options [Object] :name
105
106
  # Name of channel to join.
@@ -113,7 +114,7 @@ module Slack
113
114
  end
114
115
 
115
116
  #
116
- # Removes a user from a channel.
117
+ # This method allows a user to remove another member from a team channel.
117
118
  #
118
119
  # @option options [channel] :channel
119
120
  # Channel to remove user from.
@@ -130,7 +131,7 @@ module Slack
130
131
  end
131
132
 
132
133
  #
133
- # Leaves a channel.
134
+ # This method is used to leave a channel.
134
135
  #
135
136
  # @option options [channel] :channel
136
137
  # Channel to leave.
@@ -143,7 +144,7 @@ module Slack
143
144
  end
144
145
 
145
146
  #
146
- # Lists all channels in a Slack team.
147
+ # Don't use this method. Use conversations.list instead.
147
148
  #
148
149
  # @option options [Object] :cursor
149
150
  # 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.
@@ -166,7 +167,7 @@ module Slack
166
167
  end
167
168
 
168
169
  #
169
- # Sets the read cursor in a channel.
170
+ # This method moves the read cursor in a channel.
170
171
  #
171
172
  # @option options [channel] :channel
172
173
  # Channel to set reading cursor in.
@@ -182,7 +183,7 @@ module Slack
182
183
  end
183
184
 
184
185
  #
185
- # Renames a channel.
186
+ # This method renames a team channel.
186
187
  #
187
188
  # @option options [channel] :channel
188
189
  # Channel to rename.
@@ -200,7 +201,7 @@ module Slack
200
201
  end
201
202
 
202
203
  #
203
- # Retrieve a thread of messages posted to a channel
204
+ # This method returns an entire thread (a message plus all the messages in reply to it).
204
205
  #
205
206
  # @option options [channel] :channel
206
207
  # Channel to fetch thread from.
@@ -216,12 +217,14 @@ module Slack
216
217
  end
217
218
 
218
219
  #
219
- # Sets the purpose for a channel.
220
+ # This method is used to change the purpose of a channel. The calling user must be a member of the channel.
220
221
  #
221
222
  # @option options [channel] :channel
222
223
  # Channel to set the purpose of.
223
224
  # @option options [Object] :purpose
224
225
  # The new purpose.
226
+ # @option options [Object] :name_tagging
227
+ # if it is true, treat this like a message and not an unescaped thing.
225
228
  # @see https://api.slack.com/methods/channels.setPurpose
226
229
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.setPurpose.json
227
230
  def channels_setPurpose(options = {})
@@ -232,7 +235,7 @@ module Slack
232
235
  end
233
236
 
234
237
  #
235
- # Sets the topic for a channel.
238
+ # This method is used to change the topic of a channel. The calling user must be a member of the channel.
236
239
  #
237
240
  # @option options [channel] :channel
238
241
  # Channel to set the topic of.
@@ -248,7 +251,7 @@ module Slack
248
251
  end
249
252
 
250
253
  #
251
- # Unarchives a channel.
254
+ # This method unarchives a channel. The calling user is added to the channel.
252
255
  #
253
256
  # @option options [channel] :channel
254
257
  # Channel to unarchive.
@@ -24,7 +24,7 @@ module Slack
24
24
  end
25
25
 
26
26
  #
27
- # Deletes a message.
27
+ # This method deletes a message from a channel.
28
28
  #
29
29
  # @option options [channel] :channel
30
30
  # Channel containing the message to be deleted.
@@ -42,7 +42,25 @@ module Slack
42
42
  end
43
43
 
44
44
  #
45
- # Retrieve a permalink URL for a specific extant message
45
+ # This method deletes a pending scheduled message before it is sent.
46
+ #
47
+ # @option options [channel] :channel
48
+ # The channel the scheduled_message is posting to.
49
+ # @option options [Object] :scheduled_message_id
50
+ # scheduled_message_id returned from call to chat.scheduleMessage.
51
+ # @option options [Object] :as_user
52
+ # Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.
53
+ # @see https://api.slack.com/methods/chat.deleteScheduledMessage
54
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.deleteScheduledMessage.json
55
+ def chat_deleteScheduledMessage(options = {})
56
+ throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
57
+ throw ArgumentError.new('Required arguments :scheduled_message_id missing') if options[:scheduled_message_id].nil?
58
+ options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
59
+ post('chat.deleteScheduledMessage', options)
60
+ end
61
+
62
+ #
63
+ # Easily exchange a message timestamp and a channel ID for a friendly HTTP-based permalink to that message. Handles message threads and all conversation types.
46
64
  #
47
65
  # @option options [channel] :channel
48
66
  # The ID of the conversation or channel containing the message.
@@ -58,7 +76,7 @@ module Slack
58
76
  end
59
77
 
60
78
  #
61
- # Share a me message into a channel.
79
+ # This method sends a me message to a channel from the calling user.
62
80
  #
63
81
  # @option options [channel] :channel
64
82
  # Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
@@ -73,7 +91,7 @@ module Slack
73
91
  end
74
92
 
75
93
  #
76
- # Sends an ephemeral message to a user in a channel.
94
+ # This method posts an ephemeral message, which is visible only to the assigned user in a specific public channel, private channel, or private conversation.
77
95
  #
78
96
  # @option options [channel] :channel
79
97
  # Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
@@ -92,7 +110,7 @@ module Slack
92
110
  # @option options [Object] :parse
93
111
  # Change how messages are treated. Defaults to none. See below.
94
112
  # @option options [Object] :thread_ts
95
- # Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
113
+ # Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.
96
114
  # @see https://api.slack.com/methods/chat.postEphemeral
97
115
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postEphemeral.json
98
116
  def chat_postEphemeral(options = {})
@@ -116,7 +134,7 @@ module Slack
116
134
  end
117
135
 
118
136
  #
119
- # Sends a message to a channel.
137
+ # This method posts a message to a public channel, private channel, or direct message/IM channel.
120
138
  #
121
139
  # @option options [channel] :channel
122
140
  # Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
@@ -169,14 +187,50 @@ module Slack
169
187
  end
170
188
 
171
189
  #
172
- # Provide custom unfurl behavior for user-posted URLs
190
+ # This method schedules a message for delivery to a public channel, private channel, or direct message/IM channel at a specified time in the future.
191
+ #
192
+ # @option options [channel] :channel
193
+ # Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.
194
+ # @option options [Object] :post_at
195
+ # Unix EPOCH timestamp of time in future to send the message.
196
+ # @option options [Object] :text
197
+ # Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead. Provide no more than 40,000 characters or risk truncation.
198
+ # @option options [Object] :as_user
199
+ # Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
200
+ # @option options [Object] :attachments
201
+ # A JSON-based array of structured attachments, presented as a URL-encoded string.
202
+ # @option options [Object] :blocks
203
+ # A JSON-based array of structured blocks, presented as a URL-encoded string.
204
+ # @option options [Object] :link_names
205
+ # Find and link channel names and usernames.
206
+ # @option options [Object] :parse
207
+ # Change how messages are treated. Defaults to none. See below.
208
+ # @option options [Object] :reply_broadcast
209
+ # Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
210
+ # @option options [Object] :thread_ts
211
+ # Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
212
+ # @option options [Object] :unfurl_links
213
+ # Pass true to enable unfurling of primarily text-based content.
214
+ # @option options [Object] :unfurl_media
215
+ # Pass false to disable unfurling of media content.
216
+ # @see https://api.slack.com/methods/chat.scheduleMessage
217
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.scheduleMessage.json
218
+ def chat_scheduleMessage(options = {})
219
+ throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
220
+ throw ArgumentError.new('Required arguments :post_at missing') if options[:post_at].nil?
221
+ throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
222
+ post('chat.scheduleMessage', options)
223
+ end
224
+
225
+ #
226
+ # This method attaches Slack app unfurl behavior to a specified and relevant message. A user token is required as this method does not support bot user tokens.
173
227
  #
174
228
  # @option options [channel] :channel
175
229
  # Channel ID of the message.
176
230
  # @option options [timestamp] :ts
177
231
  # Timestamp of the message to add unfurl behavior to.
178
232
  # @option options [Object] :unfurls
179
- # URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl message attachments.
233
+ # URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.
180
234
  # @option options [Object] :user_auth_message
181
235
  # Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.
182
236
  # @option options [Object] :user_auth_required
@@ -194,7 +248,7 @@ module Slack
194
248
  end
195
249
 
196
250
  #
197
- # Updates a message.
251
+ # This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently.
198
252
  #
199
253
  # @option options [channel] :channel
200
254
  # Channel containing the message to be updated.
@@ -0,0 +1,37 @@
1
+ # This file was auto-generated by lib/tasks/web.rake
2
+
3
+ module Slack
4
+ module Web
5
+ module Api
6
+ module Endpoints
7
+ module ChatScheduledmessages
8
+ #
9
+ # This method returns a list of pending scheduled messages.
10
+ #
11
+ # @option options [channel] :channel
12
+ # The channel of the scheduled messages.
13
+ # @option options [Object] :cursor
14
+ # 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.
15
+ # @option options [timestamp] :latest
16
+ # A UNIX timestamp of the latest value in the time range.
17
+ # @option options [Object] :limit
18
+ # Maximum number of original entries to return.
19
+ # @option options [timestamp] :oldest
20
+ # A UNIX timestamp of the oldest value in the time range.
21
+ # @see https://api.slack.com/methods/chat.scheduledMessages.list
22
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat.scheduledMessages/chat.scheduledMessages.list.json
23
+ def chat_scheduledMessages_list(options = {})
24
+ options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
25
+ if block_given?
26
+ Pagination::Cursor.new(self, :chat_scheduledMessages_list, options).each do |page|
27
+ yield page
28
+ end
29
+ else
30
+ post('chat.scheduledMessages.list', options)
31
+ end
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
@@ -6,7 +6,7 @@ module Slack
6
6
  module Endpoints
7
7
  module Conversations
8
8
  #
9
- # Archives a conversation.
9
+ # 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.
10
10
  #
11
11
  # @option options [channel] :channel
12
12
  # ID of conversation to archive.
@@ -19,7 +19,7 @@ module Slack
19
19
  end
20
20
 
21
21
  #
22
- # Closes a direct message or multi-person direct message.
22
+ # 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.
23
23
  #
24
24
  # @option options [channel] :channel
25
25
  # Conversation to close.
@@ -32,7 +32,7 @@ module Slack
32
32
  end
33
33
 
34
34
  #
35
- # Initiates a public or private channel-based conversation
35
+ # 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
  #
37
37
  # @option options [Object] :name
38
38
  # Name of the public or private channel to create.
@@ -48,7 +48,7 @@ module Slack
48
48
  end
49
49
 
50
50
  #
51
- # Fetches a conversation's history of messages and events.
51
+ # 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.
52
52
  #
53
53
  # @option options [channel] :channel
54
54
  # Conversation ID to fetch history for.
@@ -77,7 +77,7 @@ module Slack
77
77
  end
78
78
 
79
79
  #
80
- # Retrieve information about a conversation.
80
+ # 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.
81
81
  #
82
82
  # @option options [channel] :channel
83
83
  # Conversation ID to learn more about.
@@ -94,7 +94,7 @@ module Slack
94
94
  end
95
95
 
96
96
  #
97
- # Invites users to a channel.
97
+ # 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
98
  #
99
99
  # @option options [channel] :channel
100
100
  # The ID of the public or private channel to invite user(s) to.
@@ -110,7 +110,7 @@ module Slack
110
110
  end
111
111
 
112
112
  #
113
- # Joins an existing conversation.
113
+ # 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.
114
114
  #
115
115
  # @option options [channel] :channel
116
116
  # ID of conversation to join.
@@ -123,7 +123,7 @@ module Slack
123
123
  end
124
124
 
125
125
  #
126
- # Removes a user from a conversation.
126
+ # 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.
127
127
  #
128
128
  # @option options [channel] :channel
129
129
  # ID of conversation to remove user from.
@@ -140,7 +140,7 @@ module Slack
140
140
  end
141
141
 
142
142
  #
143
- # Leaves a conversation.
143
+ # 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.
144
144
  #
145
145
  # @option options [channel] :channel
146
146
  # Conversation to leave.
@@ -153,7 +153,7 @@ module Slack
153
153
  end
154
154
 
155
155
  #
156
- # Lists all channels in a Slack team.
156
+ # 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
157
  #
158
158
  # @option options [Object] :cursor
159
159
  # 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.
@@ -176,7 +176,7 @@ module Slack
176
176
  end
177
177
 
178
178
  #
179
- # Retrieve members of a conversation.
179
+ # 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.
180
180
  #
181
181
  # @option options [channel] :channel
182
182
  # ID of the conversation to retrieve members for.
@@ -199,7 +199,7 @@ module Slack
199
199
  end
200
200
 
201
201
  #
202
- # Opens or resumes a direct message or multi-person direct message.
202
+ # 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.
203
203
  #
204
204
  # @option options [channel] :channel
205
205
  # Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.
@@ -215,7 +215,7 @@ module Slack
215
215
  end
216
216
 
217
217
  #
218
- # Renames a conversation.
218
+ # 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.
219
219
  #
220
220
  # @option options [channel] :channel
221
221
  # ID of conversation to rename.
@@ -231,7 +231,7 @@ module Slack
231
231
  end
232
232
 
233
233
  #
234
- # Retrieve a thread of messages posted to a conversation
234
+ # 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.
235
235
  #
236
236
  # @option options [channel] :channel
237
237
  # Conversation ID to fetch thread from.
@@ -263,7 +263,7 @@ module Slack
263
263
  end
264
264
 
265
265
  #
266
- # Sets the purpose for a conversation.
266
+ # 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.
267
267
  #
268
268
  # @option options [channel] :channel
269
269
  # Conversation to set the purpose of.
@@ -279,7 +279,7 @@ module Slack
279
279
  end
280
280
 
281
281
  #
282
- # Sets the topic for a conversation.
282
+ # 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.
283
283
  #
284
284
  # @option options [channel] :channel
285
285
  # Conversation to set the topic of.
@@ -295,7 +295,7 @@ module Slack
295
295
  end
296
296
 
297
297
  #
298
- # Reverses conversation archival.
298
+ # 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.
299
299
  #
300
300
  # @option options [channel] :channel
301
301
  # ID of conversation to unarchive.