slack-ruby-client 3.1.0 → 3.2.0

data/bin/commands/bookmarks.rb

@@ -9,7 +9,7 @@ module Slack
         g.desc 'Add bookmark to a channel.'
         g.long_desc %( Add bookmark to a channel. )
         g.command 'add' do |c|
-          c.flag 'channel_id', desc: 'Channel to add bookmark in.'
+          c.flag 'channel_id', desc: 'Channel to add bookmark in. Required for public channels.'
           c.flag 'title', desc: 'Title for the bookmark.'
           c.flag 'link', desc: 'Link to bookmark.'
           c.flag 'type', desc: 'Type of the bookmark i.e link.'
@@ -25,8 +25,8 @@ module Slack
         g.desc 'Edit bookmark.'
         g.long_desc %( Edit bookmark. )
         g.command 'edit' do |c|
-          c.flag 'channel_id', desc: 'Channel to update bookmark in.'
-          c.flag 'bookmark_id', desc: 'Bookmark to update.'
+          c.flag 'channel_id', desc: 'Channel to update bookmark in. Required for public channels.'
+          c.flag 'bookmark_id', desc: 'Bookmark to update. Required for public channels.'
           c.flag 'title', desc: 'Title for the bookmark.'
           c.flag 'link', desc: 'Link to bookmark.'
           c.flag 'emoji', desc: 'Emoji tag to apply to the link.'
@@ -38,7 +38,7 @@ module Slack
         g.desc 'List bookmark for the channel.'
         g.long_desc %( List bookmark for the channel. )
         g.command 'list' do |c|
-          c.flag 'channel_id', desc: 'Channel to list bookmarks in.'
+          c.flag 'channel_id', desc: 'Channel to list bookmarks in. Required for public channels.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.bookmarks_list(options))
           end
@@ -47,8 +47,8 @@ module Slack
         g.desc 'Remove bookmark from the channel.'
         g.long_desc %( Remove bookmark from the channel. )
         g.command 'remove' do |c|
-          c.flag 'channel_id', desc: 'Channel to remove bookmark.'
-          c.flag 'bookmark_id', desc: 'Bookmark to remove.'
+          c.flag 'channel_id', desc: 'Channel to remove bookmark. Required for public channels.'
+          c.flag 'bookmark_id', desc: 'Bookmark to remove. Required for public channels.'
           c.flag 'quip_section_id', desc: 'Quip section ID to unbookmark.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.bookmarks_remove(options))

data/bin/commands/chat.rb

@@ -10,6 +10,7 @@ module Slack
         g.long_desc %( Appends text to an existing streaming conversation. )
         g.command 'appendStream' do |c|
           c.flag 'channel', desc: 'An encoded ID that represents a channel, private group, or DM.'
+          c.flag 'chunks', desc: 'Array of streaming chunks.'
           c.flag 'ts', desc: 'The timestamp of the streaming message.'
           c.flag 'markdown_text', desc: 'Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.'
           c.action do |_global_options, options, _args|
@@ -103,7 +104,7 @@ module Slack
           c.flag 'icon_url', desc: 'URL to an image to use as the icon for this message.'
           c.flag 'link_names', desc: 'Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.'
           c.flag 'markdown_text', desc: 'Accepts message text formatted in markdown. This argument should not be used in conjunction with blocks or text. Limit this field to 12,000 characters.'
-          c.flag 'metadata', desc: 'JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.'
+          c.flag 'metadata', desc: 'JSON object with event_type and event_payload fields, presented as a URL-encoded string. You can also provide Work Object entity metadata using this parameter. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.'
           c.flag 'mrkdwn', desc: 'Disable Slack markup parsing by setting to false. Enabled by default.'
           c.flag 'parse', desc: 'Change how messages are treated. See below.'
           c.flag 'reply_broadcast', desc: 'Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.'
@@ -142,11 +143,16 @@ module Slack
         g.desc 'Starts a new streaming conversation.'
         g.long_desc %( Starts a new streaming conversation. )
         g.command 'startStream' do |c|
-          c.flag 'channel', desc: 'An encoded ID that represents a channel, private group, or DM.'
+          c.flag 'channel', desc: 'An encoded ID that represents a channel thread or DM.'
+          c.flag 'chunks', desc: 'Array of streaming chunks.'
           c.flag 'markdown_text', desc: 'Accepts message text formatted in markdown. Limit this field to 12,000 characters.'
           c.flag 'thread_ts', desc: "Provide another message's ts value to reply to. Streamed messages should always be replies to a user request."
           c.flag 'recipient_user_id', desc: 'The encoded ID of the user to receive the streaming text. Required when streaming to channels.'
           c.flag 'recipient_team_id', desc: 'The encoded ID of the team the user receiving the streaming text belongs to. Required when streaming to channels.'
+          c.flag 'task_display_mode', desc: "Specifies how tasks are displayed in the message. A timeline displays individual tasks with text in sequential order, plan displays all tasks together, with the first tasks's placement determining the placement of the rest of the tasks, and dense collapses consecutive tool calls into a single summarized task card."
+          c.flag 'icon_emoji', desc: 'Emoji to use as the icon for this message. Overrides icon_url.'
+          c.flag 'icon_url', desc: 'Image URL to use as the icon for this message.'
+          c.flag 'username', desc: "The bot's username to display."
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.chat_startStream(options))
           end
@@ -156,6 +162,7 @@ module Slack
         g.long_desc %( Stops a streaming conversation. )
         g.command 'stopStream' do |c|
           c.flag 'channel', desc: 'An encoded ID that represents a channel, private group, or DM.'
+          c.flag 'chunks', desc: 'Array of streaming chunks.'
           c.flag 'ts', desc: 'The timestamp of the streaming message.'
           c.flag 'markdown_text', desc: 'Accepts message text formatted in markdown. Limit this field to 12,000 characters.'
           c.flag 'blocks', desc: 'A list of blocks that will be rendered at the bottom of the finalized message.'
@@ -168,16 +175,15 @@ module Slack
         g.desc 'Provide custom unfurl behavior for user-posted URLs'
         g.long_desc %( Provide custom unfurl behavior for user-posted URLs )
         g.command 'unfurl' do |c|
-          c.flag 'channel', desc: 'Channel ID of the message. Both channel and ts must be provided together, or unfurl_id and source must be provided together.'
-          c.flag 'ts', desc: 'Timestamp of the message to add unfurl behavior to.'
-          c.flag 'unfurls', desc: 'URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments. Either unfurls or metadata must be provided.'
+          c.flag 'channel', desc: 'Channel ID of the message. Both channel and ts must be provided together, or unfurl_id and source must be provided together. Required for public channels.'
+          c.flag 'ts', desc: 'Timestamp of the message to add unfurl behavior to. Required for public channels.'
+          c.flag 'unfurls', desc: 'URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments. Required for public channels.'
           c.flag 'user_auth_message', desc: 'Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.'
           c.flag 'user_auth_required', desc: 'Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain.'
           c.flag 'user_auth_url', desc: 'Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.'
           c.flag 'user_auth_blocks', desc: 'Provide a JSON based array of structured blocks presented as URL-encoded string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.'
           c.flag 'unfurl_id', desc: 'The ID of the link to unfurl. Both unfurl_id and source must be provided together, or channel and ts must be provided together.'
           c.flag 'source', desc: 'The source of the link to unfurl. The source may either be composer, when the link is inside the message composer, or conversations_history, when the link has been posted to a conversation.'
-          c.flag 'metadata', desc: 'JSON object with entity_type and entity_payload fields, presented as a URL-encoded string. Either unfurls or metadata must be provided.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.chat_unfurl(options))
           end
@@ -188,6 +194,7 @@ module Slack
         g.command 'update' do |c|
           c.flag 'as_user', desc: 'Pass true to update the message as the authed user. Bot users in this context are considered authed users.'
           c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
+          c.flag 'unfurled_attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
           c.flag 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
           c.flag 'markdown_text', desc: 'Accepts message text formatted in markdown. This argument should not be used in conjunction with blocks or text. Limit this field to 12,000 characters.'
           c.flag 'metadata', desc: "JSON object with event_type and event_payload fields, presented as a URL-encoded string. If you don't include this field, the message's previous metadata will be retained. To remove previous metadata, include an empty object for this field. Metadata you post to Slack is accessible to any app or user who is a member of that workspace."

data/bin/commands/conversations.rb

@@ -24,7 +24,7 @@ module Slack
         g.long_desc %( Approves an invitation to a Slack Connect channel )
         g.command 'approveSharedInvite' do |c|
           c.flag 'invite_id', desc: 'ID of the shared channel invite to approve.'
-          c.flag 'target_team', desc: 'The team or enterprise id of the other party involved in the invitation you are approving.'
+          c.flag 'target_team', desc: 'The team or enterprise ID of the receiving party involved in the invitation you are approving.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_approveSharedInvite(options))
           end

data/bin/commands/files.rb

@@ -63,8 +63,8 @@ module Slack
           end
         end
 
-        g.desc 'List for a team, in a channel, or from a user with applied filters.'
-        g.long_desc %( List for a team, in a channel, or from a user with applied filters. )
+        g.desc 'List files for a team, in a channel, or from a user with applied filters.'
+        g.long_desc %( List files for a team, in a channel, or from a user with applied filters. )
         g.command 'list' do |c|
           c.flag 'channel', desc: 'Filter files appearing in a specific channel, indicated by its ID.'
           c.flag 'show_files_hidden_by_limit', desc: 'Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.'

data/bin/commands/oauth_v2.rb

@@ -16,6 +16,7 @@ module Slack
           c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
           c.flag 'grant_type', desc: 'The grant_type param as described in the OAuth spec.'
           c.flag 'refresh_token', desc: 'The refresh_token param as described in the OAuth spec.'
+          c.flag 'assertion', desc: 'Identity assertion JWT authorization grant.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.oauth_v2_access(options))
           end

data/bin/commands/oauth_v2_user.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Cli
+    class App
+      desc 'OauthV2User methods.'
+      command 'oauth_v2_user' do |g|
+        g.desc 'Exchanges a temporary OAuth verifier code for a user access token.'
+        g.long_desc %( Exchanges a temporary OAuth verifier code for a user access token. )
+        g.command 'access' do |c|
+          c.flag 'client_id', desc: 'Issued when you created your application. If possible, avoid sending client_id and client_secret as parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme.'
+          c.flag 'client_secret', desc: 'Issued when you created your application. If possible, avoid sending client_id and client_secret as parameters in your request and instead supply the Client ID and Client Secret using the HTTP Basic authentication scheme.'
+          c.flag 'code', desc: 'The code param returned via the OAuth callback.'
+          c.flag 'code_verifier', desc: 'The code_verifier param used to generate the code_challenge originally. Used for PKCE.'
+          c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
+          c.flag 'grant_type', desc: 'The grant_type param as described in the OAuth spec.'
+          c.flag 'refresh_token', desc: 'The refresh_token param as described in the OAuth spec.'
+          c.flag 'assertion', desc: 'Identity assertion JWT authorization grant.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.oauth_v2_user_access(options))
+          end
+        end
+      end
+    end
+  end
+end

data/bin/commands/openid_connect.rb

@@ -15,6 +15,7 @@ module Slack
           c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
           c.flag 'grant_type', desc: 'The grant_type param as described in the OAuth spec.'
           c.flag 'refresh_token', desc: 'The refresh_token param as described in the OAuth spec.'
+          c.flag 'code_verifier', desc: 'PKCE code verifier (RFC 7636). Required when the authorization request included a code_challenge.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.openid_connect_token(options))
           end

data/bin/commands/users.rb

@@ -6,8 +6,8 @@ module Slack
     class App
       desc 'Users methods.'
       command 'users' do |g|
-        g.desc 'List conversations the calling user may access.'
-        g.long_desc %( List conversations the calling user may access. )
+        g.desc 'List conversations the calling user is a member of.'
+        g.long_desc %( List conversations the calling user is a member of. )
         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.'

data/bin/commands/views.rb

@@ -23,6 +23,7 @@ module Slack
           c.flag 'user_id', desc: 'id of the user you want publish a view to.'
           c.flag 'view', desc: 'A view payload. This must be a JSON-encoded string.'
           c.flag 'hash', desc: 'A string that represents view state to protect against possible race conditions.'
+          c.flag 'interactivity_pointer', desc: ''
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.views_publish(options))
           end

data/lib/slack/version.rb

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

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAnalyticsMessages
+          #
+          # Retrieves activity metrics for messages from a given channel.
+          #
+          # @option options [channel] :channel
+          #   Channel ID for channel of the message activity to query.
+          # @option options [string] :oldest_ts
+          #   Oldest timestamp to include in the results. Defaults to 7 days before current time. If not passed while still passing the latest_ts parameter, defaults to 7 days before latest_ts.
+          # @option options [string] :latest_ts
+          #   Most recent timestamp to include in results. Defaults to current time. If not passed while still passing the oldest_ts parameter, defaults to 7 days after oldest_ts.
+          # @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.
+          # @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 = {})
+            raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            if block_given?
+              Pagination::Cursor.new(self, :admin_analytics_messages_activity, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.analytics.messages.activity', options)
+            end
+          end
+
+          #
+          # Retrieves metadata for a list of messages from a given channel.
+          #
+          # @option options [channel] :channel
+          #   Channel ID for channel containing the messages to query.
+          # @option options [string] :oldest_ts
+          #   Oldest timestamp to include in the results.
+          # @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.
+          # @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 = {})
+            raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            if block_given?
+              Pagination::Cursor.new(self, :admin_analytics_messages_metadata, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.analytics.messages.metadata', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,6 +9,8 @@ module Slack
           #
           # Approve an app for installation on a workspace.
           #
+          # @option options [boolean] :allow_child_auto_install
+          #   Auto-create an Admin-Approved App automation rule that pre-approves future child app installs from this manager app.
           # @option options [string] :app_id
           #   The id of the app to approve.
           # @option options [string] :request_id
@@ -17,6 +19,10 @@ module Slack
           #   The ID of the workspace to approve the app on.
           # @option options [Object] :enterprise_id
           #   The ID of the enterprise to approve the app on.
+          # @option options [string] :user_scopes
+          #   User scopes to approve for the app.
+          # @option options [string] :bot_scopes
+          #   Bot scopes to approve for the app.
           # @see https://api.slack.com/methods/admin.apps.approve
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.approve.json
           def admin_apps_approve(options = {})

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

@@ -57,6 +57,21 @@ module Slack
             post('admin.conversations.bulkMove', options)
           end
 
+          #
+          # Exclude channels from Slack AI in bulk
+          #
+          # @option options [array] :channel_ids
+          #   An array of channel IDs to exclude from Slack AI.
+          # @option options [boolean] :exclude
+          #   Whether the channels should be excluded from Slack AI.
+          # @see https://api.slack.com/methods/admin.conversations.bulkSetExcludeFromSlackAi
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.conversations/admin.conversations.bulkSetExcludeFromSlackAi.json
+          def admin_conversations_bulkSetExcludeFromSlackAi(options = {})
+            raise ArgumentError, 'Required arguments :channel_ids missing' if options[:channel_ids].nil?
+            raise ArgumentError, 'Required arguments :exclude missing' if options[:exclude].nil?
+            post('admin.conversations.bulkSetExcludeFromSlackAi', options)
+          end
+
           #
           # Convert a public channel to a private channel.
           #

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

@@ -27,11 +27,12 @@ module Slack
           #   The function visibility.
           # @option options [array] :user_ids
           #   List of user IDs to allow for named_entities visibility.
+          # @option options [array] :permissions
+          #   Array of permissions for the function.
           # @see https://api.slack.com/methods/admin.functions.permissions.set
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.functions.permissions/admin.functions.permissions.set.json
           def admin_functions_permissions_set(options = {})
             raise ArgumentError, 'Required arguments :function_id missing' if options[:function_id].nil?
-            raise ArgumentError, 'Required arguments :visibility missing' if options[:visibility].nil?
             post('admin.functions.permissions.set', options)
           end
         end

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

@@ -85,6 +85,10 @@ module Slack
           #   Only applies with org token and no team_id. If true, return workspaces for a user even if they may be deactivated on them. If false, return workspaces for a user only when user is active on them. Default is false.
           # @option options [boolean] :only_guests
           #   If true, returns only guests and their expiration dates that belong to the team_id.
+          # @option options [boolean] :include_admins
+          #   If true, only admin users will be returned (excludes owners). Returns all admins and owners when combined with include_owners. Cannot be used together with only_guests.
+          # @option options [boolean] :include_owners
+          #   If true, only owner users will be returned. Cannot be used together with only_guests.
           # @option options [integer] :limit
           #   Limit for how many users to be retrieved per page.
           # @see https://api.slack.com/methods/admin.users.list
@@ -115,10 +119,10 @@ module Slack
           end
 
           #
-          # Set an existing regular user or owner to be a workspace admin.
+          # Set an existing regular user or owner to be a workspace or org admin.
           #
           # @option options [Object] :team_id
-          #   The ID (T1234) of the workspace.
+          #   The ID of the workspace or organization.
           # @option options [string] :user_id
           #   The ID of the user to designate as an admin.
           # @see https://api.slack.com/methods/admin.users.setAdmin
@@ -147,12 +151,12 @@ module Slack
           end
 
           #
-          # Set an existing regular user or admin to be a workspace owner.
+          # Set an existing regular user or admin to be a workspace or org owner.
           #
           # @option options [Object] :team_id
-          #   The ID (T1234) of the workspace.
+          #   The ID of the workspace or organization.
           # @option options [Object] :user_id
-          #   Id of the user to promote to owner.
+          #   ID of the user to promote to owner.
           # @see https://api.slack.com/methods/admin.users.setOwner
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.users/admin.users.setOwner.json
           def admin_users_setOwner(options = {})
@@ -165,7 +169,7 @@ module Slack
           # Set an existing guest user, admin user, or owner to be a regular user.
           #
           # @option options [Object] :team_id
-          #   The ID (T1234) of the workspace.
+          #   The ID of the workspace or organization.
           # @option options [string] :user_id
           #   The ID of the user to designate as a regular user.
           # @see https://api.slack.com/methods/admin.users.setRegular