slack-ruby-client 0.15.1 → 0.16.0

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

@@ -6,6 +6,44 @@ module Slack
     module Api
       module Endpoints
         module AdminUsersSession
+          #
+          # Revoke a single session for a user. The user will be forced to login to Slack.
+          #
+          # @option options [Object] :session_id
+          #   ID of the session to invalidate.
+          # @option options [Object] :team_id
+          #   ID of the workspace that the session belongs to.
+          # @see https://api.slack.com/methods/admin.users.session.invalidate
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.invalidate.json
+          def admin_users_session_invalidate(options = {})
+            throw ArgumentError.new('Required arguments :session_id missing') if options[:session_id].nil?
+            throw ArgumentError.new('Required arguments :team_id missing') if options[:team_id].nil?
+            post('admin.users.session.invalidate', options)
+          end
+
+          #
+          # List active user sessions for an organization
+          #
+          # @option options [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   The ID of the workspace you'd like active sessions for. If you pass a team_id, you'll need to pass a user_id as well.
+          # @option options [Object] :user_id
+          #   The ID of user you'd like active sessions for. If you pass a user_id, you'll need to pass a team_id as well.
+          # @see https://api.slack.com/methods/admin.users.session.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users.session/admin.users.session.list.json
+          def admin_users_session_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_users_session_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.users.session.list', options)
+            end
+          end
+
           #
           # Wipes all valid sessions on all devices for a given user
           #

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

@@ -11,8 +11,6 @@ module Slack
           #
           # @option options [Object] :error
           #   Error response to return.
-          # @option options [Object] :foo
-          #   example property to return.
           # @see https://api.slack.com/methods/api.test
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/api/api.test.json
           def api_test(options = {})

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsConnections
+          #
+          # Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over,
+          #
+          # @see https://api.slack.com/methods/apps.connections.open
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.connections/apps.connections.open.json
+          def apps_connections_open(options = {})
+            post('apps.connections.open', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsEventAuthorizations
+          #
+          # Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.
+          #
+          # @option options [Object] :event_context
+          #   .
+          # @option options [Object] :cursor
+          #   .
+          # @option options [Object] :limit
+          #   .
+          # @see https://api.slack.com/methods/apps.event.authorizations.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.event.authorizations/apps.event.authorizations.list.json
+          def apps_event_authorizations_list(options = {})
+            throw ArgumentError.new('Required arguments :event_context missing') if options[:event_context].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :apps_event_authorizations_list, options).each do |page|
+                yield page
+              end
+            else
+              post('apps.event.authorizations.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AuthTeams
+          #
+          # List the workspaces a token can access.
+          #
+          # @option options [Object] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :include_icon
+          #   Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.
+          # @option options [Object] :limit
+          #   The maximum number of workspaces to return. Must be a positive integer no larger than 1000.
+          # @see https://api.slack.com/methods/auth.teams.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/auth.teams/auth.teams.list.json
+          def auth_teams_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :auth_teams_list, options).each do |page|
+                yield page
+              end
+            else
+              post('auth.teams.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,8 @@ module Slack
           #
           # @option options [Object] :bot
           #   Bot user to get info on.
+          # @option options [Object] :team_id
+          #   encoded team id or enterprise id where the bot exists, required if org token is used.
           # @see https://api.slack.com/methods/bots.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/bots/bots.info.json
           def bots_info(options = {})

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

@@ -25,6 +25,8 @@ module Slack
           #
           # @option options [Object] :name
           #   Name of 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/channels.create
@@ -109,6 +111,8 @@ module Slack
           #
           # @option options [Object] :name
           #   Name of channel to join.
+          # @option options [Object] :team_id
+          #   encoded team id to list channels 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/channels.join
@@ -162,6 +166,8 @@ module Slack
           #   Exclude the members collection from each channel.
           # @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.
+          # @option options [Object] :team_id
+          #   encoded team id to list channels in, required if org token is used.
           # @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 = {})
@@ -179,16 +185,16 @@ module Slack
           # Sets the read cursor in a channel.
           #
           # @option options [channel] :channel
-          #   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/channels.mark
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.mark.json
           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: 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: .')
+            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: conversations.mark.')
             post('channels.mark', options)
           end
 

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

@@ -154,9 +154,9 @@ module Slack
           # @option options [Object] :blocks
           #   A JSON-based array of structured blocks, presented as a URL-encoded string.
           # @option options [Object] :icon_emoji
-          #   Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. This argument may not be used with newer bot tokens.
+          #   Emoji to use as the icon for this message. Overrides icon_url. See authorship below. Use with bot tokens requires chat:write.customize.
           # @option options [Object] :icon_url
-          #   URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. This argument may not be used with newer bot tokens.
+          #   URL to an image to use as the icon for this message. See authorship below. Use with bot tokens requires chat:write.customize.
           # @option options [Object] :link_names
           #   Find and link channel names and usernames.
           # @option options [Object] :mrkdwn
@@ -172,7 +172,7 @@ module Slack
           # @option options [Object] :unfurl_media
           #   Pass false to disable unfurling of media content.
           # @option options [Object] :username
-          #   Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
+          #   Set your bot's user name. See authorship below. Use with bot tokens requires chat:write.customize.
           # @see https://api.slack.com/methods/chat.postMessage
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postMessage.json
           def chat_postMessage(options = {})

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

@@ -19,6 +19,8 @@ module Slack
           #   Maximum number of original entries to return.
           # @option options [timestamp] :oldest
           #   A UNIX timestamp of the oldest value in the time range.
+          # @option options [Object] :team_id
+          #   encoded team id to list channels in, required if org token is used.
           # @see https://api.slack.com/methods/chat.scheduledMessages.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat.scheduledMessages/chat.scheduledMessages.list.json
           def chat_scheduledMessages_list(options = {})

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

@@ -39,6 +39,8 @@ module Slack
           #   Name of the public or private channel to create.
           # @option options [Object] :is_private
           #   Create a private channel instead of a public one.
+          # @option options [Object] :team_id
+          #   encoded team id to create the channel in, required if org token is used.
           # @see https://api.slack.com/methods/conversations.create
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.create.json
           def conversations_create(options = {})
@@ -160,6 +162,8 @@ module Slack
           #   Set to true to exclude archived channels from the 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. Must be an integer no larger than 1000.
+          # @option options [Object] :team_id
+          #   encoded team id to list channels in, required if org token is used.
           # @option options [Object] :types
           #   Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.
           # @see https://api.slack.com/methods/conversations.list
@@ -174,6 +178,22 @@ module Slack
             end
           end
 
+          #
+          # Sets the read cursor in a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel or conversation to set the read cursor for.
+          # @option options [timestamp] :ts
+          #   Unique identifier of message you want marked as most recently seen in this conversation.
+          # @see https://api.slack.com/methods/conversations.mark
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.mark.json
+          def conversations_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: conversations_id(options)['channel']['id']) if options[:channel]
+            post('conversations.mark', options)
+          end
+
           #
           # Retrieve members of a conversation.
           #
@@ -235,7 +255,7 @@ module Slack
           # @option options [channel] :channel
           #   Conversation ID to fetch thread from.
           # @option options [timestamp] :ts
-          #   Unique identifier of a thread's parent message.
+          #   Unique identifier of a thread's parent message. ts must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message.
           # @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] :inclusive

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

@@ -36,7 +36,7 @@ module Slack
           end
 
           #
-          # Gets information about a team file.
+          # Gets information about a file.
           #
           # @option options [file] :file
           #   Specify a file by providing its ID.
@@ -58,12 +58,14 @@ module Slack
           end
 
           #
-          # Lists & filters team files.
+          # 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

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

@@ -88,9 +88,9 @@ module Slack
           # @option options [Object] :channels
           #   Comma-separated list of channel IDs where the file will be shared.
           # @option options [Object] :external_id
-          #   Creator defined GUID for the file.
+          #   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 by providing its ID.
+          #   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 = {})

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

@@ -25,6 +25,8 @@ module Slack
           #
           # @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
@@ -148,6 +150,8 @@ 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 = {})
@@ -165,16 +169,16 @@ module Slack
           # 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: .')
+            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
 

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

@@ -75,7 +75,7 @@ module Slack
             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: 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: .')
+            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
 

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

@@ -11,6 +11,8 @@ module Slack
           #
           # @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

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

@@ -66,16 +66,16 @@ module Slack
           # 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/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: 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: .')
+            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
 

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

@@ -17,7 +17,6 @@ module Slack
           # @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?
-            throw ArgumentError.new('Required arguments :timestamp missing') if options[:timestamp].nil?
             options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('pins.add', options)
           end
@@ -40,10 +39,6 @@ module Slack
           #
           # @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

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

@@ -54,6 +54,8 @@ module Slack
           #   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

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

@@ -17,6 +17,8 @@ module Slack
           #   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] :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/slack-ruby/slack-api-ref/blob/master/methods/search/search.all.json
           def search_all(options = {})
@@ -35,6 +37,8 @@ module Slack
           #   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] :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/slack-ruby/slack-api-ref/blob/master/methods/search/search.files.json
           def search_files(options = {})
@@ -53,6 +57,8 @@ module Slack
           #   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] :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/slack-ruby/slack-api-ref/blob/master/methods/search/search.messages.json
           def search_messages(options = {})