slack-ruby-client 0.14.3 → 0.15.1

data/lib/slack/web/api/endpoints/admin_users_session.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 AdminUsersSession
           #
-          # This method wipes a user session, leaving the user unauthenticated. The user's Slack client will reset its local cache.
+          # Wipes all valid sessions on all devices for a given user
           #
           # @option options [Object] :user_id
           #   The ID of the user to wipe sessions for.

data/lib/slack/web/api/endpoints/api.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 Api
           #
-          # This method helps you test your calling code.
+          # Checks API calling code.
           #
           # @option options [Object] :error
           #   Error response to return.

data/lib/slack/web/api/endpoints/apps.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 Apps
           #
-          # This method uninstalls an app. Unlike auth.revoke, which revokes a single token, this method revokes all tokens associated with a single installation of an app.
+          # Uninstalls your app from a workspace.
           #
           # @option options [Object] :client_id
           #   Issued when you created your application.

data/lib/slack/web/api/endpoints/apps_permissions.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 AppsPermissions
           #
-          # This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.
+          # Returns list of permissions this app has on a team.
           #
           # @see https://api.slack.com/methods/apps.permissions.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions/apps.permissions.info.json
@@ -15,7 +16,7 @@ module Slack
           end
 
           #
-          # This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.
+          # Allows an app to request additional scopes
           #
           # @option options [Object] :scopes
           #   A comma separated list of scopes to request for.

data/lib/slack/web/api/endpoints/apps_permissions_resources.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 AppsPermissionsResources
           #
-          # This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.
+          # Returns list of resource grants this app has on a team.
           #
           # @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.

data/lib/slack/web/api/endpoints/apps_permissions_scopes.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 AppsPermissionsScopes
           #
-          # This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.
+          # Returns list of scopes this app has on a team.
           #
           # @see https://api.slack.com/methods/apps.permissions.scopes.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.scopes/apps.permissions.scopes.list.json

data/lib/slack/web/api/endpoints/apps_permissions_users.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 AppsPermissionsUsers
           #
-          # This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.
+          # Returns list of user grants and corresponding scopes this app has on a team.
           #
           # @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.
@@ -25,7 +26,7 @@ module Slack
           end
 
           #
-          # This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.
+          # Enables an app to trigger a permissions modal to grant an app access to a user access scope.
           #
           # @option options [Object] :scopes
           #   A comma separated list of user scopes to request for.

data/lib/slack/web/api/endpoints/auth.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 Auth
           #
-          # This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.
+          # Revokes a token.
           #
           # @option options [Object] :test
           #   Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
@@ -17,7 +18,7 @@ module Slack
           end
 
           #
-          # This method checks authentication and tells "you" who you are, even if you might be a bot.
+          # Checks authentication & identity.
           #
           # @see https://api.slack.com/methods/auth.test
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth/auth.test.json

data/lib/slack/web/api/endpoints/bots.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 Bots
           #
-          # This method returns extended information about a bot user.
+          # Gets information about a bot user.
           #
           # @option options [Object] :bot
           #   Bot user to get info on.

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Calls
+          #
+          # Registers a new Call.
+          #
+          # @option options [Object] :external_unique_id
+          #   An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
+          # @option options [Object] :join_url
+          #   The URL required for a client to join the Call.
+          # @option options [Object] :created_by
+          #   The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.
+          # @option options [Object] :date_start
+          #   Call start time in UTC UNIX timestamp format.
+          # @option options [Object] :desktop_app_join_url
+          #   When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
+          # @option options [Object] :external_display_id
+          #   An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
+          # @option options [Object] :title
+          #   The name of the Call.
+          # @option options [Object] :users
+          #   The list of users to register as participants in the Call. Read more on how to specify users here.
+          # @see https://api.slack.com/methods/calls.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.add.json
+          def calls_add(options = {})
+            throw ArgumentError.new('Required arguments :external_unique_id missing') if options[:external_unique_id].nil?
+            throw ArgumentError.new('Required arguments :join_url missing') if options[:join_url].nil?
+            post('calls.add', options)
+          end
+
+          #
+          # Ends a Call.
+          #
+          # @option options [Object] :id
+          #   id returned when registering the call using the calls.add method.
+          # @option options [Object] :duration
+          #   Call duration in seconds.
+          # @see https://api.slack.com/methods/calls.end
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.end.json
+          def calls_end(options = {})
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            post('calls.end', options)
+          end
+
+          #
+          # Returns information about a Call.
+          #
+          # @option options [Object] :id
+          #   id of the Call returned by the calls.add method.
+          # @see https://api.slack.com/methods/calls.info
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.info.json
+          def calls_info(options = {})
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            post('calls.info', options)
+          end
+
+          #
+          # Updates information about a Call.
+          #
+          # @option options [Object] :id
+          #   id returned by the calls.add method.
+          # @option options [Object] :desktop_app_join_url
+          #   When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
+          # @option options [Object] :join_url
+          #   The URL required for a client to join the Call.
+          # @option options [Object] :title
+          #   The name of the Call.
+          # @see https://api.slack.com/methods/calls.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.update.json
+          def calls_update(options = {})
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            post('calls.update', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module CallsParticipants
+          #
+          # Registers new participants added to a Call.
+          #
+          # @option options [Object] :id
+          #   id returned by the calls.add method.
+          # @option options [Object] :users
+          #   The list of users to add as participants in the Call. Read more on how to specify users here.
+          # @see https://api.slack.com/methods/calls.participants.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls.participants/calls.participants.add.json
+          def calls_participants_add(options = {})
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
+            post('calls.participants.add', options)
+          end
+
+          #
+          # Registers participants removed from a Call.
+          #
+          # @option options [Object] :id
+          #   id returned by the calls.add method.
+          # @option options [Object] :users
+          #   The list of users to remove as participants in the Call. Read more on how to specify users here.
+          # @see https://api.slack.com/methods/calls.participants.remove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/calls.participants/calls.participants.remove.json
+          def calls_participants_remove(options = {})
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
+            post('calls.participants.remove', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/channels.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 Channels
           #
-          # This method archives a channel.
+          # Archives a channel.
           #
           # @option options [channel] :channel
           #   Channel to archive.
@@ -14,12 +15,13 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.archive.json
           def channels_archive(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('channels.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('channels.archive', options)
           end
 
           #
-          # This method is used to create a channel.
+          # Creates a channel.
           #
           # @option options [Object] :name
           #   Name of channel to create.
@@ -29,6 +31,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.create.json
           def channels_create(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            logger.warn('channels.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('channels.create', options)
           end
 
@@ -40,13 +43,13 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/channels/channels.delete.json
           def channels_delete(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('The channels.delete method is undocumented.')
             post('channels.delete', options)
           end
 
           #
-          # This method returns a portion of message events from the specified public channel.
+          # Fetches history of messages and events from a channel.
           #
           # @option options [channel] :channel
           #   Channel to fetch history for.
@@ -62,12 +65,13 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.history.json
           def channels_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('channels.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('channels.history', options)
           end
 
           #
-          # This method returns information about a team channel.
+          # Gets information about a channel.
           #
           # @option options [channel] :channel
           #   Channel to get info on.
@@ -77,12 +81,13 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.info.json
           def channels_info(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('channels.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('channels.info', options)
           end
 
           #
-          # This method is used to invite a user to a channel. The calling user must be a member of the channel.
+          # Invites a user to a channel.
           #
           # @option options [channel] :channel
           #   Channel to invite user to.
@@ -93,14 +98,14 @@ module Slack
           def channels_invite(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].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]
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            logger.warn('channels.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('channels.invite', options)
           end
 
           #
-          # This method is used to join a channel. If the channel does not exist, it is
-          # created.
+          # Joins a channel, creating it if needed.
           #
           # @option options [Object] :name
           #   Name of channel to join.
@@ -110,11 +115,12 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.join.json
           def channels_join(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            logger.warn('channels.join: 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.join.')
             post('channels.join', options)
           end
 
           #
-          # This method allows a user to remove another member from a team channel.
+          # Removes a user from a channel.
           #
           # @option options [channel] :channel
           #   Channel to remove user from.
@@ -125,13 +131,14 @@ module Slack
           def channels_kick(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].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]
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            logger.warn('channels.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('channels.kick', options)
           end
 
           #
-          # This method is used to leave a channel.
+          # Leaves a channel.
           #
           # @option options [channel] :channel
           #   Channel to leave.
@@ -139,12 +146,13 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.leave.json
           def channels_leave(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('channels.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('channels.leave', options)
           end
 
           #
-          # Don't use this method. Use conversations.list instead.
+          # Lists all channels in a Slack team.
           #
           # @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.
@@ -157,6 +165,7 @@ module Slack
           # @see https://api.slack.com/methods/channels.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.list.json
           def channels_list(options = {})
+            logger.warn('channels.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, :channels_list, options).each do |page|
                 yield page
@@ -167,7 +176,7 @@ module Slack
           end
 
           #
-          # This method moves the read cursor in a channel.
+          # Sets the read cursor in a channel.
           #
           # @option options [channel] :channel
           #   Channel to set reading cursor in.
@@ -178,12 +187,13 @@ module Slack
           def channels_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('channels.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: .')
             post('channels.mark', options)
           end
 
           #
-          # This method renames a team channel.
+          # Renames a channel.
           #
           # @option options [channel] :channel
           #   Channel to rename.
@@ -196,12 +206,13 @@ module Slack
           def channels_rename(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]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            logger.warn('channels.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('channels.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 channel
           #
           # @option options [channel] :channel
           #   Channel to fetch thread from.
@@ -212,12 +223,13 @@ module Slack
           def channels_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('channels.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('channels.replies', options)
           end
 
           #
-          # This method is used to change the purpose of a channel. The calling user must be a member of the channel.
+          # Sets the purpose for a channel.
           #
           # @option options [channel] :channel
           #   Channel to set the purpose of.
@@ -230,12 +242,13 @@ module Slack
           def channels_setPurpose(options = {})
             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: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            logger.warn('channels.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('channels.setPurpose', options)
           end
 
           #
-          # This method is used to change the topic of a channel. The calling user must be a member of the channel.
+          # Sets the topic for a channel.
           #
           # @option options [channel] :channel
           #   Channel to set the topic of.
@@ -246,12 +259,13 @@ module Slack
           def channels_setTopic(options = {})
             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: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            logger.warn('channels.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('channels.setTopic', options)
           end
 
           #
-          # This method unarchives a channel. The calling user is added to the channel.
+          # Unarchives a channel.
           #
           # @option options [channel] :channel
           #   Channel to unarchive.
@@ -259,7 +273,8 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.unarchive.json
           def channels_unarchive(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('channels.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('channels.unarchive', options)
           end
         end