oursprivacy-ingest 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b37fe59b66fe28fc56f5e19dc9b6440478ddbb90f387e9b618f2aade2a2e281
-  data.tar.gz: f1015c560142fd14deb6c9892b5349ea3c062da30610dd7fb56387abb59a309a
+  metadata.gz: abb94e2f78437ee3c959514e37490b858072ffc3f5fe8815e67c5d82d4a8981b
+  data.tar.gz: c5b94c84af1db233a51d17684e5e4c210e63beda3477c2e38ea157c3baa0a038
 SHA512:
-  metadata.gz: 52e45a24efacfc15f4826b5fb696aae27c484bb1f8e507f04c70af9040707ee961862f5217b1bc8eac3e9075f71a563687d7e77e9073a2d168ce64c4c2a0b578
-  data.tar.gz: 321cb84832e867f3fa31dda24bf650f8e2b15df38775853795c1a07277e30c512abd2fdffc6087a2c17f9cc07fd958b379c784471d65a194516b1930ad95d3f3
+  metadata.gz: 4c74d7e70b9b7d618e1acd348aae432adc4b95ad8efffd1eaf7f2bce3f5a7bbac4cbb2929cb35f7d26d7ba118bb392cc853d9f5e42e8ed699ad94a3f6b629d27
+  data.tar.gz: 2f0153bad01e49db6f65d1e10443a35b8e642b975436285937339841d5b1726a4d4100b53908cc982604d9b1b0ae1b157baaa0d715b962b89d63fd5df6b32da0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.11.0 (2026-05-28)
+
+Full Changelog: [v1.10.0...v1.11.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.10.0...v1.11.0)
+
+### Features
+
+* **api:** api update ([1836d36](https://github.com/with-ours/ingest-sdk-ruby/commit/1836d362919dea15c8bd5912d54a958a0ee34610))
+
 ## 1.10.0 (2026-05-27)
 
 Full Changelog: [v1.9.0...v1.10.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.9.0...v1.10.0)

data/README.md

@@ -17,7 +17,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.10.0"
+gem "oursprivacy-ingest", "~> 1.11.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/oursprivacy_ingest/client.rb

@@ -24,6 +24,9 @@ module OursprivacyIngest
     # @return [OursprivacyIngest::Resources::Visitor]
     attr_reader :visitor
 
+    # @return [OursprivacyIngest::Resources::Experiments]
+    attr_reader :experiments
+
     # @api private
     #
     # @return [Boolean]
@@ -77,6 +80,7 @@ module OursprivacyIngest
       @batch = OursprivacyIngest::Resources::Batch.new(client: self)
       @track = OursprivacyIngest::Resources::Track.new(client: self)
       @visitor = OursprivacyIngest::Resources::Visitor.new(client: self)
+      @experiments = OursprivacyIngest::Resources::Experiments.new(client: self)
     end
   end
 end

data/lib/oursprivacy_ingest/internal/type/union.rb

@@ -4,6 +4,17 @@ module OursprivacyIngest
   module Internal
     module Type
       # @api private
+      #
+      # @example
+      #   # `experiment_assignment_response` is a `OursprivacyIngest::Models::ExperimentAssignmentResponse`
+      #   case experiment_assignment_response
+      #   when OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0
+      #     puts(experiment_assignment_response.experiment_id)
+      #   when OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1
+      #     puts(experiment_assignment_response.in_experiment)
+      #   else
+      #     puts(experiment_assignment_response)
+      #   end
       module Union
         include OursprivacyIngest::Internal::Type::Converter
         include OursprivacyIngest::Internal::Util::SorbetRuntimeSupport

data/lib/oursprivacy_ingest/models/experiment_assignment_params.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module OursprivacyIngest
+  module Models
+    # @see OursprivacyIngest::Resources::Experiments#assignment
+    class ExperimentAssignmentParams < OursprivacyIngest::Internal::Type::BaseModel
+      extend OursprivacyIngest::Internal::Type::RequestParameters::Converter
+      include OursprivacyIngest::Internal::Type::RequestParameters
+
+      # @!attribute experiment_key
+      #   The experiment's stable key. Surfaced in the dashboard under each experiment's
+      #   setup tab.
+      #
+      #   @return [String]
+      required :experiment_key, String
+
+      # @!attribute token
+      #   The experiment token (`exp_*`) for the experiment settings holding this
+      #   experiment. Available from the dashboard.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute visitor_id
+      #   Stable identifier for the visitor — typically the Ours visitor id from your
+      #   browser cookie, or your own server-side user id if you keep the same id
+      #   consistent across browser and server.
+      #
+      #   @return [String]
+      required :visitor_id, String
+
+      # @!attribute context
+      #   Optional page context for URL + query-param eligibility. Variant bucketing is
+      #   deterministic on `visitor_id` regardless of context.
+      #
+      #   @return [OursprivacyIngest::Models::ExperimentAssignmentParams::Context, nil]
+      optional :context, -> { OursprivacyIngest::ExperimentAssignmentParams::Context }, nil?: true
+
+      # @!attribute track_impression
+      #   When true (default), an `$experiment_impression` event is enqueued and the
+      #   visitor's `experiment_assignments` map is updated. Set to false to read the
+      #   assignment without recording an impression — useful for in-test diagnostics.
+      #
+      #   @return [Boolean, nil]
+      optional :track_impression, OursprivacyIngest::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(experiment_key:, token:, visitor_id:, context: nil, track_impression: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OursprivacyIngest::Models::ExperimentAssignmentParams} for more details.
+      #
+      #   @param experiment_key [String] The experiment's stable key. Surfaced in the dashboard under each experiment's s
+      #
+      #   @param token [String] The experiment token (`exp_*`) for the experiment settings holding this experime
+      #
+      #   @param visitor_id [String] Stable identifier for the visitor — typically the Ours visitor id from your brow
+      #
+      #   @param context [OursprivacyIngest::Models::ExperimentAssignmentParams::Context, nil] Optional page context for URL + query-param eligibility. Variant bucketing is de
+      #
+      #   @param track_impression [Boolean, nil] When true (default), an `$experiment_impression` event is enqueued and the visit
+      #
+      #   @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}]
+
+      class Context < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute search
+        #   The current query string (e.g. `?utm_source=meta`). When provided, the
+        #   experiment's query-param conditions are evaluated for eligibility. If omitted,
+        #   the query string is parsed from `url`.
+        #
+        #   @return [String, nil]
+        optional :search, String, nil?: true
+
+        # @!attribute url
+        #   The current page URL. When provided, the experiment's URL patterns are evaluated
+        #   for eligibility — visitors on non-matching URLs are returned
+        #   `in_experiment: false`. Omit when the caller is pre-gating the request.
+        #
+        #   @return [String, nil]
+        optional :url, String, nil?: true
+
+        # @!method initialize(search: nil, url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OursprivacyIngest::Models::ExperimentAssignmentParams::Context} for more
+        #   details.
+        #
+        #   Optional page context for URL + query-param eligibility. Variant bucketing is
+        #   deterministic on `visitor_id` regardless of context.
+        #
+        #   @param search [String, nil] The current query string (e.g. `?utm_source=meta`). When provided, the experimen
+        #
+        #   @param url [String, nil] The current page URL. When provided, the experiment's URL patterns are evaluated
+      end
+    end
+  end
+end

data/lib/oursprivacy_ingest/models/experiment_assignment_response.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module OursprivacyIngest
+  module Models
+    # @see OursprivacyIngest::Resources::Experiments#assignment
+    module ExperimentAssignmentResponse
+      extend OursprivacyIngest::Internal::Type::Union
+
+      variant -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0 }
+
+      variant -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1 }
+
+      class UnionMember0 < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute experiment_id
+        #
+        #   @return [String]
+        required :experiment_id, String
+
+        # @!attribute in_experiment
+        #
+        #   @return [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::InExperiment]
+        required :in_experiment,
+                 enum: -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::InExperiment }
+
+        # @!attribute success
+        #
+        #   @return [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::Success]
+        required :success,
+                 enum: -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::Success }
+
+        # @!attribute variant_id
+        #
+        #   @return [String]
+        required :variant_id, String
+
+        # @!attribute experiment_key
+        #
+        #   @return [String, nil]
+        optional :experiment_key, String, nil?: true
+
+        # @!attribute experiment_name
+        #
+        #   @return [String, nil]
+        optional :experiment_name, String, nil?: true
+
+        # @!attribute is_control
+        #
+        #   @return [Boolean, nil]
+        optional :is_control, OursprivacyIngest::Internal::Type::Boolean, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [String, nil]
+        optional :type, String, nil?: true
+
+        # @!attribute variant_name
+        #
+        #   @return [String, nil]
+        optional :variant_name, String, nil?: true
+
+        # @!method initialize(experiment_id:, in_experiment:, success:, variant_id:, experiment_key: nil, experiment_name: nil, is_control: nil, type: nil, variant_name: nil)
+        #   @param experiment_id [String]
+        #   @param in_experiment [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::InExperiment]
+        #   @param success [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0::Success]
+        #   @param variant_id [String]
+        #   @param experiment_key [String, nil]
+        #   @param experiment_name [String, nil]
+        #   @param is_control [Boolean, nil]
+        #   @param type [String, nil]
+        #   @param variant_name [String, nil]
+
+        # @see OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0#in_experiment
+        module InExperiment
+          extend OursprivacyIngest::Internal::Type::Enum
+
+          TRUE = true
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+
+        # @see OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0#success
+        module Success
+          extend OursprivacyIngest::Internal::Type::Enum
+
+          TRUE = true
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+      end
+
+      class UnionMember1 < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute in_experiment
+        #
+        #   @return [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::InExperiment]
+        required :in_experiment,
+                 enum: -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::InExperiment }
+
+        # @!attribute success
+        #
+        #   @return [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::Success]
+        required :success,
+                 enum: -> { OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::Success }
+
+        # @!method initialize(in_experiment:, success:)
+        #   @param in_experiment [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::InExperiment]
+        #   @param success [Boolean, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1::Success]
+
+        # @see OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1#in_experiment
+        module InExperiment
+          extend OursprivacyIngest::Internal::Type::Enum
+
+          FALSE = false
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+
+        # @see OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1#success
+        module Success
+          extend OursprivacyIngest::Internal::Type::Enum
+
+          TRUE = true
+
+          # @!method self.values
+          #   @return [Array<Boolean>]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1)]
+    end
+  end
+end

data/lib/oursprivacy_ingest/models/experiment_personalization_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OursprivacyIngest
+  module Models
+    # @see OursprivacyIngest::Resources::Experiments#personalization
+    class ExperimentPersonalizationParams < OursprivacyIngest::Internal::Type::BaseModel
+      extend OursprivacyIngest::Internal::Type::RequestParameters::Converter
+      include OursprivacyIngest::Internal::Type::RequestParameters
+
+      # @!attribute token
+      #   The experiment token (`exp_*`).
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute visitor_id
+      #
+      #   @return [String]
+      required :visitor_id, String
+
+      # @!method initialize(token:, visitor_id:, request_options: {})
+      #   @param token [String] The experiment token (`exp_*`).
+      #
+      #   @param visitor_id [String]
+      #
+      #   @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/oursprivacy_ingest/models/experiment_personalization_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module OursprivacyIngest
+  module Models
+    # @see OursprivacyIngest::Resources::Experiments#personalization
+    class ExperimentPersonalizationResponse < OursprivacyIngest::Internal::Type::BaseModel
+      # @!attribute personalizations
+      #
+      #   @return [Array<OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization>]
+      required :personalizations,
+               -> { OursprivacyIngest::Internal::Type::ArrayOf[OursprivacyIngest::Models::ExperimentPersonalizationResponse::Personalization] }
+
+      # @!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>]
+      #   @param success [Boolean, OursprivacyIngest::Models::ExperimentPersonalizationResponse::Success]
+
+      class Personalization < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute assigned_at
+        #
+        #   @return [Float]
+        required :assigned_at, Float
+
+        # @!attribute experiment_id
+        #
+        #   @return [String]
+        required :experiment_id, String
+
+        # @!attribute variant_id
+        #
+        #   @return [String]
+        required :variant_id, String
+
+        # @!attribute experiment_key
+        #
+        #   @return [String, nil]
+        optional :experiment_key, String, nil?: true
+
+        # @!attribute experiment_name
+        #
+        #   @return [String, nil]
+        optional :experiment_name, String, nil?: true
+
+        # @!attribute variant_name
+        #
+        #   @return [String, nil]
+        optional :variant_name, String, nil?: true
+
+        # @!method initialize(assigned_at:, experiment_id:, variant_id:, experiment_key: nil, experiment_name: nil, variant_name: nil)
+        #   @param assigned_at [Float]
+        #   @param experiment_id [String]
+        #   @param variant_id [String]
+        #   @param experiment_key [String, nil]
+        #   @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/models.rb

@@ -44,6 +44,10 @@ module OursprivacyIngest
 
   BatchCreateParams = OursprivacyIngest::Models::BatchCreateParams
 
+  ExperimentAssignmentParams = OursprivacyIngest::Models::ExperimentAssignmentParams
+
+  ExperimentPersonalizationParams = OursprivacyIngest::Models::ExperimentPersonalizationParams
+
   TrackEventParams = OursprivacyIngest::Models::TrackEventParams
 
   VisitorUpsertParams = OursprivacyIngest::Models::VisitorUpsertParams

data/lib/oursprivacy_ingest/resources/experiments.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module OursprivacyIngest
+  module Resources
+    class Experiments
+      # Some parameter documentations has been truncated, see
+      # {OursprivacyIngest::Models::ExperimentAssignmentParams} for more details.
+      #
+      # Return the server-side variant assignment for a visitor in a single A/B or
+      # multivariate experiment, identified by its experiment key. Bucketing is
+      # deterministic on `visitor_id` and is sticky across calls. Tracking an impression
+      # is the default — pass `track_impression: false` to read without recording. The
+      # browser SDK and this endpoint converge on the same variant for the same visitor.
+      #
+      # @overload assignment(experiment_key, token:, visitor_id:, context: nil, track_impression: nil, request_options: {})
+      #
+      # @param experiment_key [String] The experiment's stable key. Surfaced in the dashboard under each experiment's s
+      #
+      # @param token [String] The experiment token (`exp_*`) for the experiment settings holding this experime
+      #
+      # @param visitor_id [String] Stable identifier for the visitor — typically the Ours visitor id from your brow
+      #
+      # @param context [OursprivacyIngest::Models::ExperimentAssignmentParams::Context, nil] Optional page context for URL + query-param eligibility. Variant bucketing is de
+      #
+      # @param track_impression [Boolean, nil] When true (default), an `$experiment_impression` event is enqueued and the visit
+      #
+      # @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember0, OursprivacyIngest::Models::ExperimentAssignmentResponse::UnionMember1]
+      #
+      # @see OursprivacyIngest::Models::ExperimentAssignmentParams
+      def assignment(experiment_key, params)
+        parsed, options = OursprivacyIngest::ExperimentAssignmentParams.dump_request(params)
+        path =
+          if @client.base_url_overridden?
+            [
+              "experiments/assignments/%1$s",
+              experiment_key
+            ]
+          else
+            [
+              "https://api.oursprivacy.com/api/v1/experiments/assignments/%1$s", experiment_key
+            ]
+          end
+        @client.request(
+          method: :post,
+          path: path,
+          body: parsed,
+          model: OursprivacyIngest::Models::ExperimentAssignmentResponse,
+          options: options
+        )
+      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).
+      #
+      # @overload personalization(token:, visitor_id:, request_options: {})
+      #
+      # @param token [String] The experiment token (`exp_*`).
+      #
+      # @param visitor_id [String]
+      #
+      # @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OursprivacyIngest::Models::ExperimentPersonalizationResponse]
+      #
+      # @see OursprivacyIngest::Models::ExperimentPersonalizationParams
+      def personalization(params)
+        parsed, options = OursprivacyIngest::ExperimentPersonalizationParams.dump_request(params)
+        path =
+          @client.base_url_overridden? ? "experiments/personalization" : "https://api.oursprivacy.com/api/v1/experiments/personalization"
+        @client.request(
+          method: :post,
+          path: path,
+          body: parsed,
+          model: OursprivacyIngest::Models::ExperimentPersonalizationResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [OursprivacyIngest::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/oursprivacy_ingest/version.rb

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

data/lib/oursprivacy_ingest.rb

@@ -54,11 +54,16 @@ require_relative "oursprivacy_ingest/internal/transport/pooled_net_requester"
 require_relative "oursprivacy_ingest/client"
 require_relative "oursprivacy_ingest/models/batch_create_params"
 require_relative "oursprivacy_ingest/models/batch_create_response"
+require_relative "oursprivacy_ingest/models/experiment_assignment_params"
+require_relative "oursprivacy_ingest/models/experiment_assignment_response"
+require_relative "oursprivacy_ingest/models/experiment_personalization_params"
+require_relative "oursprivacy_ingest/models/experiment_personalization_response"
 require_relative "oursprivacy_ingest/models/track_event_params"
 require_relative "oursprivacy_ingest/models/track_event_response"
 require_relative "oursprivacy_ingest/models/visitor_upsert_params"
 require_relative "oursprivacy_ingest/models/visitor_upsert_response"
 require_relative "oursprivacy_ingest/models"
 require_relative "oursprivacy_ingest/resources/batch"
+require_relative "oursprivacy_ingest/resources/experiments"
 require_relative "oursprivacy_ingest/resources/track"
 require_relative "oursprivacy_ingest/resources/visitor"

data/rbi/oursprivacy_ingest/client.rbi

@@ -19,6 +19,9 @@ module OursprivacyIngest
     sig { returns(OursprivacyIngest::Resources::Visitor) }
     attr_reader :visitor
 
+    sig { returns(OursprivacyIngest::Resources::Experiments) }
+    attr_reader :experiments
+
     # @api private
     sig { returns(T::Boolean) }
     def base_url_overridden?