braze_ruby 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8b917b476524829a7321aba5094d205b8354c09ea1f9440af5d65c1766e3dda
-  data.tar.gz: 76f533b0029ceed757ad322caad5e3c3671db936a80bcada11bcec7dd9fc02c2
+  metadata.gz: 4b76039a0f4cb84b70161c37d758241dd0f0fa3d4114bd407102e84ca04731d7
+  data.tar.gz: 8ff20890e2800b240a19798ca094d1aad8d02801b93d15b82a1831385a1cfdfd
 SHA512:
-  metadata.gz: 12e35e8e02474f45b79e7090ee3d09ab0396511b4575a0e21e6bfa25aacc65932a664b6695d5e53ada5c5c312e724fd961d3e693bcf6af59d811e8c9e5dd49fb
-  data.tar.gz: 8b8933c389cc3d43ec94a047c1dcfdf596b9ff1cc26f60366a0fb41faec3be5a22fb8752c2357a851759d4adf650d83469dabaec96e145a6fb8f432d5b0b157b
+  metadata.gz: 6c4ba02f5c3a96a1286d885dda68be3c9b939e458f040412fdbe707e36d0a3089f65e8549e2fb8f2b749be36d61a97794cc9f06fd1e4f642043902f8456c72d2
+  data.tar.gz: '084eec3c3b6fa0e36b2ddcec06afac74d002c9e4bfd5ae2ccb7f5788f4b970fd072d78ca7d80b2770e0880fa6d6c607a7cf166374d3af72ddaae4ee3e5bb17f2'

data/CHANGELOG.md

@@ -22,6 +22,15 @@ The format is based on [Keep a Changelog][] and this project adheres to
 
 ### Security
 
+## [0.11.0][] - 2025-01-31
+
+### Added
+
+* Support for Faraday middlewares ([#66][])
+* Adding support for v2 subscription endpoint ([#53][])
+* Support for Braze catalogs : edit_catalog_items ([#69][])
+* Add support for export campaigns ([#52][])
+
 ## [0.10.0][] - 2024-11-15
 
 ### Added
@@ -103,7 +112,7 @@ The format is based on [Keep a Changelog][] and this project adheres to
 * Modernize a few files and tinker with CI setup ([#26][])
 * Update authors and license ([#27][])
 
-[Unreleased]: https://github.com/jonallured/braze_ruby/compare/v0.10.0...HEAD
+[Unreleased]: https://github.com/jonallured/braze_ruby/compare/v0.11.0...HEAD
 
 [0.5.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.5.0
 [0.6.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.6.0
@@ -111,6 +120,7 @@ The format is based on [Keep a Changelog][] and this project adheres to
 [0.8.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.8.0
 [0.9.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.9.0
 [0.10.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.10.0
+[0.11.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.11.0
 
 [#25]: https://github.com/jonallured/braze_ruby/pull/25
 [#26]: https://github.com/jonallured/braze_ruby/pull/26
@@ -131,6 +141,7 @@ The format is based on [Keep a Changelog][] and this project adheres to
 [#45]: https://github.com/jonallured/braze_ruby/pull/45
 [#46]: https://github.com/jonallured/braze_ruby/pull/46
 [#47]: https://github.com/jonallured/braze_ruby/pull/47
+[#52]: https://github.com/jonallured/braze_ruby/pull/52
 [#60]: https://github.com/jonallured/braze_ruby/pull/60
 [#61]: https://github.com/jonallured/braze_ruby/pull/61
 [#62]: https://github.com/jonallured/braze_ruby/pull/62
@@ -139,3 +150,4 @@ The format is based on [Keep a Changelog][] and this project adheres to
 [#65]: https://github.com/jonallured/braze_ruby/pull/65
 [#67]: https://github.com/jonallured/braze_ruby/pull/67
 [#68]: https://github.com/jonallured/braze_ruby/pull/68
+[#69]: https://github.com/jonallured/braze_ruby/pull/69

data/README.md

@@ -58,6 +58,13 @@ api.options
 # => {:key=>"global-options"}
 ```
 
+#### Available `options` keys
+
+- retry - Number of times to retry a failed request
+- open_timeout - Number of seconds to wait for the connection to open
+- timeout - Number of seconds to wait for the request to complete
+- middlewares - Array of Faraday middleware to use
+
 ## Examples
 
 ### Initializing API
@@ -221,10 +228,13 @@ api.export_users(external_ids: [1])
 ```ruby
 api.export_users(segment_id: segment_id, callback_endpoint: 'https://example.com')
 ```
+
 ### Delete Users
 
 #####
+
 Delete Braze Users with an array of external_ids
+
 ```ruby
 api.delete_users([1, 2, 3])
 ```
@@ -232,11 +242,13 @@ api.delete_users([1, 2, 3])
 ### Subscription groups
 
 #### Get subscription group status for users by id
+
 ```ruby
 api.subscription_user_status(external_id: [1])
 ```
 
 #### Get users status for a specific subscription group
+
 ```ruby
 api.subscription_status_get(
   external_id: [1],
@@ -245,6 +257,7 @@ api.subscription_status_get(
 ```
 
 #### Set user status for a specific subscription group
+
 ```ruby
 api.subscription_status_set(
   external_id: [1],
@@ -253,6 +266,20 @@ api.subscription_status_set(
 )
 ```
 
+#### Set user status for a specific subscription group using v2 route
+
+```ruby
+api.v2_subscription_status_set(
+  subscription_groups: [
+    {
+      external_id: [1],
+      subscription_group_id: 'some-uuid',
+      subscription_state: 'subscribed|unsubscribed'
+    }
+  ]
+)
+```
+
 ### User Alias
 
 #### Create an alias-only user
@@ -269,6 +296,7 @@ api.create_user_aliases(
 ```
 
 #### Identify an alias-only user
+
 ```ruby
 api.identify_users(
   aliases_to_identify: [{
@@ -284,7 +312,9 @@ api.identify_users(
 ### External ID Migration
 
 #### Rename users' external IDs with an array of external_id_renames
+
 Note: you can send up to 50 rename objects per request.
+
 ```ruby
 api.rename_external_ids(
   external_id_renames: [{
@@ -295,7 +325,9 @@ api.rename_external_ids(
 ```
 
 #### Remove users' old deprecated external IDs
+
 Note: you can send up to 50 external IDs per request.
+
 ```ruby
 api.remove_external_ids(external_ids: ['old_external_id'])
 ```
@@ -303,16 +335,19 @@ api.remove_external_ids(external_ids: ['old_external_id'])
 ### Email Sync
 
 #### Get List of or Query Email Unsubscribes
+
 ```ruby
 api.email_unsubscribes(email: ['jdoe@example.com'])
 ```
 
 #### Get List of or Query Hard Bounced Emails
+
 ```ruby
 api.email_hard_bounces(email: ['jdoe@example.com'])
 ```
 
 #### Remove Email Addresses From Spam List
+
 ```ruby
 api.remove_emails_from_spam(email: ['jdoe@example.com'])
 ```
@@ -323,6 +358,7 @@ As of november 2024, Braze catalogs still have some moving parts (beta) and only
 partial support has been implemented
 
 #### Create Catalogs
+
 ```ruby
 api.create_catalogs(
   catalogs: [
@@ -341,16 +377,19 @@ api.create_catalogs(
 ```
 
 #### List Catalogs
+
 ```ruby
 api.list_catalogs
 ```
 
 #### Delete Catalog
+
 ```ruby
 api.delete_catalog("restaurants")
 ```
 
 #### Create Catalog Items
+
 ```ruby
 api.create_catalog_items(
   "restaurants",
@@ -366,6 +405,7 @@ api.create_catalog_items(
 ```
 
 #### Delete Catalog Items
+
 ```ruby
 api.delete_catalog_items(
   "restaurants",
@@ -377,6 +417,7 @@ api.delete_catalog_items(
 
 #### Update Catalog Items
 
+**EDIT : This functions hints at functioning like an upsert but actual API behaviour is more of the create if not existing. Further calls on items already existing will do nothing. Use edit_catalog_items for that, see below**
 This functions like an upsert, the name of the associated permission api key
 permission is `catalog.replace_items`
 
@@ -394,6 +435,52 @@ api.update_catalog_items(
 )
 ```
 
+#### Edit Catalog Items
+
+This functions actually _updates_ items. The update catalog items does not. This
+is very confusing and Braze support answers late nov 2024 did not clarify this
+point. TL;DR Actual behaviour is `update_catalog_items` functions more or less
+like an create if not existing. `edit_catalog_items` functions like an update
+without the creation bit if it item does not already exists. This will stay in
+an in-between state while Braze continues working on its implementation.
+
+`edit_catalog_items` only updates the property in the payload, it does not reset
+value for the existing properties that were omitted.
+
+When fixed we will be able to better name things
+
+```ruby
+api.edit_catalog_items(
+  "restaurants",
+  items: [
+    {
+      id: "restaurant1",
+      Name: "NewRestaurantName",
+    }
+  ]
+)
+```
+
+### Export Campaigns
+
+#### Export Campaigns List
+
+```ruby
+api.export_campaigns_list(page: 1)
+```
+
+#### Export Campaign Details
+
+```ruby
+api.export_campaign_details(campaign_id: 1)
+```
+
+#### Export Campaign Analytics
+
+```ruby
+api.export_campaign_analytics(campaign_id: 1, length: 100, ending_at: '2022-12-13T11:21:09-08:00' ))
+```
+
 ## Debugging
 
 The BRAZE_RUBY_DEBUG environment variable will trigger full printouts of the

data/lib/braze_ruby/api.rb

@@ -6,6 +6,7 @@ require "braze_ruby/endpoints/send_messages"
 require "braze_ruby/endpoints/schedule_messages"
 require "braze_ruby/endpoints/email_status"
 require "braze_ruby/endpoints/email_sync"
+require "braze_ruby/endpoints/export"
 require "braze_ruby/endpoints/delete_users"
 require "braze_ruby/endpoints/campaigns"
 require "braze_ruby/endpoints/canvas"
@@ -24,6 +25,7 @@ module BrazeRuby
     include BrazeRuby::Endpoints::ScheduleMessages
     include BrazeRuby::Endpoints::EmailStatus
     include BrazeRuby::Endpoints::EmailSync
+    include BrazeRuby::Endpoints::Export
     include BrazeRuby::Endpoints::DeleteUsers
     include BrazeRuby::Endpoints::Campaigns
     include BrazeRuby::Endpoints::Canvas

data/lib/braze_ruby/endpoints/catalogs.rb

@@ -28,6 +28,10 @@ module BrazeRuby
       def update_catalog_items(catalog_name, **payload)
         BrazeRuby::REST::UpdateCatalogItems.new(api_key, braze_url, options, catalog_name, **payload).perform
       end
+
+      def edit_catalog_items(catalog_name, **payload)
+        BrazeRuby::REST::EditCatalogItems.new(api_key, braze_url, options, catalog_name, **payload).perform
+      end
     end
   end
 end

data/lib/braze_ruby/endpoints/export.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module Endpoints
+    module Export
+      def export_campaigns_list(**payload)
+        BrazeRuby::REST::ExportCampaignsList.new(api_key, braze_url, options).perform(**payload)
+      end
+
+      def export_campaign_details(**payload)
+        BrazeRuby::REST::ExportCampaignDetails.new(api_key, braze_url, options).perform(**payload)
+      end
+
+      def export_campaign_analytics(**payload)
+        BrazeRuby::REST::ExportCampaignAnalytics.new(api_key, braze_url, options).perform(**payload)
+      end
+    end
+  end
+end

data/lib/braze_ruby/endpoints/subscription.rb

@@ -7,6 +7,10 @@ module BrazeRuby
         BrazeRuby::REST::SubscriptionStatusSet.new(api_key, braze_url, options, **payload).perform
       end
 
+      def v2_subscription_status_set(**payload)
+        BrazeRuby::REST::V2SubscriptionStatusSet.new(api_key, braze_url, options, **payload).perform
+      end
+
       def subscription_status_get(**payload)
         BrazeRuby::REST::SubscriptionStatusGet.new(api_key, braze_url, options, **payload).perform
       end

data/lib/braze_ruby/http.rb

@@ -26,6 +26,12 @@ module BrazeRuby
       end
     end
 
+    def patch(path, payload)
+      connection.patch path do |request|
+        request.body = JSON.dump(payload)
+      end
+    end
+
     def get(path, query = {})
       connection.get path, query
     end
@@ -50,6 +56,10 @@ module BrazeRuby
 
         connection.options[:timeout] = @options[:timeout]
         connection.options[:open_timeout] = @options[:open_timeout]
+
+        @options.fetch(:middlewares, []).each do |middleware|
+          connection.use middleware
+        end
       end
     end
 

data/lib/braze_ruby/rest/edit_catalog_items.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class EditCatalogItems < Base
+      attr_reader :params
+      attr_reader :catalog_name
+
+      def initialize(api_key, braze_url, options, catalog_name, **params)
+        @catalog_name = catalog_name
+        @params = params
+        super(api_key, braze_url, options)
+      end
+
+      def perform
+        http.patch("/catalogs/#{@catalog_name}/items", @params)
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/export_campaign_analytics.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class ExportCampaignAnalytics < Base
+      def perform(options)
+        http.get("/campaigns/data_series", options)
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/export_campaign_details.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class ExportCampaignDetails < Base
+      def perform(options)
+        http.get("/campaigns/details", options)
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/export_campaigns_list.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class ExportCampaignsList < Base
+      def perform(options)
+        http.get("/campaigns/list", options)
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/v2_subscription_status_set.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class V2SubscriptionStatusSet < Base
+      attr_reader :params
+
+      def initialize(api_key, braze_url, options, **params)
+        @params = params
+        super(api_key, braze_url, options)
+      end
+
+      def perform
+        http.post("/v2/subscription/status/set", {
+          **params
+        })
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest.rb

@@ -8,6 +8,9 @@ require "braze_ruby/rest/scheduled_broadcasts"
 require "braze_ruby/rest/email_status"
 require "braze_ruby/rest/email_hard_bounces"
 require "braze_ruby/rest/email_unsubscribes"
+require "braze_ruby/rest/export_campaign_analytics"
+require "braze_ruby/rest/export_campaign_details"
+require "braze_ruby/rest/export_campaigns_list"
 require "braze_ruby/rest/export_users"
 require "braze_ruby/rest/list_segments"
 require "braze_ruby/rest/delete_users"
@@ -30,3 +33,5 @@ require "braze_ruby/rest/list_catalogs"
 require "braze_ruby/rest/create_catalog_items"
 require "braze_ruby/rest/delete_catalog_items"
 require "braze_ruby/rest/update_catalog_items"
+require "braze_ruby/rest/edit_catalog_items"
+require "braze_ruby/rest/v2_subscription_status_set"

data/lib/braze_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrazeRuby
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: braze_ruby
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Josh Nussbaum
 - Hugo Bastien
 - Justin Boltz
 - Jonathan Allured
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-15 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -189,6 +189,7 @@ files:
 - lib/braze_ruby/endpoints/delete_users.rb
 - lib/braze_ruby/endpoints/email_status.rb
 - lib/braze_ruby/endpoints/email_sync.rb
+- lib/braze_ruby/endpoints/export.rb
 - lib/braze_ruby/endpoints/identify_users.rb
 - lib/braze_ruby/endpoints/remove_email_addresses_from_spam.rb
 - lib/braze_ruby/endpoints/remove_external_ids.rb
@@ -208,9 +209,13 @@ files:
 - lib/braze_ruby/rest/delete_catalog_items.rb
 - lib/braze_ruby/rest/delete_trigger_campaign_schedule.rb
 - lib/braze_ruby/rest/delete_users.rb
+- lib/braze_ruby/rest/edit_catalog_items.rb
 - lib/braze_ruby/rest/email_hard_bounces.rb
 - lib/braze_ruby/rest/email_status.rb
 - lib/braze_ruby/rest/email_unsubscribes.rb
+- lib/braze_ruby/rest/export_campaign_analytics.rb
+- lib/braze_ruby/rest/export_campaign_details.rb
+- lib/braze_ruby/rest/export_campaigns_list.rb
 - lib/braze_ruby/rest/export_users.rb
 - lib/braze_ruby/rest/identify_users.rb
 - lib/braze_ruby/rest/list_catalogs.rb
@@ -229,6 +234,7 @@ files:
 - lib/braze_ruby/rest/trigger_campaign_send.rb
 - lib/braze_ruby/rest/trigger_canvas_send.rb
 - lib/braze_ruby/rest/update_catalog_items.rb
+- lib/braze_ruby/rest/v2_subscription_status_set.rb
 - lib/braze_ruby/version.rb
 homepage: https://github.com/jonallured/braze_ruby
 licenses:
@@ -236,7 +242,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/jonallured/braze_ruby
   source_code_uri: https://github.com/jonallured/braze_ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -251,8 +257,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: A wrapper gem for the Braze REST API.
 test_files: []