stream-chat-ruby 3.5.1 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c193dc0a1beb05f205ca2ec002883897c53cb9de43bdd261f774cb10bfd77609
-  data.tar.gz: 3676694494376cfa0f10a15fc0c98d57648cfd1b656aa54494a46e20b1b152d1
+  metadata.gz: a9d9b7da9ed7b34e26558596b67c8163034c2fb7d15b5f484bd1183aa38a8977
+  data.tar.gz: 3b7a1bd942807c920c10208b64018422dac7893a6fb8432fd390892d594d52a9
 SHA512:
-  metadata.gz: e7be6e25d8a4905877fc1b98c34d1eafd10bac687160d4b7e56a5397dea4b415ce6867029bfa60a2e5b3143cc7465031f8a763e823c90a68f56d3691ac0d1521
-  data.tar.gz: 5e7ea414d7f831b07244ef1332389134e3a4594229387941efbd237c3a63ef8c6612056b9275744bffebcb2119e4a5f8364a483f1cc8e80f5f0bf39f881908f4
+  metadata.gz: 51087799d97d03e6d4f9530c3e39c9956b279d51d32ecc47fb0dcf242d12ef5c2bf1cccfb25b523d774ba31ff063284c3c013e30be8b8b0c75183648e457c728
+  data.tar.gz: 2fc7f5f3e3c3df330bd24980b5672767982bd2e66166ff245741042cbe1cdc02de2f17eeb55b82e7f60f09f854a5c62b636d28a69789aace2000061faa0234c9

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.7.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.6.0...v3.7.0) (2024-12-09)
+
+## [3.6.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.5.1...v3.6.0) (2024-05-22)
+
+
+### Features
+
+* add test for `notifications_muted` as filter in `query_members` ([#140](https://github.com/GetStream/stream-chat-ruby/issues/140)) ([61102ac](https://github.com/GetStream/stream-chat-ruby/commit/61102ac16783ecfc502d8f7d21435ec64af28436))
+
 ### [3.5.1](https://github.com/GetStream/stream-chat-ruby/compare/v3.5.0...v3.5.1) (2024-04-18)
 
 ## [3.5.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.4.0...v3.5.0) (2023-10-30)

data/README.md

@@ -165,32 +165,6 @@ status_response = client.get_export_channel_status(response['task_id'])
 # status_response['status'] == 'pending', 'completed'
 ```
 
-### Campaigns
-
-```ruby
-# Create a user or channel segment
-client.create_segment({ name: 'test', type: 'user', filter: { uniq: 'a flag on users' } })
-
-# Create a campaign that uses the segment
-client.create_campaign({
-    name: 'test',
-    text: 'Hi',
-    sender_id: campaign_sender,
-    segment_id: segment_id,
-    channel_type: 'messaging'
-})
-
-# Schedule the campaign
-client.schedule_campaign(campaign_id, Time.now.to_i)
-
-# Query the campaign to check the status
-response = client.query_campaigns(filter_conditions: { id: campaign_id })
-response['campaigns'][0]['status'] == 'completed'
-
-# Read sent information
-client.query_recipients(filter_conditions: { campaign_id: campaign_id })
-```
-
 ### Rate limits
 
 ```ruby

data/lib/stream-chat/channel.rb

@@ -16,6 +16,9 @@ module StreamChat
     sig { returns(String) }
     attr_reader :channel_type
 
+    sig { returns(String) }
+    attr_reader :cid
+
     sig { returns(StringKeyHash) }
     attr_reader :custom_data
 
@@ -166,6 +169,68 @@ module StreamChat
       @client.post('moderation/unmute/channel', data: { 'user_id' => user_id, 'channel_cid' => @cid })
     end
 
+    # Pins a channel for a user.
+    sig { params(user_id: String).returns(StreamChat::StreamResponse) }
+    def pin(user_id)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+
+      payload = {
+        set: {
+          pinned: true
+        }
+      }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
+    # Unins a channel for a user.
+    sig { params(user_id: String).returns(StreamChat::StreamResponse) }
+    def unpin(user_id)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+
+      payload = {
+        set: {
+          pinned: false
+        }
+      }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
+    # Archives a channel for a user.
+    sig { params(user_id: String).returns(StreamChat::StreamResponse) }
+    def archive(user_id)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+
+      payload = {
+        set: {
+          archived: true
+        }
+      }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
+    # Archives a channel for a user.
+    sig { params(user_id: String).returns(StreamChat::StreamResponse) }
+    def unarchive(user_id)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+
+      payload = {
+        set: {
+          archived: false
+        }
+      }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
+    # Updates a member partially in the channel.
+    sig { params(user_id: String, set: T.nilable(StringKeyHash), unset: T.nilable(T::Array[String])).returns(StreamChat::StreamResponse) }
+    def update_member_partial(user_id, set: nil, unset: nil)
+      raise StreamChannelException, 'user ID must not be empty' if user_id.empty?
+      raise StreamChannelException, 'set or unset is required' if set.nil? && unset.nil?
+
+      payload = { set: set, unset: unset }
+      @client.patch("#{url}/member/#{CGI.escape(user_id)}", data: payload)
+    end
+
     # Adds members to the channel.
     sig { params(user_ids: T::Array[String], options: T.untyped).returns(StreamChat::StreamResponse) }
     def add_members(user_ids, **options)

data/lib/stream-chat/client.rb

@@ -258,13 +258,13 @@ module StreamChat
     # Restores a user synchronously.
     sig { params(user_id: String).returns(StreamChat::StreamResponse) }
     def restore_user(user_id)
-      post("users/restore", data: { user_ids: [user_id] })
+      post('users/restore', data: { user_ids: [user_id] })
     end
 
     # Restores users synchronously.
     sig { params(user_ids: T::Array[String]).returns(StreamChat::StreamResponse) }
     def restore_users(user_ids)
-      post("users/restore", data: { user_ids: user_ids })
+      post('users/restore', data: { user_ids: user_ids })
     end
 
     # Deactivates a user.
@@ -681,13 +681,13 @@ module StreamChat
       before = T.cast(before, DateTime).rfc3339 if before.instance_of?(DateTime)
 
       updates = []
-      user_ids.each do |user_id|
-        updates.push({
-                       'id' => user_id,
-                       'set' => {
-                         'revoke_tokens_issued_before' => before
-                       }
-                     })
+      user_ids.map do |user_id|
+        {
+          'id' => user_id,
+          'set' => {
+            'revoke_tokens_issued_before' => before
+          }
+        }
       end
       update_users_partial(updates)
     end
@@ -890,84 +890,6 @@ module StreamChat
       get('imports', params: options)
     end
 
-    # Creates a campaign.
-    sig { params(campaign: StringKeyHash).returns(StreamChat::StreamResponse) }
-    def create_campaign(campaign)
-      post('campaigns', data: { campaign: campaign })
-    end
-
-    # Queries campaigns similar to query_channels or query_users.
-    sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
-    def query_campaigns(**params)
-      get('campaigns', params: { payload: params.to_json })
-    end
-
-    # Updates a campaign.
-    sig { params(campaign_id: String, campaign: StringKeyHash).returns(StreamChat::StreamResponse) }
-    def update_campaign(campaign_id, campaign)
-      put("campaigns/#{campaign_id}", data: { campaign: campaign })
-    end
-
-    # Deletes a campaign.
-    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
-    def delete_campaign(campaign_id)
-      delete("campaigns/#{campaign_id}")
-    end
-
-    # Schedules a campaign.
-    sig { params(campaign_id: String, scheduled_for: Integer).returns(StreamChat::StreamResponse) }
-    def schedule_campaign(campaign_id, scheduled_for)
-      patch("campaigns/#{campaign_id}/schedule", data: { scheduled_for: scheduled_for })
-    end
-
-    # Stops a campaign.
-    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
-    def stop_campaign(campaign_id)
-      patch("campaigns/#{campaign_id}/stop")
-    end
-
-    # Resumes a campaign.
-    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
-    def resume_campaign(campaign_id)
-      patch("campaigns/#{campaign_id}/resume")
-    end
-
-    # Tests a campaign.
-    sig { params(campaign_id: String, users: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
-    def test_campaign(campaign_id, users)
-      post("campaigns/#{campaign_id}/test", data: { users: users })
-    end
-
-    # Creates a campaign segment.
-    sig { params(segment: StringKeyHash).returns(StreamChat::StreamResponse) }
-    def create_segment(segment)
-      post('segments', data: { segment: segment })
-    end
-
-    # Queries campaign segments.
-    sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
-    def query_segments(**params)
-      get('segments', params: { payload: params.to_json })
-    end
-
-    # Updates a campaign segment.
-    sig { params(segment_id: String, segment: StringKeyHash).returns(StreamChat::StreamResponse) }
-    def update_segment(segment_id, segment)
-      put("segments/#{segment_id}", data: { segment: segment })
-    end
-
-    # Deletes a campaign segment.
-    sig { params(segment_id: String).returns(StreamChat::StreamResponse) }
-    def delete_segment(segment_id)
-      delete("segments/#{segment_id}")
-    end
-
-    # Queries campaign recipients.
-    sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
-    def query_recipients(**params)
-      get('recipients', params: { payload: params.to_json })
-    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.5.1'
+  VERSION = '3.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.7.0
 platform: ruby
 authors:
 - getstream.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday