stream-chat-ruby 3.26.2 → 3.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '019bf5c538cd43fe7a5faef6b980bf00818756ec5cc470d0e61f8e5d610bbf4e'
-  data.tar.gz: 389642e627468500058a1aa007dae4a9b2bda9bcda2e73e5fd30218730e74ce3
+  metadata.gz: 4a99c43d6a3163fd4978c76884ae662c86b2651ab15f99fa088f2ef9e8f4126a
+  data.tar.gz: b3243d7e83eb1e03e0ed9e270cfa4d439882a67836e04382c4d169e6594f01e1
 SHA512:
-  metadata.gz: c2cbc7e4c1f481fefea8d06ee3a7e4e8c3c0c8e26a068b0754574588c0d65ce262886ffe3ebcee86196085df7d520ad4b1f6234c8b87351ba57d61e8d29132e2
-  data.tar.gz: 92abc3b3c173377ac3d5bc19957221f055fdfb15eabc38d8a64ef302be883b3441db8bbf22da87b937dbbb88f726344430bc5e6a8b2376f9a0f1c90734ff7d0a
+  metadata.gz: 9f80e08e784f75111e85c56b4cecf159375fc2ffca2eab9d53aa8cd488365a39d9fcef93001351b2ecb0e9d29e900184507fafc067cbfcdab0c92ec331075d86
+  data.tar.gz: f3f66091808fdfcaa3980fd33338d94a41afe37631e39b9561cad90c955db4ddc8eca273ae44f30e91e8b84b8577f298f06f0f32f9b7a666537f3176d3f008de

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [3.27.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.26.2...v3.27.0) (2026-10-29)
+
+
+### Features
+
+* add scheduled messages support (CHA-5933) ([#221](https://github.com/GetStream/stream-chat-ruby/issues/221)) ([65f5573](https://github.com/GetStream/stream-chat-ruby/commit/65f55738d23fb9e6d011c6eab6b2ded48c129c43))
+* add history window team methods: `set_history_window_teams`, `delete_history_window_teams`, `get_history_window_teams` (CHA-5958) ([#225](https://github.com/GetStream/stream-chat-ruby/issues/225)) ([f581079](https://github.com/GetStream/stream-chat-ruby/commit/f581079f39a5b97c6518320c00bab29c85568936))
+
+
+### Other
+
+* run scheduled message specs unconditionally ([#224](https://github.com/GetStream/stream-chat-ruby/issues/224)) ([b7352bf](https://github.com/GetStream/stream-chat-ruby/commit/b7352bf5575a1940bbe465f74f7f7a8dbc6ba59d))
+
 ### [3.26.2](https://github.com/GetStream/stream-chat-ruby/compare/v3.26.1...v3.26.2) (2026-06-30)
 
 

data/lib/stream-chat/channel.rb

@@ -55,6 +55,23 @@ module StreamChat
       @client.post("#{url}/message", data: payload)
     end
 
+    # Schedules a message to be sent to this channel at a later time.
+    #
+    # The message is not sent now: it is stored and sent at scheduled_at on
+    # behalf of user_id. The response carries `scheduled_message`, whose `id`
+    # is used to update, delete or send the scheduled message now.
+    #
+    # @param [StringKeyHash] message The message to send
+    # @param [String] user_id The ID of the user the message is sent as
+    # @param [DateTime, Time, String] scheduled_at When to send the message
+    #   (at least 1 minute and at most the app's maximum lead time from now)
+    # @param [Hash] options Additional SendMessage options, e.g. skip_push
+    # @return [StreamChat::StreamResponse]
+    sig { params(message: StringKeyHash, user_id: String, scheduled_at: T.any(DateTime, Time, String), options: T.untyped).returns(StreamChat::StreamResponse) }
+    def schedule_message(message, user_id, scheduled_at, **options)
+      send_message(message, user_id, **options, scheduled_at: StreamChat.normalize_timestamp(scheduled_at))
+    end
+
     # Sends an event on this channel.
     sig { params(event: StringKeyHash, user_id: String).returns(StreamChat::StreamResponse) }
     def send_event(event, user_id)

data/lib/stream-chat/client.rb

@@ -1222,6 +1222,58 @@ module StreamChat
       post('reminders/query', data: params)
     end
 
+    # Updates a scheduled message. Schedule a message with Channel#schedule_message.
+    #
+    # At least one of message or scheduled_at is required. The message, when
+    # given, replaces the scheduled message as a whole; the sender stays the
+    # user the message was scheduled for.
+    #
+    # @param id [String] The ID of the scheduled message
+    # @param message [StringKeyHash, nil] The new message
+    # @param scheduled_at [DateTime, Time, String, nil] The new send time
+    # @return [StreamChat::StreamResponse] API response with scheduled_message
+    sig { params(id: String, message: T.nilable(StringKeyHash), scheduled_at: T.nilable(T.any(DateTime, Time, String))).returns(StreamChat::StreamResponse) }
+    def update_scheduled_message(id, message: nil, scheduled_at: nil)
+      data = {}
+      data[:message] = message if message
+      data[:scheduled_at] = StreamChat.normalize_timestamp(scheduled_at) if scheduled_at
+      patch("scheduled_messages/#{id}", data: data)
+    end
+
+    # Deletes a scheduled message: cancels it so it is never sent, or removes a failed one.
+    #
+    # @param id [String] The ID of the scheduled message
+    # @return [StreamChat::StreamResponse] API response with scheduled_message
+    sig { params(id: String).returns(StreamChat::StreamResponse) }
+    def delete_scheduled_message(id)
+      delete("scheduled_messages/#{id}")
+    end
+
+    # Sends a scheduled message right away.
+    #
+    # @param id [String] The ID of the scheduled message
+    # @return [StreamChat::StreamResponse] API response with scheduled_message
+    sig { params(id: String).returns(StreamChat::StreamResponse) }
+    def send_scheduled_message_now(id)
+      post("scheduled_messages/#{id}/send_now")
+    end
+
+    # Queries the scheduled messages of a user across channels: pending ones
+    # first, then failed ones, each by scheduled_at.
+    #
+    # @param user_id [String] The ID of the user whose scheduled messages to query
+    # @param filter [StringKeyHash, nil] Optional filter, e.g. { cid: 'messaging:general', status: ['failed'] }
+    # @param sort [Array<Hash>, nil] Optional sort; only [{ field: 'scheduled_at', direction: 1 }] is supported
+    # @param options [Hash] Additional query options: limit (1 to 100, default 20) and next
+    # @return [StreamChat::StreamResponse] API response with scheduled_messages and next
+    sig { params(user_id: String, filter: T.nilable(StringKeyHash), sort: T.nilable(T::Array[StringKeyHash]), options: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_scheduled_messages(user_id, filter: nil, sort: nil, **options)
+      data = options.merge({ user_id: user_id })
+      data[:filter] = filter if filter
+      data[:sort] = sort if sort
+      post('scheduled_messages/query', data: data)
+    end
+
     # Send the mark delivered event for this user, only works if the `delivery_receipts` setting is enabled
     #
     # @param [StringKeyHash, nil] data The delivery confirmation data
@@ -1267,6 +1319,43 @@ module StreamChat
       post('stats/team_usage', data: options)
     end
 
+    # Gives teams full history (the paid tier of the history window).
+    #
+    # Teams without full history keep the app's history window. This endpoint is
+    # server-side only and only for apps with the history window enabled; other
+    # apps get a StreamAPIException with code 17 (HTTP 403).
+    #
+    # @param teams [Array<String>] 1 to 10 teams, each listed once
+    # @return [StreamChat::StreamResponse] Response with the marked teams
+    sig { params(teams: T::Array[String]).returns(StreamChat::StreamResponse) }
+    def set_history_window_teams(teams)
+      post('history_window/teams', data: { teams: teams })
+    end
+
+    # Puts teams back on the app's default history window.
+    #
+    # A team without full history is ignored. This endpoint is server-side only
+    # and only for apps with the history window enabled; other apps get a
+    # StreamAPIException with code 17 (HTTP 403).
+    #
+    # @param teams [Array<String>] 1 to 10 teams, each listed once
+    # @return [StreamChat::StreamResponse] Response with the teams that had full history
+    sig { params(teams: T::Array[String]).returns(StreamChat::StreamResponse) }
+    def delete_history_window_teams(teams)
+      post('history_window/teams/delete', data: { teams: teams })
+    end
+
+    # Returns the app's default history window and the teams with full history.
+    #
+    # This endpoint is server-side only and only for apps with the history window
+    # enabled; other apps get a StreamAPIException with code 17 (HTTP 403).
+    #
+    # @return [StreamChat::StreamResponse] Response with default_window_hours and teams
+    sig { returns(StreamChat::StreamResponse) }
+    def get_history_window_teams
+      get('history_window/teams')
+    end
+
     private
 
     sig { returns(T::Hash[String, String]) }

data/lib/stream-chat/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module StreamChat
-  VERSION = '3.26.2'
+  VERSION = '3.27.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 3.26.2
+  version: 3.27.0
 platform: ruby
 authors:
 - getstream.io
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-30 00:00:00.000000000 Z
+date: 2026-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday