slack-ruby-client 3.2.0 → 3.3.0

data/bin/commands/slackLists_download.rb

@@ -11,6 +11,9 @@ module Slack
         g.command 'get' do |c|
           c.flag 'list_id', desc: 'ID of the List to export.'
           c.flag 'job_id', desc: 'The ID of the recently started job to export the List.'
+          c.flag 'format', desc: 'Format the export was started with. Must match the format passed to slackLists.download.start. Defaults to csv.'
+          c.flag 'include_threads', desc: 'Must match the include_threads passed to slackLists.download.start. The returned download_url carries this through so the served export matches what was generated. Only applies when format is json.'
+          c.flag 'include_attachments', desc: 'Must match the include_attachments passed to slackLists.download.start. The returned download_url carries this through so the served export matches what was generated. Only applies when format is json.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.slackLists_download_get(options))
           end
@@ -21,6 +24,9 @@ module Slack
         g.command 'start' do |c|
           c.flag 'list_id', desc: 'ID of the List to export.'
           c.flag 'include_archived', desc: ''
+          c.flag 'format', desc: 'Format of the export. Defaults to csv for backward compatibility. Use json for a complete, hierarchical export.'
+          c.flag 'include_threads', desc: "Include each item's conversation thread in the export. Only applies when format is json."
+          c.flag 'include_attachments', desc: 'Include file attachment metadata and access paths in the export. Only applies when format is json.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.slackLists_download_start(options))
           end

data/bin/commands/slackLists_items.rb

@@ -56,6 +56,7 @@ module Slack
           c.flag 'limit', desc: 'The maximum number of records to return.'
           c.flag 'cursor', desc: 'Next cursor for pagination.'
           c.flag 'archived', desc: 'Boolean indicating whether archived items or normal items should be returned.'
+          c.flag 'include_list', desc: 'Set to true to also return the parent list object, including its title, column schema, and total row count. Defaults to false to keep the response small.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.slackLists_items_list(options))
           end

data/bin/commands/users.rb

@@ -11,6 +11,7 @@ module Slack
         g.command 'conversations' do |c|
           c.flag 'cursor', desc: "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."
           c.flag 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
+          c.flag 'exclude_muted', desc: 'Set to true to exclude muted channels from the list.'
           c.flag 'limit', desc: "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 with a max value of 999."
           c.flag 'team_id', desc: 'encoded team id to list conversations in, required if org token is used.'
           c.flag 'types', desc: 'Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.'

data/bin/slack

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
-require 'gli'
+begin
+  require 'gli'
+rescue LoadError
+  abort "The slack command-line client requires the gli gem. Add `gem 'gli'` to your Gemfile, or run `gem install gli`."
+end
 require 'slack_ruby_client'
 
 module Slack

data/examples/files_upload_v2/files_upload_v2.rb

@@ -3,7 +3,7 @@ require 'slack-ruby-client'
 require 'securerandom'
 
 Slack.configure do |config|
-  config.token = ENV['SLACK_API_TOKEN']
+  config.token = ENV.fetch('SLACK_API_TOKEN', nil)
   raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
 end
 

data/examples/hi_web/hi.rb

@@ -2,7 +2,7 @@
 require 'slack-ruby-client'
 
 Slack.configure do |config|
-  config.token = ENV['SLACK_API_TOKEN']
+  config.token = ENV.fetch('SLACK_API_TOKEN', nil)
   raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
 end
 

data/examples/new_ticket/new_ticket.rb

@@ -2,7 +2,7 @@
 require 'slack-ruby-client'
 
 Slack.configure do |config|
-  config.token = ENV['SLACK_API_TOKEN']
+  config.token = ENV.fetch('SLACK_API_TOKEN', nil)
   raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
 end
 

data/examples/oauth_v2/oauth_v2.rb

@@ -18,8 +18,8 @@ server.mount_proc '/' do |req, res|
 
   response = client.oauth_v2_access(
     req.query.merge(
-      client_id: ENV['SLACK_CLIENT_ID'],
-      client_secret: ENV['SLACK_CLIENT_SECRET'],
+      client_id: ENV.fetch('SLACK_CLIENT_ID', nil),
+      client_secret: ENV.fetch('SLACK_CLIENT_SECRET', nil),
       grant_type: 'authorization_code'
     )
   )
@@ -47,10 +47,10 @@ server.mount_proc '/' do |req, res|
 end
 
 query = {
-  client_id: ENV['SLACK_CLIENT_ID'],
-  redirect_uri: ENV['REDIRECT_URI'],
-  scope: ENV['SCOPE'],
-  user_scope: ENV['USER_SCOPE']
+  client_id: ENV.fetch('SLACK_CLIENT_ID', nil),
+  redirect_uri: ENV.fetch('REDIRECT_URI', nil),
+  scope: ENV.fetch('SCOPE', nil),
+  user_scope: ENV.fetch('USER_SCOPE', nil)
 }
 
 url = "https://slack.com/oauth/v2/authorize?#{query.to_query}"

data/lib/slack/events/config.rb

@@ -12,7 +12,7 @@ module Slack
       attr_accessor(*Config::ATTRIBUTES)
 
       def reset
-        self.signing_secret = ENV['SLACK_SIGNING_SECRET']
+        self.signing_secret = ENV.fetch('SLACK_SIGNING_SECRET', nil)
         self.signature_expires_in = 5 * 60
       end
     end

data/lib/slack/events/request.rb

@@ -40,9 +40,9 @@ module Slack
       def body
         @body ||= begin
           input = http_request.body
-          input.rewind
+          input.rewind if input.respond_to?(:rewind)
           body = input.read
-          input.rewind
+          input.rewind if input.respond_to?(:rewind)
           body
         end
       end

data/lib/slack/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Slack
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

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

@@ -18,7 +18,7 @@ module Slack
           # @option options [string] :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.
           # @option options [integer] :limit
-          #   Maximum number of entries to return. The maximum limit is 100.
+          #   Maximum number of entries to return. Defaults to 50 if not passed. Max allowed is 100.
           # @see https://api.slack.com/methods/admin.analytics.messages.activity
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.analytics.messages/admin.analytics.messages.activity.json
           def admin_analytics_messages_activity(options = {})
@@ -43,7 +43,7 @@ module Slack
           # @option options [string] :latest_ts
           #   Most recent timestamp to include in the results. If not passed, defaults to current time.
           # @option options [string] :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 details.
+          #   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.
           # @see https://api.slack.com/methods/admin.analytics.messages.metadata
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.analytics.messages/admin.analytics.messages.metadata.json
           def admin_analytics_messages_metadata(options = {})

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAppsMcpServers
+          #
+          # List third-party app MCP servers approved for an organization, derived from the org's MCP server allowlist. Entries reflect allowlist state, not install/scope liveness: servers of apps that are uninstalled (but not deleted) are still listed.
+          #
+          # @option options [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @see https://api.slack.com/methods/admin.apps.mcp.servers.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.mcp.servers/admin.apps.mcp.servers.list.json
+          def admin_apps_mcp_servers_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_mcp_servers_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.mcp.servers.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAppsMcpServersPermissions
+          #
+          # List MCP servers for an app with their access control permissions
+          #
+          # @option options [string] :app_id
+          #   Encoded ID of the app.
+          # @see https://api.slack.com/methods/admin.apps.mcp.servers.permissions.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.mcp.servers.permissions/admin.apps.mcp.servers.permissions.list.json
+          def admin_apps_mcp_servers_permissions_list(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('admin.apps.mcp.servers.permissions.list', options)
+          end
+
+          #
+          # Set the access control permission for who can use an MCP server
+          #
+          # @option options [string] :app_id
+          #   Encoded ID of the app.
+          # @option options [string] :server_id
+          #   Encoded ID of the MCP server.
+          # @option options [enum] :permission_type
+          #   The type of permission that defines who can use this MCP server.
+          # @option options [array] :user_ids
+          #   List of user IDs to set for named_entities or named_entities_exclude.
+          # @option options [array] :usergroup_ids
+          #   List of encoded usergroup IDs.
+          # @see https://api.slack.com/methods/admin.apps.mcp.servers.permissions.set
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.mcp.servers.permissions/admin.apps.mcp.servers.permissions.set.json
+          def admin_apps_mcp_servers_permissions_set(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            raise ArgumentError, 'Required arguments :server_id missing' if options[:server_id].nil?
+            raise ArgumentError, 'Required arguments :permission_type missing' if options[:permission_type].nil?
+            post('admin.apps.mcp.servers.permissions.set', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/admin_apps_permissions.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 AdminAppsPermissions
+          #
+          # Grant permission for entities to access an app that has its permission type set to named_entities
+          #
+          # @option options [string] :app_id
+          #   Encoded ID of the app.
+          # @option options [array] :user_ids
+          #   List of user IDs to allow for named_entities visibility.
+          # @option options [array] :usergroup_ids
+          #   List of encoded usergroup IDs.
+          # @option options [array] :channel_ids
+          #   List of encoded channel IDs to add to the channel restriction list. Interpretation depends on the app's channel_restriction_mode, which is configured via the admin.apps.permissions.set method.
+          # @see https://api.slack.com/methods/admin.apps.permissions.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.permissions/admin.apps.permissions.add.json
+          def admin_apps_permissions_add(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('admin.apps.permissions.add', options)
+          end
+
+          #
+          # Returns the permission type of an app and if applicable, includes the entities that have been granted access
+          #
+          # @option options [string] :app_id
+          #   Encoded ID of the app.
+          # @see https://api.slack.com/methods/admin.apps.permissions.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.permissions/admin.apps.permissions.list.json
+          def admin_apps_permissions_list(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('admin.apps.permissions.list', options)
+          end
+
+          #
+          # Revoke an entity's access to an app that has its permission type set to named_entities
+          #
+          # @option options [string] :app_id
+          #   Encoded ID of the app.
+          # @option options [array] :user_ids
+          #   List of user IDs whose named_entities access will be revoked.
+          # @option options [array] :usergroup_ids
+          #   List of encoded usergroup IDs.
+          # @option options [array] :channel_ids
+          #   List of encoded channel IDs to remove from the channel restriction list. Interpretation depends on the app's channel_restriction_mode, which is configured via the admin.apps.permissions.set method.
+          # @see https://api.slack.com/methods/admin.apps.permissions.remove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.permissions/admin.apps.permissions.remove.json
+          def admin_apps_permissions_remove(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            post('admin.apps.permissions.remove', options)
+          end
+
+          #
+          # Set the permission type for who can access an app
+          #
+          # @option options [string] :app_id
+          #   Encoded ID of the app.
+          # @option options [enum] :permission_type
+          #   The type of permission that defines who can access the app.
+          # @option options [array] :user_ids
+          #   List of user IDs to allow for named_entities visibility.
+          # @option options [array] :usergroup_ids
+          #   List of encoded usergroup IDs.
+          # @option options [enum] :channel_restriction_mode
+          #   The mode that defines where the app can be used in channels.
+          # @option options [array] :channel_ids
+          #   List of encoded channel IDs for channel restrictions. Semantics depend on channel_restriction_mode: allowlist for specific_channels, exclusion list for all_channels_except.
+          # @see https://api.slack.com/methods/admin.apps.permissions.set
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.permissions/admin.apps.permissions.set.json
+          def admin_apps_permissions_set(options = {})
+            raise ArgumentError, 'Required arguments :app_id missing' if options[:app_id].nil?
+            raise ArgumentError, 'Required arguments :permission_type missing' if options[:permission_type].nil?
+            post('admin.apps.permissions.set', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -58,7 +58,7 @@ module Slack
           end
 
           #
-          # Exclude channels from Slack AI in bulk
+          # Exclude channels from Slack AI in bulk.
           #
           # @option options [array] :channel_ids
           #   An array of channel IDs to exclude from Slack AI.
@@ -72,6 +72,21 @@ module Slack
             post('admin.conversations.bulkSetExcludeFromSlackAi', options)
           end
 
+          #
+          # Set properties on channels in bulk.
+          #
+          # @option options [array] :channel_ids
+          #   An array of channel IDs on which to set the property.
+          # @option options [string] :property
+          #   The property for this channel in a key value format. Only one property can be updated at a time.
+          # @see https://api.slack.com/methods/admin.conversations.bulkSetProperties
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.bulkSetProperties.json
+          def admin_conversations_bulkSetProperties(options = {})
+            raise ArgumentError, 'Required arguments :channel_ids missing' if options[:channel_ids].nil?
+            raise ArgumentError, 'Required arguments :property missing' if options[:property].nil?
+            post('admin.conversations.bulkSetProperties', options)
+          end
+
           #
           # Convert a public channel to a private channel.
           #

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

@@ -17,7 +17,6 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.emoji/admin.emoji.add.json
           def admin_emoji_add(options = {})
             raise ArgumentError, 'Required arguments :name missing' if options[:name].nil?
-            raise ArgumentError, 'Required arguments :url missing' if options[:url].nil?
             post('admin.emoji.add', options)
           end
 

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

@@ -14,7 +14,7 @@ module Slack
           # @option options [array] :app_ids
           #   Comma-separated array of app IDs to get functions for; max 50.
           # @option options [boolean] :include_non_distributed_functions
-          #   Whether to also include functions that are not yet distributed to any users in the function count. This is needed for admins that are approving an app request and will only work if the team owns the app.
+          #   Whether to also include functions that are not yet distributed to any users in the function list. This is needed for admins that are approving an app request and will only work if the team owns the app.
           # @option options [string] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
           # @option options [integer] :limit