stream-chat-ruby 3.21.0 → 3.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04f9d9c833c0a76e5028a2ab0cf93b8825901500e56f6956276d6308e80644da
-  data.tar.gz: ac0c1c38c99ad7d1ab32f7f80c7a8becb9e22f41ecd96e5b4ae11538b5a73313
+  metadata.gz: ef599aa75d34eac737ec0477c2c2dfa76583c7cdde1cebf6a5e21b494ea9abaa
+  data.tar.gz: 9f5170f70e6c4490f691ee364c8f12efe2c45729bba0c877e064c748b31cb7cd
 SHA512:
-  metadata.gz: c372e48ee5d7889c9d8931c57524aa6bb9e9465828dee77a52ec1f2cabfe1bc32392aebf15230cb87427dbf4dff12569569f6b269cfe1d61ba39760763311657
-  data.tar.gz: 5fbaf82414b47e6f1b647280deb88ed07c62c38d833bb5698c1345326bfadc907d40112235815ce98b7a82df5b117ca7de816dc64701579dc8cd110a4f7e5859
+  metadata.gz: bae2b355732b9fcd45e66f34ea948cd19bdd68f394961b0c7e56c10ab35f012f296ff8d1b7e06613c90fbce2209778fc1d48bb4a7af124440bced0427aa51d6e
+  data.tar.gz: 1240cd43dcba18db93d412fccb3b6b453e2e5c87090d19969063c34bbdd80197b4a92a8980f50ebddc13394d328f3fe9e4abefd5f65377e2b1c933361ad5094a

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.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/campaign.rb

@@ -0,0 +1,111 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'stream-chat/client'
+require 'stream-chat/errors'
+require 'stream-chat/util'
+require 'stream-chat/types'
+
+module StreamChat
+  class Campaign
+    extend T::Sig
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :campaign_id
+
+    sig { returns(T.nilable(StringKeyHash)) }
+    attr_reader :data
+
+    sig { params(client: StreamChat::Client, campaign_id: T.nilable(String), data: T.nilable(StringKeyHash)).void }
+    def initialize(client, campaign_id = nil, data = nil)
+      @client = client
+      @campaign_id = campaign_id
+      @data = data
+    end
+
+    # Creates a campaign.
+    #
+    # @param [String, nil] campaign_id Optional campaign ID. If provided, sets the campaign_id.
+    # @param [StringKeyHash, nil] data Optional campaign data to merge with existing data.
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(campaign_id: T.nilable(String), data: T.nilable(StringKeyHash)).returns(StreamChat::StreamResponse) }
+    def create(campaign_id: nil, data: nil)
+      @campaign_id = campaign_id if campaign_id
+      @data = merge_campaign_data(@data, data) if data
+
+      state = @client.create_campaign(campaign_id: @campaign_id, data: @data)
+
+      @campaign_id = state['campaign']['id'] if @campaign_id.nil? && state.status_code >= 200 && state.status_code < 300 && state['campaign']
+      state
+    end
+
+    # Gets a campaign by ID.
+    #
+    # @return [StreamChat::StreamResponse] API response
+    sig { returns(StreamChat::StreamResponse) }
+    def get
+      raise StreamChannelException, 'campaign does not have an id' if @campaign_id.nil?
+
+      @client.get_campaign(@campaign_id)
+    end
+
+    # Updates a campaign.
+    #
+    # @param [StringKeyHash] data Campaign data to update
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(data: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def update(data)
+      raise StreamChannelException, 'campaign does not have an id' if @campaign_id.nil?
+
+      @client.update_campaign(@campaign_id, data)
+    end
+
+    # Deletes a campaign.
+    #
+    # @param [Hash] options Optional deletion options
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(options: T.untyped).returns(StreamChat::StreamResponse) }
+    def delete(**options)
+      raise StreamChannelException, 'campaign does not have an id' if @campaign_id.nil?
+
+      @client.delete_campaign(@campaign_id, **options)
+    end
+
+    # Starts a campaign.
+    #
+    # @param [DateTime, Time, String, nil] scheduled_for Optional scheduled start time
+    # @param [DateTime, Time, String, nil] stop_at Optional scheduled stop time
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(scheduled_for: T.nilable(T.any(DateTime, Time, String)), stop_at: T.nilable(T.any(DateTime, Time, String))).returns(StreamChat::StreamResponse) }
+    def start(scheduled_for: nil, stop_at: nil)
+      raise StreamChannelException, 'campaign does not have an id' if @campaign_id.nil?
+
+      @client.start_campaign(@campaign_id, scheduled_for: scheduled_for, stop_at: stop_at)
+    end
+
+    # Stops a campaign.
+    #
+    # @return [StreamChat::StreamResponse] API response
+    sig { returns(StreamChat::StreamResponse) }
+    def stop
+      raise StreamChannelException, 'campaign does not have an id' if @campaign_id.nil?
+
+      @client.stop_campaign(@campaign_id)
+    end
+
+    private
+
+    # Merges two campaign data hashes.
+    #
+    # @param [StringKeyHash, nil] data1 First campaign data hash
+    # @param [StringKeyHash, nil] data2 Second campaign data hash
+    # @return [StringKeyHash] Merged campaign data
+    sig { params(data1: T.nilable(StringKeyHash), data2: T.nilable(StringKeyHash)).returns(StringKeyHash) }
+    def merge_campaign_data(data1, data2)
+      return T.must(data2) if data1.nil?
+      return data1 if data2.nil?
+
+      data1.merge(data2)
+    end
+  end
+end

data/lib/stream-chat/client.rb

@@ -10,6 +10,7 @@ require 'time'
 require 'date'
 require 'sorbet-runtime'
 require 'stream-chat/channel'
+require 'stream-chat/campaign'
 require 'stream-chat/errors'
 require 'stream-chat/stream_response'
 require 'stream-chat/version'
@@ -555,6 +556,101 @@ module StreamChat
       StreamChat::Channel.new(self, channel_type, channel_id, data)
     end
 
+    # Creates a campaign instance
+    #
+    # @param [String, nil] campaign_id the campaign identifier
+    # @param [StringKeyHash, nil] data additional campaign data
+    #
+    # @return [StreamChat::Campaign]
+    #
+    sig { params(campaign_id: T.nilable(String), data: T.nilable(StringKeyHash)).returns(StreamChat::Campaign) }
+    def campaign(campaign_id: nil, data: nil)
+      StreamChat::Campaign.new(self, campaign_id, data)
+    end
+
+    # Creates a campaign.
+    #
+    # @param [String, nil] campaign_id Optional campaign ID
+    # @param [StringKeyHash, nil] data Campaign data including message_template, sender_id, segment_ids or user_ids, etc.
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(campaign_id: T.nilable(String), data: T.nilable(StringKeyHash)).returns(StreamChat::StreamResponse) }
+    def create_campaign(campaign_id: nil, data: nil)
+      payload = {}
+      payload['id'] = campaign_id if campaign_id
+      payload.merge!(data) if data
+      post('campaigns', data: payload)
+    end
+
+    # Gets a campaign by ID.
+    #
+    # @param [String] campaign_id The campaign ID
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
+    def get_campaign(campaign_id)
+      get("campaigns/#{campaign_id}")
+    end
+
+    # Updates a campaign.
+    #
+    # @param [String] campaign_id The campaign ID
+    # @param [StringKeyHash] data Campaign data to update
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(campaign_id: String, data: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def update_campaign(campaign_id, data)
+      put("campaigns/#{campaign_id}", data: data)
+    end
+
+    # Deletes a campaign.
+    #
+    # @param [String] campaign_id The campaign ID
+    # @param [Hash] options Optional deletion options (e.g., gdpr: true)
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(campaign_id: String, options: T.untyped).returns(StreamChat::StreamResponse) }
+    def delete_campaign(campaign_id, **options)
+      delete("campaigns/#{campaign_id}", params: options)
+    end
+
+    # Starts a campaign.
+    #
+    # @param [String] campaign_id The campaign ID
+    # @param [DateTime, Time, String, nil] scheduled_for Optional scheduled start time
+    # @param [DateTime, Time, String, nil] stop_at Optional scheduled stop time
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(campaign_id: String, scheduled_for: T.nilable(T.any(DateTime, Time, String)), stop_at: T.nilable(T.any(DateTime, Time, String))).returns(StreamChat::StreamResponse) }
+    def start_campaign(campaign_id, scheduled_for: nil, stop_at: nil)
+      payload = {}
+      payload['scheduled_for'] = StreamChat.normalize_timestamp(scheduled_for) if scheduled_for
+      payload['stop_at'] = StreamChat.normalize_timestamp(stop_at) if stop_at
+      post("campaigns/#{campaign_id}/start", data: payload)
+    end
+
+    # Stops a campaign.
+    #
+    # @param [String] campaign_id The campaign ID
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
+    def stop_campaign(campaign_id)
+      post("campaigns/#{campaign_id}/stop")
+    end
+
+    # Queries campaigns.
+    #
+    # You can query campaigns based on built-in fields as well as any custom field you add to campaigns.
+    # Multiple filters can be combined using AND, OR logical operators, each filter can use its
+    # comparison (equality, inequality, greater than, greater or equal, etc.).
+    # @param [StringKeyHash] filter_conditions Filter conditions for the query
+    # @param [Hash, nil] sort Optional sort parameters (e.g., { 'created_at' => -1 })
+    # @param [Hash] options Additional query options (limit, offset, etc.)
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(filter_conditions: StringKeyHash, sort: T.nilable(T::Hash[String, Integer]), options: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_campaigns(filter_conditions, sort: nil, **options)
+      data = options.merge({
+                             filter: filter_conditions,
+                             sort: StreamChat.get_sort_fields(sort)
+                           })
+      post('campaigns/query', data: data)
+    end
+
     # Adds a device to a user.
     sig { params(device_id: String, push_provider: String, user_id: String, push_provider_name: T.nilable(String)).returns(StreamChat::StreamResponse) }
     def add_device(device_id, push_provider, user_id, push_provider_name = nil)
@@ -1058,7 +1154,7 @@ module StreamChat
     sig { params(user_id: String, filter_conditions: T::Hash[T.untyped, T.untyped], sort: T.nilable(T::Array[T::Hash[T.untyped, T.untyped]]), options: T.untyped).returns(StreamChat::StreamResponse) }
     def query_reminders(user_id, filter_conditions = {}, sort: nil, **options)
       params = options.merge({
-                               filter_conditions: filter_conditions,
+                               filter: filter_conditions,
                                sort: sort || [{ field: 'remind_at', direction: 1 }],
                                user_id: user_id
                              })

data/lib/stream-chat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 3.21.0
+  version: 3.22.0
 platform: ruby
 authors:
 - getstream.io
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-12 00:00:00.000000000 Z
+date: 2026-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -113,6 +113,7 @@ files:
 - Rakefile
 - SECURITY.md
 - lib/stream-chat.rb
+- lib/stream-chat/campaign.rb
 - lib/stream-chat/channel.rb
 - lib/stream-chat/client.rb
 - lib/stream-chat/errors.rb