oursprivacy-ingest 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d23eb81e41813ee04947b2d1a04f410bf7b8198b2d958ae79042ca379162e62c
-  data.tar.gz: e8a0964d9d45ad11a6a2cc5dd44be08af26382036c5c95e6d6790aacd75f4817
+  metadata.gz: 58ab60818e804371f1f03601d65833bc11e8f5ed9698706d889181bb783b687f
+  data.tar.gz: 5857962996b22619663cde42083aa722f98be269735473771343811d30fd9821
 SHA512:
-  metadata.gz: 2e933d84b08922ee6f9885e9fadb991b4d237a97ed77be3b2672d1e6e59564b1f15e5f9a761cb572fddb1af0c4ccc393137f9b51eccfe371dc1fe6b0661ab75c
-  data.tar.gz: c9575d16b3128719b6aac612889144486685e7894835970a813ccd2258090668507e5e8e50d48dcdfb6bd648d421d6d1b8e2da4bcbeb856bcb9a470bc356f482
+  metadata.gz: bde8ec9eb06b0e56ef71dad7e28cb1ba5525806890af099a08006617247ba9e2ae3312fd74a9e4f255e1e1146ea0262f387e142994e5683a4398cd37739236c1
+  data.tar.gz: 61803bff65a065a1c8272195597c00840090a1289744da95fd2657b814b499a920c0b158efd2df860f6de795ad25a7e534c5883606fbf92727b8848e64e2e922

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.7.0 (2026-05-08)
+
+Full Changelog: [v1.6.0...v1.7.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.6.0...v1.7.0)
+
+### Features
+
+* **api:** api update ([356be54](https://github.com/with-ours/ingest-sdk-ruby/commit/356be5482b0ac292331685dba21a31e91a0f9d02))
+
 ## 1.6.0 (2026-05-07)
 
 Full Changelog: [v1.5.0...v1.6.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.5.0...v1.6.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.6.0"
+gem "oursprivacy-ingest", "~> 1.7.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/oursprivacy_ingest/models/batch_create_params.rb

@@ -144,6 +144,13 @@ module OursprivacyIngest
 
         # @see OursprivacyIngest::Models::BatchCreateParams::Event#default_properties
         class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
+          # @!attribute _ef_transaction_id
+          #   The Everflow affiliate Click (Transaction) ID, captured from the
+          #   `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
+          #
+          #   @return [String, nil]
+          optional :_ef_transaction_id, String, nil?: true
+
           # @!attribute active_duration
           #   The active time in milliseconds that the user had this tab active
           #
@@ -583,7 +590,7 @@ module OursprivacyIngest
           #   @return [Boolean, nil]
           optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
-          # @!method initialize(active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, wbraid: nil, webview: nil)
+          # @!method initialize(_ef_transaction_id: nil, active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, wbraid: nil, webview: nil)
           #   Some parameter documentations has been truncated, see
           #   {OursprivacyIngest::Models::BatchCreateParams::Event::DefaultProperties} for
           #   more details.
@@ -591,6 +598,9 @@ module OursprivacyIngest
           #   These properties are used throughout the Ours app to pass known values onto
           #   destinations
           #
+          #   @param _ef_transaction_id [String, nil] The Everflow affiliate Click (Transaction) ID, captured from the
+          #   `\_ef_transactio
+          #
           #   @param active_duration [Float, nil] The active time in milliseconds that the user had this tab active
           #
           #   @param ad_id [String, nil] The ad id for detected in the session. This is set by the web sdk automatically.
@@ -762,6 +772,11 @@ module OursprivacyIngest
 
         # @see OursprivacyIngest::Models::BatchCreateParams::Event#user_properties
         class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
+          # @!attribute _ef_transaction_id
+          #
+          #   @return [String, nil]
+          optional :_ef_transaction_id, String, nil?: true
+
           # @!attribute ad_id
           #
           #   @return [String, nil]
@@ -1055,10 +1070,12 @@ module OursprivacyIngest
           #   @return [String, nil]
           optional :zip, String, nil?: true
 
-          # @!method initialize(ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, wbraid: nil, zip: nil)
+          # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, wbraid: nil, zip: nil)
           #   Properties to set on the visitor. (optional) You can also update these
           #   properties via the identify endpoint.
           #
+          #   @param _ef_transaction_id [String, nil]
+          #
           #   @param ad_id [String, nil]
           #
           #   @param admitad_uid [String, nil]

data/lib/oursprivacy_ingest/models/track_event_params.rb

@@ -132,6 +132,13 @@ module OursprivacyIngest
       #   @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}]
 
       class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute _ef_transaction_id
+        #   The Everflow affiliate Click (Transaction) ID, captured from the
+        #   `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
+        #
+        #   @return [String, nil]
+        optional :_ef_transaction_id, String, nil?: true
+
         # @!attribute active_duration
         #   The active time in milliseconds that the user had this tab active
         #
@@ -571,7 +578,7 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, wbraid: nil, webview: nil)
+        # @!method initialize(_ef_transaction_id: nil, active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, wbraid: nil, webview: nil)
         #   Some parameter documentations has been truncated, see
         #   {OursprivacyIngest::Models::TrackEventParams::DefaultProperties} for more
         #   details.
@@ -579,6 +586,9 @@ module OursprivacyIngest
         #   These properties are used throughout the Ours app to pass known values onto
         #   destinations
         #
+        #   @param _ef_transaction_id [String, nil] The Everflow affiliate Click (Transaction) ID, captured from the
+        #   `\_ef_transactio
+        #
         #   @param active_duration [Float, nil] The active time in milliseconds that the user had this tab active
         #
         #   @param ad_id [String, nil] The ad id for detected in the session. This is set by the web sdk automatically.
@@ -748,6 +758,11 @@ module OursprivacyIngest
       end
 
       class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute _ef_transaction_id
+        #
+        #   @return [String, nil]
+        optional :_ef_transaction_id, String, nil?: true
+
         # @!attribute ad_id
         #
         #   @return [String, nil]
@@ -1039,10 +1054,12 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :zip, String, nil?: true
 
-        # @!method initialize(ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, wbraid: nil, zip: nil)
+        # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, wbraid: nil, zip: nil)
         #   Properties to set on the visitor. (optional) You can also update these
         #   properties via the identify endpoint.
         #
+        #   @param _ef_transaction_id [String, nil]
+        #
         #   @param ad_id [String, nil]
         #
         #   @param admitad_uid [String, nil]

data/lib/oursprivacy_ingest/models/visitor_upsert_params.rb

@@ -92,6 +92,11 @@ module OursprivacyIngest
       #   @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}]
 
       class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute _ef_transaction_id
+        #
+        #   @return [String, nil]
+        optional :_ef_transaction_id, String, nil?: true
+
         # @!attribute ad_id
         #
         #   @return [String, nil]
@@ -383,11 +388,13 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :zip, String, nil?: true
 
-        # @!method initialize(ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, wbraid: nil, zip: nil)
+        # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, campaign_id: nil, city: nil, clickid: nil, clid: nil, company_name: nil, consent: nil, country: nil, custom_properties: nil, date_of_birth: nil, dclid: nil, email: nil, epik: nil, external_id: nil, fbc: nil, fbclid: nil, fbp: nil, first_name: nil, gad_source: nil, gbraid: nil, gclid: nil, gender: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, job_title: nil, last_name: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, twclid: nil, user_agent: nil, user_agent_full_list: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, wbraid: nil, zip: nil)
         #   User properties to associate with this user. The existing user properties will
         #   be updated. And all future events will have these properties associated with
         #   them.
         #
+        #   @param _ef_transaction_id [String, nil]
+        #
         #   @param ad_id [String, nil]
         #
         #   @param admitad_uid [String, nil]
@@ -506,6 +513,13 @@ module OursprivacyIngest
       end
 
       class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
+        # @!attribute _ef_transaction_id
+        #   The Everflow affiliate Click (Transaction) ID, captured from the
+        #   `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
+        #
+        #   @return [String, nil]
+        optional :_ef_transaction_id, String, nil?: true
+
         # @!attribute active_duration
         #   The active time in milliseconds that the user had this tab active
         #
@@ -945,7 +959,7 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, wbraid: nil, webview: nil)
+        # @!method initialize(_ef_transaction_id: nil, active_duration: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, browser_language: nil, browser_name: nil, browser_version: nil, campaign_id: nil, clickid: nil, clid: nil, cpu_architecture: nil, current_url: nil, dclid: nil, device_model: nil, device_type: nil, device_vendor: nil, duration: nil, encoding: nil, engine_name: nil, engine_version: nil, epik: nil, fbc: nil, fbclid: nil, fbp: nil, fv: nil, gad_source: nil, gbraid: nil, gclid: nil, host: nil, iframe: nil, im_ref: nil, ip: nil, irclickid: nil, is_bot: nil, li_fat_id: nil, msclkid: nil, ndclid: nil, new_s: nil, os_name: nil, os_version: nil, page_hash: nil, pathname: nil, qclid: nil, rdt_cid: nil, received_at: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, screen_height: nil, screen_width: nil, session_count: nil, sid: nil, sr: nil, title: nil, ttclid: nil, twclid: nil, uafvl: nil, user_agent: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_name: nil, utm_source: nil, utm_term: nil, version: nil, wbraid: nil, webview: nil)
         #   Some parameter documentations has been truncated, see
         #   {OursprivacyIngest::Models::VisitorUpsertParams::DefaultProperties} for more
         #   details.
@@ -953,6 +967,9 @@ module OursprivacyIngest
         #   These properties are used throughout the Ours app to pass known values onto
         #   destinations
         #
+        #   @param _ef_transaction_id [String, nil] The Everflow affiliate Click (Transaction) ID, captured from the
+        #   `\_ef_transactio
+        #
         #   @param active_duration [Float, nil] The active time in milliseconds that the user had this tab active
         #
         #   @param ad_id [String, nil] The ad id for detected in the session. This is set by the web sdk automatically.

data/lib/oursprivacy_ingest/version.rb

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

data/rbi/oursprivacy_ingest/models/batch_create_params.rbi

@@ -267,6 +267,11 @@ module OursprivacyIngest
               )
             end
 
+          # The Everflow affiliate Click (Transaction) ID, captured from the
+          # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
+          sig { returns(T.nilable(String)) }
+          attr_accessor :_ef_transaction_id
+
           # The active time in milliseconds that the user had this tab active
           sig { returns(T.nilable(Float)) }
           attr_accessor :active_duration
@@ -566,6 +571,7 @@ module OursprivacyIngest
           # destinations
           sig do
             params(
+              _ef_transaction_id: T.nilable(String),
               active_duration: T.nilable(Float),
               ad_id: T.nilable(String),
               admitad_uid: T.nilable(String),
@@ -641,6 +647,9 @@ module OursprivacyIngest
             ).returns(T.attached_class)
           end
           def self.new(
+            # The Everflow affiliate Click (Transaction) ID, captured from the
+            # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
+            _ef_transaction_id: nil,
             # The active time in milliseconds that the user had this tab active
             active_duration: nil,
             # The ad id for detected in the session. This is set by the web sdk automatically.
@@ -798,6 +807,7 @@ module OursprivacyIngest
           sig do
             override.returns(
               {
+                _ef_transaction_id: T.nilable(String),
                 active_duration: T.nilable(Float),
                 ad_id: T.nilable(String),
                 admitad_uid: T.nilable(String),
@@ -922,6 +932,9 @@ module OursprivacyIngest
               )
             end
 
+          sig { returns(T.nilable(String)) }
+          attr_accessor :_ef_transaction_id
+
           sig { returns(T.nilable(String)) }
           attr_accessor :ad_id
 
@@ -1101,6 +1114,7 @@ module OursprivacyIngest
           # properties via the identify endpoint.
           sig do
             params(
+              _ef_transaction_id: T.nilable(String),
               ad_id: T.nilable(String),
               admitad_uid: T.nilable(String),
               adset_id: T.nilable(String),
@@ -1162,6 +1176,7 @@ module OursprivacyIngest
             ).returns(T.attached_class)
           end
           def self.new(
+            _ef_transaction_id: nil,
             ad_id: nil,
             admitad_uid: nil,
             adset_id: nil,
@@ -1227,6 +1242,7 @@ module OursprivacyIngest
           sig do
             override.returns(
               {
+                _ef_transaction_id: T.nilable(String),
                 ad_id: T.nilable(String),
                 admitad_uid: T.nilable(String),
                 adset_id: T.nilable(String),

data/rbi/oursprivacy_ingest/models/track_event_params.rbi

@@ -217,6 +217,11 @@ module OursprivacyIngest
             )
           end
 
+        # The Everflow affiliate Click (Transaction) ID, captured from the
+        # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
+        sig { returns(T.nilable(String)) }
+        attr_accessor :_ef_transaction_id
+
         # The active time in milliseconds that the user had this tab active
         sig { returns(T.nilable(Float)) }
         attr_accessor :active_duration
@@ -516,6 +521,7 @@ module OursprivacyIngest
         # destinations
         sig do
           params(
+            _ef_transaction_id: T.nilable(String),
             active_duration: T.nilable(Float),
             ad_id: T.nilable(String),
             admitad_uid: T.nilable(String),
@@ -591,6 +597,9 @@ module OursprivacyIngest
           ).returns(T.attached_class)
         end
         def self.new(
+          # The Everflow affiliate Click (Transaction) ID, captured from the
+          # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
+          _ef_transaction_id: nil,
           # The active time in milliseconds that the user had this tab active
           active_duration: nil,
           # The ad id for detected in the session. This is set by the web sdk automatically.
@@ -748,6 +757,7 @@ module OursprivacyIngest
         sig do
           override.returns(
             {
+              _ef_transaction_id: T.nilable(String),
               active_duration: T.nilable(Float),
               ad_id: T.nilable(String),
               admitad_uid: T.nilable(String),
@@ -870,6 +880,9 @@ module OursprivacyIngest
             )
           end
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :_ef_transaction_id
+
         sig { returns(T.nilable(String)) }
         attr_accessor :ad_id
 
@@ -1049,6 +1062,7 @@ module OursprivacyIngest
         # properties via the identify endpoint.
         sig do
           params(
+            _ef_transaction_id: T.nilable(String),
             ad_id: T.nilable(String),
             admitad_uid: T.nilable(String),
             adset_id: T.nilable(String),
@@ -1110,6 +1124,7 @@ module OursprivacyIngest
           ).returns(T.attached_class)
         end
         def self.new(
+          _ef_transaction_id: nil,
           ad_id: nil,
           admitad_uid: nil,
           adset_id: nil,
@@ -1175,6 +1190,7 @@ module OursprivacyIngest
         sig do
           override.returns(
             {
+              _ef_transaction_id: T.nilable(String),
               ad_id: T.nilable(String),
               admitad_uid: T.nilable(String),
               adset_id: T.nilable(String),

data/rbi/oursprivacy_ingest/models/visitor_upsert_params.rbi

@@ -177,6 +177,9 @@ module OursprivacyIngest
             )
           end
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :_ef_transaction_id
+
         sig { returns(T.nilable(String)) }
         attr_accessor :ad_id
 
@@ -357,6 +360,7 @@ module OursprivacyIngest
         # them.
         sig do
           params(
+            _ef_transaction_id: T.nilable(String),
             ad_id: T.nilable(String),
             admitad_uid: T.nilable(String),
             adset_id: T.nilable(String),
@@ -418,6 +422,7 @@ module OursprivacyIngest
           ).returns(T.attached_class)
         end
         def self.new(
+          _ef_transaction_id: nil,
           ad_id: nil,
           admitad_uid: nil,
           adset_id: nil,
@@ -483,6 +488,7 @@ module OursprivacyIngest
         sig do
           override.returns(
             {
+              _ef_transaction_id: T.nilable(String),
               ad_id: T.nilable(String),
               admitad_uid: T.nilable(String),
               adset_id: T.nilable(String),
@@ -557,6 +563,11 @@ module OursprivacyIngest
             )
           end
 
+        # The Everflow affiliate Click (Transaction) ID, captured from the
+        # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
+        sig { returns(T.nilable(String)) }
+        attr_accessor :_ef_transaction_id
+
         # The active time in milliseconds that the user had this tab active
         sig { returns(T.nilable(Float)) }
         attr_accessor :active_duration
@@ -856,6 +867,7 @@ module OursprivacyIngest
         # destinations
         sig do
           params(
+            _ef_transaction_id: T.nilable(String),
             active_duration: T.nilable(Float),
             ad_id: T.nilable(String),
             admitad_uid: T.nilable(String),
@@ -931,6 +943,9 @@ module OursprivacyIngest
           ).returns(T.attached_class)
         end
         def self.new(
+          # The Everflow affiliate Click (Transaction) ID, captured from the
+          # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
+          _ef_transaction_id: nil,
           # The active time in milliseconds that the user had this tab active
           active_duration: nil,
           # The ad id for detected in the session. This is set by the web sdk automatically.
@@ -1088,6 +1103,7 @@ module OursprivacyIngest
         sig do
           override.returns(
             {
+              _ef_transaction_id: T.nilable(String),
               active_duration: T.nilable(Float),
               ad_id: T.nilable(String),
               admitad_uid: T.nilable(String),

data/sig/oursprivacy_ingest/models/batch_create_params.rbs

@@ -90,6 +90,7 @@ module OursprivacyIngest
 
         type default_properties =
           {
+            _ef_transaction_id: String?,
             active_duration: Float?,
             ad_id: String?,
             admitad_uid: String?,
@@ -165,6 +166,8 @@ module OursprivacyIngest
           }
 
         class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
+          attr_accessor _ef_transaction_id: String?
+
           attr_accessor active_duration: Float?
 
           attr_accessor ad_id: String?
@@ -310,6 +313,7 @@ module OursprivacyIngest
           attr_accessor webview: bool?
 
           def initialize: (
+            ?_ef_transaction_id: String?,
             ?active_duration: Float?,
             ?ad_id: String?,
             ?admitad_uid: String?,
@@ -385,6 +389,7 @@ module OursprivacyIngest
           ) -> void
 
           def to_hash: -> {
+            _ef_transaction_id: String?,
             active_duration: Float?,
             ad_id: String?,
             admitad_uid: String?,
@@ -474,6 +479,7 @@ module OursprivacyIngest
 
         type user_properties =
           {
+            _ef_transaction_id: String?,
             ad_id: String?,
             admitad_uid: String?,
             adset_id: String?,
@@ -535,6 +541,8 @@ module OursprivacyIngest
           }
 
         class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
+          attr_accessor _ef_transaction_id: String?
+
           attr_accessor ad_id: String?
 
           attr_accessor admitad_uid: String?
@@ -652,6 +660,7 @@ module OursprivacyIngest
           attr_accessor zip: String?
 
           def initialize: (
+            ?_ef_transaction_id: String?,
             ?ad_id: String?,
             ?admitad_uid: String?,
             ?adset_id: String?,
@@ -713,6 +722,7 @@ module OursprivacyIngest
           ) -> void
 
           def to_hash: -> {
+            _ef_transaction_id: String?,
             ad_id: String?,
             admitad_uid: String?,
             adset_id: String?,

data/sig/oursprivacy_ingest/models/track_event_params.rbs

@@ -74,6 +74,7 @@ module OursprivacyIngest
 
       type default_properties =
         {
+          _ef_transaction_id: String?,
           active_duration: Float?,
           ad_id: String?,
           admitad_uid: String?,
@@ -149,6 +150,8 @@ module OursprivacyIngest
         }
 
       class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
+        attr_accessor _ef_transaction_id: String?
+
         attr_accessor active_duration: Float?
 
         attr_accessor ad_id: String?
@@ -294,6 +297,7 @@ module OursprivacyIngest
         attr_accessor webview: bool?
 
         def initialize: (
+          ?_ef_transaction_id: String?,
           ?active_duration: Float?,
           ?ad_id: String?,
           ?admitad_uid: String?,
@@ -369,6 +373,7 @@ module OursprivacyIngest
         ) -> void
 
         def to_hash: -> {
+          _ef_transaction_id: String?,
           active_duration: Float?,
           ad_id: String?,
           admitad_uid: String?,
@@ -458,6 +463,7 @@ module OursprivacyIngest
 
       type user_properties =
         {
+          _ef_transaction_id: String?,
           ad_id: String?,
           admitad_uid: String?,
           adset_id: String?,
@@ -519,6 +525,8 @@ module OursprivacyIngest
         }
 
       class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
+        attr_accessor _ef_transaction_id: String?
+
         attr_accessor ad_id: String?
 
         attr_accessor admitad_uid: String?
@@ -636,6 +644,7 @@ module OursprivacyIngest
         attr_accessor zip: String?
 
         def initialize: (
+          ?_ef_transaction_id: String?,
           ?ad_id: String?,
           ?admitad_uid: String?,
           ?adset_id: String?,
@@ -697,6 +706,7 @@ module OursprivacyIngest
         ) -> void
 
         def to_hash: -> {
+          _ef_transaction_id: String?,
           ad_id: String?,
           admitad_uid: String?,
           adset_id: String?,

data/sig/oursprivacy_ingest/models/visitor_upsert_params.rbs

@@ -54,6 +54,7 @@ module OursprivacyIngest
 
       type user_properties =
         {
+          _ef_transaction_id: String?,
           ad_id: String?,
           admitad_uid: String?,
           adset_id: String?,
@@ -115,6 +116,8 @@ module OursprivacyIngest
         }
 
       class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
+        attr_accessor _ef_transaction_id: String?
+
         attr_accessor ad_id: String?
 
         attr_accessor admitad_uid: String?
@@ -232,6 +235,7 @@ module OursprivacyIngest
         attr_accessor zip: String?
 
         def initialize: (
+          ?_ef_transaction_id: String?,
           ?ad_id: String?,
           ?admitad_uid: String?,
           ?adset_id: String?,
@@ -293,6 +297,7 @@ module OursprivacyIngest
         ) -> void
 
         def to_hash: -> {
+          _ef_transaction_id: String?,
           ad_id: String?,
           admitad_uid: String?,
           adset_id: String?,
@@ -356,6 +361,7 @@ module OursprivacyIngest
 
       type default_properties =
         {
+          _ef_transaction_id: String?,
           active_duration: Float?,
           ad_id: String?,
           admitad_uid: String?,
@@ -431,6 +437,8 @@ module OursprivacyIngest
         }
 
       class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
+        attr_accessor _ef_transaction_id: String?
+
         attr_accessor active_duration: Float?
 
         attr_accessor ad_id: String?
@@ -576,6 +584,7 @@ module OursprivacyIngest
         attr_accessor webview: bool?
 
         def initialize: (
+          ?_ef_transaction_id: String?,
           ?active_duration: Float?,
           ?ad_id: String?,
           ?admitad_uid: String?,
@@ -651,6 +660,7 @@ module OursprivacyIngest
         ) -> void
 
         def to_hash: -> {
+          _ef_transaction_id: String?,
           active_duration: Float?,
           ad_id: String?,
           admitad_uid: String?,

metadata

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