Merge pull request #574 from slack-ruby/automated-api-update

Update API from slack-api-ref@bd5dd34

Author: dblock

CHANGELOG.md

@@ -1,5 +1,6 @@
 ### 3.0.1 (Next)
 
+* [#574](https://github.com/slack-ruby/slack-ruby-client/pull/574): Update API from [slack-api-ref@bd5dd34](https://github.com/slack-ruby/slack-api-ref/commit/bd5dd34) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
 * Your contribution here.
 * [#576](https://github.com/slack-ruby/slack-ruby-client/pull/576): Add support for `blocks` in `files_upload_v2` - [@childish-sambino](https://github.com/childish-sambino).
 

bin/commands/admin_functions.rb

@@ -6,11 +6,12 @@ module Cli
     class App
       desc 'AdminFunctions methods.'
       command 'admin_functions' do |g|
-        g.desc 'Look up functions by a set of apps'
-        g.long_desc %( Look up functions by a set of apps )
+        g.desc 'Look up functions by a set of apps.'
+        g.long_desc %( Look up functions by a set of apps. )
         g.command 'list' do |c|
           c.flag 'team_id', desc: 'The team context to retrieve functions from.'
           c.flag 'app_ids', desc: 'Comma-separated array of app IDs to get functions for; max 50.'
+          c.flag 'include_non_distributed_functions', desc: '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.'
           c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
           c.flag 'limit', desc: 'The number of results that will be returned by the API on each invocation. Must be between 1 and 1000, both inclusive.'
           c.action do |_global_options, options, _args|

bin/commands/admin_functions_permissions.rb

@@ -15,8 +15,8 @@ class App
           end
         end
 
-        g.desc 'Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities'
-        g.long_desc %( Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities )
+        g.desc 'Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities.'
+        g.long_desc %( Set the visibility of a Slack function and define the users or workspaces if it is set to named_entities. )
         g.command 'set' do |c|
           c.flag 'function_id', desc: 'The function ID to set permissions for.'
           c.flag 'visibility', desc: 'The function visibility.'

bin/commands/admin_users.rb

@@ -19,6 +19,16 @@ class App
           end
         end
 
+        g.desc 'Fetches the expiration timestamp for a guest'
+        g.long_desc %( Fetches the expiration timestamp for a guest )
+        g.command 'getExpiration' do |c|
+          c.flag 'user_id', desc: 'The ID of the guest user to get the expiration for.'
+          c.flag 'target_team', desc: 'If an org token is passed in and this team is on the org, it will operate on the workspace level on the specified team. Otherwise it will operate on the org or team in context.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.admin_users_getExpiration(options))
+          end
+        end
+
         g.desc 'Invite a user to a workspace.'
         g.long_desc %( Invite a user to a workspace. )
         g.command 'invite' do |c|

bin/commands/assistant_search.rb

@@ -13,18 +13,21 @@ class App
           c.flag 'action_token', desc: 'Send action_token as received in a message event.'
           c.flag 'channel_types', desc: 'Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.'
           c.flag 'content_types', desc: 'Content types to include, a comma-separated list of any combination of messages, files, channels, users.'
-          c.flag 'include_bots', desc: 'If you want the results to include bots.'
+          c.flag 'include_bots', desc: 'Whether the results should include bots.'
+          c.flag 'include_deleted_users', desc: 'Whether to include deleted users in the user search results. Defaults to false.'
           c.flag 'before', desc: 'UNIX timestamp filter. If present, filters for results before this date.'
           c.flag 'after', desc: 'UNIX timestamp filter. If present, filters for results after this date.'
           c.flag 'include_context_messages', desc: 'Whether to include context messages surrounding the main message result. Defaults to false if unspecified.'
           c.flag 'context_channel_id', desc: 'Context channel ID to support scoping the search when applicable.'
-          c.flag 'cursor', desc: 'The cursor returned by the API. Leave this blank for the first request, and use this to get the next page of results.'
+          c.flag 'cursor', desc: 'The cursor returned by the API. Leave this blank for the first request and use this to get the next page of results.'
           c.flag 'limit', desc: 'Number of results to return, up to a max of 20. Defaults to 20.'
           c.flag 'sort', desc: 'The field to sort the results by. Defaults to score. Can be one of: score, timestamp.'
           c.flag 'sort_dir', desc: 'The direction to sort the results by. Defaults to desc.'
           c.flag 'include_message_blocks', desc: 'Whether to return the message blocks in the response.'
           c.flag 'highlight', desc: 'Whether to highlight the search query in the results. Defaults to false if unspecified.'
-          c.flag 'term_clauses', desc: 'A list of term clauses. A term clause is a string with search terms. Search results returned will match every term clause specified (i.e. conjunctive normal form).'
+          c.flag 'term_clauses', desc: 'A list of term clauses. A term clause is a string with search terms. Search results returned will match every term clause specified (i.e., conjunctive normal form).'
+          c.flag 'modifiers', desc: 'A string containing only modifiers in the format of modifier:value. Search results returned will match the modifier value. For now modifiers only affect term clauses.'
+          c.flag 'include_archived_channels', desc: 'Whether to include archived channels in the search results.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.assistant_search_context(options))
           end

bin/commands/assistant_threads.rb

@@ -12,6 +12,7 @@ class App
           c.flag 'channel_id', desc: 'Channel ID containing the assistant thread.'
           c.flag 'thread_ts', desc: 'Message timestamp of the thread of where to set the status.'
           c.flag 'status', desc: "Status of the specified bot user, e.g. 'is thinking...'."
+          c.flag 'loading_messages', desc: 'The list of messages to rotate through as a loading indicator.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.assistant_threads_setStatus(options))
           end

bin/commands/chat.rb

@@ -6,6 +6,17 @@ module Cli
     class App
       desc 'Chat methods.'
       command 'chat' do |g|
+        g.desc 'Appends text to an existing streaming conversation.'
+        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 '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|
+            puts JSON.dump(@client.chat_appendStream(options))
+          end
+        end
+
         g.desc 'Execute a slash command in a public channel (undocumented)'
         g.long_desc %( Execute a slash command in a public channel )
         g.command 'command' do |c|
@@ -87,6 +98,7 @@ class App
           c.flag '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 'channel', desc: '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.'
+          c.flag 'current_draft_last_updated_ts', desc: "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."
           c.flag 'icon_emoji', desc: 'Emoji to use as the icon for this message. Overrides icon_url.'
           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.'
@@ -127,18 +139,45 @@ class App
           end
         end
 
+        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 '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.action do |_global_options, options, _args|
+            puts JSON.dump(@client.chat_startStream(options))
+          end
+        end
+
+        g.desc 'Stops a streaming conversation.'
+        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 '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.'
+          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.action do |_global_options, options, _args|
+            puts JSON.dump(@client.chat_stopStream(options))
+          end
+        end
+
         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.'
+          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 '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

bin/commands/entity.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Cli
+    class App
+      desc 'Entity methods.'
+      command 'entity' do |g|
+        g.desc 'Provide custom flexpane behavior for Work Objects. Apps call this endpoint to send per-user flexpane metadata to the client.'
+        g.long_desc %( Provide custom flexpane behavior for Work Objects. Apps call this endpoint to send per-user flexpane metadata to the client. )
+        g.command 'presentDetails' do |c|
+          c.flag 'metadata', desc: 'URL-encoded JSON object containing flexpane metadata from the app that will be conformed to a Work Object metadata schema, keyed by entity ID.'
+          c.flag 'trigger_id', desc: 'A reference to the original user action that initiated the request.'
+          c.flag 'user_auth_required', desc: 'Set to true (or 1) to indicate that the user must authenticate to view full flexpane data.'
+          c.flag 'user_auth_url', desc: 'A custom URL to which users are directed for authentication if required.'
+          c.flag 'error', desc: ''
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.entity_presentDetails(options))
+          end
+        end
+      end
+    end
+  end
+end

bin/commands/files.rb

@@ -12,7 +12,7 @@ class App
           c.flag 'files', desc: 'Array of file ids and their corresponding (optional) titles.'
           c.flag 'channel_id', desc: 'Channel ID where the file will be shared. If not specified the file will be private.'
           c.flag 'thread_ts', desc: "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'."
-          c.flag 'channels', desc: 'Comma-separated string of channel IDs where the file will be shared.'
+          c.flag 'channels', desc: 'Comma-separated string of channel IDs or user IDs where the file will be shared.'
           c.flag 'initial_comment', desc: 'The message text introducing the file in specified channels.'
           c.flag 'blocks', desc: 'A JSON-based array of structured rich text blocks, presented as a URL-encoded string. If the initial_comment field is provided, the blocks field is ignored.'
           c.action do |_global_options, options, _args|

bin/commands/oauth_v2.rb

@@ -12,6 +12,7 @@ class App
           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.'