oursprivacy-ingest 1.17.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 982f6c0cde72164668cb677a4e4352180646096cbbeec238a0a47b2dcaed2d4f
-  data.tar.gz: 16acc49bc63b4026719f9ea7fa8401146855a9676a4b4b8dedfc8261a6e36a21
+  metadata.gz: 9c5d65392b8fbf4e765f78ac8e7f4e1ed0006e99c3519c4e4b6fe60e041d5c92
+  data.tar.gz: 8c7da5bcf8ff87ba352e7d13b563945bafcff7b6263fc1abfc2e13996c6b2982
 SHA512:
-  metadata.gz: d901242723604cc6c5ad1175b767909ef57916e192d68956eecd110cdda061a92d6479557fde84a7607ba1708cdbc99bb6ad3c57c4cbada050e6df004b345f2c
-  data.tar.gz: c7d9df16cc14b257aaa97152db30bc93c4f894d1dc4a4e52646305b2e427c89486865185570b334b49eefdcfc2d5c576e6e5776e389733138e2390bad48025fa
+  metadata.gz: 8a97c7b21f0e6c935bfca56da5a3018cb7c75308819952a97c0e0809185d155f46385fec28ca097bd38db2f0104214d65714cbc72c4ce1432dcacb28fc6cfafe
+  data.tar.gz: 168f6ea5f416348947c5f909a315cd4328d11231cc929478fdeac1dfbdf2c80ee789e2437811ef05c19677e67090a7d0753dbd00545579c324e36c9c6665d247

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.19.0 (2026-09-14)
+
+Full Changelog: [v1.18.0...v1.19.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.18.0...v1.19.0)
+
+### Features
+
+* **api:** API update.
+## 1.18.0 (2026-09-11)
+
+Full Changelog: [v1.17.0...v1.18.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.17.0...v1.18.0)
+
+### Features
+
+* **api:** API update.
 ## 1.17.0 (2026-08-21)
 
 Full Changelog: [v1.16.2...v1.17.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.16.2...v1.17.0)

data/README.md

@@ -2,8 +2,6 @@
 
 The Ours Privacy Ruby library provides convenient access to the Ours Privacy REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/with-ours/ingest-sdk-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
-It is generated with [Stainless](https://www.stainless.com/).
-
 ## Documentation
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/oursprivacy-ingest).
@@ -17,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "oursprivacy-ingest", "~> 1.17.0"
+gem "oursprivacy-ingest", "~> 1.19.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/oursprivacy_ingest/models/experiment_personalization_response.rb

@@ -4,20 +4,66 @@ module OursprivacyIngest
   module Models
     # @see OursprivacyIngest::Resources::Experiments#personalization
     class ExperimentPersonalizationResponse < OursprivacyIngest::Internal::Type::BaseModel
-      # @!attribute personalizations
+      # @!attribute properties
+      #   The visitor traits accumulated by your personalization property rules, keyed by
+      #   property key. Values are always scalars — a string, number, or boolean, or null
+      #   when the captured field was itself empty. Empty for a visitor who has not
+      #   matched any rule yet. These same values are delivered to the visitor's browser
+      #   and are readable by anyone who knows the visitor_id, so never accumulate
+      #   secrets, credentials, PHI, or confidential data into a property.
       #
-      #   @return [Array<OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization>]
-      required :personalizations,
-               -> { OursprivacyIngest::Internal::Type::ArrayOf[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization] }
+      #   @return [Hash{Symbol=>String, Float, Boolean}]
+      required :properties,
+               -> { OursprivacyIngest::Internal::Type::HashOf[union: OursprivacyIngest::Models::ExperimentPersonalizationResponse::Property] }
 
       # @!attribute success
       #
       #   @return [Boolean, OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success]
       required :success, enum: -> { OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success }
 
-      # @!method initialize(personalizations:, success:)
-      #   @param personalizations [Array<OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization>]
+      # @!attribute personalizations
+      #   @deprecated
+      #
+      #   Deprecated legacy personalization assignments. Current API responses omit this
+      #   field; use properties for accumulated personalization traits. Retained in the
+      #   SDK for callers using older responses.
+      #
+      #   @return [Array<OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization>, nil]
+      optional :personalizations,
+               -> { OursprivacyIngest::Internal::Type::ArrayOf[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization] }
+
+      # @!method initialize(properties:, success:, personalizations: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {OursprivacyIngest::Models::ExperimentPersonalizationResponse} for more details.
+      #
+      #   @param properties [Hash{Symbol=>String, Float, Boolean}] The visitor traits accumulated by your personalization property rules, keyed by
+      #
       #   @param success [Boolean, OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success]
+      #
+      #   @param personalizations [Array<OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization>] Deprecated legacy personalization assignments. Current API responses omit this f
+
+      module Property
+        extend OursprivacyIngest::Internal::Type::Union
+
+        variant String
+
+        variant Float
+
+        variant OursprivacyIngest::Internal::Type::Boolean
+
+        # @!method self.variants
+        #   @return [Array(String, Float, Boolean)]
+      end
+
+      # @see OursprivacyIngest::Models::ExperimentPersonalizationResponse#success
+      module Success
+        extend OursprivacyIngest::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
 
       class Personalization < OursprivacyIngest::Internal::Type::BaseModel
         # @!attribute assigned_at
@@ -58,16 +104,6 @@ module OursprivacyIngest
         #   @param experiment_name [String, nil]
         #   @param variant_name [String, nil]
       end
-
-      # @see OursprivacyIngest::Models::ExperimentPersonalizationResponse#success
-      module Success
-        extend OursprivacyIngest::Internal::Type::Enum
-
-        TRUE = true
-
-        # @!method self.values
-        #   @return [Array<Boolean>]
-      end
     end
   end
 end

data/lib/oursprivacy_ingest/resources/experiments.rb

@@ -51,10 +51,10 @@ module OursprivacyIngest
         )
       end
 
-      # Return the active personalization assignments for a visitor. Read-only and never
-      # records an impression. Personalizations are populated by the event-driven rule
-      # engine — until that ships, this endpoint returns an empty list for every
-      # visitor, which is the correct fail-closed behavior (no false positives).
+      # Return the visitor traits accumulated by personalization property rules.
+      # Read-only and never records an impression. Use the properties to select
+      # personalized server-rendered copy or targeting; the browser experiment runtime
+      # receives the same bag at initialization.
       #
       # @overload personalization(token:, visitor_id:, request_options: {})
       #

data/lib/oursprivacy_ingest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OursprivacyIngest
-  VERSION = "1.17.0"
+  VERSION = "1.19.0"
 end

data/rbi/oursprivacy_ingest/models/experiment_personalization_response.rbi

@@ -11,14 +11,21 @@ module OursprivacyIngest
           )
         end
 
+      # The visitor traits accumulated by your personalization property rules, keyed by
+      # property key. Values are always scalars — a string, number, or boolean, or null
+      # when the captured field was itself empty. Empty for a visitor who has not
+      # matched any rule yet. These same values are delivered to the visitor's browser
+      # and are readable by anyone who knows the visitor_id, so never accumulate
+      # secrets, credentials, PHI, or confidential data into a property.
       sig do
         returns(
-          T::Array[
-            OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization
+          T::Hash[
+            Symbol,
+            OursprivacyIngest::Models::ExperimentPersonalizationResponse::Property::Variants
           ]
         )
       end
-      attr_accessor :personalizations
+      attr_accessor :properties
 
       sig do
         returns(
@@ -27,34 +34,126 @@ module OursprivacyIngest
       end
       attr_accessor :success
 
+      # Deprecated legacy personalization assignments. Current API responses omit this
+      # field; use properties for accumulated personalization traits. Retained in the
+      # SDK for callers using older responses.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization
+            ]
+          )
+        )
+      end
+      attr_reader :personalizations
+
       sig do
         params(
           personalizations:
             T::Array[
               OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization::OrHash
+            ]
+        ).void
+      end
+      attr_writer :personalizations
+
+      sig do
+        params(
+          properties:
+            T::Hash[
+              Symbol,
+              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Property::Variants
             ],
           success:
-            OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::OrBoolean
+            OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::OrBoolean,
+          personalizations:
+            T::Array[
+              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization::OrHash
+            ]
         ).returns(T.attached_class)
       end
-      def self.new(personalizations:, success:)
+      def self.new(
+        # The visitor traits accumulated by your personalization property rules, keyed by
+        # property key. Values are always scalars — a string, number, or boolean, or null
+        # when the captured field was itself empty. Empty for a visitor who has not
+        # matched any rule yet. These same values are delivered to the visitor's browser
+        # and are readable by anyone who knows the visitor_id, so never accumulate
+        # secrets, credentials, PHI, or confidential data into a property.
+        properties:,
+        success:,
+        # Deprecated legacy personalization assignments. Current API responses omit this
+        # field; use properties for accumulated personalization traits. Retained in the
+        # SDK for callers using older responses.
+        personalizations: nil
+      )
       end
 
       sig do
         override.returns(
           {
+            properties:
+              T::Hash[
+                Symbol,
+                OursprivacyIngest::Models::ExperimentPersonalizationResponse::Property::Variants
+              ],
+            success:
+              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::TaggedBoolean,
             personalizations:
               T::Array[
                 OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization
-              ],
-            success:
-              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::TaggedBoolean
+              ]
           }
         )
       end
       def to_hash
       end
 
+      module Property
+        extend OursprivacyIngest::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(String, Float, T::Boolean) }
+
+        sig do
+          override.returns(
+            T::Array[
+              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Property::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
+      end
+
+      module Success
+        extend OursprivacyIngest::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(
+              T::Boolean,
+              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success
+            )
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Personalization < OursprivacyIngest::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -117,35 +216,6 @@ module OursprivacyIngest
         def to_hash
         end
       end
-
-      module Success
-        extend OursprivacyIngest::Internal::Type::Enum
-
-        TaggedBoolean =
-          T.type_alias do
-            T.all(
-              T::Boolean,
-              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success
-            )
-          end
-        OrBoolean = T.type_alias { T::Boolean }
-
-        TRUE =
-          T.let(
-            true,
-            OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::TaggedBoolean
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::TaggedBoolean
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/oursprivacy_ingest/resources/experiments.rbi

@@ -45,10 +45,10 @@ module OursprivacyIngest
       )
       end
 
-      # Return the active personalization assignments for a visitor. Read-only and never
-      # records an impression. Personalizations are populated by the event-driven rule
-      # engine — until that ships, this endpoint returns an empty list for every
-      # visitor, which is the correct fail-closed behavior (no false positives).
+      # Return the visitor traits accumulated by personalization property rules.
+      # Read-only and never records an impression. Use the properties to select
+      # personalized server-rendered copy or targeting; the browser experiment runtime
+      # receives the same bag at initialization.
       sig do
         params(
           token: String,

data/sig/oursprivacy_ingest/models/experiment_personalization_response.rbs

@@ -2,25 +2,52 @@ module OursprivacyIngest
   module Models
     type experiment_personalization_response =
       {
-        personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization],
-        success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success
+        properties: ::Hash[Symbol, OursprivacyIngest::Models::ExperimentPersonalizationResponse::property],
+        success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success,
+        personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization]
       }
 
     class ExperimentPersonalizationResponse < OursprivacyIngest::Internal::Type::BaseModel
-      attr_accessor personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization]
+      attr_accessor properties: ::Hash[Symbol, OursprivacyIngest::Models::ExperimentPersonalizationResponse::property]
 
       attr_accessor success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success
 
+      attr_reader personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization]?
+
+      def personalizations=: (
+        ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization]
+      ) -> ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization]
+
       def initialize: (
-        personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization],
-        success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success
+        properties: ::Hash[Symbol, OursprivacyIngest::Models::ExperimentPersonalizationResponse::property],
+        success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success,
+        ?personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization]
       ) -> void
 
       def to_hash: -> {
-        personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization],
-        success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success
+        properties: ::Hash[Symbol, OursprivacyIngest::Models::ExperimentPersonalizationResponse::property],
+        success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success,
+        personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization]
       }
 
+      type property = String | Float | bool
+
+      module Property
+        extend OursprivacyIngest::Internal::Type::Union
+
+        def self?.variants: -> ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::property]
+      end
+
+      type success = true
+
+      module Success
+        extend OursprivacyIngest::Internal::Type::Enum
+
+        TRUE: true
+
+        def self?.values: -> ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::success]
+      end
+
       type personalization =
         {
           assigned_at: Float,
@@ -62,16 +89,6 @@ module OursprivacyIngest
           variant_name: String?
         }
       end
-
-      type success = true
-
-      module Success
-        extend OursprivacyIngest::Internal::Type::Enum
-
-        TRUE: true
-
-        def self?.values: -> ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::success]
-      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oursprivacy-ingest
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Ours Privacy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-25 00:00:00.000000000 Z
+date: 2026-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi