slack-ruby-client 2.4.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b846ffe66e3daaec235dd458c3e695cdf109b5834d5b699f4c548366bebdb1a5
-  data.tar.gz: c70470051b9a5fa2ed6bb58a284e86e30c123429b6f9a183b929c5a303c128d1
+  metadata.gz: 26da07098b43509aec00e5ce7e280ff83b055cae435c2f13b7e7528200356191
+  data.tar.gz: 9982a63021be02cd1caf07d6ee44d4fc5f8be64c10b6bfbadae153ed4201db59
 SHA512:
-  metadata.gz: 89b2d6c310698ab94521bd9b1acf4b25362199fcc0e4effc4f860468668eb1cb365c8f3bfdc1ab1a4fb660715eac6c13935272217756ef36e412e245d8b272b6
-  data.tar.gz: e7afd74cd61d65c6bd36d51a1f2cbe50ac9903862daaa999743e27648f3e1f910458b7b6d0d4183fbfb6d93e60b6f2e6484480aae58c64507ec722594255c1e9
+  metadata.gz: bf976826d6f95ed2da12a61c42fd1f18c73b8f8065dc4471723ae85c11a89b764cf0a2bd0f422c634a1206ac24e8d9c1fdb68b25a5eeb93fd0957ee1094bd470
+  data.tar.gz: 9ac701bc529f369b2051d70afeedcbc05305740199fd03dd572749ff28d9df8d73c7e583e26fafc7c757b74d631c4bca3d3f73970e2571dc52c7fa925d4a1a3c

data/.github/workflows/test.yml

@@ -12,6 +12,7 @@ jobs:
           - { ruby: "3.1" }
           - { ruby: "3.2" }
           - { ruby: "3.3" }
+          - { ruby: "3.4" }
           - { ruby: ruby-head, ignore: true }
           - { ruby: jruby-head, ignore: true }
     name: test (ruby=${{ matrix.entry.ruby }}${{ matrix.entry.concurrency && ', concurrency=' }}${{ matrix.entry.concurrency }})

data/.github/workflows/update_api.yml

@@ -42,7 +42,7 @@ jobs:
           installation_id: 36985419
       - name: Create pull request
         id: cpr
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           commit-message: Update API from slack-api-ref@${{ steps.api-ref.outputs.api-ref }} (${{ steps.date.outputs.date }})
@@ -66,7 +66,7 @@ jobs:
         with:
           include: CHANGELOG.md
           find: "\\* Your contribution here."
-          replace: "* [#${{steps.cpr.outputs.pull-request-number}}](https://github.com/slack-ruby-client/pulls/${{steps.cpr.outputs.pull-request-number}}): Update API from [slack-api-ref@${{ steps.api-ref.outputs.api-ref }}](https://github.com/slack-ruby/slack-api-ref/commit/${{ steps.api-ref.outputs.api-ref }}) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).\n* Your contribution here."
+          replace: "* [#${{steps.cpr.outputs.pull-request-number}}](https://github.com/slack-ruby/slack-ruby-client/pull/${{steps.cpr.outputs.pull-request-number}}): Update API from [slack-api-ref@${{ steps.api-ref.outputs.api-ref }}](https://github.com/slack-ruby/slack-api-ref/commit/${{ steps.api-ref.outputs.api-ref }}) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).\n* Your contribution here."
       - name: Commit and Push
         if: ${{ steps.cpr.outputs.pull-request-number != '' }}
         run: |

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-08-05 13:32:37 UTC using RuboCop version 1.26.1.
+# on 2025-02-11 15:48:56 UTC using RuboCop version 1.26.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -44,30 +44,42 @@ Lint/RedundantCopDisableDirective:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
-# Offense count: 12
+# Offense count: 13
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 36
+  Max: 58
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 11
 
-# Offense count: 13
+# Offense count: 15
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 26
+  Max: 35
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 12
+
+# Offense count: 1
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom/files_spec.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+Performance/MapCompact:
+  Exclude:
+    - 'lib/slack/web/api/helpers/files.rb'
 
 # Offense count: 2
 # This cop supports safe auto-correction (--auto-correct).
@@ -81,20 +93,20 @@ Performance/StringInclude:
   Exclude:
     - 'lib/tasks/web.rake'
 
-# Offense count: 8
+# Offense count: 9
 # This cop supports safe auto-correction (--auto-correct).
 RSpec/ContextMethod:
   Exclude:
     - 'spec/slack/messages/formatting_spec.rb'
     - 'spec/slack/web/api/mixins/users_spec.rb'
 
-# Offense count: 82
+# Offense count: 84
 # Configuration parameters: Prefixes.
 # Prefixes: when, with, without
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 65
+# Offense count: 72
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 18
@@ -105,13 +117,13 @@ RSpec/ExampleLength:
 RSpec/FilePath:
   Enabled: false
 
-# Offense count: 70
+# Offense count: 74
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 94
+# Offense count: 97
 RSpec/MultipleExpectations:
   Max: 5
 
@@ -130,11 +142,12 @@ RSpec/NamedSubject:
 RSpec/NestedGroups:
   Max: 6
 
-# Offense count: 5
+# Offense count: 6
 RSpec/StubbedMock:
   Exclude:
     - 'spec/slack/real_time/client_spec.rb'
     - 'spec/slack/real_time/event_handlers/event_handlers_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom/conversations_spec.rb'
     - 'spec/slack/web/api/pagination/cursor_spec.rb'
     - 'spec/slack/web/client_spec.rb'
 
@@ -166,6 +179,13 @@ Rake/Desc:
   Exclude:
     - 'lib/tasks/git.rake'
 
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, AllowModifiersOnSymbols.
+# SupportedStyles: inline, group
+Style/AccessModifierDeclarations:
+  Exclude:
+    - 'lib/slack/real_time/client.rb'
+
 # Offense count: 4
 # Configuration parameters: MaxUnannotatedPlaceholdersAllowed, IgnoredMethods.
 # SupportedStyles: annotated, template, unannotated
@@ -181,6 +201,17 @@ Style/GlobalStdStream:
     - 'spec/integration/integration_spec.rb'
     - 'spec/slack/web/client_spec.rb'
 
+# Offense count: 1
+# This cop supports unsafe auto-correction (--auto-correct-all).
+Style/MapToHash:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom/files_spec.rb'
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/slack/web/api/helpers/files.rb'
+
 # Offense count: 1
 # This cop supports safe auto-correction (--auto-correct).
 Style/MultilineTernaryOperator:
@@ -190,7 +221,7 @@ Style/MultilineTernaryOperator:
 # Offense count: 3
 Style/OpenStructUse:
   Exclude:
-    - 'spec/slack/web/api/endpoints/custom_specs/chat_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom/chat_spec.rb'
     - 'spec/slack/web/api/pagination/cursor_spec.rb'
     - 'spec/slack/web/faraday/response/raise_error_spec.rb'
 

data/CHANGELOG.md

@@ -1,16 +1,33 @@
+### 2.5.1 (2025/02/11)
+
+* [#542](https://github.com/slack-ruby/slack-ruby-client/pull/542): Add support for ruby 3.4 - [@dblock](https://github.com/dblock).
+* [#544](https://github.com/slack-ruby/slack-ruby-client/pull/544): Fix: do not resolve channel name for `chat_postMessage` - [@dblock](https://github.com/dblock).
+
+### 2.5.0 (2025/02/09)
+
+* [#525](https://github.com/slack-ruby/slack-ruby-client/pull/525): Exclude spec files from gem package - [@amatsuda](https://github.com/amatsuda).
+* [#527](https://github.com/slack-ruby/slack-ruby-client/pull/527): Explicitly require `racc` and `ostruct` - [@dblock](https://github.com/dblock).
+* [#528](https://github.com/slack-ruby/slack-ruby-client/pull/528): Don't treat asterisks in list items as italic in markdown - [@rspeicher](https://github.com/rspeicher).
+* [#530](https://github.com/slack-ruby/slack-ruby-client/pull/530): Specify dependency on `logger` - [@rwstauner](https://github.com/rwstauner).
+* [#533](https://github.com/slack-ruby/slack-ruby-client/pull/533), [#536](https://github.com/slack-ruby/slack-ruby-client/pull/536): Added `files_upload_v2` - [@gregsaab](https://github.com/gregsaab).
+* [#538](https://github.com/slack-ruby/slack-ruby-client/pull/538): Translate channel names and support an array of channels in `files_upload_v2` - [@dblock](https://github.com/dblock).
+* [#540](https://github.com/slack-ruby/slack-ruby-client/pull/540): Added support for `channel` and `channel_id`, do not require channel in `files_upload_v2` - [@dblock](https://github.com/dblock).
+* [#541](https://github.com/slack-ruby/slack-ruby-client/pull/541): Added samples for `oauth_v2` and `files_upload_v2` - [@dblock](https://github.com/dblock).
+* [#524](https://github.com/slack-ruby/slack-ruby-client/pull/524): Update API from [slack-api-ref@3ec3c10](https://github.com/slack-ruby/slack-api-ref/commit/3ec3c10) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+
 ### 2.4.0 (2024/07/14)
 
 * [#516](https://github.com/slack-ruby/slack-ruby-client/pull/516): Add support for Ruby 3.3 - [@olleolleolle](https://github.com/olleolleolle).
 * [#520](https://github.com/slack-ruby/slack-ruby-client/pull/520): Add support for basic markdown formatting - [@nbgoodall](https://github.com/nbgoodall).
 * [#523](https://github.com/slack-ruby/slack-ruby-client/pull/523): Fix coveralls handling parallel jobs - [@dblock](https://github.com/dblock).
-* [#522](https://github.com/slack-ruby-client/pulls/522): Update API from [slack-api-ref@8a22e57](https://github.com/slack-ruby/slack-api-ref/commit/8a22e57) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#522](https://github.com/slack-ruby/slack-ruby-client/pull/522): Update API from [slack-api-ref@8a22e57](https://github.com/slack-ruby/slack-api-ref/commit/8a22e57) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
 
 ### 2.3.0 (2024/01/31)
 
 * [#494](https://github.com/slack-ruby/slack-ruby-client/pull/494): Configure Dependabot to update GitHub Actions - [@olleolleolle](https://github.com/olleolleolle).
 * [#508](https://github.com/slack-ruby/slack-ruby-client/pull/508): Fix `Slack::Events::Request#verify!` compatibility with Rack 3.x - [@dblock](https://github.com/dblock).
 * [#503](https://github.com/slack-ruby/slack-ruby-client/pull/503): Update Slack API Update API from [slack-api-ref@bc545649](https://github.com/slack-ruby/slack-api-ref/commit/bc545649) - [@dblock](https://github.com/dblock).
-* [#504](https://github.com/slack-ruby-client/pulls/504): Update API from [slack-api-ref@bc54564](https://github.com/slack-ruby/slack-api-ref/commit/bc54564) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#504](https://github.com/slack-ruby/slack-ruby-client/pull/504): Update API from [slack-api-ref@bc54564](https://github.com/slack-ruby/slack-api-ref/commit/bc54564) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
 
 ### 2.2.0 (2023/09/17)
 
@@ -19,20 +36,20 @@
 * [#454](https://github.com/slack-ruby/slack-ruby-client/pull/454): Added `Slack::Messages::Formatting#escape` - [@marfoldi](https://github.com/marfoldi).
 * [#452](https://github.com/slack-ruby/slack-ruby-client/pull/452): Automatically generate Web API multi-argument requirements from docs - [@jmanian](https://github.com/jmanian).
 * [#448](https://github.com/slack-ruby/slack-ruby-client/pull/448), [#453](https://github.com/slack-ruby/slack-ruby-client/pull/453): Automatically convert more Web API arguments to JSON-encoded strings - [@jmanian](https://github.com/jmanian).
-* [#465](https://github.com/slack-ruby-client/pulls/465): Update API from [slack-api-ref@878be8f](https://github.com/slack-ruby/slack-api-ref/commit/878be8f) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
-* [#473](https://github.com/slack-ruby-client/pulls/473): Update API from [slack-api-ref@a29b520](https://github.com/slack-ruby/slack-api-ref/commit/a29b520) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
-* [#474](https://github.com/slack-ruby-client/pulls/474): Update API from [slack-api-ref@629967e](https://github.com/slack-ruby/slack-api-ref/commit/629967e) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
-* [#475](https://github.com/slack-ruby-client/pulls/475): Update API from [slack-api-ref@977dad5](https://github.com/slack-ruby/slack-api-ref/commit/977dad5) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
-* [#476](https://github.com/slack-ruby-client/pulls/476): Update API from [slack-api-ref@d0b2989](https://github.com/slack-ruby/slack-api-ref/commit/d0b2989) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
-* [#478](https://github.com/slack-ruby-client/pulls/478): Update API from [slack-api-ref@d797055](https://github.com/slack-ruby/slack-api-ref/commit/d797055) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
-* [#480](https://github.com/slack-ruby-client/pulls/480): Add common message formatting utilities - [@chrisbloom7](https://github.com/chrisbloom7).
-* [#481](https://github.com/slack-ruby-client/pulls/481): Update API from [slack-api-ref@7c22d0b](https://github.com/slack-ruby/slack-api-ref/commit/7c22d0b) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
-* [#488](https://github.com/slack-ruby-client/pulls/488): Update API from [slack-api-ref@a45def2](https://github.com/slack-ruby/slack-api-ref/commit/a45def2) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#465](https://github.com/slack-ruby/slack-ruby-client/pull/465): Update API from [slack-api-ref@878be8f](https://github.com/slack-ruby/slack-api-ref/commit/878be8f) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#473](https://github.com/slack-ruby/slack-ruby-client/pull/473): Update API from [slack-api-ref@a29b520](https://github.com/slack-ruby/slack-api-ref/commit/a29b520) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#474](https://github.com/slack-ruby/slack-ruby-client/pull/474): Update API from [slack-api-ref@629967e](https://github.com/slack-ruby/slack-api-ref/commit/629967e) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#475](https://github.com/slack-ruby/slack-ruby-client/pull/475): Update API from [slack-api-ref@977dad5](https://github.com/slack-ruby/slack-api-ref/commit/977dad5) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#476](https://github.com/slack-ruby/slack-ruby-client/pull/476): Update API from [slack-api-ref@d0b2989](https://github.com/slack-ruby/slack-api-ref/commit/d0b2989) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#478](https://github.com/slack-ruby/slack-ruby-client/pull/478): Update API from [slack-api-ref@d797055](https://github.com/slack-ruby/slack-api-ref/commit/d797055) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#480](https://github.com/slack-ruby/slack-ruby-client/pull/480): Add common message formatting utilities - [@chrisbloom7](https://github.com/chrisbloom7).
+* [#481](https://github.com/slack-ruby/slack-ruby-client/pull/481): Update API from [slack-api-ref@7c22d0b](https://github.com/slack-ruby/slack-api-ref/commit/7c22d0b) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#488](https://github.com/slack-ruby/slack-ruby-client/pull/488): Update API from [slack-api-ref@a45def2](https://github.com/slack-ruby/slack-api-ref/commit/a45def2) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
 * [#490](https://github.com/slack-ruby/slack-ruby-client/pull/490): Add changelog uri to gemspec - [@MatheusRich](https://github.com/MatheusRich).
 * [#491](https://github.com/slack-ruby/slack-ruby-client/pull/491): Added code coverage - [@dblock](https://github.com/dblock).
 * [#486](https://github.com/slack-ruby/slack-ruby-client/pull/486): Async handler support for Slack::RealTime::Config and Client - [@milestruecar](https://github.com/milestruecar).
-* [#489](https://github.com/slack-ruby-client/pulls/489): Update API from [slack-api-ref@0d3f0b6](https://github.com/slack-ruby/slack-api-ref/commit/0d3f0b6) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
-* [#493](https://github.com/slack-ruby-client/pulls/493): Update API from [slack-api-ref@f2e768a](https://github.com/slack-ruby/slack-api-ref/commit/f2e768a) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#489](https://github.com/slack-ruby/slack-ruby-client/pull/489): Update API from [slack-api-ref@0d3f0b6](https://github.com/slack-ruby/slack-api-ref/commit/0d3f0b6) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#493](https://github.com/slack-ruby/slack-ruby-client/pull/493): Update API from [slack-api-ref@f2e768a](https://github.com/slack-ruby/slack-api-ref/commit/f2e768a) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
 
 ### 2.1.0 (2023/03/17)
 

data/CONTRIBUTING.md

@@ -27,15 +27,15 @@ bundle exec rake
 
 ### Run Examples in Development
 
-Sign up for Slack, create a private slack group for yourself.
+Sign up for Slack, create a private Slack team for yourself, then [generate an API token](https://api.slack.com/tutorials/tracks/getting-a-token) for your app and use it for some interactions.
 
-Create a new App under [https://api.slack.com/apps](https://api.slack.com/apps).
+Try running the examples in the [examples](examples) directory.
 
-![](screenshots/create-app.png)
-
-On the next screen, note the API token.
-
-To run [the example in examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb), open a terminal, cd into _examples/hi_real_time_and_web_, run `bundle install`, followed by `SLACK_API_TOKEN=<your API token> bundle exec ruby hi.rb`.
+```bash
+cd examples/hi_web
+bundle install
+SLACK_API_TOKEN=... bundle exec ruby hi.rb
+```
 
 ## Contribute Code
 

data/Gemfile

@@ -17,6 +17,7 @@ group :test do
   gem 'erubis'
   gem 'faraday-typhoeus'
   gem 'json-schema'
+  gem 'racc'
   gem 'rake', '~> 13'
   gem 'rspec'
   gem 'rubocop', '1.26.1' # Lock to specific version to avoid breaking cops/changes

data/README.md

@@ -54,14 +54,14 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
     - [Verifying the Request Signature](#verifying-the-request-signature)
   - [Message Handling](#message-handling)
     - [Formatting Messages](#formatting-messages)
-      - [Date and time formatting](#date-and-time-formatting)
-      - [Channel ID formatting](#channel-id-formatting)
-      - [User ID formatting](#user-id-formatting)
-      - [URL formatting](#url-formatting)
-      - [Markdown formatting](#markdown-formatting)
+      - [Date and Time Formatting](#date-and-time-formatting)
+      - [Channel ID Formatting](#channel-id-formatting)
+      - [User ID Formatting](#user-id-formatting)
+      - [URL Formatting](#url-formatting)
+      - [Markdown Formatting](#markdown-formatting)
     - [Parsing Messages](#parsing-messages)
-      - [Unescaping message content](#unescaping-message-content)
-      - [Escaping message content](#escaping-message-content)
+      - [Unescaping Message Content](#unescaping-message-content)
+      - [Escaping Message Content](#escaping-message-content)
   - [Command-Line Client](#command-line-client)
     - [Authenticate with Slack](#authenticate-with-slack)
     - [Send a Message](#send-a-message)
@@ -75,14 +75,13 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
 
 ## Useful to Me?
 
-* This library will let you send messages to Slack via the Web API, send and receive messages via the Real Time Messaging API and facilitate integration with the Events API.
-* To respond to slash commands, interactive components or events, 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.
-* To build a bot using the Real Time Messaging API, use [slack-ruby-bot](https://github.com/slack-ruby/slack-ruby-bot), which uses this library.
-* To roll out a complete service using the Real Time Messaging API with Slack button integration to multiple teams, check out [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server), which is built on top of slack-ruby-bot, which uses this library.
+* 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.
+* 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 **stabke** release of slack-ruby-client, 2.4.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, v2.5.1. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -106,11 +105,9 @@ Run `bundle install`.
 
 To integrate your bot with Slack, you must first create a new [Slack App](https://api.slack.com/apps).
 
-![](screenshots/create-app.png)
-
 ### OAuth Code Grant
 
-Once created, go to the app's Basic Info tab and grab the Client ID and Client Secret.  You'll need these in order complete an [OAuth code grant flow](https://api.slack.com/docs/oauth#flow) as described at [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server).
+Once created, go to the app's Basic Info tab and grab the Client ID and Client Secret. You'll need these in order complete an [OAuth Workflow](https://api.slack.com/authentication/oauth-v2). A working sample that starts a local web server and obtains a bot or a user token for your app using OAuth v2 is available in [examples/oauth_v2](examples/oauth_v2).
 
 ### Using an API Token
 
@@ -172,7 +169,28 @@ general_channel = channels.detect { |c| c.name == 'general' }
 
 ##### Upload a File
 
-Upload a file with [files_upload](https://api.slack.com/methods/files.upload).
+Upload files with [sequenced API calls](https://api.slack.com/messaging/files#uploading_files).
+
+This library provides a helper method `files_upload_v2` that wraps the three separate API calls.
+
+```ruby
+client.files_upload_v2(
+  # required options
+  filename: 'results.pdf', # this is used for the file title, unless a :title option is provided
+  contents: File.read('/users/me/results.pdf'), # the string contents of the file
+  
+  # optional options
+  channels: ['C000000', 'C000001'], # channel IDs to share the file in (:channel_id, :channel, or :channels are all supported)
+  initial_comment: 'Sharing the Q1 results :tada:', # the message that is included with the file share thread
+  snippet_type: 'text', # the type of snippet
+  title: 'Q1 Results', # sets the title of the file, overriding the filename
+  thread_ts: '1738331487.481469' # specifies a thread to add this file to
+)
+```
+
+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).
 
 ```ruby
 client.files_upload(
@@ -602,7 +620,7 @@ All text in Slack uses the same [system of formatting and escaping](https://api.
 
 `Slack::Messages::Formatting` provides a number of methods for formatting objects that you can then embed in outgoing messages.
 
-##### Date and time formatting
+##### Date and Time Formatting
 
 You can embed a pre-formatted date in a message as a string like any other text, but using Slack's date formatting allows you to display dates based on user preferences for dates and times, incorporating users' local time zones, and optionally using relative values like "yesterday", "today", or "tomorrow" when appropriate.
 
@@ -627,7 +645,7 @@ Slack::Messages::Formatting.date(date, text: 'party time!')
   # => "<!date^1688150386^{date_num} {time_secs}|party time!>"
 ```
 
-##### Channel ID formatting
+##### Channel ID Formatting
 
 If you already know the channel name you can just embed it in the message as `#some-channel`, but if you only have the ID you can embed it using special syntax which Slack will display as the channel name (while respecting channel visibility).
 
@@ -637,7 +655,7 @@ Slack::Messages::Formatting.channel_link(channel_id)
   # => "<#C0000000001>"
 ```
 
-##### User ID formatting
+##### User ID Formatting
 
 If you already know the user name you can just embed it in the message as `@some_username`, but if you only have the ID you can embed it using special syntax which Slack will display as the user name.
 
@@ -647,7 +665,7 @@ Slack::Messages::Formatting.user_link(user_id)
   # => "<@U0000000001>"
 ```
 
-##### URL formatting
+##### URL Formatting
 
 Slack will automatically parse fully qualified URLs in messages, but you need special formatting to embed a link with different text.
 
@@ -658,7 +676,7 @@ Slack::Messages::Formatting.url_link(text, url)
   # => "<https://media.giphy.com/media/AcfTF7tyikWyroP0x7/giphy.gif|party time>"
 ```
 
-##### Markdown formatting
+##### Markdown Formatting
 
 Slack uses a mishmash of regular markdown formatting with its own syntax. Some features like headings aren't supported and will be left as-is, but others like bold, strikethrough, and links are converted.
 
@@ -686,7 +704,7 @@ Slack::Messages::Formatting.markdown(text)
 
 `Slack::Messages::Formatting` also provides ways to escape or unescape messages. This comes handy, for example, you want to treat all input to a real time bot as plain text.
 
-##### Unescaping message content
+##### Unescaping Message Content
 
 ```ruby
 Slack::Messages::Formatting.unescape('Hello &amp; &lt;world&gt;')
@@ -711,7 +729,7 @@ Slack::Messages::Formatting.unescape('‘hello’')
   # => "'hello'"
 ```
 
-##### Escaping message content
+##### Escaping Message Content
 
 ```ruby
 Slack::Messages::Formatting.escape('Hello & <world>')

data/bin/commands/admin_conversations.rb

@@ -133,6 +133,17 @@ module Slack
           end
         end
 
+        g.desc 'Link a Salesforce record to a channel'
+        g.long_desc %( Link a Salesforce record to a channel )
+        g.command 'linkObjects' do |c|
+          c.flag 'channel', desc: 'Channel ID for Slack channel that will be linked to a Salesforce record.'
+          c.flag 'record_id', desc: 'Salesforce record ID (15 or 18 digit accepted). See here for how to look up record ID.'
+          c.flag 'salesforce_org_id', desc: 'Salesforce org ID (15 or 18 digit accepted). See here for how to look up Salesforce org ID.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.admin_conversations_linkObjects(options))
+          end
+        end
+
         g.desc 'Returns channels on the given team using the filters.'
         g.long_desc %( Returns channels on the given team using the filters. )
         g.command 'lookup' do |c|
@@ -222,6 +233,16 @@ module Slack
             puts JSON.dump(@client.admin_conversations_unarchive(options))
           end
         end
+
+        g.desc 'Unlink a Salesforce record from a channel'
+        g.long_desc %( Unlink a Salesforce record from a channel )
+        g.command 'unlinkObjects' do |c|
+          c.flag 'channel', desc: 'Channel ID for Slack channel that will be unlinked from the Salesforce record.'
+          c.flag 'new_name', desc: 'Channel name you would like to give to the channel that is being unlinked from the Salesforce record.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.admin_conversations_unlinkObjects(options))
+          end
+        end
       end
     end
   end

data/bin/commands/admin_users_session.rb

@@ -28,7 +28,7 @@ module Slack
         g.long_desc %( Revoke a single session for a user. The user will be forced to login to Slack. )
         g.command 'invalidate' do |c|
           c.flag 'session_id', desc: 'ID of the session to invalidate.'
-          c.flag 'team_id', desc: 'ID of the workspace that the session belongs to.'
+          c.flag 'user_id', desc: 'ID of the user that the session belongs to.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_users_session_invalidate(options))
           end

data/bin/commands/admin_workflows.rb

@@ -10,16 +10,18 @@ module Slack
         g.long_desc %( Search workflows within the team or enterprise )
         g.command 'search' do |c|
           c.flag 'app_id', desc: 'The parent app ID for which to return workflows.'
-          c.flag 'collaborator_ids', desc: 'Only include workflows where the provided user IDs are a manager/collaborator of that workflow.'
+          c.flag 'collaborator_ids', desc: 'Only include workflows where all of the provided user IDs are a manager/collaborator of that workflow.'
           c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
           c.flag 'is_sales_elevate', desc: 'Filter workflows by their Sales Elevate status.'
           c.flag 'limit', desc: 'The number of results that will be returned by the API on each invocation.'
           c.flag 'no_collaborators', desc: 'Only include workflows with no collaborators in the result; default is false.'
           c.flag 'num_trigger_ids', desc: 'Number of trigger IDs to fetch for each workflow; default is 10.'
+          c.flag 'publish_status', desc: 'Filter workflows by their published status.'
           c.flag 'query', desc: 'A search query to filter for workflow name or description.'
           c.flag 'sort', desc: 'The field used to sort the returned workflows.'
           c.flag 'sort_dir', desc: 'Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a).'
           c.flag 'source', desc: 'Source of workflow creation, either from code or workflow builder.'
+          c.flag 'step_function_ids', desc: 'Only include workflows that use all of the provided step function ids.'
           c.flag 'trigger_type_id', desc: 'Only include workflows with this trigger type.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.admin_workflows_search(options))

data/bin/commands/admin_workflows_triggers_types_permissions.rb

@@ -6,8 +6,8 @@ module Slack
     class App
       desc 'AdminWorkflowsTriggersTypesPermissions methods.'
       command 'admin_workflows_triggers_types_permissions' do |g|
-        g.desc 'list the permissions for using each trigger type in workflow builder'
-        g.long_desc %( list the permissions for using each trigger type in workflow builder )
+        g.desc 'list the permissions for using each trigger type'
+        g.long_desc %( list the permissions for using each trigger type )
         g.command 'lookup' do |c|
           c.flag 'trigger_type_ids', desc: 'The trigger types IDs for which to get the permissions.'
           c.action do |_global_options, options, _args|
@@ -15,8 +15,8 @@ module Slack
           end
         end
 
-        g.desc 'Set the permissions for using a trigger type in workflow builder'
-        g.long_desc %( Set the permissions for using a trigger type in workflow builder )
+        g.desc 'Set the permissions for using a trigger type'
+        g.long_desc %( Set the permissions for using a trigger type )
         g.command 'set' do |c|
           c.flag 'id', desc: 'The trigger type ID for which to set the permissions.'
           c.flag 'visibility', desc: 'The function visibility.'

data/bin/commands/assistant_threads.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Cli
+    class App
+      desc 'AssistantThreads methods.'
+      command 'assistant_threads' do |g|
+        g.desc 'Set the status for an AI assistant thread.'
+        g.long_desc %( Set the status for an AI assistant thread. )
+        g.command 'setStatus' do |c|
+          c.flag 'channel_id', desc: 'Channel ID containing the assistant thread.'
+          c.flag 'status', desc: "Status of the specified bot user, e.g. 'is thinking...'."
+          c.flag 'thread_ts', desc: 'Message timestamp of the thread of where to set the status.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.assistant_threads_setStatus(options))
+          end
+        end
+
+        g.desc 'Set suggested prompts for the given assistant thread'
+        g.long_desc %( Set suggested prompts for the given assistant thread )
+        g.command 'setSuggestedPrompts' do |c|
+          c.flag 'channel_id', desc: 'Channel ID containing the assistant thread.'
+          c.flag 'prompts', desc: 'Each prompt should be supplied with its title and message attribute.'
+          c.flag 'thread_ts', desc: 'Message timestamp of the thread to set suggested prompts for.'
+          c.flag 'title', desc: 'Title for the list of provided prompts. For example: Suggested Prompts, Related Questions.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.assistant_threads_setSuggestedPrompts(options))
+          end
+        end
+
+        g.desc 'Set the title for the given assistant thread'
+        g.long_desc %( Set the title for the given assistant thread )
+        g.command 'setTitle' do |c|
+          c.flag 'channel_id', desc: 'Channel ID containing the assistant thread.'
+          c.flag 'thread_ts', desc: 'Message timestamp of the thread to set suggested prompts for.'
+          c.flag 'title', desc: 'The title to use for the thread.'
+          c.action do |_global_options, options, _args|
+            puts JSON.dump(@client.assistant_threads_setTitle(options))
+          end
+        end
+      end
+    end
+  end
+end

data/bin/commands/bookmarks.rb

@@ -12,6 +12,7 @@ module Slack
           c.flag 'channel_id', desc: 'Channel to add bookmark in.'
           c.flag 'title', desc: 'Title for the bookmark.'
           c.flag 'type', desc: 'Type of the bookmark i.e link.'
+          c.flag 'access_level', desc: "The level that we are setting the file's permission to (read or write)."
           c.flag 'emoji', desc: 'Emoji tag to apply to the link.'
           c.flag 'entity_id', desc: 'ID of the entity being bookmarked. Only applies to message and file types.'
           c.flag 'link', desc: 'Link to bookmark.'

data/bin/commands/canvases.rb

@@ -6,8 +6,8 @@ module Slack
     class App
       desc 'Canvases methods.'
       command 'canvases' do |g|
-        g.desc 'Create Canvas for a user.'
-        g.long_desc %( Create Canvas for a user. )
+        g.desc 'Create canvas for a user'
+        g.long_desc %( Create canvas for a user )
         g.command 'create' do |c|
           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.'
@@ -16,8 +16,8 @@ module Slack
           end
         end
 
-        g.desc 'Deletes a canvas.'
-        g.long_desc %( Deletes a canvas. )
+        g.desc 'Deletes a canvas'
+        g.long_desc %( Deletes a canvas )
         g.command 'delete' do |c|
           c.flag 'canvas_id', desc: 'Encoded ID of the canvas.'
           c.action do |_global_options, options, _args|

data/bin/commands/canvases_access.rb

@@ -20,10 +20,10 @@ module Slack
         g.desc 'Sets the access level to a canvas for specified entities'
         g.long_desc %( Sets the access level to a canvas for specified entities )
         g.command 'set' do |c|
-          c.flag 'access_level', desc: 'Desired level of access (e.g. read, write).'
+          c.flag 'access_level', desc: 'Desired level of access.'
           c.flag 'canvas_id', desc: 'Encoded ID of the canvas.'
-          c.flag 'channel_ids', desc: 'List of channels you wish to update access for.'
-          c.flag 'user_ids', desc: 'List of users you wish to update access for.'
+          c.flag 'channel_ids', desc: 'List of channels you wish to update access for. Can only be used if user_ids is not provided.'
+          c.flag 'user_ids', desc: 'List of users you wish to update access for. Can only be used if channel_ids is not provided.'
           c.action do |_global_options, options, _args|
             puts JSON.dump(@client.canvases_access_set(options))
           end