stream-chat-ruby 3.22.0 → 3.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef599aa75d34eac737ec0477c2c2dfa76583c7cdde1cebf6a5e21b494ea9abaa
-  data.tar.gz: 9f5170f70e6c4490f691ee364c8f12efe2c45729bba0c877e064c748b31cb7cd
+  metadata.gz: 9b7896b214aa6d889a30c567056fdf2d0f6d4b6220d83a17acee469ba2b88aca
+  data.tar.gz: 4d7127a19485858f8ff18eef48996adc46dc4f6ae5661c6813a984a38017dd4b
 SHA512:
-  metadata.gz: bae2b355732b9fcd45e66f34ea948cd19bdd68f394961b0c7e56c10ab35f012f296ff8d1b7e06613c90fbce2209778fc1d48bb4a7af124440bced0427aa51d6e
-  data.tar.gz: 1240cd43dcba18db93d412fccb3b6b453e2e5c87090d19969063c34bbdd80197b4a92a8980f50ebddc13394d328f3fe9e4abefd5f65377e2b1c933361ad5094a
+  metadata.gz: 152671fd7190cb2762c3499996ade2c7fd4d4e1dfa823a05214da862d399ae39bcef64183b6ebd6e23912cba9b1685e93b8a1b7e4a06a43f8248d129bd460de4
+  data.tar.gz: 5f92a082a28faedd95b017fcc5f70f43b7c82d386da8149e4d50b03a60486f63360588b9ae280e8c71aff086cdecf6a60209fd447156e1315a02fea983b447fa

data/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 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.23.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.22.0...v3.23.0) (2026-01-29)
+
 ## [3.22.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.21.0...v3.22.0) (2026-01-15)
 
 ## [3.21.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.20.0...v3.21.0) (2025-11-12)

data/lib/stream-chat/channel.rb

@@ -97,6 +97,22 @@ module StreamChat
       state
     end
 
+    # Refreshes the channel state from the server.
+    # Updates the channel's members attribute with fresh data.
+    sig { returns(StreamChat::StreamResponse) }
+    def refresh_state
+      url = "channels/#{@channel_type}/#{@id}/query"
+      state = @client.post(url, data: { state: true })
+
+      # Members can be at top level or inside channel object (like Go's updateChannel)
+      if state['members'] && !state['members'].empty?
+        @members = state['members']
+      elsif state['channel'] && state['channel']['members']
+        @members = state['channel']['members']
+      end
+      state
+    end
+
     # Queries members of a channel.
     #
     # The queryMembers endpoint allows you to list and paginate members from a channel. The
@@ -323,9 +339,9 @@ module StreamChat
     end
 
     # Removes the ban for a user on this channel.
-    sig { params(user_id: String).returns(StreamChat::StreamResponse) }
-    def unban_user(user_id)
-      @client.unban_user(user_id, type: @channel_type, id: @id)
+    sig { params(user_id: String, options: T.untyped).returns(StreamChat::StreamResponse) }
+    def unban_user(user_id, **options)
+      @client.unban_user(user_id, type: @channel_type, id: @id, **options)
     end
 
     # Removes a channel from query channel requests for that user until a new message is added.

data/lib/stream-chat/channel_batch_updater.rb

@@ -0,0 +1,214 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'stream-chat/client'
+require 'stream-chat/stream_response'
+require 'stream-chat/types'
+
+module StreamChat
+  class ChannelBatchUpdater
+    extend T::Sig
+
+    sig { params(client: StreamChat::Client).void }
+    def initialize(client)
+      @client = client
+    end
+
+    # Member operations
+
+    # addMembers - Add members to channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param members [T.any(T::Array[String], T::Array[StringKeyHash])] Members to add
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, members: T.any(T::Array[String], T::Array[StringKeyHash])).returns(StreamChat::StreamResponse) }
+    def add_members(filter, members)
+      @client.update_channels_batch(
+        {
+          operation: 'addMembers',
+          filter: filter,
+          members: members
+        }
+      )
+    end
+
+    # removeMembers - Remove members from channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param members [T::Array[StringKeyHash]] Members to remove (each with user_id key)
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, members: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
+    def remove_members(filter, members)
+      @client.update_channels_batch(
+        {
+          operation: 'removeMembers',
+          filter: filter,
+          members: members
+        }
+      )
+    end
+
+    # inviteMembers - Invite members to channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param members [T.any(T::Array[String], T::Array[StringKeyHash])] Members to invite
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, members: T.any(T::Array[String], T::Array[StringKeyHash])).returns(StreamChat::StreamResponse) }
+    def invite_members(filter, members)
+      @client.update_channels_batch(
+        {
+          operation: 'invites',
+          filter: filter,
+          members: members
+        }
+      )
+    end
+
+    # addModerators - Add moderators to channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param members [T::Array[String]] Member IDs to promote to moderator
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, members: T::Array[String]).returns(StreamChat::StreamResponse) }
+    def add_moderators(filter, members)
+      @client.update_channels_batch(
+        {
+          operation: 'addModerators',
+          filter: filter,
+          members: members
+        }
+      )
+    end
+
+    # demoteModerators - Remove moderator role from members in channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param members [T::Array[String]] Member IDs to demote
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, members: T::Array[String]).returns(StreamChat::StreamResponse) }
+    def demote_moderators(filter, members)
+      @client.update_channels_batch(
+        {
+          operation: 'demoteModerators',
+          filter: filter,
+          members: members
+        }
+      )
+    end
+
+    # assignRoles - Assign roles to members in channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param members [T::Array[StringKeyHash]] Members with role assignments
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, members: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
+    def assign_roles(filter, members)
+      @client.update_channels_batch(
+        {
+          operation: 'assignRoles',
+          filter: filter,
+          members: members
+        }
+      )
+    end
+
+    # Visibility operations
+
+    # hide - Hide channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def hide(filter)
+      @client.update_channels_batch(
+        {
+          operation: 'hide',
+          filter: filter
+        }
+      )
+    end
+
+    # show - Show channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def show(filter)
+      @client.update_channels_batch(
+        {
+          operation: 'show',
+          filter: filter
+        }
+      )
+    end
+
+    # archive - Archive channels matching the filter for specified members
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param members [T::Array[StringKeyHash]] Members to archive channels for (each with user_id key)
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, members: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
+    def archive(filter, members)
+      @client.update_channels_batch(
+        {
+          operation: 'archive',
+          filter: filter,
+          members: members
+        }
+      )
+    end
+
+    # unarchive - Unarchive channels matching the filter for specified members
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param members [T::Array[StringKeyHash]] Members to unarchive channels for (each with user_id key)
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, members: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
+    def unarchive(filter, members)
+      @client.update_channels_batch(
+        {
+          operation: 'unarchive',
+          filter: filter,
+          members: members
+        }
+      )
+    end
+
+    # Data operations
+
+    # updateData - Update data on channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param data [StringKeyHash] Data to update
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, data: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def update_data(filter, data)
+      @client.update_channels_batch(
+        {
+          operation: 'updateData',
+          filter: filter,
+          data: data
+        }
+      )
+    end
+
+    # addFilterTags - Add filter tags to channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param tags [T::Array[String]] Tags to add
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, tags: T::Array[String]).returns(StreamChat::StreamResponse) }
+    def add_filter_tags(filter, tags)
+      @client.update_channels_batch(
+        {
+          operation: 'addFilterTags',
+          filter: filter,
+          filter_tags_update: tags
+        }
+      )
+    end
+
+    # removeFilterTags - Remove filter tags from channels matching the filter
+    # @param filter [StringKeyHash] Filter to select channels
+    # @param tags [T::Array[String]] Tags to remove
+    # @return [StreamChat::StreamResponse] The server response
+    sig { params(filter: StringKeyHash, tags: T::Array[String]).returns(StreamChat::StreamResponse) }
+    def remove_filter_tags(filter, tags)
+      @client.update_channels_batch(
+        {
+          operation: 'removeFilterTags',
+          filter: filter,
+          filter_tags_update: tags
+        }
+      )
+    end
+  end
+end

data/lib/stream-chat/client.rb

@@ -17,6 +17,7 @@ require 'stream-chat/version'
 require 'stream-chat/util'
 require 'stream-chat/types'
 require 'stream-chat/moderation'
+require 'stream-chat/channel_batch_updater'
 
 module StreamChat
   DEFAULT_BLOCKLIST = 'profanity_en_2020_v1'
@@ -485,6 +486,15 @@ module StreamChat
       get('query_banned_users', params: { payload: params.to_json })
     end
 
+    # Queries future channel bans.
+    #
+    # Future channel bans are automatically applied when a user creates a new channel
+    # or adds a member to an existing channel.
+    sig { params(options: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_future_channel_bans(**options)
+      get('query_future_channel_bans', params: { payload: options.to_json })
+    end
+
     # Allows you to search for users and see if they are online/offline.
     # You can filter and sort on the custom fields you've set for your user, the user id, and when the user was last active.
     sig { params(filter_conditions: StringKeyHash, sort: T.nilable(T::Hash[String, Integer]), options: T.untyped).returns(StreamChat::StreamResponse) }
@@ -1170,6 +1180,21 @@ module StreamChat
       post('channels/delivered', data: data || {}, params: { user_id: user_id })
     end
 
+    # Update channels in batch.
+    # @param payload [StringKeyHash] Payload containing operation, filter, and optional members/data/filter_tags_update
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(payload: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def update_channels_batch(payload)
+      put('channels/batch', data: payload)
+    end
+
+    # Returns a ChannelBatchUpdater instance for batch channel operations.
+    # @return [StreamChat::ChannelBatchUpdater] A ChannelBatchUpdater instance
+    sig { returns(StreamChat::ChannelBatchUpdater) }
+    def channel_batch_updater
+      ChannelBatchUpdater.new(self)
+    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.22.0'
+  VERSION = '3.23.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 3.22.0
+  version: 3.23.0
 platform: ruby
 authors:
 - getstream.io
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-15 00:00:00.000000000 Z
+date: 2026-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -115,6 +115,7 @@ files:
 - lib/stream-chat.rb
 - lib/stream-chat/campaign.rb
 - lib/stream-chat/channel.rb
+- lib/stream-chat/channel_batch_updater.rb
 - lib/stream-chat/client.rb
 - lib/stream-chat/errors.rb
 - lib/stream-chat/moderation.rb