slack-ruby-client 3.0.0 → 3.2.0

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

@@ -6,6 +6,27 @@ module Slack
     module Api
       module Endpoints
         module Chat
+          #
+          # Appends text to an existing streaming conversation.
+          #
+          # @option options [channel] :channel
+          #   An encoded ID that represents a channel, private group, or DM.
+          # @option options [array] :chunks
+          #   Array of streaming chunks.
+          # @option options [timestamp] :ts
+          #   The timestamp of the streaming message.
+          # @option options [string] :markdown_text
+          #   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.
+          # @see https://api.slack.com/methods/chat.appendStream
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.appendStream.json
+          def chat_appendStream(options = {})
+            raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+            raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil?
+            raise ArgumentError, 'Required arguments :markdown_text missing' if options[:markdown_text].nil?
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            post('chat.appendStream', options)
+          end
+
           #
           # Execute a slash command in a public channel (undocumented)
           #
@@ -125,7 +146,8 @@ module Slack
           def chat_postEphemeral(options = {})
             raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
             raise ArgumentError, 'Required arguments :user missing' if options[:user].nil?
-            raise ArgumentError, 'At least one of :attachments, :blocks, :text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil?
+            raise ArgumentError, 'At least one of :attachments, :blocks, :text, :markdown_text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil? && options[:markdown_text].nil?
+            raise ArgumentError, ':text, :markdown_text are mutually exclusive' if !options[:text].nil? && !options[:markdown_text].nil?
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             options = encode_options_as_json(options, %i[attachments blocks])
             post('chat.postEphemeral', options)
@@ -142,6 +164,8 @@ module Slack
           #   A JSON-based array of structured blocks, presented as a URL-encoded string.
           # @option options [channel] :channel
           #   An encoded ID or channel name that represents a channel, private group, or IM channel to send the message to. See below for more details.
+          # @option options [string] :current_draft_last_updated_ts
+          #   This field represents the timestamp of the draft's last update at the time this API is called. If the current message is a draft, this field can be provided to ensure synchronization with the server.
           # @option options [string] :icon_emoji
           #   Emoji to use as the icon for this message. Overrides icon_url.
           # @option options [string] :icon_url
@@ -151,7 +175,7 @@ module Slack
           # @option options [string] :markdown_text
           #   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.
           # @option options [string] :metadata
-          #   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.
+          #   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.
           # @option options [boolean] :mrkdwn
           #   Disable Slack markup parsing by setting to false. Enabled by default.
           # @option options [string] :parse
@@ -172,7 +196,8 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postMessage.json
           def chat_postMessage(options = {})
             raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
-            raise ArgumentError, 'At least one of :attachments, :blocks, :text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil?
+            raise ArgumentError, 'At least one of :attachments, :blocks, :text, :markdown_text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil? && options[:markdown_text].nil?
+            raise ArgumentError, ':text, :markdown_text are mutually exclusive' if !options[:text].nil? && !options[:markdown_text].nil?
             options = encode_options_as_json(options, %i[attachments blocks metadata])
             post('chat.postMessage', options)
           end
@@ -213,20 +238,78 @@ module Slack
           def chat_scheduleMessage(options = {})
             raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
             raise ArgumentError, 'Required arguments :post_at missing' if options[:post_at].nil?
-            raise ArgumentError, 'At least one of :attachments, :blocks, :text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil?
+            raise ArgumentError, 'At least one of :attachments, :blocks, :text, :markdown_text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil? && options[:markdown_text].nil?
+            raise ArgumentError, ':text, :markdown_text are mutually exclusive' if !options[:text].nil? && !options[:markdown_text].nil?
             options = encode_options_as_json(options, %i[attachments blocks metadata])
             post('chat.scheduleMessage', options)
           end
 
+          #
+          # Starts a new streaming conversation.
+          #
+          # @option options [channel] :channel
+          #   An encoded ID that represents a channel thread or DM.
+          # @option options [array] :chunks
+          #   Array of streaming chunks.
+          # @option options [string] :markdown_text
+          #   Accepts message text formatted in markdown. Limit this field to 12,000 characters.
+          # @option options [string] :thread_ts
+          #   Provide another message's ts value to reply to. Streamed messages should always be replies to a user request.
+          # @option options [Object] :recipient_user_id
+          #   The encoded ID of the user to receive the streaming text. Required when streaming to channels.
+          # @option options [string] :recipient_team_id
+          #   The encoded ID of the team the user receiving the streaming text belongs to. Required when streaming to channels.
+          # @option options [enum] :task_display_mode
+          #   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.
+          # @option options [string] :icon_emoji
+          #   Emoji to use as the icon for this message. Overrides icon_url.
+          # @option options [string] :icon_url
+          #   Image URL to use as the icon for this message.
+          # @option options [string] :username
+          #   The bot's username to display.
+          # @see https://api.slack.com/methods/chat.startStream
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.startStream.json
+          def chat_startStream(options = {})
+            raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+            raise ArgumentError, 'Required arguments :thread_ts missing' if options[:thread_ts].nil?
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            post('chat.startStream', options)
+          end
+
+          #
+          # Stops a streaming conversation.
+          #
+          # @option options [channel] :channel
+          #   An encoded ID that represents a channel, private group, or DM.
+          # @option options [array] :chunks
+          #   Array of streaming chunks.
+          # @option options [timestamp] :ts
+          #   The timestamp of the streaming message.
+          # @option options [string] :markdown_text
+          #   Accepts message text formatted in markdown. Limit this field to 12,000 characters.
+          # @option options [Object] :blocks
+          #   A list of blocks that will be rendered at the bottom of the finalized message.
+          # @option options [string] :metadata
+          #   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.
+          # @see https://api.slack.com/methods/chat.stopStream
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.stopStream.json
+          def chat_stopStream(options = {})
+            raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+            raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil?
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            options = encode_options_as_json(options, %i[metadata])
+            post('chat.stopStream', options)
+          end
+
           #
           # Provide custom unfurl behavior for user-posted URLs
           #
           # @option options [channel] :channel
-          #   Channel ID of the message. Both channel and ts must be provided together, or unfurl_id and source must be provided together.
+          #   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.
           # @option options [timestamp] :ts
-          #   Timestamp of the message to add unfurl behavior to.
+          #   Timestamp of the message to add unfurl behavior to. Required for public channels.
           # @option options [string] :unfurls
-          #   URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.
+          #   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.
           # @option options [string] :user_auth_message
           #   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.
           # @option options [boolean] :user_auth_required
@@ -242,9 +325,6 @@ module Slack
           # @see https://api.slack.com/methods/chat.unfurl
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.unfurl.json
           def chat_unfurl(options = {})
-            raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
-            raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil?
-            raise ArgumentError, 'Required arguments :unfurls missing' if options[:unfurls].nil?
             options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             options = encode_options_as_json(options, %i[unfurls user_auth_blocks])
             post('chat.unfurl', options)
@@ -257,6 +337,8 @@ module Slack
           #   Pass true to update the message as the authed user. Bot users in this context are considered authed users.
           # @option options [string] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string.
+          # @option options [string] :unfurled_attachments
+          #   A JSON-based array of structured attachments, presented as a URL-encoded string.
           # @option options [string] :blocks
           #   A JSON-based array of structured blocks, presented as a URL-encoded string.
           # @option options [string] :markdown_text
@@ -282,9 +364,10 @@ module Slack
           def chat_update(options = {})
             raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
             raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil?
-            raise ArgumentError, 'At least one of :attachments, :blocks, :text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil?
+            raise ArgumentError, 'At least one of :attachments, :blocks, :text, :markdown_text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil? && options[:markdown_text].nil?
+            raise ArgumentError, ':text, :markdown_text are mutually exclusive' if !options[:text].nil? && !options[:markdown_text].nil?
             options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
-            options = encode_options_as_json(options, %i[attachments blocks metadata])
+            options = encode_options_as_json(options, %i[attachments unfurled_attachments blocks metadata])
             post('chat.update', options)
           end
         end

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

@@ -34,7 +34,7 @@ module Slack
           # @option options [Object] :invite_id
           #   ID of the shared channel invite to approve.
           # @option options [Object] :target_team
-          #   The team or enterprise id of the other party involved in the invitation you are approving.
+          #   The team or enterprise ID of the receiving party involved in the invitation you are approving.
           # @see https://api.slack.com/methods/conversations.approveSharedInvite
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.approveSharedInvite.json
           def conversations_approveSharedInvite(options = {})

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Entity
+          #
+          # Provide custom flexpane behavior for Work Objects. Apps call this endpoint to send per-user flexpane metadata to the client.
+          #
+          # @option options [object] :metadata
+          #   URL-encoded JSON object containing flexpane metadata from the app that will be conformed to a Work Object metadata schema, keyed by entity ID.
+          # @option options [string] :trigger_id
+          #   A reference to the original user action that initiated the request.
+          # @option options [boolean] :user_auth_required
+          #   Set to true (or 1) to indicate that the user must authenticate to view full flexpane data.
+          # @option options [string] :user_auth_url
+          #   A custom URL to which users are directed for authentication if required.
+          # @option options [Object] :error
+          # @see https://api.slack.com/methods/entity.presentDetails
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/entity/entity.presentDetails.json
+          def entity_presentDetails(options = {})
+            raise ArgumentError, 'Required arguments :trigger_id missing' if options[:trigger_id].nil?
+            options = encode_options_as_json(options, %i[metadata])
+            post('entity.presentDetails', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,7 +16,7 @@ module Slack
           # @option options [string] :thread_ts
           #   Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead. Also make sure to provide only one channel when using 'thread_ts'.
           # @option options [string] :channels
-          #   Comma-separated string of channel IDs where the file will be shared.
+          #   Comma-separated string of channel IDs or user IDs where the file will be shared.
           # @option options [string] :initial_comment
           #   The message text introducing the file in specified channels.
           # @option options [string] :blocks
@@ -100,7 +100,7 @@ module Slack
           end
 
           #
-          # List for a team, in a channel, or from a user with applied filters.
+          # List files 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.

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

@@ -15,12 +15,16 @@ module Slack
           #   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.
           # @option options [string] :code
           #   The code param returned via the OAuth callback.
+          # @option options [string] :code_verifier
+          #   The code_verifier param used to generate the code_challenge originally. Used for PKCE.
           # @option options [string] :redirect_uri
           #   This must match the originally submitted URI (if one was sent).
           # @option options [string] :grant_type
           #   The grant_type param as described in the OAuth spec.
           # @option options [string] :refresh_token
           #   The refresh_token param as described in the OAuth spec.
+          # @option options [string] :assertion
+          #   Identity assertion JWT authorization grant.
           # @see https://api.slack.com/methods/oauth.v2.access
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/oauth.v2/oauth.v2.access.json
           def oauth_v2_access(options = {})

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module OauthV2User
+          #
+          # Exchanges a temporary OAuth verifier code for a user access token.
+          #
+          # @option options [string] :client_id
+          #   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.
+          # @option options [string] :client_secret
+          #   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.
+          # @option options [string] :code
+          #   The code param returned via the OAuth callback.
+          # @option options [string] :code_verifier
+          #   The code_verifier param used to generate the code_challenge originally. Used for PKCE.
+          # @option options [string] :redirect_uri
+          #   This must match the originally submitted URI (if one was sent).
+          # @option options [string] :grant_type
+          #   The grant_type param as described in the OAuth spec.
+          # @option options [string] :refresh_token
+          #   The refresh_token param as described in the OAuth spec.
+          # @option options [string] :assertion
+          #   Identity assertion JWT authorization grant.
+          # @see https://api.slack.com/methods/oauth.v2.user.access
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/oauth.v2.user/oauth.v2.user.access.json
+          def oauth_v2_user_access(options = {})
+            post('oauth.v2.user.access', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,6 +21,8 @@ module Slack
           #   The grant_type param as described in the OAuth spec.
           # @option options [string] :refresh_token
           #   The refresh_token param as described in the OAuth spec.
+          # @option options [string] :code_verifier
+          #   PKCE code verifier (RFC 7636). Required when the authorization request included a code_challenge.
           # @see https://api.slack.com/methods/openid.connect.token
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/openid.connect/openid.connect.token.json
           def openid_connect_token(options = {})

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

@@ -7,7 +7,7 @@ module Slack
       module Endpoints
         module Users
           #
-          # List conversations the calling user may access.
+          # List conversations the calling user is a member of.
           #
           # @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 detail.

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

@@ -33,6 +33,7 @@ module Slack
           #   A view payload. This must be a JSON-encoded string.
           # @option options [string] :hash
           #   A string that represents view state to protect against possible race conditions.
+          # @option options [string] :interactivity_pointer
           # @see https://api.slack.com/methods/views.publish
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.publish.json
           def views_publish(options = {})

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

@@ -2,6 +2,7 @@
 # This file was auto-generated by lib/tasks/web.rake
 
 require_relative 'endpoints/admin_analytics'
+require_relative 'endpoints/admin_analytics_messages'
 require_relative 'endpoints/admin_apps'
 require_relative 'endpoints/admin_apps_activities'
 require_relative 'endpoints/admin_apps_approved'
@@ -40,11 +41,14 @@ require_relative 'endpoints/apps_auth_external'
 require_relative 'endpoints/apps_connections'
 require_relative 'endpoints/apps_datastore'
 require_relative 'endpoints/apps_event_authorizations'
+require_relative 'endpoints/apps_icon'
 require_relative 'endpoints/apps_manifest'
+require_relative 'endpoints/apps_user_connection'
 require_relative 'endpoints/assistant_search'
 require_relative 'endpoints/assistant_threads'
 require_relative 'endpoints/auth'
 require_relative 'endpoints/auth_teams'
+require_relative 'endpoints/blocks'
 require_relative 'endpoints/bookmarks'
 require_relative 'endpoints/bots'
 require_relative 'endpoints/calls'
@@ -61,6 +65,7 @@ require_relative 'endpoints/conversations_requestSharedInvite'
 require_relative 'endpoints/dialog'
 require_relative 'endpoints/dnd'
 require_relative 'endpoints/emoji'
+require_relative 'endpoints/entity'
 require_relative 'endpoints/files'
 require_relative 'endpoints/files_comments'
 require_relative 'endpoints/files_remote'
@@ -71,6 +76,7 @@ require_relative 'endpoints/functions_workflows_steps_responses'
 require_relative 'endpoints/migration'
 require_relative 'endpoints/oauth'
 require_relative 'endpoints/oauth_v2'
+require_relative 'endpoints/oauth_v2_user'
 require_relative 'endpoints/openid_connect'
 require_relative 'endpoints/pins'
 require_relative 'endpoints/reactions'
@@ -107,6 +113,7 @@ module Slack
         include Slack::Web::Api::Mixins::Users
 
         include AdminAnalytics
+        include AdminAnalyticsMessages
         include AdminApps
         include AdminAppsActivities
         include AdminAppsApproved
@@ -145,11 +152,14 @@ module Slack
         include AppsConnections
         include AppsDatastore
         include AppsEventAuthorizations
+        include AppsIcon
         include AppsManifest
+        include AppsUserConnection
         include AssistantSearch
         include AssistantThreads
         include Auth
         include AuthTeams
+        include Blocks
         include Bookmarks
         include Bots
         include Calls
@@ -166,6 +176,7 @@ module Slack
         include Dialog
         include Dnd
         include Emoji
+        include Entity
         include Files
         include FilesComments
         include FilesRemote
@@ -176,6 +187,7 @@ module Slack
         include Migration
         include Oauth
         include OauthV2
+        include OauthV2User
         include OpenidConnect
         include Pins
         include Reactions