slack-ruby-client 2.7.0 → 3.1.0

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

@@ -6,6 +6,25 @@ 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 [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)
           #
@@ -27,12 +46,12 @@ module Slack
           #
           # Deletes a message.
           #
+          # @option options [boolean] :as_user
+          #   (Legacy) Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. See legacy as_user parameter below.
           # @option options [channel] :channel
           #   Channel containing the message to be deleted.
           # @option options [timestamp] :ts
           #   Timestamp of the message to be deleted.
-          # @option options [boolean] :as_user
-          #   Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.
           # @see https://api.slack.com/methods/chat.delete
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.delete.json
           def chat_delete(options = {})
@@ -45,12 +64,12 @@ module Slack
           #
           # Deletes a pending scheduled message from the queue.
           #
+          # @option options [boolean] :as_user
+          #   Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.
           # @option options [channel] :channel
           #   The channel the scheduled_message is posting to.
           # @option options [string] :scheduled_message_id
           #   scheduled_message_id returned from call to chat.scheduleMessage.
-          # @option options [boolean] :as_user
-          #   Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.
           # @see https://api.slack.com/methods/chat.deleteScheduledMessage
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.deleteScheduledMessage.json
           def chat_deleteScheduledMessage(options = {})
@@ -94,18 +113,14 @@ module Slack
           #
           # Sends an ephemeral message to a user in a channel.
           #
-          # @option options [channel] :channel
-          #   Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
-          # @option options [user] :user
-          #   id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
+          # @option options [boolean] :as_user
+          #   (Legacy) Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.
           # @option options [string] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string.
-          # @option options [blocks[] as string] :blocks
+          # @option options [string] :blocks
           #   A JSON-based array of structured blocks, presented as a URL-encoded string.
-          # @option options [string] :text
-          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
-          # @option options [boolean] :as_user
-          #   (Legacy) Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.
+          # @option options [channel] :channel
+          #   Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
           # @option options [string] :icon_emoji
           #   Emoji to use as the icon for this message. Overrides icon_url.
           # @option options [string] :icon_url
@@ -116,8 +131,12 @@ module Slack
           #   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] :parse
           #   Change how messages are treated. Defaults to none. See below.
+          # @option options [string] :text
+          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
           # @option options [string] :thread_ts
           #   Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.
+          # @option options [user] :user
+          #   id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
           # @option options [string] :username
           #   Set your bot's user name.
           # @see https://api.slack.com/methods/chat.postEphemeral
@@ -134,18 +153,16 @@ module Slack
           #
           # Sends a message to a channel.
           #
-          # @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] :attachments
-          #   A JSON-based array of structured attachments, presented as a URL-encoded string.
-          # @option options [blocks[] as string] :blocks
-          #   A JSON-based array of structured blocks, presented as a URL-encoded string.
-          # @option options [string] :text
-          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
-          # @option options [Object] :agent_message_source_type
-          #   Identify how the message was posted for agentforce BE logging.
           # @option options [boolean] :as_user
           #   (Legacy) Pass true to post the message as the authed user instead of as a bot. Defaults to false. Can only be used by classic apps. See legacy as_user parameter below.
+          # @option options [["string", "boolean"]] :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 [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
@@ -162,6 +179,8 @@ module Slack
           #   Change how messages are treated. See below.
           # @option options [boolean] :reply_broadcast
           #   Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
+          # @option options [string] :text
+          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
           # @option options [string] :thread_ts
           #   Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
           # @option options [boolean] :unfurl_links
@@ -182,34 +201,34 @@ module Slack
           #
           # Schedules a message to be sent to a channel.
           #
-          # @option options [channel] :channel
-          #   Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.
-          # @option options [integer] :post_at
-          #   Unix timestamp representing the future time the message should post to Slack.
+          # @option options [boolean] :as_user
+          #   Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See chat.postMessage.
           # @option options [string] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string.
-          # @option options [blocks[] as string] :blocks
+          # @option options [string] :blocks
           #   A JSON-based array of structured blocks, presented as a URL-encoded string.
-          # @option options [string] :text
-          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
-          # @option options [boolean] :as_user
-          #   Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See chat.postMessage.
+          # @option options [channel] :channel
+          #   Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.
           # @option options [boolean] :link_names
           #   Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.
           # @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.
           # @option options [enum] :parse
           #   Change how messages are treated. See chat.postMessage.
+          # @option options [integer] :post_at
+          #   Unix timestamp representing the future time the message should post to Slack.
           # @option options [boolean] :reply_broadcast
           #   Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
+          # @option options [string] :text
+          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
           # @option options [string] :thread_ts
           #   Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
           # @option options [boolean] :unfurl_links
           #   Pass true to enable unfurling of primarily text-based content.
           # @option options [boolean] :unfurl_media
           #   Pass false to disable unfurling of media content.
+          # @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.scheduleMessage
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.scheduleMessage.json
           def chat_scheduleMessage(options = {})
@@ -220,6 +239,51 @@ module Slack
             post('chat.scheduleMessage', options)
           end
 
+          #
+          # Starts a new streaming conversation.
+          #
+          # @option options [channel] :channel
+          #   An encoded ID that represents a channel, private group, or DM.
+          # @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.
+          # @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 [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
           #
@@ -228,57 +292,56 @@ module Slack
           # @option options [timestamp] :ts
           #   Timestamp of the message to add unfurl behavior to.
           # @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.
-          # @option options [enum] :source
-          #   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.
-          # @option options [string] :unfurl_id
-          #   The ID of the link to unfurl. Both unfurl_id and source must be provided together, or channel and ts must be provided together.
-          # @option options [Object] :user_auth_blocks
-          #   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.
-          # @option options [Object] :user_auth_message
+          #   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.
+          # @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
           #   Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain.
-          # @option options [Object] :user_auth_url
+          # @option options [string] :user_auth_url
           #   Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.
+          # @option options [Object] :user_auth_blocks
+          #   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.
+          # @option options [string] :unfurl_id
+          #   The ID of the link to unfurl. Both unfurl_id and source must be provided together, or channel and ts must be provided together.
+          # @option options [enum] :source
+          #   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.
+          # @option options [string] :metadata
+          #   JSON object with entity_type and entity_payload fields, presented as a URL-encoded string. Either unfurls or metadata must be provided.
           # @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])
+            options = encode_options_as_json(options, %i[unfurls user_auth_blocks metadata])
             post('chat.unfurl', options)
           end
 
           #
           # Updates a message.
           #
-          # @option options [channel] :channel
-          #   Channel containing the message to be updated. For direct messages, ensure that this value is a DM ID (starts with D) instead of a User ID (starts with either U or W).
-          # @option options [timestamp] :ts
-          #   Timestamp of the message to be updated.
+          # @option options [["boolean", "string"]] :as_user
+          #   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 [blocks[] as string] :blocks
+          # @option options [string] :blocks
           #   A JSON-based array of structured blocks, presented as a URL-encoded string.
-          # @option options [string] :text
-          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
-          # @option options [boolean] :as_user
-          #   Pass true to update the message as the authed user. Bot users in this context are considered authed users.
-          # @option options [array] :file_ids
-          #   Array of new file ids that will be sent with this message.
-          # @option options [boolean] :link_names
-          #   Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none.
           # @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. 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.
+          # @option options [channel] :channel
+          #   Channel containing the message to be updated. For direct messages, ensure that this value is a DM ID (starts with D) instead of a User ID (starts with either U or W).
+          # @option options [["boolean", "string"]] :link_names
+          #   Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none.
           # @option options [string] :parse
           #   Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, client.
+          # @option options [string] :text
+          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
+          # @option options [timestamp] :ts
+          #   Timestamp of the message to be updated.
           # @option options [boolean] :reply_broadcast
           #   Broadcast an existing thread reply to make it visible to everyone in the channel or conversation.
+          # @option options [array] :file_ids
+          #   Array of new file ids that will be sent with this message.
           # @see https://api.slack.com/methods/chat.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.update.json
           def chat_update(options = {})

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

@@ -11,14 +11,14 @@ module Slack
           #
           # @option options [string] :channel_name
           #   Name of the channel. If the channel does not exist already in your workspace, this name is the one that the channel will take.
-          # @option options [Object] :channel_id
-          #   ID of the channel that you'd like to accept. Must provide either invite_id or channel_id.
+          # @option options [boolean] :is_private
+          #   Whether the channel should be private.
           # @option options [boolean] :free_trial_accepted
           #   Whether you'd like to use your workspace's free trial to begin using Slack Connect.
           # @option options [Object] :invite_id
           #   ID of the invite that you'd like to accept. Must provide either invite_id or channel_id. See the shared_channel_invite_received event payload for more details on how to retrieve the ID of the invitation.
-          # @option options [boolean] :is_private
-          #   Whether the channel should be private.
+          # @option options [Object] :channel_id
+          #   ID of the channel that you'd like to accept. Must provide either invite_id or channel_id.
           # @option options [Object] :team_id
           #   The ID of the workspace to accept the channel in. If an org-level token is used to call this method, the team_id argument is required.
           # @see https://api.slack.com/methods/conversations.acceptSharedInvite
@@ -71,10 +71,10 @@ module Slack
           #
           # Initiates a public or private channel-based conversation
           #
-          # @option options [string] :name
-          #   Name of the public or private channel to create.
           # @option options [boolean] :is_private
           #   Create a private channel instead of a public one.
+          # @option options [string] :name
+          #   Name of the public or private channel to create.
           # @option options [string] :team_id
           #   encoded team id to create the channel in, required if org token is used.
           # @see https://api.slack.com/methods/conversations.create
@@ -151,10 +151,10 @@ module Slack
           #
           # @option options [channel] :channel
           #   The ID of the public or private channel to invite user(s) to.
-          # @option options [string] :users
-          #   A comma separated list of user IDs. Up to 1000 users may be listed.
           # @option options [boolean] :force
           #   When set to true and multiple user IDs are provided, continue inviting the valid ones while disregarding invalid IDs. Defaults to false.
+          # @option options [string] :users
+          #   A comma separated list of user IDs. Up to 100 users may be listed.
           # @see https://api.slack.com/methods/conversations.invite
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.invite.json
           def conversations_invite(options = {})
@@ -171,10 +171,10 @@ module Slack
           #   ID of the channel on your team that you'd like to share.
           # @option options [array] :emails
           #   Optional email to receive this invite. Either emails or user_ids must be provided. Only one email or one user ID may be invited at a time.
-          # @option options [boolean] :external_limited
-          #   Optional boolean on whether invite is to an external limited member. Defaults to true.
           # @option options [array] :user_ids
           #   Optional user_id to receive this invite. Either emails or user_ids must be provided. Only one email or one user ID may be invited at a time.
+          # @option options [boolean] :external_limited
+          #   Optional boolean on whether invite is to an external limited member. Defaults to true.
           # @see https://api.slack.com/methods/conversations.inviteShared
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.inviteShared.json
           def conversations_inviteShared(options = {})
@@ -253,10 +253,10 @@ module Slack
           #
           # Lists shared channel invites that have been generated or received but have not been approved by all parties
           #
-          # @option options [string] :cursor
-          #   Set to next_cursor returned by previous call to list items in subsequent page.
           # @option options [string] :team_id
           #   Encoded team id for the workspace to retrieve invites for, required if org token is used.
+          # @option options [string] :cursor
+          #   Set to next_cursor returned by previous call to list items in subsequent page.
           # @see https://api.slack.com/methods/conversations.listConnectInvites
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.listConnectInvites.json
           def conversations_listConnectInvites(options = {})
@@ -313,12 +313,12 @@ module Slack
           #
           # @option options [channel] :channel
           #   Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.
-          # @option options [boolean] :prevent_creation
-          #   Do not create a direct message or multi-person direct message. This is used to see if there is an existing dm or mpdm.
           # @option options [boolean] :return_im
           #   Boolean, indicates you want the full IM channel definition in the response.
           # @option options [string] :users
           #   Comma separated lists of users. If only one user is included, this creates a 1:1 DM.  The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.
+          # @option options [boolean] :prevent_creation
+          #   Do not create a direct message or multi-person direct message. This is used to see if there is an existing dm or mpdm.
           # @see https://api.slack.com/methods/conversations.open
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.open.json
           def conversations_open(options = {})
@@ -347,8 +347,6 @@ module Slack
           #
           # @option options [channel] :channel
           #   Conversation ID to fetch thread from.
-          # @option options [timestamp] :ts
-          #   Unique identifier of either a thread's parent message or a message in the thread. 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 [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.
           # @option options [boolean] :include_all_metadata
@@ -361,6 +359,8 @@ module Slack
           #   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 [timestamp] :oldest
           #   Only messages after this Unix timestamp will be included in results.
+          # @option options [timestamp] :ts
+          #   Unique identifier of either a thread's parent message or a message in the thread. 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.
           # @see https://api.slack.com/methods/conversations.replies
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.replies.json
           def conversations_replies(options = {})

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

@@ -10,7 +10,7 @@ module Slack
           # Create a channel canvas for a channel
           #
           # @option options [string] :channel_id
-          #   Channel ID of the channel we create the channel canvas for.
+          #   Channel ID of the channel the canvas will be tabbed in.
           # @option options [Object] :document_content
           #   Structure describing the type and value of the content to create.
           # @option options [string] :title

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

@@ -9,18 +9,18 @@ module Slack
           #
           # Upgrade or downgrade Slack Connect channel permissions between 'can post only' and 'can post and invite'.
           #
-          # @option options [enum] :action
-          #   Type of action to be taken: upgrade or downgrade.
           # @option options [channel] :channel
           #   The channel ID to change external invite permissions for.
           # @option options [Object] :target_team
           #   The encoded team ID of the target team.  Must be in the specified channel.
+          # @option options [enum] :action
+          #   Type of action to be taken: upgrade or downgrade.
           # @see https://api.slack.com/methods/conversations.externalInvitePermissions.set
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations.externalInvitePermissions/conversations.externalInvitePermissions.set.json
           def conversations_externalInvitePermissions_set(options = {})
-            raise ArgumentError, 'Required arguments :action missing' if options[:action].nil?
             raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
             raise ArgumentError, 'Required arguments :target_team missing' if options[:target_team].nil?
+            raise ArgumentError, 'Required arguments :action missing' if options[:action].nil?
             options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.externalInvitePermissions.set', options)
           end

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

@@ -11,10 +11,10 @@ module Slack
           #
           # @option options [Object] :invite_id
           #   ID of the requested shared channel invite to approve.
-          # @option options [string] :channel_id
-          #   Optional channel_id to which external user will be invited to. Will override the value on the requested invite.
           # @option options [boolean] :is_external_limited
           #   Optional boolean on whether the invited team will have post-only permissions in the channel. Will override the value on the requested invite.
+          # @option options [string] :channel_id
+          #   Optional channel_id to which external user will be invited to. Will override the value on the requested invite.
           # @option options [object] :message
           #   Object describing the text to send along with the invite. If this object is specified, both text and is_override are required properties. If is_override is set to true, text will override the original invitation message. Otherwise, text will be appended to the original invitation message. The total length of the message cannot exceed 560 characters. If is_override is set to false, the length of text and the user specified message on the invite request in total must be less than 560 characters.
           # @see https://api.slack.com/methods/conversations.requestSharedInvite.approve
@@ -41,20 +41,20 @@ module Slack
           #
           # Lists requests to add external users to channels with ability to filter.
           #
-          # @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. See pagination for more detail.
+          # @option options [Object] :user_id
+          #   Optional filter to return invitation requests for the inviting user.
+          # @option options [boolean] :include_expired
+          #   When true expired invitation requests will be returned, otherwise they will be excluded.
           # @option options [boolean] :include_approved
           #   When true approved invitation requests will be returned, otherwise they will be excluded.
           # @option options [boolean] :include_denied
           #   When true denied invitation requests will be returned, otherwise they will be excluded.
-          # @option options [boolean] :include_expired
-          #   When true expired invitation requests will be returned, otherwise they will be excluded.
           # @option options [array] :invite_ids
           #   An optional list of invitation ids to look up.
           # @option options [integer] :limit
           #   The number of items to return. Must be between 1 - 1000 (inclusive).
-          # @option options [Object] :user_id
-          #   Optional filter to return invitation requests for the inviting user.
+          # @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. See pagination for more detail.
           # @see https://api.slack.com/methods/conversations.requestSharedInvite.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations.requestSharedInvite/conversations.requestSharedInvite.list.json
           def conversations_requestSharedInvite_list(options = {})

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

@@ -27,10 +27,10 @@ module Slack
           #
           # Retrieves a user's current Do Not Disturb status.
           #
-          # @option options [string] :team_id
-          #   Encoded team id where passed in user param belongs, required if org token is used. If no user param is passed, then a team which has access to the app should be passed.
           # @option options [user] :user
           #   User to fetch status for (defaults to current user).
+          # @option options [string] :team_id
+          #   Encoded team id where passed in user param belongs, required if org token is used. If no user param is passed, then a team which has access to the app should be passed.
           # @see https://api.slack.com/methods/dnd.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.info.json
           def dnd_info(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

@@ -11,16 +11,16 @@ module Slack
           #
           # @option options [array] :files
           #   Array of file ids and their corresponding (optional) titles.
-          # @option options [blocks[] as string] :blocks
-          #   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.
           # @option options [Object] :channel_id
           #   Channel ID where the file will be shared. If not specified the file will be private.
+          # @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] :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] :blocks
+          #   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.
           # @see https://api.slack.com/methods/files.completeUploadExternal
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.completeUploadExternal.json
           def files_completeUploadExternal(options = {})
@@ -61,29 +61,29 @@ module Slack
           #
           # Gets a URL for an edge external file upload
           #
-          # @option options [string] :filename
-          #   Name of the file being uploaded.
           # @option options [integer] :length
           #   Size in bytes of the file being uploaded.
-          # @option options [string] :alt_txt
-          #   Description of image for screen-reader.
+          # @option options [string] :filename
+          #   Name of the file being uploaded.
           # @option options [string] :snippet_type
           #   Syntax type of the snippet being uploaded.
+          # @option options [string] :alt_txt
+          #   Description of image for screen-reader.
           # @see https://api.slack.com/methods/files.getUploadURLExternal
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.getUploadURLExternal.json
           def files_getUploadURLExternal(options = {})
-            raise ArgumentError, 'Required arguments :filename missing' if options[:filename].nil?
             raise ArgumentError, 'Required arguments :length missing' if options[:length].nil?
+            raise ArgumentError, 'Required arguments :filename missing' if options[:filename].nil?
             post('files.getUploadURLExternal', options)
           end
 
           #
           # Gets information about a file.
           #
-          # @option options [file] :file
-          #   Specify a file by providing its ID.
           # @option options [string] :cursor
           #   Parameter for pagination. File comments are paginated for a single file. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See pagination for more details.
+          # @option options [file] :file
+          #   Specify a file by providing its ID.
           # @option options [integer] :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.
           # @see https://api.slack.com/methods/files.info

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

@@ -13,14 +13,14 @@ module Slack
           #   Creator defined GUID for the file.
           # @option options [string] :external_url
           #   URL of the remote file.
-          # @option options [string] :title
-          #   Title of the file being shared.
           # @option options [string] :filetype
           #   type of file.
           # @option options [Object] :indexable_file_contents
           #   A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.
           # @option options [Object] :preview_image
           #   Preview of the document via multipart/form-data.
+          # @option options [string] :title
+          #   Title of the file being shared.
           # @see https://api.slack.com/methods/files.remote.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.add.json
           def files_remote_add(options = {})