slack-ruby-client 0.14.4 → 0.16.0

data/lib/slack/web/api/endpoints/dialog.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 Dialog
           #
-          # Open a dialog with a user by exchanging a trigger_id received from another interaction. See the dialogs documentation to learn how to obtain triggers define form elements.
+          # Open a dialog with a user
           #
           # @option options [Object] :dialog
           #   The dialog definition. This must be a JSON-encoded string.

data/lib/slack/web/api/endpoints/dnd.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 Dnd
           #
-          # Ends the user's currently scheduled Do Not Disturb session immediately.
+          # Ends the current user's Do Not Disturb session immediately.
           #
           # @see https://api.slack.com/methods/dnd.endDnd
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.endDnd.json
@@ -24,7 +25,7 @@ module Slack
           end
 
           #
-          # Provides information about a user's current Do Not Disturb settings.
+          # Retrieves a user's current Do Not Disturb status.
           #
           # @option options [user] :user
           #   User to fetch status for (defaults to current user).
@@ -36,7 +37,7 @@ module Slack
           end
 
           #
-          # Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration.
+          # Turns on Do Not Disturb mode for the current user, or changes its duration.
           #
           # @option options [Object] :num_minutes
           #   Number of minutes, from now, to snooze until.
@@ -48,7 +49,7 @@ module Slack
           end
 
           #
-          # Provides information about the current Do Not Disturb settings for a list of users in a Slack team.
+          # Retrieves the Do Not Disturb status for up to 50 users on a team.
           #
           # @option options [Object] :users
           #   Comma-separated list of users to fetch Do Not Disturb status for.

data/lib/slack/web/api/endpoints/emoji.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 Emoji
           #
-          # This method lists the custom emoji for a team.
+          # Lists custom emoji for a team.
           #
           # @see https://api.slack.com/methods/emoji.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/emoji/emoji.list.json

data/lib/slack/web/api/endpoints/files.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 Files
           #
-          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
+          # Deletes a file.
           #
           # @option options [file] :file
           #   ID of file to delete.
@@ -35,7 +36,7 @@ module Slack
           end
 
           #
-          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
+          # Gets information about a file.
           #
           # @option options [file] :file
           #   Specify a file by providing its ID.
@@ -57,10 +58,14 @@ module Slack
           end
 
           #
-          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
+          # List for a team, in a channel, or from a user with applied filters.
           #
           # @option options [channel] :channel
           #   Filter files appearing in a specific channel, indicated by its ID.
+          # @option options [Object] :show_files_hidden_by_limit
+          #   Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.
+          # @option options [Object] :team_id
+          #   encoded team id to list files in, required if org token is used.
           # @option options [Object] :ts_from
           #   Filter files created after this timestamp (inclusive).
           # @option options [Object] :ts_to
@@ -72,13 +77,13 @@ module Slack
           # @see https://api.slack.com/methods/files.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.list.json
           def files_list(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]
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('files.list', options)
           end
 
           #
-          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
+          # Revokes public/external sharing access for a file
           #
           # @option options [file] :file
           #   File to revoke.
@@ -100,13 +105,13 @@ module Slack
           def files_share(options = {})
             throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             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('The files.share method is undocumented.')
             post('files.share', options)
           end
 
           #
-          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
+          # Enables a file for public/external sharing.
           #
           # @option options [file] :file
           #   File to share.
@@ -118,7 +123,7 @@ module Slack
           end
 
           #
-          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
+          # Uploads or creates a file.
           #
           # @option options [Object] :channels
           #   Comma-separated list of channel names or IDs where the file will be shared.

data/lib/slack/web/api/endpoints/files_comments.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 FilesComments
           #
-          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
+          # Deletes an existing comment on a file.
           #
           # @option options [file] :file
           #   File to delete a comment from.

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module FilesRemote
+          #
+          # Adds a file from a remote service
+          #
+          # @option options [Object] :external_id
+          #   Creator defined GUID for the file.
+          # @option options [Object] :external_url
+          #   URL of the remote file.
+          # @option options [Object] :title
+          #   Title of the file being shared.
+          # @option options [Object] :filetype
+          #   type of file.
+          # @option options [Object] :indexable_file_contents
+          #   A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.
+          # @option options [Object] :preview_image
+          #   Preview of the document via multipart/form-data.
+          # @see https://api.slack.com/methods/files.remote.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.add.json
+          def files_remote_add(options = {})
+            throw ArgumentError.new('Required arguments :external_id missing') if options[:external_id].nil?
+            throw ArgumentError.new('Required arguments :external_url missing') if options[:external_url].nil?
+            throw ArgumentError.new('Required arguments :title missing') if options[:title].nil?
+            post('files.remote.add', options)
+          end
+
+          #
+          # Retrieve information about a remote file added to Slack
+          #
+          # @option options [Object] :external_id
+          #   Creator defined GUID for the file.
+          # @option options [file] :file
+          #   Specify a file by providing its ID.
+          # @see https://api.slack.com/methods/files.remote.info
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.info.json
+          def files_remote_info(options = {})
+            post('files.remote.info', options)
+          end
+
+          #
+          # Retrieve information about a remote file added to Slack
+          #
+          # @option options [channel] :channel
+          #   Filter files appearing in a specific channel, indicated by its ID.
+          # @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.
+          # @option options [Object] :ts_from
+          #   Filter files created after this timestamp (inclusive).
+          # @option options [Object] :ts_to
+          #   Filter files created before this timestamp (inclusive).
+          # @see https://api.slack.com/methods/files.remote.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.list.json
+          def files_remote_list(options = {})
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            if block_given?
+              Pagination::Cursor.new(self, :files_remote_list, options).each do |page|
+                yield page
+              end
+            else
+              post('files.remote.list', options)
+            end
+          end
+
+          #
+          # Remove a remote file.
+          #
+          # @option options [Object] :external_id
+          #   Creator defined GUID for the file.
+          # @option options [file] :file
+          #   Specify a file by providing its ID.
+          # @see https://api.slack.com/methods/files.remote.remove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.remove.json
+          def files_remote_remove(options = {})
+            post('files.remote.remove', options)
+          end
+
+          #
+          # Share a remote file into a channel.
+          #
+          # @option options [Object] :channels
+          #   Comma-separated list of channel IDs where the file will be shared.
+          # @option options [Object] :external_id
+          #   The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack.  Either this field or file or both are required.
+          # @option options [file] :file
+          #   Specify a file registered with Slack by providing its ID. Either this field or external_id or both are required.
+          # @see https://api.slack.com/methods/files.remote.share
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.share.json
+          def files_remote_share(options = {})
+            throw ArgumentError.new('Required arguments :channels missing') if options[:channels].nil?
+            post('files.remote.share', options)
+          end
+
+          #
+          # Updates an existing remote file.
+          #
+          # @option options [Object] :external_id
+          #   Creator defined GUID for the file.
+          # @option options [Object] :external_url
+          #   URL of the remote file.
+          # @option options [file] :file
+          #   Specify a file by providing its ID.
+          # @option options [Object] :filetype
+          #   type of file.
+          # @option options [Object] :indexable_file_contents
+          #   File containing contents that can be used to improve searchability for the remote file.
+          # @option options [Object] :preview_image
+          #   Preview of the document via multipart/form-data.
+          # @option options [Object] :title
+          #   Title of the file being shared.
+          # @see https://api.slack.com/methods/files.remote.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.update.json
+          def files_remote_update(options = {})
+            post('files.remote.update', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Groups
           #
-          # This method archives a private channel.
+          # Archives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to archive.
@@ -15,29 +16,29 @@ module Slack
           def groups_archive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.archive: 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.archive.')
             post('groups.archive', options)
           end
 
           #
-          # This method creates a private channel.
+          # Creates a private channel.
           #
           # @option options [Object] :name
           #   Name of private channel to create.
+          # @option options [Object] :team_id
+          #   encoded team id to create the channel in, required if org token is used.
           # @option options [Object] :validate
           #   Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
           # @see https://api.slack.com/methods/groups.create
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/groups/groups.create.json
           def groups_create(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            logger.warn('groups.create: 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.create.')
             post('groups.create', options)
           end
 
           #
-          # This method takes an existing private channel and performs the following steps:
-          # - Renames the existing private channel (from "example" to "example-archived").
-          # - Archives the existing private channel.
-          # - Creates a new private channel with the name of the existing private channel.
-          # - Adds all members of the existing private channel to the new private channel.
+          # Clones and archives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to clone and archive.
@@ -46,13 +47,12 @@ module Slack
           def groups_createChild(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.createChild: 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: .')
             post('groups.createChild', options)
           end
 
           #
-          # This method returns a portion of messages/events from the specified private channel.
-          # To read the entire history for a private channel, call the method with no latest or
-          # oldest arguments, and then continue paging using the instructions below.
+          # Fetches history of messages and events from a private channel.
           #
           # @option options [group] :channel
           #   Private channel to fetch history for.
@@ -69,11 +69,12 @@ module Slack
           def groups_history(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.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('groups.history', options)
           end
 
           #
-          # Don't use this method. Use conversations.info instead.
+          # Gets information about a private channel.
           #
           # @option options [group] :channel
           #   Private channel to get info on.
@@ -84,11 +85,12 @@ module Slack
           def groups_info(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.info: 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.info.')
             post('groups.info', options)
           end
 
           #
-          # This method is used to invite a user to a private channel. The calling user must be a member of the private channel.
+          # Invites a user to a private channel.
           #
           # @option options [group] :channel
           #   Private channel to invite user to.
@@ -101,11 +103,12 @@ module Slack
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            logger.warn('groups.invite: 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.invite.')
             post('groups.invite', options)
           end
 
           #
-          # This method allows a user to remove another member from a private channel.
+          # Removes a user from a private channel.
           #
           # @option options [group] :channel
           #   Private channel to remove user from.
@@ -118,11 +121,12 @@ module Slack
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            logger.warn('groups.kick: 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.kick.')
             post('groups.kick', options)
           end
 
           #
-          # This method is used to leave a private channel.
+          # Leaves a private channel.
           #
           # @option options [group] :channel
           #   Private channel to leave.
@@ -131,11 +135,12 @@ module Slack
           def groups_leave(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.leave: 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.leave.')
             post('groups.leave', options)
           end
 
           #
-          # Don't use this method. Use conversations.list instead.
+          # Lists private channels that the calling user has access to.
           #
           # @option options [Object] :cursor
           #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
@@ -145,9 +150,12 @@ module Slack
           #   Exclude the members from each group.
           # @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 channels in, required if org token is used.
           # @see https://api.slack.com/methods/groups.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/groups/groups.list.json
           def groups_list(options = {})
+            logger.warn('groups.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, :groups_list, options).each do |page|
                 yield page
@@ -158,23 +166,24 @@ module Slack
           end
 
           #
-          # This method moves the read cursor in a private channel.
+          # Sets the read cursor in a private channel.
           #
           # @option options [group] :channel
-          #   Private channel to set reading cursor in.
+          #   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/groups.mark
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/groups/groups.mark.json
           def groups_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: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.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('groups.mark', options)
           end
 
           #
-          # This method opens a private channel.
+          # Opens a private channel.
           #
           # @option options [group] :channel
           #   Private channel to open.
@@ -183,11 +192,12 @@ module Slack
           def groups_open(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.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: .')
             post('groups.open', options)
           end
 
           #
-          # This method renames a private channel.
+          # Renames a private channel.
           #
           # @option options [group] :channel
           #   Private channel to rename.
@@ -201,11 +211,12 @@ module Slack
             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: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.rename: 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.rename.')
             post('groups.rename', 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 private channel
           #
           # @option options [group] :channel
           #   Private channel to fetch thread from.
@@ -217,11 +228,12 @@ module Slack
             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: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.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('groups.replies', options)
           end
 
           #
-          # This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.
+          # Sets the purpose for a private channel.
           #
           # @option options [group] :channel
           #   Private channel to set the purpose of.
@@ -233,11 +245,12 @@ module Slack
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.setPurpose: 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.setPurpose.')
             post('groups.setPurpose', options)
           end
 
           #
-          # This method is used to change the topic of a private channel. The calling user must be a member of the private channel.
+          # Sets the topic for a private channel.
           #
           # @option options [group] :channel
           #   Private channel to set the topic of.
@@ -249,11 +262,12 @@ module Slack
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.setTopic: 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.setTopic.')
             post('groups.setTopic', options)
           end
 
           #
-          # This method unarchives a private channel.
+          # Unarchives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to unarchive.
@@ -262,6 +276,7 @@ module Slack
           def groups_unarchive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            logger.warn('groups.unarchive: 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.unarchive.')
             post('groups.unarchive', options)
           end
         end