slack-ruby-client 2.7.0 → 3.0.0

data/bin/commands/chat.rb

@@ -20,9 +20,9 @@ module Slack
         g.desc 'Deletes a message.'
         g.long_desc %( Deletes a message. )
         g.command 'delete' do |c|
+          c.flag 'as_user', desc: '(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.'
           c.flag 'channel', desc: 'Channel containing the message to be deleted.'
           c.flag 'ts', desc: 'Timestamp of the message to be deleted.'
-          c.flag 'as_user', desc: '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.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.chat_delete(options))
           end
@@ -31,9 +31,9 @@ module Slack
         g.desc 'Deletes a pending scheduled message from the queue.'
         g.long_desc %( Deletes a pending scheduled message from the queue. )
         g.command 'deleteScheduledMessage' do |c|
+          c.flag 'as_user', desc: '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.'
           c.flag 'channel', desc: 'The channel the scheduled_message is posting to.'
           c.flag 'scheduled_message_id', desc: 'scheduled_message_id returned from call to chat.scheduleMessage.'
-          c.flag 'as_user', desc: '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.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.chat_deleteScheduledMessage(options))
           end
@@ -62,18 +62,18 @@ module Slack
         g.desc 'Sends an ephemeral message to a user in a channel.'
         g.long_desc %( Sends an ephemeral message to a user in a channel. )
         g.command 'postEphemeral' do |c|
-          c.flag 'channel', desc: 'Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.'
-          c.flag 'user', desc: 'id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.'
+          c.flag 'as_user', desc: '(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.'
           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 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
-          c.flag 'as_user', desc: '(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.'
+          c.flag 'channel', desc: 'Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.'
           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 channel names and usernames.'
           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 'parse', desc: 'Change how messages are treated. Defaults to none. See below.'
+          c.flag 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
           c.flag 'thread_ts', desc: "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."
+          c.flag 'user', desc: 'id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.'
           c.flag 'username', desc: "Set your bot's user name."
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.chat_postEphemeral(options))
@@ -83,12 +83,10 @@ module Slack
         g.desc 'Sends a message to a channel.'
         g.long_desc %( Sends a message to a channel. )
         g.command 'postMessage' do |c|
-          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 'as_user', desc: '(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.'
           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 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
-          c.flag 'agent_message_source_type', desc: 'Identify how the message was posted for agentforce BE logging.'
-          c.flag 'as_user', desc: '(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.'
+          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 '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.'
@@ -97,6 +95,7 @@ module Slack
           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.'
+          c.flag 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
           c.flag 'thread_ts', desc: "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead."
           c.flag 'unfurl_links', desc: 'Pass true to enable unfurling of primarily text-based content.'
           c.flag 'unfurl_media', desc: 'Pass false to disable unfurling of media content.'
@@ -109,20 +108,20 @@ module Slack
         g.desc 'Schedules a message to be sent to a channel.'
         g.long_desc %( Schedules a message to be sent to a channel. )
         g.command 'scheduleMessage' do |c|
-          c.flag 'channel', desc: 'Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.'
-          c.flag 'post_at', desc: 'Unix timestamp representing the future time the message should post to Slack.'
+          c.flag 'as_user', desc: '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.'
           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 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
-          c.flag 'as_user', desc: '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.'
+          c.flag 'channel', desc: 'Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.'
           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 'parse', desc: 'Change how messages are treated. See chat.postMessage.'
+          c.flag 'post_at', desc: 'Unix timestamp representing the future time the message should post to Slack.'
           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.'
+          c.flag 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
           c.flag 'thread_ts', desc: "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead."
           c.flag 'unfurl_links', desc: 'Pass true to enable unfurling of primarily text-based content.'
           c.flag 'unfurl_media', desc: 'Pass false to disable unfurling of media content.'
+          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_scheduleMessage(options))
           end
@@ -134,12 +133,12 @@ module Slack
           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 '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 '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 '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 '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.action do |_global_options, options, _args|
             puts JSON.dump(@client.chat_unfurl(options))
           end
@@ -148,18 +147,18 @@ module Slack
         g.desc 'Updates a message.'
         g.long_desc %( Updates a message. )
         g.command 'update' do |c|
-          c.flag 'channel', desc: '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).'
-          c.flag 'ts', desc: 'Timestamp of the message to be updated.'
+          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 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
-          c.flag 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
-          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 'file_ids', desc: 'Array of new file ids that will be sent with this message.'
-          c.flag 'link_names', desc: '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.'
           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."
+          c.flag 'channel', desc: '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).'
+          c.flag 'link_names', desc: '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.'
           c.flag 'parse', desc: '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.'
+          c.flag 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
+          c.flag 'ts', desc: 'Timestamp of the message to be updated.'
           c.flag 'reply_broadcast', desc: 'Broadcast an existing thread reply to make it visible to everyone in the channel or conversation.'
+          c.flag 'file_ids', desc: 'Array of new file ids that will be sent with this message.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.chat_update(options))
           end

data/bin/commands/conversations.rb

@@ -10,10 +10,10 @@ module Slack
         g.long_desc %( Accepts an invitation to a Slack Connect channel. )
         g.command 'acceptSharedInvite' do |c|
           c.flag 'channel_name', desc: 'Name of the channel. If the channel does not exist already in your workspace, this name is the one that the channel will take.'
-          c.flag 'channel_id', desc: "ID of the channel that you'd like to accept. Must provide either invite_id or channel_id."
+          c.flag 'is_private', desc: 'Whether the channel should be private.'
           c.flag 'free_trial_accepted', desc: "Whether you'd like to use your workspace's free trial to begin using Slack Connect."
           c.flag 'invite_id', desc: "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."
-          c.flag 'is_private', desc: 'Whether the channel should be private.'
+          c.flag 'channel_id', desc: "ID of the channel that you'd like to accept. Must provide either invite_id or channel_id."
           c.flag 'team_id', desc: '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.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_acceptSharedInvite(options))
@@ -51,8 +51,8 @@ module Slack
         g.desc 'Initiates a public or private channel-based conversation'
         g.long_desc %( Initiates a public or private channel-based conversation )
         g.command 'create' do |c|
-          c.flag 'name', desc: 'Name of the public or private channel to create.'
           c.flag 'is_private', desc: 'Create a private channel instead of a public one.'
+          c.flag 'name', desc: 'Name of the public or private channel to create.'
           c.flag 'team_id', desc: 'encoded team id to create the channel in, required if org token is used.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_create(options))
@@ -99,8 +99,8 @@ module Slack
         g.long_desc %( Invites users to a channel. )
         g.command 'invite' do |c|
           c.flag 'channel', desc: 'The ID of the public or private channel to invite user(s) to.'
-          c.flag 'users', desc: 'A comma separated list of user IDs. Up to 1000 users may be listed.'
           c.flag 'force', desc: 'When set to true and multiple user IDs are provided, continue inviting the valid ones while disregarding invalid IDs. Defaults to false.'
+          c.flag 'users', desc: 'A comma separated list of user IDs. Up to 100 users may be listed.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_invite(options))
           end
@@ -111,8 +111,8 @@ module Slack
         g.command 'inviteShared' do |c|
           c.flag 'channel', desc: "ID of the channel on your team that you'd like to share."
           c.flag 'emails', desc: '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.'
-          c.flag 'external_limited', desc: 'Optional boolean on whether invite is to an external limited member. Defaults to true.'
           c.flag 'user_ids', desc: '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.'
+          c.flag 'external_limited', desc: 'Optional boolean on whether invite is to an external limited member. Defaults to true.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_inviteShared(options))
           end
@@ -162,8 +162,8 @@ module Slack
         g.desc 'Lists shared channel invites that have been generated or received but have not been approved by all parties'
         g.long_desc %( Lists shared channel invites that have been generated or received but have not been approved by all parties )
         g.command 'listConnectInvites' do |c|
-          c.flag 'cursor', desc: 'Set to next_cursor returned by previous call to list items in subsequent page.'
           c.flag 'team_id', desc: 'Encoded team id for the workspace to retrieve invites for, required if org token is used.'
+          c.flag 'cursor', desc: 'Set to next_cursor returned by previous call to list items in subsequent page.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_listConnectInvites(options))
           end
@@ -194,9 +194,9 @@ module Slack
         g.long_desc %( Opens or resumes a direct message or multi-person direct message. )
         g.command 'open' do |c|
           c.flag 'channel', desc: "Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead."
-          c.flag 'prevent_creation', desc: 'Do not create a direct message or multi-person direct message. This is used to see if there is an existing dm or mpdm.'
           c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
           c.flag 'users', desc: '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.'
+          c.flag 'prevent_creation', desc: 'Do not create a direct message or multi-person direct message. This is used to see if there is an existing dm or mpdm.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_open(options))
           end
@@ -216,13 +216,13 @@ module Slack
         g.long_desc %( Retrieve a thread of messages posted to a conversation )
         g.command 'replies' do |c|
           c.flag 'channel', desc: 'Conversation ID to fetch thread from.'
-          c.flag 'ts', desc: "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."
           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 'include_all_metadata', desc: 'Return all metadata associated with this message.'
           c.flag 'inclusive', desc: 'Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified.'
           c.flag 'latest', desc: 'Only messages before this Unix timestamp will be included in results.'
           c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
           c.flag 'oldest', desc: 'Only messages after this Unix timestamp will be included in results.'
+          c.flag 'ts', desc: "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."
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_replies(options))
           end

data/bin/commands/conversations_canvases.rb

@@ -9,7 +9,7 @@ module Slack
         g.desc 'Create a channel canvas for a channel'
         g.long_desc %( Create a channel canvas for a channel )
         g.command 'create' do |c|
-          c.flag 'channel_id', desc: 'Channel ID of the channel we create the channel canvas for.'
+          c.flag 'channel_id', desc: 'Channel ID of the channel the canvas will be tabbed in.'
           c.flag 'document_content', desc: 'Structure describing the type and value of the content to create.'
           c.flag 'title', desc: 'Title of the newly created canvas.'
           c.action do |_global_options, options, _args|

data/bin/commands/conversations_externalInvitePermissions.rb

@@ -9,9 +9,9 @@ module Slack
         g.desc "Upgrade or downgrade Slack Connect channel permissions between 'can post only' and 'can post and invite'."
         g.long_desc %( Upgrade or downgrade Slack Connect channel permissions between 'can post only' and 'can post and invite'. )
         g.command 'set' do |c|
-          c.flag 'action', desc: 'Type of action to be taken: upgrade or downgrade.'
           c.flag 'channel', desc: 'The channel ID to change external invite permissions for.'
           c.flag 'target_team', desc: 'The encoded team ID of the target team.  Must be in the specified channel.'
+          c.flag 'action', desc: 'Type of action to be taken: upgrade or downgrade.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_externalInvitePermissions_set(options))
           end

data/bin/commands/conversations_requestSharedInvite.rb

@@ -10,8 +10,8 @@ module Slack
         g.long_desc %( Approves a request to add an external user to a channel and sends them a Slack Connect invite )
         g.command 'approve' do |c|
           c.flag 'invite_id', desc: 'ID of the requested shared channel invite to approve.'
-          c.flag 'channel_id', desc: 'Optional channel_id to which external user will be invited to. Will override the value on the requested invite.'
           c.flag 'is_external_limited', desc: 'Optional boolean on whether the invited team will have post-only permissions in the channel. Will override the value on the requested invite.'
+          c.flag 'channel_id', desc: 'Optional channel_id to which external user will be invited to. Will override the value on the requested invite.'
           c.flag 'message', desc: '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.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_requestSharedInvite_approve(options))
@@ -31,13 +31,13 @@ module Slack
         g.desc 'Lists requests to add external users to channels with ability to filter.'
         g.long_desc %( Lists requests to add external users to channels with ability to filter. )
         g.command 'list' 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. See pagination for more detail."
+          c.flag 'user_id', desc: 'Optional filter to return invitation requests for the inviting user.'
+          c.flag 'include_expired', desc: 'When true expired invitation requests will be returned, otherwise they will be excluded.'
           c.flag 'include_approved', desc: 'When true approved invitation requests will be returned, otherwise they will be excluded.'
           c.flag 'include_denied', desc: 'When true denied invitation requests will be returned, otherwise they will be excluded.'
-          c.flag 'include_expired', desc: 'When true expired invitation requests will be returned, otherwise they will be excluded.'
           c.flag 'invite_ids', desc: 'An optional list of invitation ids to look up.'
           c.flag 'limit', desc: 'The number of items to return. Must be between 1 - 1000 (inclusive).'
-          c.flag 'user_id', desc: 'Optional filter to return invitation requests for the inviting user.'
+          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. See pagination for more detail."
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.conversations_requestSharedInvite_list(options))
           end

data/bin/commands/dnd.rb

@@ -25,8 +25,8 @@ module Slack
         g.desc "Retrieves a user's current Do Not Disturb status."
         g.long_desc %( Retrieves a user's current Do Not Disturb status. )
         g.command 'info' do |c|
-          c.flag 'team_id', desc: '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.'
           c.flag 'user', desc: 'User to fetch status for (defaults to current user).'
+          c.flag 'team_id', desc: '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.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.dnd_info(options))
           end

data/bin/commands/files.rb

@@ -10,11 +10,11 @@ module Slack
         g.long_desc %( Finishes an upload started with files.getUploadURLExternal )
         g.command 'completeUploadExternal' do |c|
           c.flag 'files', desc: 'Array of file ids and their corresponding (optional) titles.'
-          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.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 'initial_comment', desc: 'The message text introducing the file in specified channels.'
-          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 '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|
             puts JSON.dump(@client.files_completeUploadExternal(options))
           end
@@ -43,10 +43,10 @@ module Slack
         g.desc 'Gets a URL for an edge external file upload'
         g.long_desc %( Gets a URL for an edge external file upload )
         g.command 'getUploadURLExternal' do |c|
-          c.flag 'filename', desc: 'Name of the file being uploaded.'
           c.flag 'length', desc: 'Size in bytes of the file being uploaded.'
-          c.flag 'alt_txt', desc: 'Description of image for screen-reader.'
+          c.flag 'filename', desc: 'Name of the file being uploaded.'
           c.flag 'snippet_type', desc: 'Syntax type of the snippet being uploaded.'
+          c.flag 'alt_txt', desc: 'Description of image for screen-reader.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.files_getUploadURLExternal(options))
           end
@@ -55,8 +55,8 @@ module Slack
         g.desc 'Gets information about a file.'
         g.long_desc %( Gets information about a file. )
         g.command 'info' do |c|
-          c.flag 'file', desc: 'Specify a file by providing its ID.'
           c.flag 'cursor', desc: "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."
+          c.flag 'file', desc: 'Specify a file by providing its ID.'
           c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached."
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.files_info(options))

data/bin/commands/files_remote.rb

@@ -11,10 +11,10 @@ module Slack
         g.command 'add' do |c|
           c.flag 'external_id', desc: 'Creator defined GUID for the file.'
           c.flag 'external_url', desc: 'URL of the remote file.'
-          c.flag 'title', desc: 'Title of the file being shared.'
           c.flag 'filetype', desc: 'type of file.'
           c.flag 'indexable_file_contents', desc: 'A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.'
           c.flag 'preview_image', desc: 'Preview of the document via multipart/form-data.'
+          c.flag 'title', desc: 'Title of the file being shared.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.files_remote_add(options))
           end

data/bin/commands/functions.rb

@@ -9,8 +9,8 @@ module Slack
         g.desc 'Signal that a function failed to complete'
         g.long_desc %( Signal that a function failed to complete )
         g.command 'completeError' do |c|
-          c.flag 'error', desc: 'A human-readable error message that contains information about why the function failed to complete.'
           c.flag 'function_execution_id', desc: 'Context identifier that maps to the executed function.'
+          c.flag 'error', desc: 'A human-readable error message that contains information about why the function failed to complete.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.functions_completeError(options))
           end

data/bin/commands/functions_distributions_permissions.rb

@@ -9,21 +9,21 @@ module Slack
         g.desc 'Grant users access to a custom slack function if its permission_type is set to named_entities'
         g.long_desc %( Grant users access to a custom slack function if its permission_type is set to named_entities )
         g.command 'add' do |c|
-          c.flag 'function_app_id', desc: 'The encoded ID of the app.'
-          c.flag 'function_callback_id', desc: "The callback ID defined in the function's definition file."
           c.flag 'function_id', desc: 'The encoded ID of the function.'
+          c.flag 'function_callback_id', desc: "The callback ID defined in the function's definition file."
+          c.flag 'function_app_id', desc: 'The encoded ID of the app.'
           c.flag 'user_ids', desc: 'List of encoded user IDs.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.functions_distributions_permissions_add(options))
           end
         end
 
-        g.desc 'List the access type of a custom slack function and include the users or team or org ids with access if its permission_type is set to named_entities'
-        g.long_desc %( List the access type of a custom slack function and include the users or team or org ids with access if its permission_type is set to named_entities )
+        g.desc 'List the access type of a custom slack function and include the users, team or org ids with access if its permission_type is set to named_entities'
+        g.long_desc %( List the access type of a custom slack function and include the users, team or org ids with access if its permission_type is set to named_entities )
         g.command 'list' do |c|
-          c.flag 'function_app_id', desc: 'The encoded ID of the app.'
-          c.flag 'function_callback_id', desc: "The callback ID defined in the function's definition file."
           c.flag 'function_id', desc: 'The encoded ID of the function.'
+          c.flag 'function_callback_id', desc: "The callback ID defined in the function's definition file."
+          c.flag 'function_app_id', desc: 'The encoded ID of the app.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.functions_distributions_permissions_list(options))
           end
@@ -32,25 +32,25 @@ module Slack
         g.desc 'Revoke user access to a custom slack function if permission_type set to named_entities'
         g.long_desc %( Revoke user access to a custom slack function if permission_type set to named_entities )
         g.command 'remove' do |c|
-          c.flag 'function_app_id', desc: 'The encoded ID of the app.'
-          c.flag 'function_callback_id', desc: "The callback ID defined in the function's definition file."
           c.flag 'function_id', desc: 'The encoded ID of the function.'
+          c.flag 'function_callback_id', desc: "The callback ID defined in the function's definition file."
+          c.flag 'function_app_id', desc: 'The encoded ID of the app.'
           c.flag 'user_ids', desc: 'List of encoded user IDs.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.functions_distributions_permissions_remove(options))
           end
         end
 
-        g.desc 'Set the access type of a custom slack function and define the users or team or org ids to be granted access if permission_type is set to named_entities'
-        g.long_desc %( Set the access type of a custom slack function and define the users or team or org ids to be granted access if permission_type is set to named_entities )
+        g.desc 'Set the access type of a custom slack function and define the users, team or org ids to be granted access if permission_type is set to named_entities'
+        g.long_desc %( Set the access type of a custom slack function and define the users, team or org ids to be granted access if permission_type is set to named_entities )
         g.command 'set' do |c|
-          c.flag 'permission_type', desc: 'The type of permission that defines how the function can be distributed.'
-          c.flag 'function_app_id', desc: 'The encoded ID of the app.'
-          c.flag 'function_callback_id', desc: "The callback ID defined in the function's definition file."
           c.flag 'function_id', desc: 'The encoded ID of the function.'
-          c.flag 'org_ids', desc: 'List of org IDs to allow for named_entities permission.'
-          c.flag 'team_ids', desc: 'List of team IDs to allow for named_entities permission.'
+          c.flag 'function_callback_id', desc: "The callback ID defined in the function's definition file."
+          c.flag 'function_app_id', desc: 'The encoded ID of the app.'
+          c.flag 'permission_type', desc: 'The type of permission that defines how the function can be distributed.'
           c.flag 'user_ids', desc: 'List of encoded user IDs.'
+          c.flag 'team_ids', desc: 'List of team IDs to allow for named_entities permission.'
+          c.flag 'org_ids', desc: 'List of org IDs to allow for named_entities permission.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.functions_distributions_permissions_set(options))
           end

data/bin/commands/functions_workflows_steps.rb

@@ -9,10 +9,10 @@ module Slack
         g.desc "List the steps of a specific function of a workflow's versions"
         g.long_desc %( List the steps of a specific function of a workflow's versions )
         g.command 'list' do |c|
-          c.flag 'function_id', desc: 'The ID of the function to query.'
+          c.flag 'workflow_id', desc: 'The workflow ID, starts with Wf*.'
           c.flag 'workflow', desc: 'The workflow encoded ID or workflow reference.'
           c.flag 'workflow_app_id', desc: 'The app tied to the workflow reference.'
-          c.flag 'workflow_id', desc: 'The workflow ID, starts with Wf*.'
+          c.flag 'function_id', desc: 'The ID of the function to query.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.functions_workflows_steps_list(options))
           end

data/bin/commands/functions_workflows_steps_responses.rb

@@ -9,10 +9,10 @@ module Slack
         g.desc 'Download form responses of a workflow'
         g.long_desc %( Download form responses of a workflow )
         g.command 'export' do |c|
-          c.flag 'step_id', desc: 'The ID of the OpenForm step to export.'
+          c.flag 'workflow_id', desc: 'The workflow ID, starts with Wf*.'
           c.flag 'workflow', desc: 'The workflow encoded ID or workflow reference.'
           c.flag 'workflow_app_id', desc: 'The app tied to the workflow reference.'
-          c.flag 'workflow_id', desc: 'The workflow ID, starts with Wf*.'
+          c.flag 'step_id', desc: 'The ID of the OpenForm step to export.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.functions_workflows_steps_responses_export(options))
           end

data/bin/commands/migration.rb

@@ -6,8 +6,8 @@ module Slack
     class App
       desc 'Migration methods.'
       command 'migration' do |g|
-        g.desc 'For Enterprise Grid workspaces, map local user IDs to global user IDs'
-        g.long_desc %( For Enterprise Grid workspaces, map local user IDs to global user IDs )
+        g.desc 'For Enterprise organization workspaces, map local user IDs to global user IDs'
+        g.long_desc %( For Enterprise organization workspaces, map local user IDs to global user IDs )
         g.command 'exchange' do |c|
           c.flag 'users', desc: 'A comma-separated list of user ids, up to 400 per request.'
           c.flag 'team_id', desc: 'Specify team_id starts with T in case of Org Token.'

data/bin/commands/oauth_v2.rb

@@ -12,8 +12,8 @@ module Slack
           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 'grant_type', desc: 'The grant_type param as described in the OAuth spec.'
           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.action do |_global_options, options, _args|
             puts JSON.dump(@client.oauth_v2_access(options))

data/bin/commands/openid_connect.rb

@@ -12,8 +12,8 @@ module Slack
           c.flag 'client_id', desc: 'Issued when you created your application.'
           c.flag 'client_secret', desc: 'Issued when you created your application.'
           c.flag 'code', desc: 'The code param returned via the OAuth callback.'
-          c.flag 'grant_type', desc: 'The grant_type param as described in the OAuth spec.'
           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.action do |_global_options, options, _args|
             puts JSON.dump(@client.openid_connect_token(options))

data/bin/commands/reactions.rb

@@ -33,11 +33,11 @@ module Slack
         g.desc 'Lists reactions made by a user.'
         g.long_desc %( Lists reactions made by a user. )
         g.command 'list' do |c|
-          c.flag 'cursor', desc: "Parameter for pagination. 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. See pagination for more details."
+          c.flag 'user', desc: 'Show reactions made by this user. Defaults to the authed user.'
           c.flag 'full', desc: 'If true always return the complete reaction list.'
+          c.flag 'cursor', desc: "Parameter for pagination. 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. See pagination for more details."
           c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached."
           c.flag 'team_id', desc: 'encoded team id to list reactions in, required if org token is used.'
-          c.flag 'user', desc: 'Show reactions made by this user. Defaults to the authed user.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.reactions_list(options))
           end
@@ -47,9 +47,9 @@ module Slack
         g.long_desc %( Removes a reaction from an item. )
         g.command 'remove' do |c|
           c.flag 'name', desc: 'Reaction (emoji) name.'
-          c.flag 'channel', desc: 'Channel where the message to remove reaction from was posted.'
           c.flag 'file', desc: 'File to remove reaction from.'
           c.flag 'file_comment', desc: 'File comment to remove reaction from.'
+          c.flag 'channel', desc: 'Channel where the message to remove reaction from was posted.'
           c.flag 'timestamp', desc: 'Timestamp of the message to remove reaction from.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.reactions_remove(options))

data/bin/commands/reminders.rb

@@ -11,9 +11,9 @@ module Slack
         g.command 'add' do |c|
           c.flag 'text', desc: 'The content of the reminder.'
           c.flag 'time', desc: 'Can also take a type of integer. When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday").'
-          c.flag 'recurrence', desc: 'Specify the repeating behavior of a reminder. Available options: daily, weekly, monthly, or yearly. If weekly, may further specify the days of the week.'
-          c.flag 'team_id', desc: 'Encoded team id, required if org token is used.'
           c.flag 'user', desc: 'No longer supported - reminders cannot be set for other users. Previously, was the user who would receive the reminder.'
+          c.flag 'team_id', desc: 'Encoded team id, required if org token is used.'
+          c.flag 'recurrence', desc: 'Specify the repeating behavior of a reminder. Available options: daily, weekly, monthly, or yearly. If weekly, may further specify the days of the week.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.reminders_add(options))
           end

data/bin/commands/rtm.rb

@@ -15,6 +15,21 @@ module Slack
             puts JSON.dump(@client.rtm_connect(options))
           end
         end
+
+        g.desc 'Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.'
+        g.long_desc %( Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead. )
+        g.command 'start' do |c|
+          c.flag 'simple_latest', desc: 'Return timestamp only for latest message object of each channel (improves performance).'
+          c.flag 'no_unreads', desc: 'Skip unread counts for each channel (improves performance).'
+          c.flag 'mpim_aware', desc: 'Returns MPIMs to the client in the API response.'
+          c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
+          c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
+          c.flag 'no_latest', desc: 'Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1.'
+          c.flag 'include_locale', desc: 'Set this to true to receive the locale for users and channels. Defaults to false.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.rtm_start(options))
+          end
+        end
       end
     end
   end

data/bin/commands/search.rb

@@ -9,8 +9,8 @@ module Slack
         g.desc 'Searches for messages and files matching a query.'
         g.long_desc %( Searches for messages and files matching a query. )
         g.command 'all' do |c|
-          c.flag 'query', desc: 'Search query. May contains booleans, etc.'
           c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
+          c.flag 'query', desc: 'Search query. May contains booleans, etc.'
           c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
           c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
           c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
@@ -22,8 +22,8 @@ module Slack
         g.desc 'Searches for files matching a query.'
         g.long_desc %( Searches for files matching a query. )
         g.command 'files' do |c|
-          c.flag 'query', desc: 'Search query.'
           c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
+          c.flag 'query', desc: 'Search query.'
           c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
           c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
           c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
@@ -35,9 +35,9 @@ module Slack
         g.desc 'Searches for messages matching a query.'
         g.long_desc %( Searches for messages matching a query. )
         g.command 'messages' do |c|
-          c.flag 'query', desc: 'Search query.'
-          c.flag 'cursor', desc: "Use this when getting results with cursormark pagination. For first call send * for subsequent calls, send the value of next_cursor returned in the previous call's results."
           c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
+          c.flag 'cursor', desc: "Use this when getting results with cursormark pagination. For first call send * for subsequent calls, send the value of next_cursor returned in the previous call's results."
+          c.flag 'query', desc: 'Search query.'
           c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
           c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
           c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'