slack-ruby-client 0.7.9 → 0.16.0

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

@@ -11,7 +11,7 @@ module Slack
           # @option options [Object] :presence
           #   Either `active` or `away`.
           # @see https://api.slack.com/methods/presence.set
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/presence.set.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/presence.set.json
           def presence_set(options = {})
             throw ArgumentError.new('Required arguments :presence missing') if options[:presence].nil?
             post('presence.set', options)

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,80 +7,88 @@ 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 [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] :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/dblock/slack-api-ref/blob/master/methods/reactions/reactions.add.json
+          # @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?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            throw ArgumentError.new('Required arguments :timestamp missing') if options[:timestamp].nil?
+            options = options.merge(channel: conversations_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.
           # @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
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.get.json
           def reactions_get(options = {})
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('reactions.get', options)
           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] :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.
           # @option options [Object] :full
           #   If true always return the complete reaction list.
+          # @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 list hasn't been reached.
+          # @option options [Object] :team_id
+          #   encoded team id to list reactions in, required if org token is used.
+          # @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
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.list.json
           def reactions_list(options = {})
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
-            post('reactions.list', options)
+            if block_given?
+              Pagination::Cursor.new(self, :reactions_list, options).each do |page|
+                yield page
+              end
+            else
+              post('reactions.list', options)
+            end
           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
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions/reactions.remove.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.remove.json
           def reactions_remove(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('reactions.remove', options)
           end
         end

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.
@@ -15,7 +16,7 @@ module Slack
           # @option options [user] :user
           #   The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.
           # @see https://api.slack.com/methods/reminders.add
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.add.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.add.json
           def reminders_add(options = {})
             throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
             throw ArgumentError.new('Required arguments :time missing') if options[:time].nil?
@@ -24,46 +25,46 @@ 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.
           # @see https://api.slack.com/methods/reminders.complete
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.complete.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.complete.json
           def reminders_complete(options = {})
             throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil?
             post('reminders.complete', options)
           end
 
           #
-          # This method deletes a reminder.
+          # Deletes a reminder.
           #
           # @option options [Object] :reminder
           #   The ID of the reminder.
           # @see https://api.slack.com/methods/reminders.delete
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.delete.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.delete.json
           def reminders_delete(options = {})
             throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil?
             post('reminders.delete', options)
           end
 
           #
-          # This method returns information about a reminder.
+          # Gets information about a reminder.
           #
           # @option options [Object] :reminder
           #   The ID of the reminder.
           # @see https://api.slack.com/methods/reminders.info
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.info.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.info.json
           def reminders_info(options = {})
             throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil?
             post('reminders.info', options)
           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
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.list.json
           def reminders_list(options = {})
             post('reminders.list', options)
           end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,17 +7,37 @@ module Slack
       module Endpoints
         module Rtm
           #
-          # This method starts a Real Time Messaging API session. Refer to the
-          # RTM API documentation for full details on how to use the RTM API.
+          # 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
+          #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
+          # @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/slack-ruby/slack-api-ref/blob/master/methods/rtm/rtm.connect.json
+          def rtm_connect(options = {})
+            post('rtm.connect', options)
+          end
+
+          #
+          # Starts a Real Time Messaging session.
+          #
+          # @option options [Object] :batch_presence_aware
+          #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
+          # @option options [Object] :include_locale
+          #   Set this to true to receive the locale for users and channels. Defaults to false.
           # @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
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/rtm/rtm.start.json
           def rtm_start(options = {})
             post('rtm.start', options)
           end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,54 +7,60 @@ 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 1 to enable query highlight markers (see below).
+          # @option options [Object] :team_id
+          #   encoded team id to search in, required if org token is used.
           # @see https://api.slack.com/methods/search.all
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.all.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/search/search.all.json
           def search_all(options = {})
             throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
             post('search.all', options)
           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.
+          #   Search query.
+          # @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 1 to enable query highlight markers (see below).
+          # @option options [Object] :team_id
+          #   encoded team id to search in, required if org token is used.
           # @see https://api.slack.com/methods/search.files
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.files.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/search/search.files.json
           def search_files(options = {})
             throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
             post('search.files', options)
           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.
+          #   Search query.
+          # @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 1 to enable query highlight markers (see below).
+          # @option options [Object] :team_id
+          #   encoded team id to search in, required if org token is used.
           # @see https://api.slack.com/methods/search.messages
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.messages.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/search/search.messages.json
           def search_messages(options = {})
             throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
             post('search.messages', options)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,49 +7,57 @@ 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
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars/stars.add.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.add.json
           def stars_add(options = {})
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('stars.add', options)
           end
 
           #
-          # This method lists the items starred by the authed user.
+          # Lists stars for 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.
+          # @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 list hasn't been reached.
           # @see https://api.slack.com/methods/stars.list
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars/stars.list.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.list.json
           def stars_list(options = {})
-            post('stars.list', options)
+            if block_given?
+              Pagination::Cursor.new(self, :stars_list, options).each do |page|
+                yield page
+              end
+            else
+              post('stars.list', options)
+            end
           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
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars/stars.remove.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.remove.json
           def stars_remove(options = {})
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('stars.remove', options)
           end
         end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,51 +7,58 @@ 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).
+          # @option options [Object] :team_id
+          #   encoded team id to get logs from, required if org token is used.
           # @see https://api.slack.com/methods/team.accessLogs
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team/team.accessLogs.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.accessLogs.json
           def team_accessLogs(options = {})
             post('team.accessLogs', options)
           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 [Object] :team_id
+          #   encoded team id to get the billable information from, required if org token is used.
           # @option options [user] :user
           #   A user to retrieve the billable information for. Defaults to all users.
           # @see https://api.slack.com/methods/team.billableInfo
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team/team.billableInfo.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.billableInfo.json
           def team_billableInfo(options = {})
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('team.billableInfo', options)
           end
 
           #
-          # This method provides information about your team.
+          # Gets information about the current team.
           #
+          # @option options [Object] :team
+          #   Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels.
           # @see https://api.slack.com/methods/team.info
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team/team.info.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.info.json
           def team_info(options = {})
             post('team.info', options)
           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 [Object] :team_id
+          #   encoded team id to get logs from, required if org token is used.
+          # @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
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.integrationLogs.json
           def team_integrationLogs(options = {})
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('team.integrationLogs', options)