oursprivacy-ingest 1.6.0 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d23eb81e41813ee04947b2d1a04f410bf7b8198b2d958ae79042ca379162e62c
4
- data.tar.gz: e8a0964d9d45ad11a6a2cc5dd44be08af26382036c5c95e6d6790aacd75f4817
3
+ metadata.gz: 5d06e18330db6cc630140dbf1427a9886afe1e46a7cb9090a40039e79e6fa2c9
4
+ data.tar.gz: 381ee0491d16a154af3ca8e6e68fb28f17ccea558e1212cf9fa25c7ce3f2389d
5
5
  SHA512:
6
- metadata.gz: 2e933d84b08922ee6f9885e9fadb991b4d237a97ed77be3b2672d1e6e59564b1f15e5f9a761cb572fddb1af0c4ccc393137f9b51eccfe371dc1fe6b0661ab75c
7
- data.tar.gz: c9575d16b3128719b6aac612889144486685e7894835970a813ccd2258090668507e5e8e50d48dcdfb6bd648d421d6d1b8e2da4bcbeb856bcb9a470bc356f482
6
+ metadata.gz: 55f2670ce0dfea75fa60b0cdef0c8cdade89204876d7c40fe2009f3b3163a40877a6b3aa2b0567d7dda699835e5cf2a1be89737a1f086b97c229c0d8e9b0c729
7
+ data.tar.gz: 3f9568a76a6db6e36e7b8bd3d33fb1d5cd1d287252d6b26ceed962da726ef39beb5eb5c3608d9a78565b75482a562fc51f14fb96803adeca45682d60f0e04411
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.8.0 (2026-05-14)
4
+
5
+ Full Changelog: [v1.7.0...v1.8.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.7.0...v1.8.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([8e6e1ea](https://github.com/with-ours/ingest-sdk-ruby/commit/8e6e1ea7e97cd504e9c8f8c3ac8570058abf2d66))
10
+
11
+
12
+ ### Bug Fixes
13
+
14
+ * **client:** elide content type header on requests without body ([c2ebcd3](https://github.com/with-ours/ingest-sdk-ruby/commit/c2ebcd3b45059a25d7a961e6621cd5d2b2231ae9))
15
+
16
+ ## 1.7.0 (2026-05-08)
17
+
18
+ Full Changelog: [v1.6.0...v1.7.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.6.0...v1.7.0)
19
+
20
+ ### Features
21
+
22
+ * **api:** api update ([356be54](https://github.com/with-ours/ingest-sdk-ruby/commit/356be5482b0ac292331685dba21a31e91a0f9d02))
23
+
3
24
  ## 1.6.0 (2026-05-07)
4
25
 
5
26
  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 CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "oursprivacy-ingest", "~> 1.6.0"
20
+ gem "oursprivacy-ingest", "~> 1.8.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -300,6 +300,8 @@ module OursprivacyIngest
300
300
  OursprivacyIngest::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
301
301
  end
302
302
 
303
+ headers.delete("content-type") if body.nil?
304
+
303
305
  url = OursprivacyIngest::Internal::Util.join_parsed_uri(
304
306
  @base_url_components,
305
307
  {**req, path: path, query: query}
@@ -144,6 +144,13 @@ module OursprivacyIngest
144
144
 
145
145
  # @see OursprivacyIngest::Models::BatchCreateParams::Event#default_properties
146
146
  class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
147
+ # @!attribute _ef_transaction_id
148
+ # The Everflow affiliate Click (Transaction) ID, captured from the
149
+ # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
150
+ #
151
+ # @return [String, nil]
152
+ optional :_ef_transaction_id, String, nil?: true
153
+
147
154
  # @!attribute active_duration
148
155
  # The active time in milliseconds that the user had this tab active
149
156
  #
@@ -193,6 +200,13 @@ module OursprivacyIngest
193
200
  # @return [String, nil]
194
201
  optional :basis_cid, String, nil?: true
195
202
 
203
+ # @!attribute beeswax_auction_id
204
+ # The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the
205
+ # `{{AUCTION_ID}}` macro on creative click URLs. Ex: bx-auc-abc123
206
+ #
207
+ # @return [String, nil]
208
+ optional :beeswax_auction_id, String, nil?: true
209
+
196
210
  # @!attribute browser_language
197
211
  # The language of the browser. Ex: en-US
198
212
  #
@@ -583,7 +597,7 @@ module OursprivacyIngest
583
597
  # @return [Boolean, nil]
584
598
  optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
585
599
 
586
- # @!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)
600
+ # @!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, beeswax_auction_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, 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)
587
601
  # Some parameter documentations has been truncated, see
588
602
  # {OursprivacyIngest::Models::BatchCreateParams::Event::DefaultProperties} for
589
603
  # more details.
@@ -591,6 +605,9 @@ module OursprivacyIngest
591
605
  # These properties are used throughout the Ours app to pass known values onto
592
606
  # destinations
593
607
  #
608
+ # @param _ef_transaction_id [String, nil] The Everflow affiliate Click (Transaction) ID, captured from the
609
+ # `\_ef_transactio
610
+ #
594
611
  # @param active_duration [Float, nil] The active time in milliseconds that the user had this tab active
595
612
  #
596
613
  # @param ad_id [String, nil] The ad id for detected in the session. This is set by the web sdk automatically.
@@ -607,6 +624,8 @@ module OursprivacyIngest
607
624
  #
608
625
  # @param basis_cid [String, nil] The Basis DSP Click ID. Ex: basis_cid123
609
626
  #
627
+ # @param beeswax_auction_id [String, nil] The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the `{{AUCTION_ID}
628
+ #
610
629
  # @param browser_language [String, nil] The language of the browser. Ex: en-US
611
630
  #
612
631
  # @param browser_name [String, nil] The name of the browser. Ex: Chrome
@@ -762,6 +781,11 @@ module OursprivacyIngest
762
781
 
763
782
  # @see OursprivacyIngest::Models::BatchCreateParams::Event#user_properties
764
783
  class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
784
+ # @!attribute _ef_transaction_id
785
+ #
786
+ # @return [String, nil]
787
+ optional :_ef_transaction_id, String, nil?: true
788
+
765
789
  # @!attribute ad_id
766
790
  #
767
791
  # @return [String, nil]
@@ -797,6 +821,11 @@ module OursprivacyIngest
797
821
  # @return [String, nil]
798
822
  optional :basis_cid, String, nil?: true
799
823
 
824
+ # @!attribute beeswax_auction_id
825
+ #
826
+ # @return [String, nil]
827
+ optional :beeswax_auction_id, String, nil?: true
828
+
800
829
  # @!attribute campaign_id
801
830
  #
802
831
  # @return [String, nil]
@@ -1055,10 +1084,12 @@ module OursprivacyIngest
1055
1084
  # @return [String, nil]
1056
1085
  optional :zip, String, nil?: true
1057
1086
 
1058
- # @!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)
1087
+ # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_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, 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)
1059
1088
  # Properties to set on the visitor. (optional) You can also update these
1060
1089
  # properties via the identify endpoint.
1061
1090
  #
1091
+ # @param _ef_transaction_id [String, nil]
1092
+ #
1062
1093
  # @param ad_id [String, nil]
1063
1094
  #
1064
1095
  # @param admitad_uid [String, nil]
@@ -1073,6 +1104,8 @@ module OursprivacyIngest
1073
1104
  #
1074
1105
  # @param basis_cid [String, nil]
1075
1106
  #
1107
+ # @param beeswax_auction_id [String, nil]
1108
+ #
1076
1109
  # @param campaign_id [String, nil]
1077
1110
  #
1078
1111
  # @param city [String, nil]
@@ -132,6 +132,13 @@ module OursprivacyIngest
132
132
  # @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}]
133
133
 
134
134
  class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
135
+ # @!attribute _ef_transaction_id
136
+ # The Everflow affiliate Click (Transaction) ID, captured from the
137
+ # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
138
+ #
139
+ # @return [String, nil]
140
+ optional :_ef_transaction_id, String, nil?: true
141
+
135
142
  # @!attribute active_duration
136
143
  # The active time in milliseconds that the user had this tab active
137
144
  #
@@ -181,6 +188,13 @@ module OursprivacyIngest
181
188
  # @return [String, nil]
182
189
  optional :basis_cid, String, nil?: true
183
190
 
191
+ # @!attribute beeswax_auction_id
192
+ # The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the
193
+ # `{{AUCTION_ID}}` macro on creative click URLs. Ex: bx-auc-abc123
194
+ #
195
+ # @return [String, nil]
196
+ optional :beeswax_auction_id, String, nil?: true
197
+
184
198
  # @!attribute browser_language
185
199
  # The language of the browser. Ex: en-US
186
200
  #
@@ -571,7 +585,7 @@ module OursprivacyIngest
571
585
  # @return [Boolean, nil]
572
586
  optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
573
587
 
574
- # @!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)
588
+ # @!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, beeswax_auction_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, 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)
575
589
  # Some parameter documentations has been truncated, see
576
590
  # {OursprivacyIngest::Models::TrackEventParams::DefaultProperties} for more
577
591
  # details.
@@ -579,6 +593,9 @@ module OursprivacyIngest
579
593
  # These properties are used throughout the Ours app to pass known values onto
580
594
  # destinations
581
595
  #
596
+ # @param _ef_transaction_id [String, nil] The Everflow affiliate Click (Transaction) ID, captured from the
597
+ # `\_ef_transactio
598
+ #
582
599
  # @param active_duration [Float, nil] The active time in milliseconds that the user had this tab active
583
600
  #
584
601
  # @param ad_id [String, nil] The ad id for detected in the session. This is set by the web sdk automatically.
@@ -595,6 +612,8 @@ module OursprivacyIngest
595
612
  #
596
613
  # @param basis_cid [String, nil] The Basis DSP Click ID. Ex: basis_cid123
597
614
  #
615
+ # @param beeswax_auction_id [String, nil] The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the `{{AUCTION_ID}
616
+ #
598
617
  # @param browser_language [String, nil] The language of the browser. Ex: en-US
599
618
  #
600
619
  # @param browser_name [String, nil] The name of the browser. Ex: Chrome
@@ -748,6 +767,11 @@ module OursprivacyIngest
748
767
  end
749
768
 
750
769
  class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
770
+ # @!attribute _ef_transaction_id
771
+ #
772
+ # @return [String, nil]
773
+ optional :_ef_transaction_id, String, nil?: true
774
+
751
775
  # @!attribute ad_id
752
776
  #
753
777
  # @return [String, nil]
@@ -783,6 +807,11 @@ module OursprivacyIngest
783
807
  # @return [String, nil]
784
808
  optional :basis_cid, String, nil?: true
785
809
 
810
+ # @!attribute beeswax_auction_id
811
+ #
812
+ # @return [String, nil]
813
+ optional :beeswax_auction_id, String, nil?: true
814
+
786
815
  # @!attribute campaign_id
787
816
  #
788
817
  # @return [String, nil]
@@ -1039,10 +1068,12 @@ module OursprivacyIngest
1039
1068
  # @return [String, nil]
1040
1069
  optional :zip, String, nil?: true
1041
1070
 
1042
- # @!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)
1071
+ # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_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, 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)
1043
1072
  # Properties to set on the visitor. (optional) You can also update these
1044
1073
  # properties via the identify endpoint.
1045
1074
  #
1075
+ # @param _ef_transaction_id [String, nil]
1076
+ #
1046
1077
  # @param ad_id [String, nil]
1047
1078
  #
1048
1079
  # @param admitad_uid [String, nil]
@@ -1057,6 +1088,8 @@ module OursprivacyIngest
1057
1088
  #
1058
1089
  # @param basis_cid [String, nil]
1059
1090
  #
1091
+ # @param beeswax_auction_id [String, nil]
1092
+ #
1060
1093
  # @param campaign_id [String, nil]
1061
1094
  #
1062
1095
  # @param city [String, nil]
@@ -92,6 +92,11 @@ module OursprivacyIngest
92
92
  # @param request_options [OursprivacyIngest::RequestOptions, Hash{Symbol=>Object}]
93
93
 
94
94
  class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
95
+ # @!attribute _ef_transaction_id
96
+ #
97
+ # @return [String, nil]
98
+ optional :_ef_transaction_id, String, nil?: true
99
+
95
100
  # @!attribute ad_id
96
101
  #
97
102
  # @return [String, nil]
@@ -127,6 +132,11 @@ module OursprivacyIngest
127
132
  # @return [String, nil]
128
133
  optional :basis_cid, String, nil?: true
129
134
 
135
+ # @!attribute beeswax_auction_id
136
+ #
137
+ # @return [String, nil]
138
+ optional :beeswax_auction_id, String, nil?: true
139
+
130
140
  # @!attribute campaign_id
131
141
  #
132
142
  # @return [String, nil]
@@ -383,11 +393,13 @@ module OursprivacyIngest
383
393
  # @return [String, nil]
384
394
  optional :zip, String, nil?: true
385
395
 
386
- # @!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)
396
+ # @!method initialize(_ef_transaction_id: nil, ad_id: nil, admitad_uid: nil, adset_id: nil, alart: nil, aleid: nil, axwrt: nil, basis_cid: nil, beeswax_auction_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, 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)
387
397
  # User properties to associate with this user. The existing user properties will
388
398
  # be updated. And all future events will have these properties associated with
389
399
  # them.
390
400
  #
401
+ # @param _ef_transaction_id [String, nil]
402
+ #
391
403
  # @param ad_id [String, nil]
392
404
  #
393
405
  # @param admitad_uid [String, nil]
@@ -402,6 +414,8 @@ module OursprivacyIngest
402
414
  #
403
415
  # @param basis_cid [String, nil]
404
416
  #
417
+ # @param beeswax_auction_id [String, nil]
418
+ #
405
419
  # @param campaign_id [String, nil]
406
420
  #
407
421
  # @param city [String, nil]
@@ -506,6 +520,13 @@ module OursprivacyIngest
506
520
  end
507
521
 
508
522
  class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
523
+ # @!attribute _ef_transaction_id
524
+ # The Everflow affiliate Click (Transaction) ID, captured from the
525
+ # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
526
+ #
527
+ # @return [String, nil]
528
+ optional :_ef_transaction_id, String, nil?: true
529
+
509
530
  # @!attribute active_duration
510
531
  # The active time in milliseconds that the user had this tab active
511
532
  #
@@ -555,6 +576,13 @@ module OursprivacyIngest
555
576
  # @return [String, nil]
556
577
  optional :basis_cid, String, nil?: true
557
578
 
579
+ # @!attribute beeswax_auction_id
580
+ # The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the
581
+ # `{{AUCTION_ID}}` macro on creative click URLs. Ex: bx-auc-abc123
582
+ #
583
+ # @return [String, nil]
584
+ optional :beeswax_auction_id, String, nil?: true
585
+
558
586
  # @!attribute browser_language
559
587
  # The language of the browser. Ex: en-US
560
588
  #
@@ -945,7 +973,7 @@ module OursprivacyIngest
945
973
  # @return [Boolean, nil]
946
974
  optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
947
975
 
948
- # @!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)
976
+ # @!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, beeswax_auction_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, 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)
949
977
  # Some parameter documentations has been truncated, see
950
978
  # {OursprivacyIngest::Models::VisitorUpsertParams::DefaultProperties} for more
951
979
  # details.
@@ -953,6 +981,9 @@ module OursprivacyIngest
953
981
  # These properties are used throughout the Ours app to pass known values onto
954
982
  # destinations
955
983
  #
984
+ # @param _ef_transaction_id [String, nil] The Everflow affiliate Click (Transaction) ID, captured from the
985
+ # `\_ef_transactio
986
+ #
956
987
  # @param active_duration [Float, nil] The active time in milliseconds that the user had this tab active
957
988
  #
958
989
  # @param ad_id [String, nil] The ad id for detected in the session. This is set by the web sdk automatically.
@@ -969,6 +1000,8 @@ module OursprivacyIngest
969
1000
  #
970
1001
  # @param basis_cid [String, nil] The Basis DSP Click ID. Ex: basis_cid123
971
1002
  #
1003
+ # @param beeswax_auction_id [String, nil] The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the `{{AUCTION_ID}
1004
+ #
972
1005
  # @param browser_language [String, nil] The language of the browser. Ex: en-US
973
1006
  #
974
1007
  # @param browser_name [String, nil] The name of the browser. Ex: Chrome
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module OursprivacyIngest
4
- VERSION = "1.6.0"
4
+ VERSION = "1.8.0"
5
5
  end
@@ -267,6 +267,11 @@ module OursprivacyIngest
267
267
  )
268
268
  end
269
269
 
270
+ # The Everflow affiliate Click (Transaction) ID, captured from the
271
+ # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
272
+ sig { returns(T.nilable(String)) }
273
+ attr_accessor :_ef_transaction_id
274
+
270
275
  # The active time in milliseconds that the user had this tab active
271
276
  sig { returns(T.nilable(Float)) }
272
277
  attr_accessor :active_duration
@@ -300,6 +305,11 @@ module OursprivacyIngest
300
305
  sig { returns(T.nilable(String)) }
301
306
  attr_accessor :basis_cid
302
307
 
308
+ # The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the
309
+ # `{{AUCTION_ID}}` macro on creative click URLs. Ex: bx-auc-abc123
310
+ sig { returns(T.nilable(String)) }
311
+ attr_accessor :beeswax_auction_id
312
+
303
313
  # The language of the browser. Ex: en-US
304
314
  sig { returns(T.nilable(String)) }
305
315
  attr_accessor :browser_language
@@ -566,6 +576,7 @@ module OursprivacyIngest
566
576
  # destinations
567
577
  sig do
568
578
  params(
579
+ _ef_transaction_id: T.nilable(String),
569
580
  active_duration: T.nilable(Float),
570
581
  ad_id: T.nilable(String),
571
582
  admitad_uid: T.nilable(String),
@@ -574,6 +585,7 @@ module OursprivacyIngest
574
585
  aleid: T.nilable(String),
575
586
  axwrt: T.nilable(String),
576
587
  basis_cid: T.nilable(String),
588
+ beeswax_auction_id: T.nilable(String),
577
589
  browser_language: T.nilable(String),
578
590
  browser_name: T.nilable(String),
579
591
  browser_version: T.nilable(String),
@@ -641,6 +653,9 @@ module OursprivacyIngest
641
653
  ).returns(T.attached_class)
642
654
  end
643
655
  def self.new(
656
+ # The Everflow affiliate Click (Transaction) ID, captured from the
657
+ # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
658
+ _ef_transaction_id: nil,
644
659
  # The active time in milliseconds that the user had this tab active
645
660
  active_duration: nil,
646
661
  # The ad id for detected in the session. This is set by the web sdk automatically.
@@ -658,6 +673,9 @@ module OursprivacyIngest
658
673
  axwrt: nil,
659
674
  # The Basis DSP Click ID. Ex: basis_cid123
660
675
  basis_cid: nil,
676
+ # The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the
677
+ # `{{AUCTION_ID}}` macro on creative click URLs. Ex: bx-auc-abc123
678
+ beeswax_auction_id: nil,
661
679
  # The language of the browser. Ex: en-US
662
680
  browser_language: nil,
663
681
  # The name of the browser. Ex: Chrome
@@ -798,6 +816,7 @@ module OursprivacyIngest
798
816
  sig do
799
817
  override.returns(
800
818
  {
819
+ _ef_transaction_id: T.nilable(String),
801
820
  active_duration: T.nilable(Float),
802
821
  ad_id: T.nilable(String),
803
822
  admitad_uid: T.nilable(String),
@@ -806,6 +825,7 @@ module OursprivacyIngest
806
825
  aleid: T.nilable(String),
807
826
  axwrt: T.nilable(String),
808
827
  basis_cid: T.nilable(String),
828
+ beeswax_auction_id: T.nilable(String),
809
829
  browser_language: T.nilable(String),
810
830
  browser_name: T.nilable(String),
811
831
  browser_version: T.nilable(String),
@@ -922,6 +942,9 @@ module OursprivacyIngest
922
942
  )
923
943
  end
924
944
 
945
+ sig { returns(T.nilable(String)) }
946
+ attr_accessor :_ef_transaction_id
947
+
925
948
  sig { returns(T.nilable(String)) }
926
949
  attr_accessor :ad_id
927
950
 
@@ -943,6 +966,9 @@ module OursprivacyIngest
943
966
  sig { returns(T.nilable(String)) }
944
967
  attr_accessor :basis_cid
945
968
 
969
+ sig { returns(T.nilable(String)) }
970
+ attr_accessor :beeswax_auction_id
971
+
946
972
  sig { returns(T.nilable(String)) }
947
973
  attr_accessor :campaign_id
948
974
 
@@ -1101,6 +1127,7 @@ module OursprivacyIngest
1101
1127
  # properties via the identify endpoint.
1102
1128
  sig do
1103
1129
  params(
1130
+ _ef_transaction_id: T.nilable(String),
1104
1131
  ad_id: T.nilable(String),
1105
1132
  admitad_uid: T.nilable(String),
1106
1133
  adset_id: T.nilable(String),
@@ -1108,6 +1135,7 @@ module OursprivacyIngest
1108
1135
  aleid: T.nilable(String),
1109
1136
  axwrt: T.nilable(String),
1110
1137
  basis_cid: T.nilable(String),
1138
+ beeswax_auction_id: T.nilable(String),
1111
1139
  campaign_id: T.nilable(String),
1112
1140
  city: T.nilable(String),
1113
1141
  clickid: T.nilable(String),
@@ -1162,6 +1190,7 @@ module OursprivacyIngest
1162
1190
  ).returns(T.attached_class)
1163
1191
  end
1164
1192
  def self.new(
1193
+ _ef_transaction_id: nil,
1165
1194
  ad_id: nil,
1166
1195
  admitad_uid: nil,
1167
1196
  adset_id: nil,
@@ -1169,6 +1198,7 @@ module OursprivacyIngest
1169
1198
  aleid: nil,
1170
1199
  axwrt: nil,
1171
1200
  basis_cid: nil,
1201
+ beeswax_auction_id: nil,
1172
1202
  campaign_id: nil,
1173
1203
  city: nil,
1174
1204
  clickid: nil,
@@ -1227,6 +1257,7 @@ module OursprivacyIngest
1227
1257
  sig do
1228
1258
  override.returns(
1229
1259
  {
1260
+ _ef_transaction_id: T.nilable(String),
1230
1261
  ad_id: T.nilable(String),
1231
1262
  admitad_uid: T.nilable(String),
1232
1263
  adset_id: T.nilable(String),
@@ -1234,6 +1265,7 @@ module OursprivacyIngest
1234
1265
  aleid: T.nilable(String),
1235
1266
  axwrt: T.nilable(String),
1236
1267
  basis_cid: T.nilable(String),
1268
+ beeswax_auction_id: T.nilable(String),
1237
1269
  campaign_id: T.nilable(String),
1238
1270
  city: T.nilable(String),
1239
1271
  clickid: T.nilable(String),
@@ -217,6 +217,11 @@ module OursprivacyIngest
217
217
  )
218
218
  end
219
219
 
220
+ # The Everflow affiliate Click (Transaction) ID, captured from the
221
+ # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
222
+ sig { returns(T.nilable(String)) }
223
+ attr_accessor :_ef_transaction_id
224
+
220
225
  # The active time in milliseconds that the user had this tab active
221
226
  sig { returns(T.nilable(Float)) }
222
227
  attr_accessor :active_duration
@@ -250,6 +255,11 @@ module OursprivacyIngest
250
255
  sig { returns(T.nilable(String)) }
251
256
  attr_accessor :basis_cid
252
257
 
258
+ # The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the
259
+ # `{{AUCTION_ID}}` macro on creative click URLs. Ex: bx-auc-abc123
260
+ sig { returns(T.nilable(String)) }
261
+ attr_accessor :beeswax_auction_id
262
+
253
263
  # The language of the browser. Ex: en-US
254
264
  sig { returns(T.nilable(String)) }
255
265
  attr_accessor :browser_language
@@ -516,6 +526,7 @@ module OursprivacyIngest
516
526
  # destinations
517
527
  sig do
518
528
  params(
529
+ _ef_transaction_id: T.nilable(String),
519
530
  active_duration: T.nilable(Float),
520
531
  ad_id: T.nilable(String),
521
532
  admitad_uid: T.nilable(String),
@@ -524,6 +535,7 @@ module OursprivacyIngest
524
535
  aleid: T.nilable(String),
525
536
  axwrt: T.nilable(String),
526
537
  basis_cid: T.nilable(String),
538
+ beeswax_auction_id: T.nilable(String),
527
539
  browser_language: T.nilable(String),
528
540
  browser_name: T.nilable(String),
529
541
  browser_version: T.nilable(String),
@@ -591,6 +603,9 @@ module OursprivacyIngest
591
603
  ).returns(T.attached_class)
592
604
  end
593
605
  def self.new(
606
+ # The Everflow affiliate Click (Transaction) ID, captured from the
607
+ # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
608
+ _ef_transaction_id: nil,
594
609
  # The active time in milliseconds that the user had this tab active
595
610
  active_duration: nil,
596
611
  # The ad id for detected in the session. This is set by the web sdk automatically.
@@ -608,6 +623,9 @@ module OursprivacyIngest
608
623
  axwrt: nil,
609
624
  # The Basis DSP Click ID. Ex: basis_cid123
610
625
  basis_cid: nil,
626
+ # The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the
627
+ # `{{AUCTION_ID}}` macro on creative click URLs. Ex: bx-auc-abc123
628
+ beeswax_auction_id: nil,
611
629
  # The language of the browser. Ex: en-US
612
630
  browser_language: nil,
613
631
  # The name of the browser. Ex: Chrome
@@ -748,6 +766,7 @@ module OursprivacyIngest
748
766
  sig do
749
767
  override.returns(
750
768
  {
769
+ _ef_transaction_id: T.nilable(String),
751
770
  active_duration: T.nilable(Float),
752
771
  ad_id: T.nilable(String),
753
772
  admitad_uid: T.nilable(String),
@@ -756,6 +775,7 @@ module OursprivacyIngest
756
775
  aleid: T.nilable(String),
757
776
  axwrt: T.nilable(String),
758
777
  basis_cid: T.nilable(String),
778
+ beeswax_auction_id: T.nilable(String),
759
779
  browser_language: T.nilable(String),
760
780
  browser_name: T.nilable(String),
761
781
  browser_version: T.nilable(String),
@@ -870,6 +890,9 @@ module OursprivacyIngest
870
890
  )
871
891
  end
872
892
 
893
+ sig { returns(T.nilable(String)) }
894
+ attr_accessor :_ef_transaction_id
895
+
873
896
  sig { returns(T.nilable(String)) }
874
897
  attr_accessor :ad_id
875
898
 
@@ -891,6 +914,9 @@ module OursprivacyIngest
891
914
  sig { returns(T.nilable(String)) }
892
915
  attr_accessor :basis_cid
893
916
 
917
+ sig { returns(T.nilable(String)) }
918
+ attr_accessor :beeswax_auction_id
919
+
894
920
  sig { returns(T.nilable(String)) }
895
921
  attr_accessor :campaign_id
896
922
 
@@ -1049,6 +1075,7 @@ module OursprivacyIngest
1049
1075
  # properties via the identify endpoint.
1050
1076
  sig do
1051
1077
  params(
1078
+ _ef_transaction_id: T.nilable(String),
1052
1079
  ad_id: T.nilable(String),
1053
1080
  admitad_uid: T.nilable(String),
1054
1081
  adset_id: T.nilable(String),
@@ -1056,6 +1083,7 @@ module OursprivacyIngest
1056
1083
  aleid: T.nilable(String),
1057
1084
  axwrt: T.nilable(String),
1058
1085
  basis_cid: T.nilable(String),
1086
+ beeswax_auction_id: T.nilable(String),
1059
1087
  campaign_id: T.nilable(String),
1060
1088
  city: T.nilable(String),
1061
1089
  clickid: T.nilable(String),
@@ -1110,6 +1138,7 @@ module OursprivacyIngest
1110
1138
  ).returns(T.attached_class)
1111
1139
  end
1112
1140
  def self.new(
1141
+ _ef_transaction_id: nil,
1113
1142
  ad_id: nil,
1114
1143
  admitad_uid: nil,
1115
1144
  adset_id: nil,
@@ -1117,6 +1146,7 @@ module OursprivacyIngest
1117
1146
  aleid: nil,
1118
1147
  axwrt: nil,
1119
1148
  basis_cid: nil,
1149
+ beeswax_auction_id: nil,
1120
1150
  campaign_id: nil,
1121
1151
  city: nil,
1122
1152
  clickid: nil,
@@ -1175,6 +1205,7 @@ module OursprivacyIngest
1175
1205
  sig do
1176
1206
  override.returns(
1177
1207
  {
1208
+ _ef_transaction_id: T.nilable(String),
1178
1209
  ad_id: T.nilable(String),
1179
1210
  admitad_uid: T.nilable(String),
1180
1211
  adset_id: T.nilable(String),
@@ -1182,6 +1213,7 @@ module OursprivacyIngest
1182
1213
  aleid: T.nilable(String),
1183
1214
  axwrt: T.nilable(String),
1184
1215
  basis_cid: T.nilable(String),
1216
+ beeswax_auction_id: T.nilable(String),
1185
1217
  campaign_id: T.nilable(String),
1186
1218
  city: T.nilable(String),
1187
1219
  clickid: T.nilable(String),
@@ -177,6 +177,9 @@ module OursprivacyIngest
177
177
  )
178
178
  end
179
179
 
180
+ sig { returns(T.nilable(String)) }
181
+ attr_accessor :_ef_transaction_id
182
+
180
183
  sig { returns(T.nilable(String)) }
181
184
  attr_accessor :ad_id
182
185
 
@@ -198,6 +201,9 @@ module OursprivacyIngest
198
201
  sig { returns(T.nilable(String)) }
199
202
  attr_accessor :basis_cid
200
203
 
204
+ sig { returns(T.nilable(String)) }
205
+ attr_accessor :beeswax_auction_id
206
+
201
207
  sig { returns(T.nilable(String)) }
202
208
  attr_accessor :campaign_id
203
209
 
@@ -357,6 +363,7 @@ module OursprivacyIngest
357
363
  # them.
358
364
  sig do
359
365
  params(
366
+ _ef_transaction_id: T.nilable(String),
360
367
  ad_id: T.nilable(String),
361
368
  admitad_uid: T.nilable(String),
362
369
  adset_id: T.nilable(String),
@@ -364,6 +371,7 @@ module OursprivacyIngest
364
371
  aleid: T.nilable(String),
365
372
  axwrt: T.nilable(String),
366
373
  basis_cid: T.nilable(String),
374
+ beeswax_auction_id: T.nilable(String),
367
375
  campaign_id: T.nilable(String),
368
376
  city: T.nilable(String),
369
377
  clickid: T.nilable(String),
@@ -418,6 +426,7 @@ module OursprivacyIngest
418
426
  ).returns(T.attached_class)
419
427
  end
420
428
  def self.new(
429
+ _ef_transaction_id: nil,
421
430
  ad_id: nil,
422
431
  admitad_uid: nil,
423
432
  adset_id: nil,
@@ -425,6 +434,7 @@ module OursprivacyIngest
425
434
  aleid: nil,
426
435
  axwrt: nil,
427
436
  basis_cid: nil,
437
+ beeswax_auction_id: nil,
428
438
  campaign_id: nil,
429
439
  city: nil,
430
440
  clickid: nil,
@@ -483,6 +493,7 @@ module OursprivacyIngest
483
493
  sig do
484
494
  override.returns(
485
495
  {
496
+ _ef_transaction_id: T.nilable(String),
486
497
  ad_id: T.nilable(String),
487
498
  admitad_uid: T.nilable(String),
488
499
  adset_id: T.nilable(String),
@@ -490,6 +501,7 @@ module OursprivacyIngest
490
501
  aleid: T.nilable(String),
491
502
  axwrt: T.nilable(String),
492
503
  basis_cid: T.nilable(String),
504
+ beeswax_auction_id: T.nilable(String),
493
505
  campaign_id: T.nilable(String),
494
506
  city: T.nilable(String),
495
507
  clickid: T.nilable(String),
@@ -557,6 +569,11 @@ module OursprivacyIngest
557
569
  )
558
570
  end
559
571
 
572
+ # The Everflow affiliate Click (Transaction) ID, captured from the
573
+ # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
574
+ sig { returns(T.nilable(String)) }
575
+ attr_accessor :_ef_transaction_id
576
+
560
577
  # The active time in milliseconds that the user had this tab active
561
578
  sig { returns(T.nilable(Float)) }
562
579
  attr_accessor :active_duration
@@ -590,6 +607,11 @@ module OursprivacyIngest
590
607
  sig { returns(T.nilable(String)) }
591
608
  attr_accessor :basis_cid
592
609
 
610
+ # The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the
611
+ # `{{AUCTION_ID}}` macro on creative click URLs. Ex: bx-auc-abc123
612
+ sig { returns(T.nilable(String)) }
613
+ attr_accessor :beeswax_auction_id
614
+
593
615
  # The language of the browser. Ex: en-US
594
616
  sig { returns(T.nilable(String)) }
595
617
  attr_accessor :browser_language
@@ -856,6 +878,7 @@ module OursprivacyIngest
856
878
  # destinations
857
879
  sig do
858
880
  params(
881
+ _ef_transaction_id: T.nilable(String),
859
882
  active_duration: T.nilable(Float),
860
883
  ad_id: T.nilable(String),
861
884
  admitad_uid: T.nilable(String),
@@ -864,6 +887,7 @@ module OursprivacyIngest
864
887
  aleid: T.nilable(String),
865
888
  axwrt: T.nilable(String),
866
889
  basis_cid: T.nilable(String),
890
+ beeswax_auction_id: T.nilable(String),
867
891
  browser_language: T.nilable(String),
868
892
  browser_name: T.nilable(String),
869
893
  browser_version: T.nilable(String),
@@ -931,6 +955,9 @@ module OursprivacyIngest
931
955
  ).returns(T.attached_class)
932
956
  end
933
957
  def self.new(
958
+ # The Everflow affiliate Click (Transaction) ID, captured from the
959
+ # `_ef_transaction_id` URL parameter. Ex: ef_click_abc123
960
+ _ef_transaction_id: nil,
934
961
  # The active time in milliseconds that the user had this tab active
935
962
  active_duration: nil,
936
963
  # The ad id for detected in the session. This is set by the web sdk automatically.
@@ -948,6 +975,9 @@ module OursprivacyIngest
948
975
  axwrt: nil,
949
976
  # The Basis DSP Click ID. Ex: basis_cid123
950
977
  basis_cid: nil,
978
+ # The Beeswax (FreeWheel Buyer Cloud) auction ID, captured from the
979
+ # `{{AUCTION_ID}}` macro on creative click URLs. Ex: bx-auc-abc123
980
+ beeswax_auction_id: nil,
951
981
  # The language of the browser. Ex: en-US
952
982
  browser_language: nil,
953
983
  # The name of the browser. Ex: Chrome
@@ -1088,6 +1118,7 @@ module OursprivacyIngest
1088
1118
  sig do
1089
1119
  override.returns(
1090
1120
  {
1121
+ _ef_transaction_id: T.nilable(String),
1091
1122
  active_duration: T.nilable(Float),
1092
1123
  ad_id: T.nilable(String),
1093
1124
  admitad_uid: T.nilable(String),
@@ -1096,6 +1127,7 @@ module OursprivacyIngest
1096
1127
  aleid: T.nilable(String),
1097
1128
  axwrt: T.nilable(String),
1098
1129
  basis_cid: T.nilable(String),
1130
+ beeswax_auction_id: T.nilable(String),
1099
1131
  browser_language: T.nilable(String),
1100
1132
  browser_name: T.nilable(String),
1101
1133
  browser_version: T.nilable(String),
@@ -90,6 +90,7 @@ module OursprivacyIngest
90
90
 
91
91
  type default_properties =
92
92
  {
93
+ _ef_transaction_id: String?,
93
94
  active_duration: Float?,
94
95
  ad_id: String?,
95
96
  admitad_uid: String?,
@@ -98,6 +99,7 @@ module OursprivacyIngest
98
99
  aleid: String?,
99
100
  axwrt: String?,
100
101
  basis_cid: String?,
102
+ beeswax_auction_id: String?,
101
103
  browser_language: String?,
102
104
  browser_name: String?,
103
105
  browser_version: String?,
@@ -165,6 +167,8 @@ module OursprivacyIngest
165
167
  }
166
168
 
167
169
  class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
170
+ attr_accessor _ef_transaction_id: String?
171
+
168
172
  attr_accessor active_duration: Float?
169
173
 
170
174
  attr_accessor ad_id: String?
@@ -181,6 +185,8 @@ module OursprivacyIngest
181
185
 
182
186
  attr_accessor basis_cid: String?
183
187
 
188
+ attr_accessor beeswax_auction_id: String?
189
+
184
190
  attr_accessor browser_language: String?
185
191
 
186
192
  attr_accessor browser_name: String?
@@ -310,6 +316,7 @@ module OursprivacyIngest
310
316
  attr_accessor webview: bool?
311
317
 
312
318
  def initialize: (
319
+ ?_ef_transaction_id: String?,
313
320
  ?active_duration: Float?,
314
321
  ?ad_id: String?,
315
322
  ?admitad_uid: String?,
@@ -318,6 +325,7 @@ module OursprivacyIngest
318
325
  ?aleid: String?,
319
326
  ?axwrt: String?,
320
327
  ?basis_cid: String?,
328
+ ?beeswax_auction_id: String?,
321
329
  ?browser_language: String?,
322
330
  ?browser_name: String?,
323
331
  ?browser_version: String?,
@@ -385,6 +393,7 @@ module OursprivacyIngest
385
393
  ) -> void
386
394
 
387
395
  def to_hash: -> {
396
+ _ef_transaction_id: String?,
388
397
  active_duration: Float?,
389
398
  ad_id: String?,
390
399
  admitad_uid: String?,
@@ -393,6 +402,7 @@ module OursprivacyIngest
393
402
  aleid: String?,
394
403
  axwrt: String?,
395
404
  basis_cid: String?,
405
+ beeswax_auction_id: String?,
396
406
  browser_language: String?,
397
407
  browser_name: String?,
398
408
  browser_version: String?,
@@ -474,6 +484,7 @@ module OursprivacyIngest
474
484
 
475
485
  type user_properties =
476
486
  {
487
+ _ef_transaction_id: String?,
477
488
  ad_id: String?,
478
489
  admitad_uid: String?,
479
490
  adset_id: String?,
@@ -481,6 +492,7 @@ module OursprivacyIngest
481
492
  aleid: String?,
482
493
  axwrt: String?,
483
494
  basis_cid: String?,
495
+ beeswax_auction_id: String?,
484
496
  campaign_id: String?,
485
497
  city: String?,
486
498
  clickid: String?,
@@ -535,6 +547,8 @@ module OursprivacyIngest
535
547
  }
536
548
 
537
549
  class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
550
+ attr_accessor _ef_transaction_id: String?
551
+
538
552
  attr_accessor ad_id: String?
539
553
 
540
554
  attr_accessor admitad_uid: String?
@@ -549,6 +563,8 @@ module OursprivacyIngest
549
563
 
550
564
  attr_accessor basis_cid: String?
551
565
 
566
+ attr_accessor beeswax_auction_id: String?
567
+
552
568
  attr_accessor campaign_id: String?
553
569
 
554
570
  attr_accessor city: String?
@@ -652,6 +668,7 @@ module OursprivacyIngest
652
668
  attr_accessor zip: String?
653
669
 
654
670
  def initialize: (
671
+ ?_ef_transaction_id: String?,
655
672
  ?ad_id: String?,
656
673
  ?admitad_uid: String?,
657
674
  ?adset_id: String?,
@@ -659,6 +676,7 @@ module OursprivacyIngest
659
676
  ?aleid: String?,
660
677
  ?axwrt: String?,
661
678
  ?basis_cid: String?,
679
+ ?beeswax_auction_id: String?,
662
680
  ?campaign_id: String?,
663
681
  ?city: String?,
664
682
  ?clickid: String?,
@@ -713,6 +731,7 @@ module OursprivacyIngest
713
731
  ) -> void
714
732
 
715
733
  def to_hash: -> {
734
+ _ef_transaction_id: String?,
716
735
  ad_id: String?,
717
736
  admitad_uid: String?,
718
737
  adset_id: String?,
@@ -720,6 +739,7 @@ module OursprivacyIngest
720
739
  aleid: String?,
721
740
  axwrt: String?,
722
741
  basis_cid: String?,
742
+ beeswax_auction_id: String?,
723
743
  campaign_id: String?,
724
744
  city: String?,
725
745
  clickid: String?,
@@ -74,6 +74,7 @@ module OursprivacyIngest
74
74
 
75
75
  type default_properties =
76
76
  {
77
+ _ef_transaction_id: String?,
77
78
  active_duration: Float?,
78
79
  ad_id: String?,
79
80
  admitad_uid: String?,
@@ -82,6 +83,7 @@ module OursprivacyIngest
82
83
  aleid: String?,
83
84
  axwrt: String?,
84
85
  basis_cid: String?,
86
+ beeswax_auction_id: String?,
85
87
  browser_language: String?,
86
88
  browser_name: String?,
87
89
  browser_version: String?,
@@ -149,6 +151,8 @@ module OursprivacyIngest
149
151
  }
150
152
 
151
153
  class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
154
+ attr_accessor _ef_transaction_id: String?
155
+
152
156
  attr_accessor active_duration: Float?
153
157
 
154
158
  attr_accessor ad_id: String?
@@ -165,6 +169,8 @@ module OursprivacyIngest
165
169
 
166
170
  attr_accessor basis_cid: String?
167
171
 
172
+ attr_accessor beeswax_auction_id: String?
173
+
168
174
  attr_accessor browser_language: String?
169
175
 
170
176
  attr_accessor browser_name: String?
@@ -294,6 +300,7 @@ module OursprivacyIngest
294
300
  attr_accessor webview: bool?
295
301
 
296
302
  def initialize: (
303
+ ?_ef_transaction_id: String?,
297
304
  ?active_duration: Float?,
298
305
  ?ad_id: String?,
299
306
  ?admitad_uid: String?,
@@ -302,6 +309,7 @@ module OursprivacyIngest
302
309
  ?aleid: String?,
303
310
  ?axwrt: String?,
304
311
  ?basis_cid: String?,
312
+ ?beeswax_auction_id: String?,
305
313
  ?browser_language: String?,
306
314
  ?browser_name: String?,
307
315
  ?browser_version: String?,
@@ -369,6 +377,7 @@ module OursprivacyIngest
369
377
  ) -> void
370
378
 
371
379
  def to_hash: -> {
380
+ _ef_transaction_id: String?,
372
381
  active_duration: Float?,
373
382
  ad_id: String?,
374
383
  admitad_uid: String?,
@@ -377,6 +386,7 @@ module OursprivacyIngest
377
386
  aleid: String?,
378
387
  axwrt: String?,
379
388
  basis_cid: String?,
389
+ beeswax_auction_id: String?,
380
390
  browser_language: String?,
381
391
  browser_name: String?,
382
392
  browser_version: String?,
@@ -458,6 +468,7 @@ module OursprivacyIngest
458
468
 
459
469
  type user_properties =
460
470
  {
471
+ _ef_transaction_id: String?,
461
472
  ad_id: String?,
462
473
  admitad_uid: String?,
463
474
  adset_id: String?,
@@ -465,6 +476,7 @@ module OursprivacyIngest
465
476
  aleid: String?,
466
477
  axwrt: String?,
467
478
  basis_cid: String?,
479
+ beeswax_auction_id: String?,
468
480
  campaign_id: String?,
469
481
  city: String?,
470
482
  clickid: String?,
@@ -519,6 +531,8 @@ module OursprivacyIngest
519
531
  }
520
532
 
521
533
  class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
534
+ attr_accessor _ef_transaction_id: String?
535
+
522
536
  attr_accessor ad_id: String?
523
537
 
524
538
  attr_accessor admitad_uid: String?
@@ -533,6 +547,8 @@ module OursprivacyIngest
533
547
 
534
548
  attr_accessor basis_cid: String?
535
549
 
550
+ attr_accessor beeswax_auction_id: String?
551
+
536
552
  attr_accessor campaign_id: String?
537
553
 
538
554
  attr_accessor city: String?
@@ -636,6 +652,7 @@ module OursprivacyIngest
636
652
  attr_accessor zip: String?
637
653
 
638
654
  def initialize: (
655
+ ?_ef_transaction_id: String?,
639
656
  ?ad_id: String?,
640
657
  ?admitad_uid: String?,
641
658
  ?adset_id: String?,
@@ -643,6 +660,7 @@ module OursprivacyIngest
643
660
  ?aleid: String?,
644
661
  ?axwrt: String?,
645
662
  ?basis_cid: String?,
663
+ ?beeswax_auction_id: String?,
646
664
  ?campaign_id: String?,
647
665
  ?city: String?,
648
666
  ?clickid: String?,
@@ -697,6 +715,7 @@ module OursprivacyIngest
697
715
  ) -> void
698
716
 
699
717
  def to_hash: -> {
718
+ _ef_transaction_id: String?,
700
719
  ad_id: String?,
701
720
  admitad_uid: String?,
702
721
  adset_id: String?,
@@ -704,6 +723,7 @@ module OursprivacyIngest
704
723
  aleid: String?,
705
724
  axwrt: String?,
706
725
  basis_cid: String?,
726
+ beeswax_auction_id: String?,
707
727
  campaign_id: String?,
708
728
  city: String?,
709
729
  clickid: String?,
@@ -54,6 +54,7 @@ module OursprivacyIngest
54
54
 
55
55
  type user_properties =
56
56
  {
57
+ _ef_transaction_id: String?,
57
58
  ad_id: String?,
58
59
  admitad_uid: String?,
59
60
  adset_id: String?,
@@ -61,6 +62,7 @@ module OursprivacyIngest
61
62
  aleid: String?,
62
63
  axwrt: String?,
63
64
  basis_cid: String?,
65
+ beeswax_auction_id: String?,
64
66
  campaign_id: String?,
65
67
  city: String?,
66
68
  clickid: String?,
@@ -115,6 +117,8 @@ module OursprivacyIngest
115
117
  }
116
118
 
117
119
  class UserProperties < OursprivacyIngest::Internal::Type::BaseModel
120
+ attr_accessor _ef_transaction_id: String?
121
+
118
122
  attr_accessor ad_id: String?
119
123
 
120
124
  attr_accessor admitad_uid: String?
@@ -129,6 +133,8 @@ module OursprivacyIngest
129
133
 
130
134
  attr_accessor basis_cid: String?
131
135
 
136
+ attr_accessor beeswax_auction_id: String?
137
+
132
138
  attr_accessor campaign_id: String?
133
139
 
134
140
  attr_accessor city: String?
@@ -232,6 +238,7 @@ module OursprivacyIngest
232
238
  attr_accessor zip: String?
233
239
 
234
240
  def initialize: (
241
+ ?_ef_transaction_id: String?,
235
242
  ?ad_id: String?,
236
243
  ?admitad_uid: String?,
237
244
  ?adset_id: String?,
@@ -239,6 +246,7 @@ module OursprivacyIngest
239
246
  ?aleid: String?,
240
247
  ?axwrt: String?,
241
248
  ?basis_cid: String?,
249
+ ?beeswax_auction_id: String?,
242
250
  ?campaign_id: String?,
243
251
  ?city: String?,
244
252
  ?clickid: String?,
@@ -293,6 +301,7 @@ module OursprivacyIngest
293
301
  ) -> void
294
302
 
295
303
  def to_hash: -> {
304
+ _ef_transaction_id: String?,
296
305
  ad_id: String?,
297
306
  admitad_uid: String?,
298
307
  adset_id: String?,
@@ -300,6 +309,7 @@ module OursprivacyIngest
300
309
  aleid: String?,
301
310
  axwrt: String?,
302
311
  basis_cid: String?,
312
+ beeswax_auction_id: String?,
303
313
  campaign_id: String?,
304
314
  city: String?,
305
315
  clickid: String?,
@@ -356,6 +366,7 @@ module OursprivacyIngest
356
366
 
357
367
  type default_properties =
358
368
  {
369
+ _ef_transaction_id: String?,
359
370
  active_duration: Float?,
360
371
  ad_id: String?,
361
372
  admitad_uid: String?,
@@ -364,6 +375,7 @@ module OursprivacyIngest
364
375
  aleid: String?,
365
376
  axwrt: String?,
366
377
  basis_cid: String?,
378
+ beeswax_auction_id: String?,
367
379
  browser_language: String?,
368
380
  browser_name: String?,
369
381
  browser_version: String?,
@@ -431,6 +443,8 @@ module OursprivacyIngest
431
443
  }
432
444
 
433
445
  class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
446
+ attr_accessor _ef_transaction_id: String?
447
+
434
448
  attr_accessor active_duration: Float?
435
449
 
436
450
  attr_accessor ad_id: String?
@@ -447,6 +461,8 @@ module OursprivacyIngest
447
461
 
448
462
  attr_accessor basis_cid: String?
449
463
 
464
+ attr_accessor beeswax_auction_id: String?
465
+
450
466
  attr_accessor browser_language: String?
451
467
 
452
468
  attr_accessor browser_name: String?
@@ -576,6 +592,7 @@ module OursprivacyIngest
576
592
  attr_accessor webview: bool?
577
593
 
578
594
  def initialize: (
595
+ ?_ef_transaction_id: String?,
579
596
  ?active_duration: Float?,
580
597
  ?ad_id: String?,
581
598
  ?admitad_uid: String?,
@@ -584,6 +601,7 @@ module OursprivacyIngest
584
601
  ?aleid: String?,
585
602
  ?axwrt: String?,
586
603
  ?basis_cid: String?,
604
+ ?beeswax_auction_id: String?,
587
605
  ?browser_language: String?,
588
606
  ?browser_name: String?,
589
607
  ?browser_version: String?,
@@ -651,6 +669,7 @@ module OursprivacyIngest
651
669
  ) -> void
652
670
 
653
671
  def to_hash: -> {
672
+ _ef_transaction_id: String?,
654
673
  active_duration: Float?,
655
674
  ad_id: String?,
656
675
  admitad_uid: String?,
@@ -659,6 +678,7 @@ module OursprivacyIngest
659
678
  aleid: String?,
660
679
  axwrt: String?,
661
680
  basis_cid: String?,
681
+ beeswax_auction_id: String?,
662
682
  browser_language: String?,
663
683
  browser_name: String?,
664
684
  browser_version: String?,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: oursprivacy-ingest
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.6.0
4
+ version: 1.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ours Privacy
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-05-07 00:00:00.000000000 Z
11
+ date: 2026-05-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi