stream-chat-ruby 2.22.2 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38d1012ba93c094b6a28185368ae809b0c6ef9bd67d9b88fc7731261c53e25b5
-  data.tar.gz: 04113551dd54cbd418e289f024213bfa3d388168711266a40bd8678d5b59284b
+  metadata.gz: 06e555a899a1f327f6ab64ae55a383c84bf76991df3530d67b8c29a84a27e0b4
+  data.tar.gz: 93df6034f3d3f76d735f3a023ef0e160b1c74930509b52c80df3e9436b28780d
 SHA512:
-  metadata.gz: 15dca07dcf3d295ac549a2f7d7ddc28663d21c24afa1cd9d4fca89d7a129b00f49594da4713757349903e61b1b2c2b5b32c70e0af1d3827dfd42523ad108c765
-  data.tar.gz: 0d1c5dc9a6ccab2ef2db44fc6eeb221ccf62d16c8779554831784525e2ed375b53f7086f27e02dd22d9a57c77fec1b80e3930cad65a19c898dca2591e3699e6b
+  metadata.gz: 668c718c2dc5b9c75db14601a3c8d2ebf6eaf3f7a53d14b654c05236304b8bc46fd8c76f6790cde9c16453911bc07bc6f4efb6c7be5547a036b2f98d33c58b35
+  data.tar.gz: e5b37cf05fedfe43a6d5b512dd36a0443010c7261070d40aa3455448c98a47842cbe2dbdd4b03cd83c315851aa810e66fda1e7cba4c358da1d015bde6f484484

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 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.
 
+## [2.23.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.22.2...v2.23.0) (2022-05-19)
+
+
+### Features
+
+* **campaign:** add campaign endpoints ([c8c698b](https://github.com/GetStream/stream-chat-ruby/commit/c8c698b51ee2c9f54819c2b9407a3fff7808efd5))
+* **import:** add import endpoints ([#102](https://github.com/GetStream/stream-chat-ruby/issues/102)) ([4d7358d](https://github.com/GetStream/stream-chat-ruby/commit/4d7358d39615c5346f9fdcb2b0dfbffa3c2ae79c))
+
 ### [2.22.2](https://github.com/GetStream/stream-chat-ruby/compare/v2.22.1...v2.22.2) (2022-04-21)
 
 

data/lib/stream-chat/client.rb

@@ -206,14 +206,14 @@ module StreamChat
       get('search', params: { payload: options.merge(to_merge).to_json })
     end
 
-    # <b>DEPRECATED:</b> Please use <tt>upsert_users</tt> instead.
+    # @deprecated Use {#upsert_users} instead.
     T::Sig::WithoutRuntime.sig { params(users: T::Array[StringKeyHash]).returns(StreamChat::StreamResponse) }
     def update_users(users)
       warn '[DEPRECATION] `update_users` is deprecated.  Please use `upsert_users` instead.'
       upsert_users(users)
     end
 
-    # <b>DEPRECATED:</b> Please use <tt>upsert_user</tt> instead.
+    # @deprecated Use {#upsert_user} instead.
     T::Sig::WithoutRuntime.sig { params(user: StringKeyHash).returns(StreamChat::StreamResponse) }
     def update_user(user)
       warn '[DEPRECATION] `update_user` is deprecated.  Please use `upsert_user` instead.'
@@ -834,6 +834,122 @@ module StreamChat
       get('push_providers')
     end
 
+    # Creates a signed URL for imports.
+    # @example
+    #   url_resp = client.create_import_url('myfile.json')
+    #   Faraday.put(url_resp['upload_url'], File.read('myfile.json'), 'Content-Type' => 'application/json')
+    #   client.create_import(url_resp['path'], 'upsert')
+    T::Sig::WithoutRuntime.sig { params(filename: String).returns(StreamChat::StreamResponse) }
+    def create_import_url(filename)
+      post('import_urls', data: { filename: filename })
+    end
+
+    # Creates a new import.
+    # @example
+    #   url_resp = client.create_import_url('myfile.json')
+    #   Faraday.put(url_resp['upload_url'], File.read('myfile.json'), 'Content-Type' => 'application/json')
+    #   client.create_import(url_resp['path'], 'upsert')
+    T::Sig::WithoutRuntime.sig { params(path: String, mode: String).returns(StreamChat::StreamResponse) }
+    def create_import(path, mode)
+      post('imports', data: { path: path, mode: mode })
+    end
+
+    # Returns an import by id.
+    T::Sig::WithoutRuntime.sig { params(id: String).returns(StreamChat::StreamResponse) }
+    def get_import(id)
+      get("imports/#{id}")
+    end
+
+    # Lists imports. Options dictionary can contain 'offset' and 'limit' keys for pagination.
+    T::Sig::WithoutRuntime.sig { params(options: T.untyped).returns(StreamChat::StreamResponse) }
+    def list_imports(options)
+      get('imports', params: options)
+    end
+
+    # Creates a campaign.
+    T::Sig::WithoutRuntime.sig { params(campaign: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def create_campaign(campaign)
+      post('campaigns', data: { campaign: campaign })
+    end
+
+    # Gets a campaign.
+    T::Sig::WithoutRuntime.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.
+    T::Sig::WithoutRuntime.sig { params(options: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def list_campaigns(options)
+      get('campaigns', params: options)
+    end
+
+    # Updates a campaign.
+    T::Sig::WithoutRuntime.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.
+    T::Sig::WithoutRuntime.sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
+    def delete_campaign(campaign_id)
+      delete("campaigns/#{campaign_id}")
+    end
+
+    # Schedules a campaign.
+    T::Sig::WithoutRuntime.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 })
+    end
+
+    # Stops a campaign.
+    T::Sig::WithoutRuntime.sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
+    def stop_campaign(campaign_id)
+      patch("campaigns/#{campaign_id}/stop")
+    end
+
+    # Resumes a campaign.
+    T::Sig::WithoutRuntime.sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
+    def resume_campaign(campaign_id)
+      patch("campaigns/#{campaign_id}/resume")
+    end
+
+    # Tests a campaign.
+    T::Sig::WithoutRuntime.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.
+    T::Sig::WithoutRuntime.sig { params(segment: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def create_segment(segment)
+      post('segments', data: { segment: segment })
+    end
+
+    # Gets a campaign segment.
+    T::Sig::WithoutRuntime.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.
+    T::Sig::WithoutRuntime.sig { params(options: StringKeyHash).returns(StreamChat::StreamResponse) }
+    def list_segments(options)
+      get('segments', params: options)
+    end
+
+    # Updates a campaign segment.
+    T::Sig::WithoutRuntime.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.
+    T::Sig::WithoutRuntime.sig { params(segment_id: String).returns(StreamChat::StreamResponse) }
+    def delete_segment(segment_id)
+      delete("segments/#{segment_id}")
+    end
+
     private
 
     T::Sig::WithoutRuntime.sig { returns(T::Hash[String, String]) }

data/lib/stream-chat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.22.2
+  version: 2.23.0
 platform: ruby
 authors:
 - getstream.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday