slack-ruby-client 0.7.9 → 0.16.0

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,94 +7,110 @@ 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.
           # @see https://api.slack.com/methods/im.close
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.close.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.close.json
           def im_close(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].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]
+            logger.warn('im.close: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.close.')
             post('im.close', options)
           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.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @option options [timestamp] :latest
           #   End of time range of messages to include in results.
           # @option options [timestamp] :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] :unreads
           #   Include unread_count_display in the output?.
           # @see https://api.slack.com/methods/im.history
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.history.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.history.json
           def im_history(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].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]
+            logger.warn('im.history: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.history.')
             post('im.history', options)
           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/dblock/slack-api-ref/blob/master/methods/im/im.list.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.list.json
           def im_list(options = {})
-            post('im.list', options)
+            logger.warn('im.list: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.list, users.conversations.')
+            if block_given?
+              Pagination::Cursor.new(self, :im_list, options).each do |page|
+                yield page
+              end
+            else
+              post('im.list', options)
+            end
           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.
           # @option options [timestamp] :ts
           #   Timestamp of the most recently seen message.
           # @see https://api.slack.com/methods/im.mark
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.mark.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.mark.json
           def im_mark(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].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]
+            logger.warn('im.mark: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.mark.')
             post('im.mark', options)
           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.
+          # @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
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.open.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.open.json
           def im_open(options = {})
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            logger.warn('im.open: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.open.')
             post('im.open', options)
           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.
           # @option options [Object] :thread_ts
           #   Unique identifier of a thread's parent message.
           # @see https://api.slack.com/methods/im.replies
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.replies.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.replies.json
           def im_replies(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :thread_ts missing') if options[:thread_ts].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]
+            logger.warn('im.replies: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.replies.')
             post('im.replies', options)
           end
         end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        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] :team_id
+          #   Specify team_id starts with T in case of Org Token.
+          # @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/slack-ruby/slack-api-ref/blob/master/methods/migration/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
+  end
+end

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,63 +7,75 @@ 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.
           # @see https://api.slack.com/methods/mpim.close
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim/mpim.close.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.close.json
           def mpim_close(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].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]
+            logger.warn('mpim.close: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.close.')
             post('mpim.close', options)
           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.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @option options [timestamp] :latest
           #   End of time range of messages to include in results.
           # @option options [timestamp] :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] :unreads
           #   Include unread_count_display in the output?.
           # @see https://api.slack.com/methods/mpim.history
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim/mpim.history.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.history.json
           def mpim_history(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].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]
+            logger.warn('mpim.history: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.history.')
             post('mpim.history', options)
           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.
           #
+          # @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/mpim.list
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim/mpim.list.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.list.json
           def mpim_list(options = {})
-            post('mpim.list', options)
+            logger.warn('mpim.list: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.list, users.conversations.')
+            if block_given?
+              Pagination::Cursor.new(self, :mpim_list, options).each do |page|
+                yield page
+              end
+            else
+              post('mpim.list', options)
+            end
           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.
+          #   Channel or conversation to set the read cursor for.
           # @option options [timestamp] :ts
-          #   Timestamp of the most recently seen message.
+          #   Unique identifier of message you want marked as most recently seen in this conversation.
           # @see https://api.slack.com/methods/mpim.mark
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim/mpim.mark.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.mark.json
           def mpim_mark(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].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]
+            logger.warn('mpim.mark: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.mark.')
             post('mpim.mark', options)
           end
 
@@ -72,25 +85,27 @@ module Slack
           # @option options [Object] :users
           #   Comma separated lists of users.  The ordering of the users is preserved whenever a MPIM group is returned.
           # @see https://api.slack.com/methods/mpim.open
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim/mpim.open.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.open.json
           def mpim_open(options = {})
             throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
+            logger.warn('mpim.open: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.open.')
             post('mpim.open', options)
           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.
           # @option options [Object] :thread_ts
           #   Unique identifier of a thread's parent message.
           # @see https://api.slack.com/methods/mpim.replies
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim/mpim.replies.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.replies.json
           def mpim_replies(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :thread_ts missing') if options[:thread_ts].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]
+            logger.warn('mpim.replies: This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Alternative methods: conversations.replies.')
             post('mpim.replies', options)
           end
         end

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,8 +7,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 verifier code for an access token.
           #
           # @option options [Object] :client_id
           #   Issued when you created your application.
@@ -17,13 +17,34 @@ module Slack
           #   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. Only valid with a legacy workspace app.
           # @see https://api.slack.com/methods/oauth.access
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/oauth/oauth.access.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/oauth/oauth.access.json
           def oauth_access(options = {})
+            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/slack-ruby/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.access', options)
+            post('oauth.token', options)
           end
         end
       end

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,55 +7,45 @@ 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.
-          # @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/dblock/slack-api-ref/blob/master/methods/pins/pins.add.json
+          # @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?
-            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('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.
           # @see https://api.slack.com/methods/pins.list
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/pins/pins.list.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/pins/pins.list.json
           def pins_list(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].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('pins.list', options)
           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.
-          # @option options [file] :file
-          #   File to un-pin.
-          # @option options [Object] :file_comment
-          #   File comment to un-pin.
           # @option options [Object] :timestamp
           #   Timestamp of the message to un-pin.
           # @see https://api.slack.com/methods/pins.remove
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/pins/pins.remove.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/pins/pins.remove.json
           def pins_remove(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].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('pins.remove', options)
           end
         end