oursprivacy-ingest 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e29d953b7f51d8c1d0b15f99c03827a17ab5bb671fc8b637d63d598c916fdd02
-  data.tar.gz: 5fefefc85727ce3285123c89a616a504b21d748e545349cf34f51ea93f79ac9d
+  metadata.gz: 338a6db802eed864a04718f0af20545fa170ab041a6fa567289679d123cb65e4
+  data.tar.gz: f483a6cdbd771fa24edb5c96cda88ca1bfc95271f48261e0d3a182e50d5e4cf2
 SHA512:
-  metadata.gz: 94d807d33f1e40b63ecd0b9a030efd975347c217bf77946b688e704253805768afc40dd1856a6a14b22f6c7c89b396671c5808dbc68b5b8d000d3bf6236bd39a
-  data.tar.gz: a99ce17810aedc5983a837495944551c8552ecb377a172f6a50e0659968ebd6011035a9a3d49030c1a1b2cffa9255ab81f1be0f1afd7a3c617b7fd917139ccdf
+  metadata.gz: a1dd070e8a94bffbfa4c9633e70d361ab048185b72480319745fe2959e6d67eccd742a30cff9569faa289874c5df52b11a03fed010c110a7758679f0e253f430
+  data.tar.gz: d32cc73c25c5d3cebac7098bdeb1fc1204ed9684ae3925a917ecb62f448cdefcaf30d426f8dfbfee629ed0eb51a4c50e0de9978f53e9ef623b9edbedc7773edd

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.4.0 (2025-12-11)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** api update ([5500b66](https://github.com/with-ours/ingest-sdk-ruby/commit/5500b667b8f79e0936853aed3d0bbd063fbfbfa8))
+* **api:** api update ([128fa8b](https://github.com/with-ours/ingest-sdk-ruby/commit/128fa8b374d76c26ea54cb9f4235ec60be56571f))
+
+## 0.3.0 (2025-11-21)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** api update ([fa6630a](https://github.com/with-ours/ingest-sdk-ruby/commit/fa6630a4c94741148f9e8e3871d5e1c643f7a59d))
+* **api:** api update ([530c7b7](https://github.com/with-ours/ingest-sdk-ruby/commit/530c7b70a30f02da2c9ce0a7cfb2de9f7501ade4))
+
+
+### Chores
+
+* explicitly require "base64" gem ([df2507c](https://github.com/with-ours/ingest-sdk-ruby/commit/df2507c16311559c20db6f3de9d37919b8c4a3e8))
+
 ## 0.2.0 (2025-11-19)
 
 Full Changelog: [v0.1.1...v0.2.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v0.1.1...v0.2.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", "~> 0.2.0"
+gem "oursprivacy-ingest", "~> 0.4.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/oursprivacy_ingest/models/track_event_params.rb

@@ -47,10 +47,9 @@ module OursprivacyIngest
       # @!attribute event_properties
       #   Any additional event properties you want to pass along.
       #
-      #   @return [Hash{Symbol=>Object, nil}, nil]
+      #   @return [Hash{Symbol=>String, nil}, nil]
       optional :event_properties,
-               OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
-                                                         nil?: true],
+               OursprivacyIngest::Internal::Type::HashOf[String, nil?: true],
                api_name: :eventProperties,
                nil?: true
 
@@ -101,7 +100,7 @@ module OursprivacyIngest
       #
       #   @param email [String, nil] The email address of a user. We will associate this event with the user or creat
       #
-      #   @param event_properties [Hash{Symbol=>Object, nil}, nil] Any additional event properties you want to pass along.
+      #   @param event_properties [Hash{Symbol=>String, nil}, nil] Any additional event properties you want to pass along.
       #
       #   @param external_id [String, nil] The externalId (the ID in your system) of a user. We will associate this event w
       #
@@ -133,6 +132,12 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :adset_id, String, nil?: true
 
+        # @!attribute basis_cid
+        #   The Basis DSP Click ID. Ex: basis_cid123
+        #
+        #   @return [String, nil]
+        optional :basis_cid, String, nil?: true
+
         # @!attribute browser_language
         #   The language of the browser. Ex: en-US
         #
@@ -293,18 +298,30 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :iframe, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
+        # @!attribute im_ref
+        #   The Impact Click ID reference. Ex: im_ref123
+        #
+        #   @return [String, nil]
+        optional :im_ref, String, nil?: true
+
         # @!attribute ip
         #   The IP address of the user. Ex: 127.0.0.1
         #
         #   @return [String, nil]
         optional :ip, String, nil?: true
 
+        # @!attribute irclickid
+        #   The Impact Click ID. Ex: irclickid123
+        #
+        #   @return [String, nil]
+        optional :irclickid, String, nil?: true
+
         # @!attribute is_bot
         #   Whether we have detected that the user is a bot. This is set automatically by
         #   the Ours server primarily for events tracked through the web SDK.
         #
-        #   @return [Object, nil]
-        optional :is_bot, OursprivacyIngest::Internal::Type::Unknown
+        #   @return [String, nil]
+        optional :is_bot, String, nil?: true
 
         # @!attribute li_fat_id
         #   The LinkedIn Click ID. Ex: li_fat_id123
@@ -378,6 +395,12 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :referrer, String, nil?: true
 
+        # @!attribute referring_domain
+        #   The referring domain of the current page
+        #
+        #   @return [String, nil]
+        optional :referring_domain, String, nil?: true
+
         # @!attribute sacid
         #   The StackAdapt Tracking ID. Ex: sacid123
         #
@@ -505,7 +528,7 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(active_duration: nil, ad_id: nil, adset_id: 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, ip: 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, 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(active_duration: nil, ad_id: nil, adset_id: 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.
@@ -519,6 +542,8 @@ module OursprivacyIngest
         #
         #   @param adset_id [String, nil] The adset id for detected in the session. This is set by the web sdk automatical
         #
+        #   @param basis_cid [String, nil] The Basis DSP Click ID. Ex: basis_cid123
+        #
         #   @param browser_language [String, nil] The language of the browser. Ex: en-US
         #
         #   @param browser_name [String, nil] The name of the browser. Ex: Chrome
@@ -571,9 +596,13 @@ module OursprivacyIngest
         #
         #   @param iframe [Boolean, nil] Whether the user is in an iframe. Ex: true
         #
+        #   @param im_ref [String, nil] The Impact Click ID reference. Ex: im_ref123
+        #
         #   @param ip [String, nil] The IP address of the user. Ex: 127.0.0.1
         #
-        #   @param is_bot [Object] Whether we have detected that the user is a bot. This is set automatically by th
+        #   @param irclickid [String, nil] The Impact Click ID. Ex: irclickid123
+        #
+        #   @param is_bot [String, nil] Whether we have detected that the user is a bot. This is set automatically by th
         #
         #   @param li_fat_id [String, nil] The LinkedIn Click ID. Ex: li_fat_id123
         #
@@ -599,6 +628,8 @@ module OursprivacyIngest
         #
         #   @param referrer [String, nil] The referrer URL of the current page
         #
+        #   @param referring_domain [String, nil] The referring domain of the current page
+        #
         #   @param sacid [String, nil] The StackAdapt Tracking ID. Ex: sacid123
         #
         #   @param sccid [String, nil] The SnapChat Click ID. Ex: sccid123
@@ -653,6 +684,11 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :adset_id, String, nil?: true
 
+        # @!attribute basis_cid
+        #
+        #   @return [String, nil]
+        optional :basis_cid, String, nil?: true
+
         # @!attribute campaign_id
         #
         #   @return [String, nil]
@@ -680,11 +716,8 @@ module OursprivacyIngest
 
         # @!attribute consent
         #
-        #   @return [Hash{Symbol=>Object, nil}, nil]
-        optional :consent,
-                 OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
-                                                           nil?: true],
-                 nil?: true
+        #   @return [Hash{Symbol=>String, nil}, nil]
+        optional :consent, OursprivacyIngest::Internal::Type::HashOf[String, nil?: true], nil?: true
 
         # @!attribute country
         #
@@ -693,11 +726,8 @@ module OursprivacyIngest
 
         # @!attribute custom_properties
         #
-        #   @return [Hash{Symbol=>Object, nil}, nil]
-        optional :custom_properties,
-                 OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
-                                                           nil?: true],
-                 nil?: true
+        #   @return [Hash{Symbol=>String, nil}, nil]
+        optional :custom_properties, OursprivacyIngest::Internal::Type::HashOf[String, nil?: true], nil?: true
 
         # @!attribute date_of_birth
         #
@@ -764,16 +794,26 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :gender, String, nil?: true
 
+        # @!attribute im_ref
+        #
+        #   @return [String, nil]
+        optional :im_ref, String, nil?: true
+
         # @!attribute ip
         #   The IP address of the user
         #
         #   @return [String, nil]
         optional :ip, String, nil?: true
 
+        # @!attribute irclickid
+        #
+        #   @return [String, nil]
+        optional :irclickid, String, nil?: true
+
         # @!attribute is_bot
         #
-        #   @return [Object, nil]
-        optional :is_bot, OursprivacyIngest::Internal::Type::Unknown
+        #   @return [String, nil]
+        optional :is_bot, String, nil?: true
 
         # @!attribute job_title
         #
@@ -802,8 +842,8 @@ module OursprivacyIngest
 
         # @!attribute phone_number
         #
-        #   @return [Object, nil]
-        optional :phone_number, OursprivacyIngest::Internal::Type::Unknown
+        #   @return [String, nil]
+        optional :phone_number, String, nil?: true
 
         # @!attribute qclid
         #
@@ -820,6 +860,11 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :referrer, String, nil?: true
 
+        # @!attribute referring_domain
+        #
+        #   @return [String, nil]
+        optional :referring_domain, String, nil?: true
+
         # @!attribute sacid
         #
         #   @return [String, nil]
@@ -897,10 +942,10 @@ module OursprivacyIngest
 
         # @!attribute zip
         #
-        #   @return [Object, nil]
-        optional :zip, OursprivacyIngest::Internal::Type::Unknown
+        #   @return [String, nil]
+        optional :zip, String, nil?: true
 
-        # @!method initialize(ad_id: nil, adset_id: 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, ip: 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, 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(ad_id: nil, adset_id: 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.
         #
@@ -908,6 +953,8 @@ module OursprivacyIngest
         #
         #   @param adset_id [String, nil]
         #
+        #   @param basis_cid [String, nil]
+        #
         #   @param campaign_id [String, nil]
         #
         #   @param city [String, nil]
@@ -918,11 +965,11 @@ module OursprivacyIngest
         #
         #   @param company_name [String, nil]
         #
-        #   @param consent [Hash{Symbol=>Object, nil}, nil]
+        #   @param consent [Hash{Symbol=>String, nil}, nil]
         #
         #   @param country [String, nil]
         #
-        #   @param custom_properties [Hash{Symbol=>Object, nil}, nil]
+        #   @param custom_properties [Hash{Symbol=>String, nil}, nil]
         #
         #   @param date_of_birth [String, nil]
         #
@@ -950,9 +997,13 @@ module OursprivacyIngest
         #
         #   @param gender [String, nil]
         #
+        #   @param im_ref [String, nil]
+        #
         #   @param ip [String, nil] The IP address of the user
         #
-        #   @param is_bot [Object]
+        #   @param irclickid [String, nil]
+        #
+        #   @param is_bot [String, nil]
         #
         #   @param job_title [String, nil]
         #
@@ -964,7 +1015,7 @@ module OursprivacyIngest
         #
         #   @param ndclid [String, nil]
         #
-        #   @param phone_number [Object]
+        #   @param phone_number [String, nil]
         #
         #   @param qclid [String, nil]
         #
@@ -972,6 +1023,8 @@ module OursprivacyIngest
         #
         #   @param referrer [String, nil]
         #
+        #   @param referring_domain [String, nil]
+        #
         #   @param sacid [String, nil]
         #
         #   @param sccid [String, nil]
@@ -1002,7 +1055,7 @@ module OursprivacyIngest
         #
         #   @param wbraid [String, nil]
         #
-        #   @param zip [Object]
+        #   @param zip [String, nil]
       end
     end
   end

data/lib/oursprivacy_ingest/models/visitor_upsert_params.rb

@@ -86,6 +86,11 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :adset_id, String, nil?: true
 
+        # @!attribute basis_cid
+        #
+        #   @return [String, nil]
+        optional :basis_cid, String, nil?: true
+
         # @!attribute campaign_id
         #
         #   @return [String, nil]
@@ -113,11 +118,8 @@ module OursprivacyIngest
 
         # @!attribute consent
         #
-        #   @return [Hash{Symbol=>Object, nil}, nil]
-        optional :consent,
-                 OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
-                                                           nil?: true],
-                 nil?: true
+        #   @return [Hash{Symbol=>String, nil}, nil]
+        optional :consent, OursprivacyIngest::Internal::Type::HashOf[String, nil?: true], nil?: true
 
         # @!attribute country
         #
@@ -126,11 +128,8 @@ module OursprivacyIngest
 
         # @!attribute custom_properties
         #
-        #   @return [Hash{Symbol=>Object, nil}, nil]
-        optional :custom_properties,
-                 OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
-                                                           nil?: true],
-                 nil?: true
+        #   @return [Hash{Symbol=>String, nil}, nil]
+        optional :custom_properties, OursprivacyIngest::Internal::Type::HashOf[String, nil?: true], nil?: true
 
         # @!attribute date_of_birth
         #
@@ -197,16 +196,26 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :gender, String, nil?: true
 
+        # @!attribute im_ref
+        #
+        #   @return [String, nil]
+        optional :im_ref, String, nil?: true
+
         # @!attribute ip
         #   The IP address of the user
         #
         #   @return [String, nil]
         optional :ip, String, nil?: true
 
+        # @!attribute irclickid
+        #
+        #   @return [String, nil]
+        optional :irclickid, String, nil?: true
+
         # @!attribute is_bot
         #
-        #   @return [Object, nil]
-        optional :is_bot, OursprivacyIngest::Internal::Type::Unknown
+        #   @return [String, nil]
+        optional :is_bot, String, nil?: true
 
         # @!attribute job_title
         #
@@ -235,8 +244,8 @@ module OursprivacyIngest
 
         # @!attribute phone_number
         #
-        #   @return [Object, nil]
-        optional :phone_number, OursprivacyIngest::Internal::Type::Unknown
+        #   @return [String, nil]
+        optional :phone_number, String, nil?: true
 
         # @!attribute qclid
         #
@@ -253,6 +262,11 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :referrer, String, nil?: true
 
+        # @!attribute referring_domain
+        #
+        #   @return [String, nil]
+        optional :referring_domain, String, nil?: true
+
         # @!attribute sacid
         #
         #   @return [String, nil]
@@ -330,10 +344,10 @@ module OursprivacyIngest
 
         # @!attribute zip
         #
-        #   @return [Object, nil]
-        optional :zip, OursprivacyIngest::Internal::Type::Unknown
+        #   @return [String, nil]
+        optional :zip, String, nil?: true
 
-        # @!method initialize(ad_id: nil, adset_id: 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, ip: 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, 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(ad_id: nil, adset_id: 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.
@@ -342,6 +356,8 @@ module OursprivacyIngest
         #
         #   @param adset_id [String, nil]
         #
+        #   @param basis_cid [String, nil]
+        #
         #   @param campaign_id [String, nil]
         #
         #   @param city [String, nil]
@@ -352,11 +368,11 @@ module OursprivacyIngest
         #
         #   @param company_name [String, nil]
         #
-        #   @param consent [Hash{Symbol=>Object, nil}, nil]
+        #   @param consent [Hash{Symbol=>String, nil}, nil]
         #
         #   @param country [String, nil]
         #
-        #   @param custom_properties [Hash{Symbol=>Object, nil}, nil]
+        #   @param custom_properties [Hash{Symbol=>String, nil}, nil]
         #
         #   @param date_of_birth [String, nil]
         #
@@ -384,9 +400,13 @@ module OursprivacyIngest
         #
         #   @param gender [String, nil]
         #
+        #   @param im_ref [String, nil]
+        #
         #   @param ip [String, nil] The IP address of the user
         #
-        #   @param is_bot [Object]
+        #   @param irclickid [String, nil]
+        #
+        #   @param is_bot [String, nil]
         #
         #   @param job_title [String, nil]
         #
@@ -398,7 +418,7 @@ module OursprivacyIngest
         #
         #   @param ndclid [String, nil]
         #
-        #   @param phone_number [Object]
+        #   @param phone_number [String, nil]
         #
         #   @param qclid [String, nil]
         #
@@ -406,6 +426,8 @@ module OursprivacyIngest
         #
         #   @param referrer [String, nil]
         #
+        #   @param referring_domain [String, nil]
+        #
         #   @param sacid [String, nil]
         #
         #   @param sccid [String, nil]
@@ -436,7 +458,7 @@ module OursprivacyIngest
         #
         #   @param wbraid [String, nil]
         #
-        #   @param zip [Object]
+        #   @param zip [String, nil]
       end
 
       class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
@@ -459,6 +481,12 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :adset_id, String, nil?: true
 
+        # @!attribute basis_cid
+        #   The Basis DSP Click ID. Ex: basis_cid123
+        #
+        #   @return [String, nil]
+        optional :basis_cid, String, nil?: true
+
         # @!attribute browser_language
         #   The language of the browser. Ex: en-US
         #
@@ -619,18 +647,30 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :iframe, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
+        # @!attribute im_ref
+        #   The Impact Click ID reference. Ex: im_ref123
+        #
+        #   @return [String, nil]
+        optional :im_ref, String, nil?: true
+
         # @!attribute ip
         #   The IP address of the user. Ex: 127.0.0.1
         #
         #   @return [String, nil]
         optional :ip, String, nil?: true
 
+        # @!attribute irclickid
+        #   The Impact Click ID. Ex: irclickid123
+        #
+        #   @return [String, nil]
+        optional :irclickid, String, nil?: true
+
         # @!attribute is_bot
         #   Whether we have detected that the user is a bot. This is set automatically by
         #   the Ours server primarily for events tracked through the web SDK.
         #
-        #   @return [Object, nil]
-        optional :is_bot, OursprivacyIngest::Internal::Type::Unknown
+        #   @return [String, nil]
+        optional :is_bot, String, nil?: true
 
         # @!attribute li_fat_id
         #   The LinkedIn Click ID. Ex: li_fat_id123
@@ -704,6 +744,12 @@ module OursprivacyIngest
         #   @return [String, nil]
         optional :referrer, String, nil?: true
 
+        # @!attribute referring_domain
+        #   The referring domain of the current page
+        #
+        #   @return [String, nil]
+        optional :referring_domain, String, nil?: true
+
         # @!attribute sacid
         #   The StackAdapt Tracking ID. Ex: sacid123
         #
@@ -831,7 +877,7 @@ module OursprivacyIngest
         #   @return [Boolean, nil]
         optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(active_duration: nil, ad_id: nil, adset_id: 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, ip: 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, 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(active_duration: nil, ad_id: nil, adset_id: 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.
@@ -845,6 +891,8 @@ module OursprivacyIngest
         #
         #   @param adset_id [String, nil] The adset id for detected in the session. This is set by the web sdk automatical
         #
+        #   @param basis_cid [String, nil] The Basis DSP Click ID. Ex: basis_cid123
+        #
         #   @param browser_language [String, nil] The language of the browser. Ex: en-US
         #
         #   @param browser_name [String, nil] The name of the browser. Ex: Chrome
@@ -897,9 +945,13 @@ module OursprivacyIngest
         #
         #   @param iframe [Boolean, nil] Whether the user is in an iframe. Ex: true
         #
+        #   @param im_ref [String, nil] The Impact Click ID reference. Ex: im_ref123
+        #
         #   @param ip [String, nil] The IP address of the user. Ex: 127.0.0.1
         #
-        #   @param is_bot [Object] Whether we have detected that the user is a bot. This is set automatically by th
+        #   @param irclickid [String, nil] The Impact Click ID. Ex: irclickid123
+        #
+        #   @param is_bot [String, nil] Whether we have detected that the user is a bot. This is set automatically by th
         #
         #   @param li_fat_id [String, nil] The LinkedIn Click ID. Ex: li_fat_id123
         #
@@ -925,6 +977,8 @@ module OursprivacyIngest
         #
         #   @param referrer [String, nil] The referrer URL of the current page
         #
+        #   @param referring_domain [String, nil] The referring domain of the current page
+        #
         #   @param sacid [String, nil] The StackAdapt Tracking ID. Ex: sacid123
         #
         #   @param sccid [String, nil] The SnapChat Click ID. Ex: sccid123

data/lib/oursprivacy_ingest/resources/track.rb

@@ -23,7 +23,7 @@ module OursprivacyIngest
       #
       # @param email [String, nil] The email address of a user. We will associate this event with the user or creat
       #
-      # @param event_properties [Hash{Symbol=>Object, nil}, nil] Any additional event properties you want to pass along.
+      # @param event_properties [Hash{Symbol=>String, nil}, nil] Any additional event properties you want to pass along.
       #
       # @param external_id [String, nil] The externalId (the ID in your system) of a user. We will associate this event w
       #

data/lib/oursprivacy_ingest/version.rb

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

data/lib/oursprivacy_ingest.rb

@@ -3,6 +3,7 @@
 # Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
+require "base64"
 require "cgi"
 require "date"
 require "erb"

data/manifest.yaml

@@ -1,5 +1,6 @@
 dependencies:
   - English
+  - base64
   - cgi
   - date
   - erb