slack-api 1.6.0 → 1.6.1

data/lib/slack/endpoint/groups.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Groups
       #
-      # This method archives a private channel.
+      # Archives a private channel.
       #
       # @option options [Object] :channel
       #   Private channel to archive
@@ -30,7 +30,7 @@ module Slack
       end
 
       #
-      # This method creates a private channel.
+      # Creates a private channel.
       #
       # @option options [Object] :name
       #   Name of private channel to create
@@ -45,7 +45,7 @@ module Slack
       end
 
       #
-      # This method takes an existing private channel and performs the following steps:
+      # Clones and archives a private channel.
       #
       # @option options [Object] :channel
       #   Private channel to clone and archive.
@@ -58,20 +58,18 @@ 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 [Object] :channel
       #   Private channel to fetch history for.
+      # @option options [Object] :count
+      #   Number of messages to return, between 1 and 1000.
+      # @option options [Object] :inclusive
+      #   Include messages with latest or oldest timestamp in results.
       # @option options [Object] :latest
       #   End of time range of messages to include in results.
       # @option options [Object] :oldest
       #   Start of time range of messages to include in results.
-      # @option options [Object] :inclusive
-      #   Include messages with latest or oldest timestamp in results.
-      # @option options [Object] :count
-      #   Number of messages to return, between 1 and 1000.
       # @option options [Object] :unreads
       #   Include unread_count_display in the output?
       # @see https://api.slack.com/methods/groups.history
@@ -83,10 +81,12 @@ module Slack
       end
 
       #
-      # This method returns information about a private channel.
+      # Gets information about a private channel.
       #
       # @option options [Object] :channel
       #   Private channel to get info on
+      # @option options [Object] :include_locale
+      #   Set this to true to receive the locale for this group. Defaults to false
       # @see https://api.slack.com/methods/groups.info
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.info.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.info.json
@@ -96,7 +96,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 [Object] :channel
       #   Private channel to invite user to.
@@ -112,7 +112,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 [Object] :channel
       #   Private channel to remove user from.
@@ -128,7 +128,7 @@ module Slack
       end
 
       #
-      # This method is used to leave a private channel.
+      # Leaves a private channel.
       #
       # @option options [Object] :channel
       #   Private channel to leave
@@ -141,11 +141,12 @@ module Slack
       end
 
       #
-      # This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in.
-      # The list of (non-deactivated) members in each private channel is also returned.
+      # Lists private channels that the calling user has access to.
       #
       # @option options [Object] :exclude_archived
       #   Don't return archived private channels.
+      # @option options [Object] :exclude_members
+      #   Exclude the members from each group
       # @see https://api.slack.com/methods/groups.list
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.list.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.list.json
@@ -154,7 +155,7 @@ module Slack
       end
 
       #
-      # This method moves the read cursor in a private channel.
+      # Sets the read cursor in a private channel.
       #
       # @option options [Object] :channel
       #   Private channel to set reading cursor in.
@@ -170,7 +171,7 @@ module Slack
       end
 
       #
-      # This method opens a private channel.
+      # Opens a private channel.
       #
       # @option options [Object] :channel
       #   Private channel to open.
@@ -183,7 +184,7 @@ module Slack
       end
 
       #
-      # This method renames a private channel.
+      # Renames a private channel.
       #
       # @option options [Object] :channel
       #   Private channel to rename
@@ -201,7 +202,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 [Object] :channel
       #   Private channel to fetch thread from
@@ -217,7 +218,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 [Object] :channel
       #   Private channel to set the purpose of
@@ -233,7 +234,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 [Object] :channel
       #   Private channel to set the topic of
@@ -249,7 +250,7 @@ module Slack
       end
 
       #
-      # This method unarchives a private channel.
+      # Unarchives a private channel.
       #
       # @option options [Object] :channel
       #   Private channel to unarchive

data/lib/slack/endpoint/im.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Im
       #
-      # This method closes a direct message channel.
+      # Close a direct message channel.
       #
       # @option options [Object] :channel
       #   Direct message channel to close.
@@ -17,20 +17,18 @@ 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 [Object] :channel
       #   Direct message channel to fetch history for.
+      # @option options [Object] :count
+      #   Number of messages to return, between 1 and 1000.
+      # @option options [Object] :inclusive
+      #   Include messages with latest or oldest timestamp in results.
       # @option options [Object] :latest
       #   End of time range of messages to include in results.
       # @option options [Object] :oldest
       #   Start of time range of messages to include in results.
-      # @option options [Object] :inclusive
-      #   Include messages with latest or oldest timestamp in results.
-      # @option options [Object] :count
-      #   Number of messages to return, between 1 and 1000.
       # @option options [Object] :unreads
       #   Include unread_count_display in the output?
       # @see https://api.slack.com/methods/im.history
@@ -42,8 +40,12 @@ module Slack
       end
 
       #
-      # This method returns a list of all im channels that the user has.
+      # 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.
+      # @option options [Object] :limit
+      #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
       # @see https://api.slack.com/methods/im.list
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.list.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.list.json
@@ -52,7 +54,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 [Object] :channel
       #   Direct message channel to set reading cursor in.
@@ -68,10 +70,12 @@ module Slack
       end
 
       #
-      # This method opens a direct message channel with another member of your Slack team.
+      # Opens a direct message channel.
       #
       # @option options [Object] :user
       #   User to open a direct message channel with.
+      # @option options [Object] :include_locale
+      #   Set this to true to receive the locale for this im. Defaults to false
       # @option options [Object] :return_im
       #   Boolean, indicates you want the full IM channel definition in the response.
       # @see https://api.slack.com/methods/im.open
@@ -83,7 +87,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 [Object] :channel
       #   Direct message channel to fetch thread from

data/lib/slack/endpoint/migration.rb

@@ -0,0 +1,23 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Migration
+      #
+      # 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
+      # @option options [Object] :to_old
+      #   Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.
+      # @see https://api.slack.com/methods/migration.exchange
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/migration.exchange.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/migration.exchange.json
+      def migration_exchange(options={})
+        throw ArgumentError.new("Required arguments :users missing") if options[:users].nil?
+        post("migration.exchange", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/mpim.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Mpim
       #
-      # This method closes a multiparty direct message channel.
+      # Closes a multiparty direct message channel.
       #
       # @option options [Object] :channel
       #   MPIM to close.
@@ -17,20 +17,18 @@ 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 [Object] :channel
       #   Multiparty direct message to fetch history for.
+      # @option options [Object] :count
+      #   Number of messages to return, between 1 and 1000.
+      # @option options [Object] :inclusive
+      #   Include messages with latest or oldest timestamp in results.
       # @option options [Object] :latest
       #   End of time range of messages to include in results.
       # @option options [Object] :oldest
       #   Start of time range of messages to include in results.
-      # @option options [Object] :inclusive
-      #   Include messages with latest or oldest timestamp in results.
-      # @option options [Object] :count
-      #   Number of messages to return, between 1 and 1000.
       # @option options [Object] :unreads
       #   Include unread_count_display in the output?
       # @see https://api.slack.com/methods/mpim.history
@@ -42,7 +40,7 @@ module Slack
       end
 
       #
-      # This method returns a list of all multiparty direct message channels that the user has.
+      # Lists multiparty direct message channels for the calling user.
       #
       # @see https://api.slack.com/methods/mpim.list
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/mpim.list.md
@@ -52,7 +50,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 [Object] :channel
       #   multiparty direct message channel to set reading cursor in.
@@ -81,7 +79,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 [Object] :channel
       #   Multiparty direct message channel to fetch thread from.

data/lib/slack/endpoint/oauth.rb

@@ -4,8 +4,7 @@ module Slack
   module Endpoint
     module Oauth
       #
-      # This method allows you to exchange a temporary OAuth code for an API access token.
-      # This is used as part of the OAuth authentication flow.
+      # Exchanges a temporary OAuth code for an API token.
       #
       # @option options [Object] :client_id
       #   Issued when you created your application.
@@ -25,6 +24,29 @@ module Slack
         post("oauth.access", options)
       end
 
+      #
+      # Exchanges a temporary OAuth verifier code for a workspace token.
+      #
+      # @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] :code
+      #   The code param returned via the OAuth callback.
+      # @option options [Object] :redirect_uri
+      #   This must match the originally submitted URI (if one was sent).
+      # @option options [Object] :single_channel
+      #   Request the user to add your app only to a single channel.
+      # @see https://api.slack.com/methods/oauth.token
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/oauth.token.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/oauth.token.json
+      def oauth_token(options={})
+        throw ArgumentError.new("Required arguments :client_id missing") if options[:client_id].nil?
+        throw ArgumentError.new("Required arguments :client_secret missing") if options[:client_secret].nil?
+        throw ArgumentError.new("Required arguments :code missing") if options[:code].nil?
+        post("oauth.token", options)
+      end
+
     end
   end
 end

data/lib/slack/endpoint/pins.rb

@@ -4,8 +4,7 @@ module Slack
   module Endpoint
     module Pins
       #
-      # This method pins an item (file, file comment, channel message, or group message) to a particular channel.
-      # The channel argument is required and one of file, file_comment, or timestamp must also be specified.
+      # Pins an item to a channel.
       #
       # @option options [Object] :channel
       #   Channel to pin the item in.
@@ -24,7 +23,7 @@ module Slack
       end
 
       #
-      # This method lists the items pinned to a channel.
+      # Lists items pinned to a channel.
       #
       # @option options [Object] :channel
       #   Channel to get pinned items for.
@@ -37,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 [Object] :channel
       #   Channel where the item is pinned to.

data/lib/slack/endpoint/reactions.rb

@@ -4,17 +4,16 @@ module Slack
   module Endpoint
     module Reactions
       #
-      # This method adds a reaction (emoji) to 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.
+      # Adds a reaction to an item.
       #
       # @option options [Object] :name
       #   Reaction (emoji) name.
+      # @option options [Object] :channel
+      #   Channel where the message to add reaction to was posted.
       # @option options [Object] :file
       #   File to add reaction to.
       # @option options [Object] :file_comment
       #   File comment to add reaction to.
-      # @option options [Object] :channel
-      #   Channel where the message to add reaction to was posted.
       # @option options [Object] :timestamp
       #   Timestamp of the message to add reaction to.
       # @see https://api.slack.com/methods/reactions.add
@@ -26,18 +25,18 @@ module Slack
       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 [Object] :channel
+      #   Channel where the message to get reactions for was posted.
       # @option options [Object] :file
       #   File to get reactions for.
       # @option options [Object] :file_comment
       #   File comment to get reactions for.
-      # @option options [Object] :channel
-      #   Channel where the message to get reactions for was posted.
-      # @option options [Object] :timestamp
-      #   Timestamp of the message to get reactions for.
       # @option options [Object] :full
       #   If true always return the complete reaction list.
+      # @option options [Object] :timestamp
+      #   Timestamp of the message to get reactions for.
       # @see https://api.slack.com/methods/reactions.get
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/reactions.get.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/reactions.get.json
@@ -46,16 +45,16 @@ 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] :user
-      #   Show reactions made by this user. Defaults to the authed user.
-      # @option options [Object] :full
-      #   If true always return the complete reaction list.
       # @option options [Object] :count
       #   Number of items to return per page.
+      # @option options [Object] :full
+      #   If true always return the complete reaction list.
       # @option options [Object] :page
       #   Page number of results to return.
+      # @option options [Object] :user
+      #   Show reactions made by this user. Defaults to the authed user.
       # @see https://api.slack.com/methods/reactions.list
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/reactions.list.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/reactions.list.json
@@ -64,17 +63,16 @@ 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.
+      # @option options [Object] :channel
+      #   Channel where the message to remove reaction from was posted.
       # @option options [Object] :file
       #   File to remove reaction from.
       # @option options [Object] :file_comment
       #   File comment to remove reaction from.
-      # @option options [Object] :channel
-      #   Channel where the message to remove reaction from was posted.
       # @option options [Object] :timestamp
       #   Timestamp of the message to remove reaction from.
       # @see https://api.slack.com/methods/reactions.remove