slack-ruby-client 0.14.4 → 0.14.5

data/lib/slack/web/api/endpoints/groups.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Groups
           #
-          # This method archives a private channel.
+          # Archives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to archive.
@@ -19,7 +20,7 @@ module Slack
           end
 
           #
-          # This method creates a private channel.
+          # Creates a private channel.
           #
           # @option options [Object] :name
           #   Name of private channel to create.
@@ -33,11 +34,7 @@ module Slack
           end
 
           #
-          # This method takes an existing private channel and performs the following steps:
-          # - Renames the existing private channel (from "example" to "example-archived").
-          # - Archives the existing private channel.
-          # - Creates a new private channel with the name of the existing private channel.
-          # - Adds all members of the existing private channel to the new private channel.
+          # Clones and archives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to clone and archive.
@@ -50,9 +47,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Fetches history of messages and events from a private channel.
           #
           # @option options [group] :channel
           #   Private channel to fetch history for.
@@ -73,7 +68,7 @@ module Slack
           end
 
           #
-          # Don't use this method. Use conversations.info instead.
+          # Gets information about a private channel.
           #
           # @option options [group] :channel
           #   Private channel to get info on.
@@ -88,7 +83,7 @@ module Slack
           end
 
           #
-          # This method is used to invite a user to a private channel. The calling user must be a member of the private channel.
+          # Invites a user to a private channel.
           #
           # @option options [group] :channel
           #   Private channel to invite user to.
@@ -105,7 +100,7 @@ module Slack
           end
 
           #
-          # This method allows a user to remove another member from a private channel.
+          # Removes a user from a private channel.
           #
           # @option options [group] :channel
           #   Private channel to remove user from.
@@ -122,7 +117,7 @@ module Slack
           end
 
           #
-          # This method is used to leave a private channel.
+          # Leaves a private channel.
           #
           # @option options [group] :channel
           #   Private channel to leave.
@@ -135,7 +130,7 @@ module Slack
           end
 
           #
-          # Don't use this method. Use conversations.list instead.
+          # Lists private channels that the calling user has access to.
           #
           # @option options [Object] :cursor
           #   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.
@@ -158,7 +153,7 @@ module Slack
           end
 
           #
-          # This method moves the read cursor in a private channel.
+          # Sets the read cursor in a private channel.
           #
           # @option options [group] :channel
           #   Private channel to set reading cursor in.
@@ -174,7 +169,7 @@ module Slack
           end
 
           #
-          # This method opens a private channel.
+          # Opens a private channel.
           #
           # @option options [group] :channel
           #   Private channel to open.
@@ -187,7 +182,7 @@ module Slack
           end
 
           #
-          # This method renames a private channel.
+          # Renames a private channel.
           #
           # @option options [group] :channel
           #   Private channel to rename.
@@ -205,7 +200,7 @@ module Slack
           end
 
           #
-          # This method returns an entire thread (a message plus all the messages in reply to it).
+          # Retrieve a thread of messages posted to a private channel
           #
           # @option options [group] :channel
           #   Private channel to fetch thread from.
@@ -221,7 +216,7 @@ module Slack
           end
 
           #
-          # This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.
+          # Sets the purpose for a private channel.
           #
           # @option options [group] :channel
           #   Private channel to set the purpose of.
@@ -237,7 +232,7 @@ module Slack
           end
 
           #
-          # This method is used to change the topic of a private channel. The calling user must be a member of the private channel.
+          # Sets the topic for a private channel.
           #
           # @option options [group] :channel
           #   Private channel to set the topic of.
@@ -253,7 +248,7 @@ module Slack
           end
 
           #
-          # This method unarchives a private channel.
+          # Unarchives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to unarchive.

data/lib/slack/web/api/endpoints/im.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Im
           #
-          # This method closes a direct message channel.
+          # Close a direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to close.
@@ -19,9 +20,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Fetches history of messages and events from direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to fetch history for.
@@ -42,7 +41,7 @@ module Slack
           end
 
           #
-          # Don't use this method. Use conversations.list instead.
+          # Lists direct message channels for the calling user.
           #
           # @option options [Object] :cursor
           #   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.
@@ -61,7 +60,7 @@ module Slack
           end
 
           #
-          # This method moves the read cursor in a direct message channel.
+          # Sets the read cursor in a direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to set reading cursor in.
@@ -77,7 +76,7 @@ module Slack
           end
 
           #
-          # This method opens a direct message channel with another member of your Slack team.
+          # Opens a direct message channel.
           #
           # @option options [user] :user
           #   User to open a direct message channel with.
@@ -94,7 +93,7 @@ module Slack
           end
 
           #
-          # This method returns an entire thread (a message plus all the messages in reply to it).
+          # Retrieve a thread of messages posted to a direct message conversation
           #
           # @option options [im] :channel
           #   Direct message channel to fetch thread from.

data/lib/slack/web/api/endpoints/migration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Migration
           #
-          # Easily convert your vintage user IDs to Enterprise Grid-friendly global user IDs.
+          # For Enterprise Grid workspaces, map local user IDs to global user IDs
           #
           # @option options [Object] :users
           #   A comma-separated list of user ids, up to 400 per request.

data/lib/slack/web/api/endpoints/mpim.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Mpim
           #
-          # This method closes a multiparty direct message channel.
+          # Closes a multiparty direct message channel.
           #
           # @option options [channel] :channel
           #   MPIM to close.
@@ -19,9 +20,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Fetches history of messages and events from a multiparty direct message.
           #
           # @option options [channel] :channel
           #   Multiparty direct message to fetch history for.
@@ -42,7 +41,7 @@ module Slack
           end
 
           #
-          # Don't use this method. Use conversations.list instead.
+          # Lists multiparty direct message channels for the calling user.
           #
           # @option options [Object] :cursor
           #   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.
@@ -61,7 +60,7 @@ module Slack
           end
 
           #
-          # This method moves the read cursor in a multiparty direct message channel.
+          # Sets the read cursor in a multiparty direct message channel.
           #
           # @option options [channel] :channel
           #   multiparty direct message channel to set reading cursor in.
@@ -89,7 +88,7 @@ module Slack
           end
 
           #
-          # This method returns an entire thread (a message plus all the messages in reply to it).
+          # Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.
           #
           # @option options [channel] :channel
           #   Multiparty direct message channel to fetch thread from.

data/lib/slack/web/api/endpoints/oauth.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Oauth
           #
-          # This method allows you to exchange a temporary OAuth code for an API access token.
+          # Exchanges a temporary OAuth verifier code for an access token.
           #
           # @option options [Object] :client_id
           #   Issued when you created your application.
@@ -28,7 +29,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Exchanges a temporary OAuth verifier code for a workspace token.
           #
           # @option options [Object] :client_id
           #   Issued when you created your application.

data/lib/slack/web/api/endpoints/oauth_v2.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module OauthV2
+          #
+          # Exchanges a temporary OAuth verifier code for an access token.
+          #
+          # @option options [Object] :code
+          #   The code param returned via the OAuth callback.
+          # @option options [Object] :client_id
+          #   Issued when you created your application.
+          # @option options [Object] :client_secret
+          #   Issued when you created your application.
+          # @option options [Object] :redirect_uri
+          #   This must match the originally submitted URI (if one was sent).
+          # @see https://api.slack.com/methods/oauth.v2.access
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/oauth.v2/oauth.v2.access.json
+          def oauth_v2_access(options = {})
+            throw ArgumentError.new('Required arguments :code missing') if options[:code].nil?
+            post('oauth.v2.access', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/pins.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,27 +7,23 @@ module Slack
       module Endpoints
         module Pins
           #
-          # This method pins a channel message or group message to a particular channel.
-          # The channel argument is required and timestamp must also be specified.
+          # Pins an item to a channel.
           #
           # @option options [channel] :channel
           #   Channel to pin the item in.
-          # @option options [file] :file
-          #   File to pin.
-          # @option options [Object] :file_comment
-          #   File comment to pin.
           # @option options [Object] :timestamp
           #   Timestamp of the message to pin.
           # @see https://api.slack.com/methods/pins.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/pins/pins.add.json
           def pins_add(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :timestamp missing') if options[:timestamp].nil?
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('pins.add', options)
           end
 
           #
-          # This method lists the items pinned to a channel.
+          # Lists items pinned to a channel.
           #
           # @option options [channel] :channel
           #   Channel to get pinned items for.
@@ -39,8 +36,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Un-pins an item from a channel.
           #
           # @option options [channel] :channel
           #   Channel where the item is pinned to.

data/lib/slack/web/api/endpoints/reactions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,29 +7,26 @@ module Slack
       module Endpoints
         module Reactions
           #
-          # 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.
+          # Adds a reaction to an item.
           #
-          # @option options [Object] :name
-          #   Reaction (emoji) name.
           # @option options [channel] :channel
           #   Channel where the message to add reaction to was posted.
-          # @option options [file] :file
-          #   File to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead.
-          # @option options [Object] :file_comment
-          #   File comment to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead.
+          # @option options [Object] :name
+          #   Reaction (emoji) name.
           # @option options [Object] :timestamp
           #   Timestamp of the message to add reaction to.
           # @see https://api.slack.com/methods/reactions.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.add.json
           def reactions_add(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            throw ArgumentError.new('Required arguments :timestamp missing') if options[:timestamp].nil?
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('reactions.add', options)
           end
 
           #
-          # This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).
+          # Gets reactions for an item.
           #
           # @option options [channel] :channel
           #   Channel where the message to get reactions for was posted.
@@ -48,7 +46,7 @@ module Slack
           end
 
           #
-          # This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.
+          # Lists reactions made by a user.
           #
           # @option options [Object] :cursor
           #   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.
@@ -72,8 +70,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Removes a reaction from an item.
           #
           # @option options [Object] :name
           #   Reaction (emoji) name.

data/lib/slack/web/api/endpoints/reminders.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Reminders
           #
-          # This method creates a reminder.
+          # Creates a reminder.
           #
           # @option options [Object] :text
           #   The content of the reminder.
@@ -24,7 +25,7 @@ module Slack
           end
 
           #
-          # This method completes a reminder.
+          # Marks a reminder as complete.
           #
           # @option options [Object] :reminder
           #   The ID of the reminder to be marked as complete.
@@ -36,7 +37,7 @@ module Slack
           end
 
           #
-          # This method deletes a reminder.
+          # Deletes a reminder.
           #
           # @option options [Object] :reminder
           #   The ID of the reminder.
@@ -48,7 +49,7 @@ module Slack
           end
 
           #
-          # This method returns information about a reminder.
+          # Gets information about a reminder.
           #
           # @option options [Object] :reminder
           #   The ID of the reminder.
@@ -60,7 +61,7 @@ module Slack
           end
 
           #
-          # This method lists all reminders created by or for a given user.
+          # Lists all reminders created by or for a given user.
           #
           # @see https://api.slack.com/methods/reminders.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.list.json