slack-ruby-client 0.9.0 → 0.9.1

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

@@ -6,8 +6,7 @@ module Slack
       module Endpoints
         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,28 @@ module Slack
             throw ArgumentError.new('Required arguments :code missing') if options[:code].nil?
             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/dblock/slack-api-ref/blob/master/methods/oauth/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/web/api/endpoints/pins.rb

@@ -6,8 +6,7 @@ module Slack
       module Endpoints
         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 [channel] :channel
           #   Channel to pin the item in.
@@ -26,7 +25,7 @@ module Slack
           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 +38,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

@@ -6,17 +6,16 @@ module Slack
       module Endpoints
         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 [channel] :channel
+          #   Channel where the message to add reaction to was posted.
           # @option options [file] :file
           #   File to add reaction to.
           # @option options [Object] :file_comment
           #   File comment to add reaction to.
-          # @option options [channel] :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
@@ -28,18 +27,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 [channel] :channel
+          #   Channel where the message to get reactions for was posted.
           # @option options [file] :file
           #   File to get reactions for.
           # @option options [Object] :file_comment
           #   File comment to get reactions for.
-          # @option options [channel] :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/dblock/slack-api-ref/blob/master/methods/reactions/reactions.get.json
           def reactions_get(options = {})
@@ -48,12 +47,12 @@ 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 [user] :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 [user] :user
+          #   Show reactions made by this user. Defaults to the authed user.
           # @see https://api.slack.com/methods/reactions.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions/reactions.list.json
           def reactions_list(options = {})
@@ -62,17 +61,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 [channel] :channel
+          #   Channel where the message to remove reaction from was posted.
           # @option options [file] :file
           #   File to remove reaction from.
           # @option options [Object] :file_comment
           #   File comment to remove reaction from.
-          # @option options [channel] :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

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

@@ -6,7 +6,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 +24,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 +36,7 @@ module Slack
           end
 
           #
-          # This method deletes a reminder.
+          # Deletes a reminder.
           #
           # @option options [Object] :reminder
           #   The ID of the reminder.
@@ -48,7 +48,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 +60,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/dblock/slack-api-ref/blob/master/methods/reminders/reminders.list.json

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

@@ -6,8 +6,12 @@ module Slack
       module Endpoints
         module Rtm
           #
-          # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
+          # Starts a Real Time Messaging session.
           #
+          # @option options [Object] :batch_presence_aware
+          #   Group presence change notices as presence_change_batch events when possible. See batching.
+          # @option options [Object] :presence_sub
+          #   Only deliver presence events when requested by subscription. See presence subscriptions.
           # @see https://api.slack.com/methods/rtm.connect
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/rtm/rtm.connect.json
           def rtm_connect(options = {})
@@ -15,16 +19,20 @@ module Slack
           end
 
           #
-          # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
+          # Starts a Real Time Messaging session.
           #
-          # @option options [Object] :simple_latest
-          #   Return timestamp only for latest message object of each channel (improves performance).
-          # @option options [Object] :no_unreads
-          #   Skip unread counts for each channel (improves performance).
+          # @option options [Object] :batch_presence_aware
+          #   Group presence change notices as presence_change_batch events when possible. See batching.
           # @option options [Object] :mpim_aware
           #   Returns MPIMs to the client in the API response.
           # @option options [Object] :no_latest
           #   Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1.
+          # @option options [Object] :no_unreads
+          #   Skip unread counts for each channel (improves performance).
+          # @option options [Object] :presence_sub
+          #   Only deliver presence events when requested by subscription. See presence subscriptions.
+          # @option options [Object] :simple_latest
+          #   Return timestamp only for latest message object of each channel (improves performance).
           # @see https://api.slack.com/methods/rtm.start
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/rtm/rtm.start.json
           def rtm_start(options = {})

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

@@ -6,16 +6,16 @@ module Slack
       module Endpoints
         module Search
           #
-          # This method allows users and applications to search both messages and files in a single call.
+          # Searches for messages and files matching a query.
           #
           # @option options [Object] :query
           #   Search query. May contains booleans, etc.
+          # @option options [Object] :highlight
+          #   Pass a value of true to enable query highlight markers (see below).
           # @option options [Object] :sort
           #   Return matches sorted by either score or timestamp.
           # @option options [Object] :sort_dir
           #   Change sort direction to ascending (asc) or descending (desc).
-          # @option options [Object] :highlight
-          #   Pass a value of true to enable query highlight markers (see below).
           # @see https://api.slack.com/methods/search.all
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.all.json
           def search_all(options = {})
@@ -24,16 +24,16 @@ module Slack
           end
 
           #
-          # This method returns files matching a search query.
+          # Searches for files matching a query.
           #
           # @option options [Object] :query
           #   Search query. May contain booleans, etc.
+          # @option options [Object] :highlight
+          #   Pass a value of true to enable query highlight markers (see below).
           # @option options [Object] :sort
           #   Return matches sorted by either score or timestamp.
           # @option options [Object] :sort_dir
           #   Change sort direction to ascending (asc) or descending (desc).
-          # @option options [Object] :highlight
-          #   Pass a value of true to enable query highlight markers (see below).
           # @see https://api.slack.com/methods/search.files
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.files.json
           def search_files(options = {})
@@ -42,16 +42,16 @@ module Slack
           end
 
           #
-          # This method returns messages matching a search query.
+          # Searches for messages matching a query.
           #
           # @option options [Object] :query
           #   Search query. May contains booleans, etc.
+          # @option options [Object] :highlight
+          #   Pass a value of true to enable query highlight markers (see below).
           # @option options [Object] :sort
           #   Return matches sorted by either score or timestamp.
           # @option options [Object] :sort_dir
           #   Change sort direction to ascending (asc) or descending (desc).
-          # @option options [Object] :highlight
-          #   Pass a value of true to enable query highlight markers (see below).
           # @see https://api.slack.com/methods/search.messages
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.messages.json
           def search_messages(options = {})

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

@@ -6,15 +6,14 @@ module Slack
       module Endpoints
         module Stars
           #
-          # This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
-          # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
+          # Adds a star to an item.
           #
+          # @option options [channel] :channel
+          #   Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
           # @option options [file] :file
           #   File to add star to.
           # @option options [Object] :file_comment
           #   File comment to add star to.
-          # @option options [channel] :channel
-          #   Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
           # @option options [Object] :timestamp
           #   Timestamp of the message to add star to.
           # @see https://api.slack.com/methods/stars.add
@@ -25,7 +24,7 @@ module Slack
           end
 
           #
-          # This method lists the items starred by the authed user.
+          # Lists stars for a user.
           #
           # @see https://api.slack.com/methods/stars.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars/stars.list.json
@@ -34,15 +33,14 @@ module Slack
           end
 
           #
-          # This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
-          # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
+          # Removes a star from an item.
           #
+          # @option options [channel] :channel
+          #   Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
           # @option options [file] :file
           #   File to remove star from.
           # @option options [Object] :file_comment
           #   File comment to remove star from.
-          # @option options [channel] :channel
-          #   Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
           # @option options [Object] :timestamp
           #   Timestamp of the message to remove star from.
           # @see https://api.slack.com/methods/stars.remove

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Team
           #
-          # This method is used to get the access logs for users on a team.
+          # Gets the access logs for the current team.
           #
           # @option options [Object] :before
           #   End of time range of logs to include in results (inclusive).
@@ -17,8 +17,7 @@ module Slack
           end
 
           #
-          # This method lists billable information for each user on the team. Currently this consists solely of whether the user is
-          # subject to billing per Slack's Fair Billing policy.
+          # Gets billable users information for the current team.
           #
           # @option options [user] :user
           #   A user to retrieve the billable information for. Defaults to all users.
@@ -30,7 +29,7 @@ module Slack
           end
 
           #
-          # This method provides information about your team.
+          # Gets information about the current team.
           #
           # @see https://api.slack.com/methods/team.info
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team/team.info.json
@@ -39,16 +38,16 @@ module Slack
           end
 
           #
-          # This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.
+          # Gets the integration logs for the current team.
           #
-          # @option options [Object] :service_id
-          #   Filter logs to this service. Defaults to all logs.
           # @option options [Object] :app_id
           #   Filter logs to this Slack app. Defaults to all logs.
-          # @option options [user] :user
-          #   Filter logs generated by this user's actions. Defaults to all logs.
           # @option options [Object] :change_type
           #   Filter logs with this change type. Defaults to all logs.
+          # @option options [Object] :service_id
+          #   Filter logs to this service. Defaults to all logs.
+          # @option options [user] :user
+          #   Filter logs generated by this user's actions. Defaults to all logs.
           # @see https://api.slack.com/methods/team.integrationLogs
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team/team.integrationLogs.json
           def team_integrationLogs(options = {})

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module TeamProfile
           #
-          # This method is used to get the profile field definitions for this team.
+          # Retrieve a team's profile.
           #
           # @option options [Object] :visibility
           #   Filter by visibility.

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

@@ -6,16 +6,16 @@ module Slack
       module Endpoints
         module Usergroups
           #
-          # This method is used to create a User Group.
+          # Create a User Group
           #
           # @option options [Object] :name
           #   A name for the User Group. Must be unique among User Groups.
-          # @option options [Object] :handle
-          #   A mention handle. Must be unique among channels, users and User Groups.
-          # @option options [Object] :description
-          #   A short description of the User Group.
           # @option options [Object] :channels
           #   A comma separated string of encoded channel IDs for which the User Group uses as a default.
+          # @option options [Object] :description
+          #   A short description of the User Group.
+          # @option options [Object] :handle
+          #   A mention handle. Must be unique among channels, users and User Groups.
           # @option options [Object] :include_count
           #   Include the number of users in each User Group.
           # @see https://api.slack.com/methods/usergroups.create
@@ -26,7 +26,7 @@ module Slack
           end
 
           #
-          # This method disables an existing User Group.
+          # Disable an existing User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to disable.
@@ -40,7 +40,7 @@ module Slack
           end
 
           #
-          # This method enables a User Group which was previously disabled.
+          # Enable a User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to enable.
@@ -54,12 +54,12 @@ module Slack
           end
 
           #
-          # This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.
+          # List all User Groups for a team
           #
-          # @option options [Object] :include_disabled
-          #   Include disabled User Groups.
           # @option options [Object] :include_count
           #   Include the number of users in each User Group.
+          # @option options [Object] :include_disabled
+          #   Include disabled User Groups.
           # @option options [Object] :include_users
           #   Include the list of users for each User Group.
           # @see https://api.slack.com/methods/usergroups.list
@@ -69,20 +69,20 @@ module Slack
           end
 
           #
-          # This method updates the properties of an existing User Group.
+          # Update an existing User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to update.
-          # @option options [Object] :name
-          #   A name for the User Group. Must be unique among User Groups.
-          # @option options [Object] :handle
-          #   A mention handle. Must be unique among channels, users and User Groups.
-          # @option options [Object] :description
-          #   A short description of the User Group.
           # @option options [Object] :channels
           #   A comma separated string of encoded channel IDs for which the User Group uses as a default.
+          # @option options [Object] :description
+          #   A short description of the User Group.
+          # @option options [Object] :handle
+          #   A mention handle. Must be unique among channels, users and User Groups.
           # @option options [Object] :include_count
           #   Include the number of users in the User Group.
+          # @option options [Object] :name
+          #   A name for the User Group. Must be unique among User Groups.
           # @see https://api.slack.com/methods/usergroups.update
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.update.json
           def usergroups_update(options = {})