slack-ruby-client 2.6.0 → 3.0.0

data/README.md

@@ -2,12 +2,10 @@ Slack Ruby Client
 =================
 
 [![Gem Version](https://badge.fury.io/rb/slack-ruby-client.svg)](http://badge.fury.io/rb/slack-ruby-client)
-[![Integration Tests](https://github.com/slack-ruby/slack-ruby-client/actions/workflows/integration_test.yml/badge.svg?branch=master)](https://github.com/slack-ruby/slack-ruby-client/actions/workflows/integration_test.yml)
 [![Tests](https://github.com/slack-ruby/slack-ruby-client/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/slack-ruby/slack-ruby-client/actions/workflows/test.yml)
-[![Code Climate](https://codeclimate.com/github/slack-ruby/slack-ruby-client/badges/gpa.svg)](https://codeclimate.com/github/slack-ruby/slack-ruby-client)
 [![Coverage Status](https://coveralls.io/repos/github/slack-ruby/slack-ruby-client/badge.svg?branch=master)](https://coveralls.io/github/slack-ruby/slack-ruby-client?branch=master)
 
-A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messaging](https://api.slack.com/rtm) and [Events](https://api.slack.com/events-api) APIs. Comes with a handy command-line client, too. If you are not familiar with these concepts, you might want to watch [this video](http://code.dblock.org/2016/03/11/your-first-slack-bot-service-video.html).
+A Ruby client for the Slack [Web](https://api.slack.com/web) and [Events](https://api.slack.com/events-api) APIs. Comes with a handy command-line client, too. If you are not familiar with these concepts, you might want to watch [this video](http://code.dblock.org/2016/03/11/your-first-slack-bot-service-video.html).
 
 ![](slack.png)
 
@@ -39,16 +37,6 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
       - [Slack Errors](#slack-errors)
       - [Rate Limiting](#rate-limiting)
       - [Other Errors](#other-errors)
-  - [RealTime Client](#realtime-client)
-    - [Configuring Slack::RealTime::Client](#configuring-slackrealtimeclient)
-      - [Caveats](#caveats)
-        - [websocket_ping](#websocket_ping)
-    - [RealTime Store](#realtime-store)
-      - [Slack::RealTime::Stores::Starter](#slackrealtimestoresstarter)
-      - [Slack::RealTime::Stores::Store](#slackrealtimestoresstore)
-  - [Combining RealTime and Web Clients](#combining-realtime-and-web-clients)
-    - [Concurrency](#concurrency)
-      - [Async](#async)
   - [Events API](#events-api)
     - [Configuring Slack::Events](#configuring-slackevents)
     - [Verifying the Request Signature](#verifying-the-request-signature)
@@ -68,7 +56,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
     - [Send a Message](#send-a-message)
     - [Get Channel Info](#get-channel-info-1)
     - [List Users](#list-users)
-- [Enterprise Support](#enterprise-support)
+- [Sponsorship and Enterprise Support](#sponsorship-and-enterprise-support)
 - [History](#history)
 - [Security](#security)
 - [Contributing](#contributing)
@@ -76,13 +64,13 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
 
 ## Useful to Me?
 
-* This library lets you send messages to Slack via the Web API, send and receive messages via the Real Time Messaging API, and facilitates integration with the Events API.
+* This library lets you send messages to Slack via the Web API and facilitates integration with the Events API.
 * To write a complete bot for Slack you need more than this library, and it's much easier to start with [slack-ruby-bot-server-events](https://github.com/slack-ruby/slack-ruby-bot-server-events).
 * To respond to slash commands, interactive components, or events at the lowest level, implement a web application using your favorite web framework, and use this library to call the Slack Web API, and to verify that events are coming from Slack.
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, v3.0.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -92,12 +80,6 @@ Add to Gemfile.
 gem 'slack-ruby-client'
 ```
 
-If you're going to be using the RealTime client, add `async-websocket`. See below for more information about concurrency.
-
-```
-gem 'async-websocket', '~> 0.8.0'
-```
-
 Run `bundle install`.
 
 ## Usage
@@ -174,6 +156,8 @@ Upload files with [sequenced API calls](https://api.slack.com/messaging/files#up
 
 This library provides a helper method `files_upload_v2` that wraps the three separate API calls.
 
+Upload a single file.
+
 ```ruby
 client.files_upload_v2(
   # required options
@@ -189,6 +173,19 @@ client.files_upload_v2(
 )
 ```
 
+Upload multiple files.
+
+```ruby
+client.files_upload_v2(
+  files: [
+    { filename: 'report.pdf', content: File.read('/users/me/report.pdf'), title: 'Monthly Report' },
+    { filename: 'data.csv', content: File.read('/users/me/data.csv'), title: 'Raw Data' }
+  ],
+  channels: ['#general'],
+  initial_comment: 'Here are the monthly results!'
+)
+```
+
 You can use a channel ID passed as `channel_id`, a single channel as `channel`, an array of channel IDs as `channels`, or a channel name or names (prefixed with `#`) in `files_upload_v2`. Lookup by name is not supported by the Slack API and this method called invokes `conversations_list` in order to locate the channel ID. This invocation can have a cost if you have many Slack channels and is only recommended when you intend to list channels anyway.
 
 Note: This library includes a `files_upload` method that uses a deprecated endpoint `files.upload` that will [no longer be supported on 3/11/2025](https://api.slack.com/methods/files.upload#markdown).
@@ -271,12 +268,12 @@ You can configure the Web client either globally or via the initializer.
 
 ```ruby
 Slack::Web::Client.configure do |config|
-  config.user_agent = 'Slack Ruby Client/1.0'
+  config.user_agent = 'Slack Ruby Client/3.0'
 end
 ```
 
 ```ruby
-client = Slack::Web::Client.new(user_agent: 'Slack Ruby Client/1.0')
+client = Slack::Web::Client.new(user_agent: 'Slack Ruby Client/3.0')
 ```
 
 The following settings are supported.
@@ -304,7 +301,7 @@ You can also pass request options, including `timeout` and `open_timeout` into i
 client.conversations_list(request: { timeout: 180 })
 ```
 
-You can also control what proxy options are used by modifying the `http_proxy` environment variable per [Net::HTTP's documentation](https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html#class-Net::HTTP-label-Proxies).
+You can control what proxy options are used by modifying the `http_proxy` environment variable per [Net::HTTP's documentation](https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html#class-Net::HTTP-label-Proxies).
 
 Note that Docker on OSX seems to incorrectly set the proxy, causing `Faraday::ConnectionFailed, ERROR -- : Failed to open TCP connection to : (getaddrinfo: Name or service not known)`. You might need to manually unset `http_proxy` in that case, eg. `http_proxy="" bundle exec ruby ./my_bot.rb`.
 
@@ -388,194 +385,6 @@ Specifically `Slack::Web::Api::Errors::ParsingError` will be raised on non-json
 
 In any other case, a `Faraday::ClientError` will be raised.
 
-### RealTime Client
-
-The Real Time Messaging API is a WebSocket-based API that allows you to receive events from Slack in real time and send messages as user.
-
-```ruby
-client = Slack::RealTime::Client.new
-
-client.on :hello do
-  puts "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
-end
-
-client.on :message do |data|
-  case data.text
-  when 'bot hi' then
-    client.message(channel: data.channel, text: "Hi <@#{data.user}>!")
-  when /^bot/ then
-    client.message(channel: data.channel, text: "Sorry <@#{data.user}>, what?")
-  end
-end
-
-client.on :close do |_data|
-  puts "Client is about to disconnect"
-end
-
-client.on :closed do |_data|
-  puts "Client has disconnected successfully!"
-end
-
-client.start!
-```
-
-You can send typing indicators with `typing`.
-
-```ruby
-client.typing channel: data.channel
-```
-
-You can send a ping with `ping`.
-
-```ruby
-client.ping
-```
-
-#### Configuring Slack::RealTime::Client
-
-You can configure the RealTime client either globally or via the initializer.
-
-```ruby
-Slack::RealTime::Client.configure do |config|
-  config.websocket_ping = 42
-end
-```
-
-```ruby
-client = Slack::RealTime::Client.new(websocket_ping: 42)
-```
-
-The following settings are supported.
-
-setting         | description
-----------------|-----------------------------------------------------------------------------------------------------
-token           | Slack API token.
-websocket_ping  | How long the socket can be idle before sending a ping message to confirm it's still connected, default is 30.
-websocket_proxy | Connect via proxy, include `:origin` and `:headers`.
-start_options   | Options to pass to `rtm.connect`, default is `{ request: { timeout: 180 } }`.
-store_class     | Local store class, default is an in-memory `Slack::RealTime::Stores::Starter`.
-store_options   | Options to initialize the store, default is `{}`.
-async_handlers  | Option to run handlers asynchronously. Valid options are `:all` or `:none`, default is `:none`.
-logger          | Optional `Logger` instance that logs RealTime requests and socket data.
-
-Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.connect](https://api.slack.com/methods/rtm.connect). While `token` and `logger` options are passed down from the RealTime client, you may also configure Web client options via `Slack::Web::Client.configure` as described above.
-
-See a fully working example in [examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb).
-
-![](examples/hi_real_time_and_web/hi.gif)
-
-##### Caveats
-
-###### `websocket_ping`
-
-This setting determines how long the socket can be idle before sending a ping message to confirm it's still connected.
-
-It's important to note that if a ping message was sent and no response was received within the amount of time specified in `websocket_ping` the client will attempt to reestablish it's connection to the message server.
-
-Note that the ping may take between `websocket_ping` and `websocket_ping * 3/2` seconds to actually trigger when there is no activity on the socket. This is because the timer that checks whether to ping is triggered at every `websocket_ping / 2` interval.
-
-To disable this feature set `websocket_ping` to 0.
-
-#### RealTime Store
-
-The RealTime client exposes and maintains a local store upon successful connection.
-Event hooks keep the store's cached data up-to-date.
-
-Tracking with a local store can be disabled with `Slack::RealTime::Client.new(store_class: nil)`.
-
-##### `Slack::RealTime::Stores::Starter`
-
-A small store that only caches and tracks data returned in the [rtm.connect](https://api.slack.com/methods/rtm.connect#examples) response.
-This store provides `self` and `team` for accessing the limited data about the authenticated user and its workspace, but does not cache other users or bots, channels, or direct messages.
-
-##### `Slack::RealTime::Stores::Store`
-
-A more complete store that tracks most changes visible to the authenticated user.
-
-You can see all of the cache types in the table below (each is a hash indexed by its objects' `id`).
-
-Cache              | Description
--------------------|-------------------------------------------------------------------------------------------------
-`teams`            | Workspaces (teams). Will likely contain only one `team`.
-`users`            | All [user](https://api.slack.com/types/user) objects, including `self`.
-`bots`             | All [bot users](https://api.slack.com/bot-users) (from Slack Apps and legacy custom integrations).
-`public_channels`  | Public [conversation](https://api.slack.com/types/conversation) objects.
-`private_channels` | Private [conversation](https://api.slack.com/types/conversation) and [group](https://api.slack.com/types/group) objects with the authenticated user as a member.
-`ims`              | Visible [im](https://api.slack.com/types/im) objects, direct message channels with the authenticated user.
-`mpims`            | Visible [mpim](https://api.slack.com/types/mpim) objects, multiparty direct message channels that include the authenticated user.
-
-By default, none of these caches are initialized with data beyond what is returned from [rtm.connect](https://api.slack.com/methods/rtm.connect#examples), same as [Slack::RealTime::Stores::Starter](#slackrealtimestoresstarter).
-When configured, this store initializes its caches by making additional calls to Web API methods upon successful connection to the RTM API (i.e. "hello" message).
-
-Configure by specifying which caches to fetch:
-```ruby
-Slack::RealTime::Client.configure do |config|
-  config.store_class = Slack::RealTime::Stores::Store
-  config.store_options = { caches: %i[teams users public_channels private_channels ims] }
-end
-```
-or with the `:all` option:
-```ruby
-Slack::RealTime::Client.configure do |config|
-  config.store_class = Slack::RealTime::Stores::Store
-  config.store_options = { caches: :all }
-end
-```
-
-Note: For `teams`, this makes a single call to `team.info`, while for `users` and all conversation-like types, this makes paginated calls to `users.list` and `conversations.list` respectively.
-Only `bots` requires a separate call for every bot user, so may be slow if your workplace has a lot of bot users.
-
-### Combining RealTime and Web Clients
-
-Since the Web client is used to obtain the RealTime client's WebSocket URL, you can continue using the Web client in combination with the RealTime client.
-
-```ruby
-client = Slack::RealTime::Client.new
-
-client.on :message do |data|
-  case data.text
-  when 'bot hi' then
-    client.web_client.chat_postMessage(channel: data.channel, text: "Hi <@#{data.user}>!")
-  when /^bot/ then
-    client.web_client.chat_postMessage(channel: data.channel, text: "Sorry <@#{data.user}>, what?")
-  end
-end
-
-client.start!
-```
-
-See a fully working example in [examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb).
-
-![](examples/hi_real_time_and_web/hi.gif)
-
-#### Concurrency
-
-`Slack::RealTime::Client` needs help from a concurrency library and supports [Async](https://github.com/socketry/async).
-
-```ruby
-Slack::RealTime.configure do |config|
-  config.concurrency = Slack::RealTime::Concurrency::Async
-end
-```
-
-Use `client.start_async` instead of `client.start!`. A good example of such application is [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server).
-
-```ruby
-client = Slack::RealTime::Client.new
-
-client.start_async
-```
-
-##### Async
-
-Add `async-websocket` to your Gemfile.
-
-```
-gem 'async-websocket'
-```
-
-See a fully working example in [examples/hi_real_time_async_async](examples/hi_real_time_async_async/hi.rb).
-
 ### Events API
 
 This library provides limited support for the [Slack Events API](https://api.slack.com/events-api).
@@ -608,9 +417,11 @@ slack_request.verify!
 
 To specify secrets on a per-request basis:
 ```ruby
-Slack::Events::Request.new(http_request,
-                           signing_secret: signing_secret,
-                           signature_expires_in: signature_expires_in)
+Slack::Events::Request.new(
+  http_request,
+  signing_secret: signing_secret,
+  signature_expires_in: signature_expires_in
+)
 ```
 
 The `verify!` call may raise `Slack::Events::Request::MissingSigningSecret`, `Slack::Events::Request::InvalidSignature` or `Slack::Events::Request::TimestampExpired` errors.
@@ -793,11 +604,11 @@ $ slack users list | jq '.members | map({(.id): .name})'
 
 See `slack help` for a complete command-line reference.
 
-## Enterprise Support
+## Sponsorship and Enterprise Support
 
-Available as part of the Tidelift Subscription.
+This library was created and has been maintained for a decade by [@dblock](https://github.com/dblock). Please consider [a sponsorship](https://github.com/sponsors/dblock).
 
-The maintainers of slack-ruby-client are working with Tidelift to deliver commercial support and maintenance. Save time, reduce risk, and improve code health, while paying the maintainers of slack-ruby-client. Click [here](https://tidelift.com/subscription/request-a-demo?utm_source=rubygems-slack-ruby-client&utm_medium=referral&utm_campaign=enterprise) for more details.
+Enterprise Support is available as part of a Tidelift Subscription. Click [here](https://tidelift.com/subscription/request-a-demo?utm_source=rubygems-slack-ruby-client&utm_medium=referral&utm_campaign=enterprise) for more details.
 
 ## History
 
@@ -813,6 +624,6 @@ See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Copyright and License
 
-Copyright (c) 2015-2021, [Daniel Doubrovkine](https://twitter.com/dblockdotorg), [Artsy](https://www.artsy.net) and [Contributors](CHANGELOG.md).
+Copyright (c) 2015-2025, [Daniel Doubrovkine](https://twitter.com/dblockdotorg), [Artsy](https://www.artsy.net) and [Contributors](CHANGELOG.md).
 
 This project is licensed under the [MIT License](LICENSE.md).

data/Rakefile

@@ -19,5 +19,4 @@ task default: %i[spec rubocop]
 
 load 'tasks/git.rake'
 load 'tasks/web.rake'
-load 'tasks/real_time.rake'
 load 'tasks/update.rake'

data/UPGRADING.md

@@ -1,6 +1,10 @@
 Upgrading Slack-Ruby-Client
 ===========================
 
+### Upgrading to >= 3.0.0
+
+Support for the [RTM API](https://docs.slack.dev/tools/java-slack-sdk/guides/rtm/) has been removed in [#573](https://github.com/slack-ruby/slack-ruby-client/pull/573). By now you should have [migrated your app to granular permissions](https://code.dblock.org/2020/11/30/migrating-classic-slack-ruby-bots-to-granular-permissions.html), and you should lock your slack-ruby-client to 2.x for those bots. Next, to remove RTM components we found it more effective to just [write a new version of a bot](https://code.dblock.org/2024/06/30/writing-a-channel-slack-bot.html) and avoid a complex migration.
+
 ### Upgrading to >= 2.0.0
 
 [#416](https://github.com/slack-ruby/slack-ruby-client/pull/416) Removes default values for Faraday's SSL settings `ca_file` and `ca_path`.

data/bin/commands/admin_analytics.rb

@@ -9,8 +9,8 @@ module Slack
         g.desc 'Retrieve analytics data for a given date, presented as a compressed JSON file'
         g.long_desc %( Retrieve analytics data for a given date, presented as a compressed JSON file )
         g.command 'getFile' do |c|
-          c.flag 'type', desc: 'The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).'
           c.flag 'date', desc: 'Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC. Required unless metadata_only is set to true.'
+          c.flag 'type', desc: 'The type of analytics to retrieve. The options are currently limited to member (for Enterprise org member analytics) and public_channel (for public channel analytics).'
           c.flag 'metadata_only', desc: 'Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_analytics_getFile(options))

data/bin/commands/admin_apps.rb

@@ -10,9 +10,9 @@ module Slack
         g.long_desc %( Approve an app for installation on a workspace. )
         g.command 'approve' do |c|
           c.flag 'app_id', desc: 'The id of the app to approve.'
-          c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
           c.flag 'request_id', desc: 'The id of the request to approve.'
           c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
+          c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_approve(options))
           end
@@ -22,8 +22,8 @@ module Slack
         g.long_desc %( Clear an app resolution )
         g.command 'clearResolution' do |c|
           c.flag 'app_id', desc: 'The id of the app whose resolution you want to clear/undo.'
-          c.flag 'enterprise_id', desc: 'The enterprise to clear the app resolution from.'
           c.flag 'team_id', desc: 'The workspace to clear the app resolution from.'
+          c.flag 'enterprise_id', desc: 'The enterprise to clear the app resolution from.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_clearResolution(options))
           end
@@ -33,9 +33,9 @@ module Slack
         g.long_desc %( Restrict an app for installation on a workspace. )
         g.command 'restrict' do |c|
           c.flag 'app_id', desc: 'The id of the app to restrict.'
-          c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
           c.flag 'request_id', desc: 'The id of the request to restrict.'
           c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
+          c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_restrict(options))
           end
@@ -45,8 +45,8 @@ module Slack
         g.long_desc %( Uninstall an app from one or many workspaces, or an entire enterprise organization. )
         g.command 'uninstall' do |c|
           c.flag 'app_id', desc: 'The ID of the app to uninstall.'
-          c.flag 'enterprise_id', desc: 'The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.'
           c.flag 'team_ids', desc: 'IDs of the teams to uninstall from (max 100). With an org-level token, this or enterprise_id is required.'
+          c.flag 'enterprise_id', desc: 'The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_uninstall(options))
           end

data/bin/commands/admin_apps_activities.rb

@@ -10,18 +10,18 @@ module Slack
         g.long_desc %( Get logs for a specified team/org )
         g.command 'list' do |c|
           c.flag 'app_id', desc: 'The ID of the app to get activities from.'
-          c.flag 'component_id', desc: 'The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for worflows.'
-          c.flag 'component_type', desc: 'The component type of log events to be returned. Acceptable values are events_api, workflows, functions and tables.'
+          c.flag 'team_id', desc: 'The team who owns this log.'
           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 'limit', desc: 'The maximum number of items to return.'
-          c.flag 'log_event_type', desc: 'The event type of log events to be returned.'
-          c.flag 'max_date_created', desc: 'The latest timestamp of the log to retrieve (epoch microseconds).'
-          c.flag 'min_date_created', desc: 'The earliest timestamp of the log to retrieve (epoch microseconds).'
           c.flag 'min_log_level', desc: 'The minimum log level of the log events to be returned. Defaults to info. Acceptable values (in order of relative importance from smallest to largest) are trace, debug, info, warn, error and fatal.'
-          c.flag 'sort_direction', desc: 'The direction you want the data sorted by (always by timestamp).'
+          c.flag 'log_event_type', desc: 'The event type of log events to be returned.'
           c.flag 'source', desc: 'The source of log events to be returned. Acceptable values are slack and developer.'
-          c.flag 'team_id', desc: 'The team who owns this log.'
+          c.flag 'component_type', desc: 'The component type of log events to be returned. Acceptable values are events_api, workflows, functions and tables.'
+          c.flag 'component_id', desc: 'The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for workflows.'
           c.flag 'trace_id', desc: 'The trace ID of log events to be returned.'
+          c.flag 'min_date_created', desc: 'The earliest timestamp of the log to retrieve (epoch microseconds).'
+          c.flag 'max_date_created', desc: 'The latest timestamp of the log to retrieve (epoch microseconds).'
+          c.flag 'sort_direction', desc: 'The direction you want the data sorted by (always by timestamp).'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_activities_list(options))
           end

data/bin/commands/admin_apps_approved.rb

@@ -9,11 +9,11 @@ module Slack
         g.desc 'List approved apps for an org or workspace.'
         g.long_desc %( List approved apps for an org or workspace. )
         g.command 'list' do |c|
-          c.flag 'certified', desc: 'Limit the results to only include certified apps. When false, no certified apps will appear in the result.'
-          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
-          c.flag 'enterprise_id', desc: '.'
           c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
-          c.flag 'team_id', desc: '.'
+          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+          c.flag 'team_id', desc: ''
+          c.flag 'enterprise_id', desc: ''
+          c.flag 'certified', desc: 'Limit the results to only include certified apps. When false, no certified apps will appear in the result.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_approved_list(options))
           end

data/bin/commands/admin_apps_config.rb

@@ -10,6 +10,7 @@ module Slack
         g.long_desc %( Look up the app config for connectors by their IDs )
         g.command 'lookup' do |c|
           c.flag 'app_ids', desc: 'An array of app IDs to get app configs for.'
+          c.flag 'rich_link_preview_types', desc: 'return apps with the corresponding rich link preview layouts.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_config_lookup(options))
           end
@@ -19,8 +20,9 @@ module Slack
         g.long_desc %( Set the app config for a connector )
         g.command 'set' do |c|
           c.flag 'app_id', desc: 'The encoded app ID to set the app config for.'
-          c.flag 'domain_restrictions', desc: 'Domain restrictions for the app. Should be an object with two properties: urls and emails. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.'
           c.flag 'workflow_auth_strategy', desc: 'The workflow auth permission. Can be one of builder_choice or end_user_only.'
+          c.flag 'rich_link_preview_type', desc: 'Indicates the app-level override for rich link preview. Unsupported for free teams.'
+          c.flag 'domain_restrictions', desc: 'Domain restrictions for the app. Should be an object with two properties: urls and emails. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_config_set(options))
           end

data/bin/commands/admin_apps_requests.rb

@@ -10,8 +10,8 @@ module Slack
         g.long_desc %( Cancel app request for team )
         g.command 'cancel' do |c|
           c.flag 'request_id', desc: 'The id of the request to cancel.'
-          c.flag 'enterprise_id', desc: 'The ID of the enterprise where this request belongs.'
           c.flag 'team_id', desc: 'The ID of the workspace where this request belongs.'
+          c.flag 'enterprise_id', desc: 'The ID of the enterprise where this request belongs.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_requests_cancel(options))
           end
@@ -20,11 +20,11 @@ module Slack
         g.desc 'List app requests for a team/workspace.'
         g.long_desc %( List app requests for a team/workspace. )
         g.command 'list' do |c|
-          c.flag 'certified', desc: 'Include requests for certified apps.'
-          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
-          c.flag 'enterprise_id', desc: '.'
           c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
-          c.flag 'team_id', desc: '.'
+          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+          c.flag 'team_id', desc: ''
+          c.flag 'enterprise_id', desc: ''
+          c.flag 'certified', desc: 'Include requests for certified apps.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_requests_list(options))
           end

data/bin/commands/admin_apps_restricted.rb

@@ -9,11 +9,11 @@ module Slack
         g.desc 'List restricted apps for an org or workspace.'
         g.long_desc %( List restricted apps for an org or workspace. )
         g.command 'list' do |c|
-          c.flag 'certified', desc: 'Limit the results to only include certified apps. When false, no certified apps will appear in the result.'
-          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
-          c.flag 'enterprise_id', desc: '.'
           c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
-          c.flag 'team_id', desc: '.'
+          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+          c.flag 'team_id', desc: ''
+          c.flag 'enterprise_id', desc: ''
+          c.flag 'certified', desc: 'Limit the results to only include certified apps. When false, no certified apps will appear in the result.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_apps_restricted_list(options))
           end

data/bin/commands/admin_audit_anomaly_allow.rb

@@ -6,19 +6,19 @@ module Slack
     class App
       desc 'AdminAuditAnomalyAllow methods.'
       command 'admin_audit_anomaly_allow' do |g|
-        g.desc 'API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration.'
-        g.long_desc %( API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration. )
+        g.desc 'API to allow Enterprise org admins to read the allow list of IP blocks and ASNs from the enterprise configuration.'
+        g.long_desc %( API to allow Enterprise org admins to read the allow list of IP blocks and ASNs from the enterprise configuration. )
         g.command 'getItem' do |c|
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_audit_anomaly_allow_getItem(options))
           end
         end
 
-        g.desc 'API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.'
-        g.long_desc %( API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration. )
+        g.desc 'API to allow Enterprise org admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.'
+        g.long_desc %( API to allow Enterprise org admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration. )
         g.command 'updateItem' do |c|
-          c.flag 'trusted_asns', desc: 'allow list of Autonomous System Numbers (ASN) in the enterprise grid configuarion.'
-          c.flag 'trusted_cidr', desc: 'allow list of IPv4 addressses using cidr notation in the enterprise grid configuarion.'
+          c.flag 'trusted_cidr', desc: 'allow list of IPv4 addresses using cidr notation in the Enterprise organization configuration.'
+          c.flag 'trusted_asns', desc: 'allow list of Autonomous System Numbers (ASN) in the Enterprise organization configuration.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_audit_anomaly_allow_updateItem(options))
           end

data/bin/commands/admin_auth_policy.rb

@@ -9,9 +9,9 @@ module Slack
         g.desc 'Assign entities to a particular authentication policy.'
         g.long_desc %( Assign entities to a particular authentication policy. )
         g.command 'assignEntities' do |c|
-          c.flag 'entity_ids', desc: 'Array of IDs to assign to the policy.'
-          c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
           c.flag 'policy_name', desc: 'The name of the authentication policy to assign the entities to. Currently, email_password is the only policy that may be used with this method.'
+          c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
+          c.flag 'entity_ids', desc: 'Array of IDs to assign to the policy.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_auth_policy_assignEntities(options))
           end
@@ -21,9 +21,9 @@ module Slack
         g.long_desc %( Fetch all the entities assigned to a particular authentication policy by name. )
         g.command 'getEntities' do |c|
           c.flag 'policy_name', desc: 'The name of the policy to fetch entities for. Currently, email_password is the only policy that may be used with this method.'
-          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
           c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
           c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 and 1000, both inclusive.'
+          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_auth_policy_getEntities(options))
           end
@@ -32,9 +32,9 @@ module Slack
         g.desc 'Remove specified entities from a specified authentication policy.'
         g.long_desc %( Remove specified entities from a specified authentication policy. )
         g.command 'removeEntities' do |c|
-          c.flag 'entity_ids', desc: "Encoded IDs of the entities you'd like to remove from the policy."
-          c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
           c.flag 'policy_name', desc: 'The name of the policy to remove entities from. Currently, email_password is the only policy that may be used with this method.'
+          c.flag 'entity_type', desc: 'The type of entity to assign to the policy. Currently, USER is supported.'
+          c.flag 'entity_ids', desc: "Encoded IDs of the entities you'd like to remove from the policy."
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_auth_policy_removeEntities(options))
           end

data/bin/commands/admin_barriers.rb

@@ -9,8 +9,8 @@ module Slack
         g.desc 'Create an Information Barrier'
         g.long_desc %( Create an Information Barrier )
         g.command 'create' do |c|
-          c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
           c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
+          c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
           c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_barriers_create(options))
@@ -29,8 +29,8 @@ module Slack
         g.desc 'Get all Information Barriers for your organization'
         g.long_desc %( Get all Information Barriers for your organization )
         g.command 'list' do |c|
-          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
           c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
+          c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_barriers_list(options))
           end
@@ -40,8 +40,8 @@ module Slack
         g.long_desc %( Update an existing Information Barrier )
         g.command 'update' do |c|
           c.flag 'barrier_id', desc: "The ID of the barrier you're trying to modify."
-          c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
           c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
+          c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
           c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_barriers_update(options))