oursprivacy-ingest 1.16.2 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b9b9f2ed6e3a6555f1d5ef3760ae53925a85d09e4c5fad764f531948827f9c
-  data.tar.gz: 10d136ae93b05263abb71e8681b52c0610bfc4d399969f0caafd48bd6e224de1
+  metadata.gz: 22e4ba859643905caf56c7cf4e161514503d2cf4c47662d87232bd5d22229f27
+  data.tar.gz: d14639768b9c3cd94b9e842bb64bdd8784ba109746be2d6eb2af0ebf24454d45
 SHA512:
-  metadata.gz: df4c1209ecd477be51a993bfc9f8c431b8a05e56f3f033789dab96afb3a7adbed4ae157c2df7dc9cd579877cdda79ff9b927e560f172997cea12eda920f0e67b
-  data.tar.gz: 3080aa71012f38b6df74467e9f963dcb46e382aabc96825977e7aa4c8d66f0f8a7caf2d3777f163883297f674dc564631a857e0fc8b25089b5c8c3e10105df9c
+  metadata.gz: 3a8582c10816b4ecbbe89a80c302c7c8ddd6654db913d12a0dd4d5eb99e9761531180b8c97a0b459b34b3cb94b64a65631e3eaf29753f4ccc0d380d16f0a08e4
+  data.tar.gz: b03ea599196cb64ed9bfc7e4b212df77289fba26e5b3480eebc4dde1a6fd1f1f3b97d4ec6b653cd091ac4f8e2bf32314b1585d293b35774a34facea01db1bf93

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([b8020be](https://github.com/with-ours/ingest-sdk-ruby/commit/b8020be57eff92f2009805eee4d558bd9dab78f0))
+
 ## 1.16.2 (2026-08-03)
 
 Full Changelog: [v1.16.1...v1.16.2](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.16.1...v1.16.2)

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.16.2"
+gem "oursprivacy-ingest", "~> 1.18.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/oursprivacy_ingest/models/experiment_personalization_response.rb

@@ -10,13 +10,31 @@ module OursprivacyIngest
       required :personalizations,
                -> { OursprivacyIngest::Internal::Type::ArrayOf[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization] }
 
+      # @!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 [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:)
+      # @!method initialize(personalizations:, properties:, success:)
+      #   Some parameter documentations has been truncated, see
+      #   {OursprivacyIngest::Models::ExperimentPersonalizationResponse} for more details.
+      #
       #   @param personalizations [Array<OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization>]
+      #
+      #   @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]
 
       class Personalization < OursprivacyIngest::Internal::Type::BaseModel
@@ -59,6 +77,19 @@ module OursprivacyIngest
         #   @param variant_name [String, nil]
       end
 
+      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

data/lib/oursprivacy_ingest/resources/batch.rb

@@ -3,9 +3,10 @@
 module OursprivacyIngest
   module Resources
     class Batch
-      # Send multiple `/track`-shaped events in a single request. The top-level token is
-      # authorized once for the full batch. Each batch row must include `distinctId`,
-      # and mixed validation or queue outcomes are reported per row.
+      # Send multiple `/track`-shaped events in a single request. This endpoint is
+      # intended for replay, backfill, and asynchronous bulk delivery. The top-level
+      # token is authorized once for the full batch. Each batch row must include
+      # `distinctId`, and mixed validation or queue outcomes are reported per row.
       #
       # @overload create(token:, events:, request_options: {})
       #

data/lib/oursprivacy_ingest/resources/experiments.rb

@@ -51,10 +51,13 @@ 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 a visitor's active personalization assignments and accumulated
+      # personalization properties. Read-only and never records an impression.
+      # `personalizations` lists the personalization experiences the visitor is
+      # currently assigned to; `properties` returns the visitor traits your
+      # personalization property rules have accumulated, ready to use in server-rendered
+      # copy or targeting. Both are empty for a visitor who has not matched anything
+      # yet.
       #
       # @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.16.2"
+  VERSION = "1.18.0"
 end

data/rbi/oursprivacy_ingest/models/experiment_personalization_response.rbi

@@ -20,6 +20,22 @@ module OursprivacyIngest
       end
       attr_accessor :personalizations
 
+      # 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::Hash[
+            Symbol,
+            OursprivacyIngest::Models::ExperimentPersonalizationResponse::Property::Variants
+          ]
+        )
+      end
+      attr_accessor :properties
+
       sig do
         returns(
           OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::TaggedBoolean
@@ -33,11 +49,26 @@ module OursprivacyIngest
             T::Array[
               OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization::OrHash
             ],
+          properties:
+            T::Hash[
+              Symbol,
+              OursprivacyIngest::Models::ExperimentPersonalizationResponse::Property::Variants
+            ],
           success:
             OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::OrBoolean
         ).returns(T.attached_class)
       end
-      def self.new(personalizations:, success:)
+      def self.new(
+        personalizations:,
+        # 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:
+      )
       end
 
       sig do
@@ -47,6 +78,11 @@ module OursprivacyIngest
               T::Array[
                 OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization
               ],
+            properties:
+              T::Hash[
+                Symbol,
+                OursprivacyIngest::Models::ExperimentPersonalizationResponse::Property::Variants
+              ],
             success:
               OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success::TaggedBoolean
           }
@@ -118,6 +154,22 @@ module OursprivacyIngest
         end
       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
 

data/rbi/oursprivacy_ingest/resources/batch.rbi

@@ -3,9 +3,10 @@
 module OursprivacyIngest
   module Resources
     class Batch
-      # Send multiple `/track`-shaped events in a single request. The top-level token is
-      # authorized once for the full batch. Each batch row must include `distinctId`,
-      # and mixed validation or queue outcomes are reported per row.
+      # Send multiple `/track`-shaped events in a single request. This endpoint is
+      # intended for replay, backfill, and asynchronous bulk delivery. The top-level
+      # token is authorized once for the full batch. Each batch row must include
+      # `distinctId`, and mixed validation or queue outcomes are reported per row.
       sig do
         params(
           token: String,

data/rbi/oursprivacy_ingest/resources/experiments.rbi

@@ -45,10 +45,13 @@ 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 a visitor's active personalization assignments and accumulated
+      # personalization properties. Read-only and never records an impression.
+      # `personalizations` lists the personalization experiences the visitor is
+      # currently assigned to; `properties` returns the visitor traits your
+      # personalization property rules have accumulated, ready to use in server-rendered
+      # copy or targeting. Both are empty for a visitor who has not matched anything
+      # yet.
       sig do
         params(
           token: String,

data/sig/oursprivacy_ingest/models/experiment_personalization_response.rbs

@@ -3,21 +3,26 @@ module OursprivacyIngest
     type experiment_personalization_response =
       {
         personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization],
+        properties: ::Hash[Symbol, OursprivacyIngest::Models::ExperimentPersonalizationResponse::property],
         success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success
       }
 
     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
 
       def initialize: (
         personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization],
+        properties: ::Hash[Symbol, OursprivacyIngest::Models::ExperimentPersonalizationResponse::property],
         success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success
       ) -> void
 
       def to_hash: -> {
         personalizations: ::Array[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization],
+        properties: ::Hash[Symbol, OursprivacyIngest::Models::ExperimentPersonalizationResponse::property],
         success: OursprivacyIngest::Models::ExperimentPersonalizationResponse::success
       }
 
@@ -63,6 +68,14 @@ module OursprivacyIngest
         }
       end
 
+      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

metadata

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