stream-chat-ruby 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a528ef5495dbf3fc9d123e554151ee6654ef3ddf04499f89e6c093fce8f2e93
-  data.tar.gz: 5b08570a5dbfbbfdc73c356d93861f9fad95f81cf2578ef9caea24947deb9c34
+  metadata.gz: 73e40b4cf714cd04476c91ac638895cab0327dc618fb54031a83aaadc8b3279a
+  data.tar.gz: b5c98b143f98798cb2cd9db4e5a3c2c8c4cc7aaf9e35aa55a392c371d06fc970
 SHA512:
-  metadata.gz: 3f5e0d125c1b9a95395daea29a8694ca96d74939193f5eb035c8e1b0af840c91f457beaa4eca4dec6485fecfe2e9fd7a57f0f1c3ea34ee4f829027a77145cd59
-  data.tar.gz: 6548249f3cd5ddbb2051c84a546c94f6277571075c84c4cbcb38d359c0970ceb9d45df3158c59c2dcd160dec44508ad108371343bd6ad5c3a3b931b9a4399d6f
+  metadata.gz: 74e06fd1205667b6c0a6f2d745f197aac2639ca5d932dee52bea8f2a4e371d9fc7d4ed8c2663010b47a1b1af0d7dd644f3bdf16b26f0048ed2fad6d8a5c18859
+  data.tar.gz: a91d9ec87dfb82fb7a393212a08641bd4b8164ccd38ef0259fbcb27d4824dc3a4b0330b973b6d46315ab77cf17c357dd48961cf37ac3ccf1748310e3fb6bfb8f

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.3.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.2.0...v3.3.0) (2022-11-17)
+
+
+### Features
+
+* add campaign support ([#124](https://github.com/GetStream/stream-chat-ruby/issues/124)) ([d7a935f](https://github.com/GetStream/stream-chat-ruby/commit/d7a935f7b4459399b82db1d51a541388caeb5e68))
+
 ## [3.2.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.1.0...v3.2.0) (2022-11-17)
 
 

data/README.md

@@ -57,7 +57,7 @@ client = StreamChat::Client.new('STREAM_KEY', 'STREAM_SECRET')
 > # Wrong:
 > user = { "user" => { "id" => "bob-1"}}
 > # Correct:
-> user = { :user => { :id => "bob-1" }}
+> user = { user: { id: "bob-1" }}
 > ```
 
 ### Generate a token for client-side usage:
@@ -70,14 +70,14 @@ client.create_token('bob-1')
 
 ```ruby
 client.upsert_user({
-    :id => 'bob-1',
-    :role => 'admin',
-    :name => 'Robert Tables'
+    id: 'bob-1',
+    role: 'admin',
+    name: 'Robert Tables'
 })
 
 # Batch update is also supported
-jane = {:id => 'jane-1'}
-june = {:id => 'june-1'}
+jane = {id: 'jane-1'}
+june = {id: 'june-1'}
 client.upsert_users([jane, june])
 ```
 
@@ -85,10 +85,10 @@ client.upsert_users([jane, june])
 
 ```ruby
 client.create_channel_type({
-    :name => 'livechat',
-    :automod => 'disabled',
-    :commands => ['ban'],
-    :mutes => true
+    name: 'livechat',
+    automod: 'disabled',
+    commands: ['ban'],
+    mutes: true
 })
 
 channel_types = client.list_channel_types()
@@ -109,7 +109,7 @@ chan.add_members(['bob-1', 'jane-77'])
 
 ### Reactions
 ```ruby
-chan.send_reaction(m1['id'], {:type => 'like'}, 'bob-1')
+chan.send_reaction(m1['id'], {type: 'like'}, 'bob-1')
 ```
 
 ### Moderation
@@ -125,7 +125,7 @@ chan.unban_user('bob-1')
 ### Messages
 
 ```ruby
-m1 = chan.send_message({:text => 'Hi Jane!'}, 'bob-1')
+m1 = chan.send_message({text: 'Hi Jane!'}, 'bob-1')
 
 deleted_message = client.delete_message(m1['message']['id'])
 
@@ -158,13 +158,39 @@ client.delete_blocklist('my_blocker')
 
 ```ruby
 # Register an export
-response = client.export_channels({:type => 'messaging', :id => 'jane'})
+response = client.export_channels({type: 'messaging', id: 'jane'})
 
 # Check completion
 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/client.rb

@@ -869,16 +869,10 @@ module StreamChat
       post('campaigns', data: { campaign: campaign })
     end
 
-    # Gets a campaign.
-    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
-    def get_campaign(campaign_id)
-      get("campaigns/#{campaign_id}")
-    end
-
-    # Lists all campaigns. Options dictionary can contain 'offset' and 'limit' keys for pagination.
-    sig { params(options: StringKeyHash).returns(StreamChat::StreamResponse) }
-    def list_campaigns(options)
-      get('campaigns', params: options)
+    # 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.
@@ -894,9 +888,9 @@ module StreamChat
     end
 
     # Schedules a campaign.
-    sig { params(campaign_id: String, send_at: Integer).returns(StreamChat::StreamResponse) }
-    def schedule_campaign(campaign_id, send_at)
-      patch("campaigns/#{campaign_id}/schedule", data: { send_at: send_at })
+    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.
@@ -923,16 +917,10 @@ module StreamChat
       post('segments', data: { segment: segment })
     end
 
-    # Gets a campaign segment.
-    sig { params(segment_id: String).returns(StreamChat::StreamResponse) }
-    def get_segment(segment_id)
-      get("segments/#{segment_id}")
-    end
-
-    # Lists all campaign segments. Options dictionary can contain 'offset' and 'limit' keys for pagination.
-    sig { params(options: StringKeyHash).returns(StreamChat::StreamResponse) }
-    def list_segments(options)
-      get('segments', params: options)
+    # 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.
@@ -947,6 +935,12 @@ module StreamChat
       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.2.0'
+  VERSION = '3.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - getstream.io