oursprivacy-ingest 1.23.0 → 1.24.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 +4 -4
- data/CHANGELOG.md +7 -0
- data/README.md +1 -1
- data/lib/oursprivacy_ingest/internal/transport/base_client.rb +2 -4
- data/lib/oursprivacy_ingest/internal/transport/pooled_net_requester.rb +1 -2
- data/lib/oursprivacy_ingest/internal/type/array_of.rb +1 -2
- data/lib/oursprivacy_ingest/internal/type/base_model.rb +3 -6
- data/lib/oursprivacy_ingest/internal/type/enum.rb +1 -2
- data/lib/oursprivacy_ingest/internal/type/hash_of.rb +1 -2
- data/lib/oursprivacy_ingest/internal/util.rb +3 -2
- data/lib/oursprivacy_ingest/models/batch_create_params.rb +35 -2
- data/lib/oursprivacy_ingest/models/track_event_params.rb +35 -2
- data/lib/oursprivacy_ingest/models/visitor_upsert_params.rb +35 -2
- data/lib/oursprivacy_ingest/version.rb +1 -1
- data/rbi/oursprivacy_ingest/internal/util.rbi +2 -2
- data/rbi/oursprivacy_ingest/models/batch_create_params.rbi +37 -3
- data/rbi/oursprivacy_ingest/models/track_event_params.rbi +37 -3
- data/rbi/oursprivacy_ingest/models/visitor_upsert_params.rbi +37 -3
- data/sig/oursprivacy_ingest/models/batch_create_params.rbs +23 -3
- data/sig/oursprivacy_ingest/models/track_event_params.rbs +23 -3
- data/sig/oursprivacy_ingest/models/visitor_upsert_params.rbs +23 -3
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9a5f91fcf54ec325d304ff1b03188c2a0e56a08bbb623e14b30c116f4fdde72f
|
|
4
|
+
data.tar.gz: fc1bdee43aa919976fd9969e22deeed0200763c1d4660aff67e1a448a205b7a1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c0752178bfe5fbcaeb77aca3e5f602cd8f49984a86e0d5927e75e33176d1738e583d5811d6bac8cbd1d22a89747b8b768d2634df19904c99817bbb0df302580d
|
|
7
|
+
data.tar.gz: f52c1fdc02cb01faaf2b6da2e6bf54564a6b2e01f75c27a099216ffbdcb3027a0cdc5ef506e455185b98ffb81fe84878aae63e2ee729ca242bf3b0a399d64163
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.24.0 (2026-10-22)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.23.0...v1.24.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.23.0...v1.24.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** API update.
|
|
3
10
|
## 1.23.0 (2026-10-16)
|
|
4
11
|
|
|
5
12
|
Full Changelog: [v1.22.0...v1.23.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v1.22.0...v1.23.0)
|
data/README.md
CHANGED
|
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
15
15
|
<!-- x-release-please-start-version -->
|
|
16
16
|
|
|
17
17
|
```ruby
|
|
18
|
-
gem "oursprivacy-ingest", "~> 1.
|
|
18
|
+
gem "oursprivacy-ingest", "~> 1.24.0"
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
<!-- x-release-please-end -->
|
|
@@ -12,7 +12,7 @@ module OursprivacyIngest
|
|
|
12
12
|
# from whatwg fetch spec
|
|
13
13
|
MAX_REDIRECTS = 20
|
|
14
14
|
|
|
15
|
-
# rubocop:disable Style/MutableConstant
|
|
15
|
+
# rubocop:disable-next Style/MutableConstant
|
|
16
16
|
PLATFORM_HEADERS =
|
|
17
17
|
{
|
|
18
18
|
"x-stainless-arch" => OursprivacyIngest::Internal::Util.arch,
|
|
@@ -22,7 +22,6 @@ module OursprivacyIngest
|
|
|
22
22
|
"x-stainless-runtime" => ::RUBY_ENGINE,
|
|
23
23
|
"x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION
|
|
24
24
|
}
|
|
25
|
-
# rubocop:enable Style/MutableConstant
|
|
26
25
|
|
|
27
26
|
class << self
|
|
28
27
|
# @api private
|
|
@@ -521,9 +520,8 @@ module OursprivacyIngest
|
|
|
521
520
|
#
|
|
522
521
|
# @return [String]
|
|
523
522
|
def inspect
|
|
524
|
-
# rubocop:disable Layout/LineLength
|
|
523
|
+
# rubocop:disable-next Layout/LineLength
|
|
525
524
|
"#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{@base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
|
|
526
|
-
# rubocop:enable Layout/LineLength
|
|
527
525
|
end
|
|
528
526
|
|
|
529
527
|
define_sorbet_constant!(:RequestComponents) do
|
|
@@ -133,7 +133,7 @@ module OursprivacyIngest
|
|
|
133
133
|
req = nil
|
|
134
134
|
finished = false
|
|
135
135
|
|
|
136
|
-
# rubocop:disable Metrics/BlockLength
|
|
136
|
+
# rubocop:disable-next Metrics/BlockLength
|
|
137
137
|
enum = Enumerator.new do |y|
|
|
138
138
|
next if finished
|
|
139
139
|
|
|
@@ -181,7 +181,6 @@ module OursprivacyIngest
|
|
|
181
181
|
rescue StandardError
|
|
182
182
|
raise OursprivacyIngest::Errors::APIConnectionError.new(url: url, request: req)
|
|
183
183
|
end
|
|
184
|
-
# rubocop:enable Metrics/BlockLength
|
|
185
184
|
|
|
186
185
|
_, response = enum.next
|
|
187
186
|
body = OursprivacyIngest::Internal::Util.fused_enum(enum, external: true) do
|
|
@@ -46,9 +46,8 @@ module OursprivacyIngest
|
|
|
46
46
|
#
|
|
47
47
|
# @return [Boolean]
|
|
48
48
|
def ==(other)
|
|
49
|
-
# rubocop:disable Layout/LineLength
|
|
49
|
+
# rubocop:disable-next Layout/LineLength
|
|
50
50
|
other.is_a?(OursprivacyIngest::Internal::Type::ArrayOf) && other.nilable? == nilable? && other.item_type == item_type
|
|
51
|
-
# rubocop:enable Layout/LineLength
|
|
52
51
|
end
|
|
53
52
|
|
|
54
53
|
# @api public
|
|
@@ -95,7 +95,7 @@ module OursprivacyIngest
|
|
|
95
95
|
end
|
|
96
96
|
|
|
97
97
|
# rubocop:disable Style/CaseEquality
|
|
98
|
-
# rubocop:disable Metrics/BlockLength
|
|
98
|
+
# rubocop:disable-next Metrics/BlockLength
|
|
99
99
|
define_method(name_sym) do
|
|
100
100
|
target = type_fn.call
|
|
101
101
|
|
|
@@ -132,7 +132,6 @@ module OursprivacyIngest
|
|
|
132
132
|
end
|
|
133
133
|
end
|
|
134
134
|
end
|
|
135
|
-
# rubocop:enable Metrics/BlockLength
|
|
136
135
|
# rubocop:enable Style/CaseEquality
|
|
137
136
|
end
|
|
138
137
|
|
|
@@ -205,9 +204,8 @@ module OursprivacyIngest
|
|
|
205
204
|
#
|
|
206
205
|
# @return [Boolean]
|
|
207
206
|
def ==(other)
|
|
208
|
-
# rubocop:disable Layout/LineLength
|
|
207
|
+
# rubocop:disable-next Layout/LineLength
|
|
209
208
|
other.is_a?(Class) && other <= OursprivacyIngest::Internal::Type::BaseModel && other.fields == fields
|
|
210
|
-
# rubocop:enable Layout/LineLength
|
|
211
209
|
end
|
|
212
210
|
|
|
213
211
|
# @api public
|
|
@@ -266,7 +264,7 @@ module OursprivacyIngest
|
|
|
266
264
|
data = instance.to_h
|
|
267
265
|
status = instance.instance_variable_get(:@coerced)
|
|
268
266
|
|
|
269
|
-
# rubocop:disable Metrics/BlockLength
|
|
267
|
+
# rubocop:disable-next Metrics/BlockLength
|
|
270
268
|
fields.each do |name, field|
|
|
271
269
|
mode, required, target = field.fetch_values(:mode, :required, :type)
|
|
272
270
|
api_name, nilable, const = field.fetch_values(:api_name, :nilable, :const)
|
|
@@ -302,7 +300,6 @@ module OursprivacyIngest
|
|
|
302
300
|
status.store(name, state.fetch(:error) || true)
|
|
303
301
|
data.store(name, converted)
|
|
304
302
|
end
|
|
305
|
-
# rubocop:enable Metrics/BlockLength
|
|
306
303
|
|
|
307
304
|
keys.each { data.store(_1, val.fetch(_1)) }
|
|
308
305
|
instance
|
|
@@ -37,9 +37,8 @@ module OursprivacyIngest
|
|
|
37
37
|
#
|
|
38
38
|
# @return [Boolean]
|
|
39
39
|
def ==(other)
|
|
40
|
-
# rubocop:disable Style/CaseEquality
|
|
40
|
+
# rubocop:disable-next Style/CaseEquality
|
|
41
41
|
OursprivacyIngest::Internal::Type::Enum === other && other.values.to_set == values.to_set
|
|
42
|
-
# rubocop:enable Style/CaseEquality
|
|
43
42
|
end
|
|
44
43
|
|
|
45
44
|
# @api public
|
|
@@ -61,9 +61,8 @@ module OursprivacyIngest
|
|
|
61
61
|
#
|
|
62
62
|
# @return [Boolean]
|
|
63
63
|
def ==(other)
|
|
64
|
-
# rubocop:disable Layout/LineLength
|
|
64
|
+
# rubocop:disable-next Layout/LineLength
|
|
65
65
|
other.is_a?(OursprivacyIngest::Internal::Type::HashOf) && other.nilable? == nilable? && other.item_type == item_type
|
|
66
|
-
# rubocop:enable Layout/LineLength
|
|
67
66
|
end
|
|
68
67
|
|
|
69
68
|
# @api public
|
|
@@ -529,6 +529,8 @@ module OursprivacyIngest
|
|
|
529
529
|
write_query_param_element!(collection, "#{key}[#{name}]", value)
|
|
530
530
|
end
|
|
531
531
|
in Array
|
|
532
|
+
# Array#join flattens nested arrays; stringify each element to preserve query values.
|
|
533
|
+
# rubocop:disable-next Style/MapJoin
|
|
532
534
|
collection[key] = element.map(&:to_s).join(",")
|
|
533
535
|
else
|
|
534
536
|
collection[key] = element.to_s
|
|
@@ -770,9 +772,8 @@ module OursprivacyIngest
|
|
|
770
772
|
def close_fused!(enum)
|
|
771
773
|
return unless enum.is_a?(Enumerator)
|
|
772
774
|
|
|
773
|
-
# rubocop:disable Lint/UnreachableLoop
|
|
775
|
+
# rubocop:disable-next Lint/UnreachableLoop
|
|
774
776
|
enum.rewind.each { break }
|
|
775
|
-
# rubocop:enable Lint/UnreachableLoop
|
|
776
777
|
end
|
|
777
778
|
|
|
778
779
|
# @api private
|
|
@@ -624,6 +624,14 @@ module OursprivacyIngest
|
|
|
624
624
|
# @return [String, nil]
|
|
625
625
|
optional :ttclid, String, nil?: true
|
|
626
626
|
|
|
627
|
+
# @!attribute ttd_impression_id
|
|
628
|
+
# The Trade Desk impression ID, captured from a configured ttd_impression_id URL
|
|
629
|
+
# parameter using the %%TTD_IMPRESSIONID%% creative macro. Sent as imp on
|
|
630
|
+
# conversions. Leading and trailing whitespace is removed before validation.
|
|
631
|
+
#
|
|
632
|
+
# @return [String, nil]
|
|
633
|
+
optional :ttd_impression_id, String, nil?: true
|
|
634
|
+
|
|
627
635
|
# @!attribute twclid
|
|
628
636
|
# The Twitter Click ID. Ex: twclid123 Leading and trailing whitespace is removed
|
|
629
637
|
# before validation.
|
|
@@ -724,7 +732,13 @@ module OursprivacyIngest
|
|
|
724
732
|
# @return [Boolean, nil]
|
|
725
733
|
optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
|
|
726
734
|
|
|
727
|
-
# @!
|
|
735
|
+
# @!attribute ylpcid
|
|
736
|
+
# The Yelp Click ID from the landing URL, sent unchanged and unhashed.
|
|
737
|
+
#
|
|
738
|
+
# @return [String, nil]
|
|
739
|
+
optional :ylpcid, String, nil?: true
|
|
740
|
+
|
|
741
|
+
# @!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, graid: nil, grclid: 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, ob_click_id: nil, oppref: 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, ttd_impression_id: 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, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, webview: nil, ylpcid: nil)
|
|
728
742
|
# Some parameter documentations has been truncated, see
|
|
729
743
|
# {OursprivacyIngest::Models::BatchCreateParams::Event::DefaultProperties} for
|
|
730
744
|
# more details.
|
|
@@ -866,6 +880,8 @@ module OursprivacyIngest
|
|
|
866
880
|
#
|
|
867
881
|
# @param ttclid [String, nil] The TikTok Click ID. Ex: ttclid123 Leading and trailing whitespace is removed be
|
|
868
882
|
#
|
|
883
|
+
# @param ttd_impression_id [String, nil] The Trade Desk impression ID, captured from a configured ttd_impression_id URL p
|
|
884
|
+
#
|
|
869
885
|
# @param twclid [String, nil] The Twitter Click ID. Ex: twclid123 Leading and trailing whitespace is removed b
|
|
870
886
|
#
|
|
871
887
|
# @param uafvl [String, nil] User agent as a full list of strings. Leading and trailing whitespace is removed
|
|
@@ -894,6 +910,8 @@ module OursprivacyIngest
|
|
|
894
910
|
# @param wbraid [String, nil] The WBRAID Identifier. The web SDK automatically captures this from the query pa
|
|
895
911
|
#
|
|
896
912
|
# @param webview [Boolean, nil] Whether the user is in a webview. Ex: true
|
|
913
|
+
#
|
|
914
|
+
# @param ylpcid [String, nil] The Yelp Click ID from the landing URL, sent unchanged and unhashed.
|
|
897
915
|
|
|
898
916
|
# Any JSON value: string, number, boolean, array, object, or null.
|
|
899
917
|
#
|
|
@@ -1558,6 +1576,12 @@ module OursprivacyIngest
|
|
|
1558
1576
|
# @return [String, nil]
|
|
1559
1577
|
optional :ttclid, String, nil?: true
|
|
1560
1578
|
|
|
1579
|
+
# @!attribute ttd_impression_id
|
|
1580
|
+
# Leading and trailing whitespace is removed before validation.
|
|
1581
|
+
#
|
|
1582
|
+
# @return [String, nil]
|
|
1583
|
+
optional :ttd_impression_id, String, nil?: true
|
|
1584
|
+
|
|
1561
1585
|
# @!attribute twclid
|
|
1562
1586
|
#
|
|
1563
1587
|
# @return [String, nil]
|
|
@@ -1632,6 +1656,11 @@ module OursprivacyIngest
|
|
|
1632
1656
|
# @return [String, nil]
|
|
1633
1657
|
optional :wbraid, String, nil?: true
|
|
1634
1658
|
|
|
1659
|
+
# @!attribute ylpcid
|
|
1660
|
+
#
|
|
1661
|
+
# @return [String, nil]
|
|
1662
|
+
optional :ylpcid, String, nil?: true
|
|
1663
|
+
|
|
1635
1664
|
# @!attribute zip
|
|
1636
1665
|
# Any JSON value: string, number, boolean, array, object, or null.
|
|
1637
1666
|
#
|
|
@@ -1642,7 +1671,7 @@ module OursprivacyIngest
|
|
|
1642
1671
|
},
|
|
1643
1672
|
nil?: true
|
|
1644
1673
|
|
|
1645
|
-
# @!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, graid: nil, grclid: 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, ob_click_id: nil, oppref: 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, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, zip: nil)
|
|
1674
|
+
# @!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, graid: nil, grclid: 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, ob_click_id: nil, oppref: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, ttd_impression_id: 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, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, ylpcid: nil, zip: nil)
|
|
1646
1675
|
# Some parameter documentations has been truncated, see
|
|
1647
1676
|
# {OursprivacyIngest::Models::BatchCreateParams::Event::UserProperties} for more
|
|
1648
1677
|
# details.
|
|
@@ -1756,6 +1785,8 @@ module OursprivacyIngest
|
|
|
1756
1785
|
#
|
|
1757
1786
|
# @param ttclid [String, nil]
|
|
1758
1787
|
#
|
|
1788
|
+
# @param ttd_impression_id [String, nil] Leading and trailing whitespace is removed before validation.
|
|
1789
|
+
#
|
|
1759
1790
|
# @param twclid [String, nil]
|
|
1760
1791
|
#
|
|
1761
1792
|
# @param user_agent [String, nil]
|
|
@@ -1780,6 +1811,8 @@ module OursprivacyIngest
|
|
|
1780
1811
|
#
|
|
1781
1812
|
# @param wbraid [String, nil]
|
|
1782
1813
|
#
|
|
1814
|
+
# @param ylpcid [String, nil]
|
|
1815
|
+
#
|
|
1783
1816
|
# @param zip [String, Float, Boolean, Array<Object>, Hash{Symbol=>Object}, nil] Any JSON value: string, number, boolean, array, object, or null.
|
|
1784
1817
|
|
|
1785
1818
|
module Consent
|
|
@@ -612,6 +612,14 @@ module OursprivacyIngest
|
|
|
612
612
|
# @return [String, nil]
|
|
613
613
|
optional :ttclid, String, nil?: true
|
|
614
614
|
|
|
615
|
+
# @!attribute ttd_impression_id
|
|
616
|
+
# The Trade Desk impression ID, captured from a configured ttd_impression_id URL
|
|
617
|
+
# parameter using the %%TTD_IMPRESSIONID%% creative macro. Sent as imp on
|
|
618
|
+
# conversions. Leading and trailing whitespace is removed before validation.
|
|
619
|
+
#
|
|
620
|
+
# @return [String, nil]
|
|
621
|
+
optional :ttd_impression_id, String, nil?: true
|
|
622
|
+
|
|
615
623
|
# @!attribute twclid
|
|
616
624
|
# The Twitter Click ID. Ex: twclid123 Leading and trailing whitespace is removed
|
|
617
625
|
# before validation.
|
|
@@ -712,7 +720,13 @@ module OursprivacyIngest
|
|
|
712
720
|
# @return [Boolean, nil]
|
|
713
721
|
optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
|
|
714
722
|
|
|
715
|
-
# @!
|
|
723
|
+
# @!attribute ylpcid
|
|
724
|
+
# The Yelp Click ID from the landing URL, sent unchanged and unhashed.
|
|
725
|
+
#
|
|
726
|
+
# @return [String, nil]
|
|
727
|
+
optional :ylpcid, String, nil?: true
|
|
728
|
+
|
|
729
|
+
# @!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, graid: nil, grclid: 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, ob_click_id: nil, oppref: 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, ttd_impression_id: 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, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, webview: nil, ylpcid: nil)
|
|
716
730
|
# Some parameter documentations has been truncated, see
|
|
717
731
|
# {OursprivacyIngest::Models::TrackEventParams::DefaultProperties} for more
|
|
718
732
|
# details.
|
|
@@ -854,6 +868,8 @@ module OursprivacyIngest
|
|
|
854
868
|
#
|
|
855
869
|
# @param ttclid [String, nil] The TikTok Click ID. Ex: ttclid123 Leading and trailing whitespace is removed be
|
|
856
870
|
#
|
|
871
|
+
# @param ttd_impression_id [String, nil] The Trade Desk impression ID, captured from a configured ttd_impression_id URL p
|
|
872
|
+
#
|
|
857
873
|
# @param twclid [String, nil] The Twitter Click ID. Ex: twclid123 Leading and trailing whitespace is removed b
|
|
858
874
|
#
|
|
859
875
|
# @param uafvl [String, nil] User agent as a full list of strings. Leading and trailing whitespace is removed
|
|
@@ -882,6 +898,8 @@ module OursprivacyIngest
|
|
|
882
898
|
# @param wbraid [String, nil] The WBRAID Identifier. The web SDK automatically captures this from the query pa
|
|
883
899
|
#
|
|
884
900
|
# @param webview [Boolean, nil] Whether the user is in a webview. Ex: true
|
|
901
|
+
#
|
|
902
|
+
# @param ylpcid [String, nil] The Yelp Click ID from the landing URL, sent unchanged and unhashed.
|
|
885
903
|
|
|
886
904
|
# Any JSON value: string, number, boolean, array, object, or null.
|
|
887
905
|
#
|
|
@@ -1538,6 +1556,12 @@ module OursprivacyIngest
|
|
|
1538
1556
|
# @return [String, nil]
|
|
1539
1557
|
optional :ttclid, String, nil?: true
|
|
1540
1558
|
|
|
1559
|
+
# @!attribute ttd_impression_id
|
|
1560
|
+
# Leading and trailing whitespace is removed before validation.
|
|
1561
|
+
#
|
|
1562
|
+
# @return [String, nil]
|
|
1563
|
+
optional :ttd_impression_id, String, nil?: true
|
|
1564
|
+
|
|
1541
1565
|
# @!attribute twclid
|
|
1542
1566
|
#
|
|
1543
1567
|
# @return [String, nil]
|
|
@@ -1612,13 +1636,18 @@ module OursprivacyIngest
|
|
|
1612
1636
|
# @return [String, nil]
|
|
1613
1637
|
optional :wbraid, String, nil?: true
|
|
1614
1638
|
|
|
1639
|
+
# @!attribute ylpcid
|
|
1640
|
+
#
|
|
1641
|
+
# @return [String, nil]
|
|
1642
|
+
optional :ylpcid, String, nil?: true
|
|
1643
|
+
|
|
1615
1644
|
# @!attribute zip
|
|
1616
1645
|
# Any JSON value: string, number, boolean, array, object, or null.
|
|
1617
1646
|
#
|
|
1618
1647
|
# @return [String, Float, Boolean, Array<Object>, Hash{Symbol=>Object}, nil]
|
|
1619
1648
|
optional :zip, union: -> { OursprivacyIngest::TrackEventParams::UserProperties::Zip }, nil?: true
|
|
1620
1649
|
|
|
1621
|
-
# @!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, graid: nil, grclid: 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, ob_click_id: nil, oppref: 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, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, zip: nil)
|
|
1650
|
+
# @!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, graid: nil, grclid: 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, ob_click_id: nil, oppref: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, ttd_impression_id: 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, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, ylpcid: nil, zip: nil)
|
|
1622
1651
|
# Some parameter documentations has been truncated, see
|
|
1623
1652
|
# {OursprivacyIngest::Models::TrackEventParams::UserProperties} for more details.
|
|
1624
1653
|
#
|
|
@@ -1731,6 +1760,8 @@ module OursprivacyIngest
|
|
|
1731
1760
|
#
|
|
1732
1761
|
# @param ttclid [String, nil]
|
|
1733
1762
|
#
|
|
1763
|
+
# @param ttd_impression_id [String, nil] Leading and trailing whitespace is removed before validation.
|
|
1764
|
+
#
|
|
1734
1765
|
# @param twclid [String, nil]
|
|
1735
1766
|
#
|
|
1736
1767
|
# @param user_agent [String, nil]
|
|
@@ -1755,6 +1786,8 @@ module OursprivacyIngest
|
|
|
1755
1786
|
#
|
|
1756
1787
|
# @param wbraid [String, nil]
|
|
1757
1788
|
#
|
|
1789
|
+
# @param ylpcid [String, nil]
|
|
1790
|
+
#
|
|
1758
1791
|
# @param zip [String, Float, Boolean, Array<Object>, Hash{Symbol=>Object}, nil] Any JSON value: string, number, boolean, array, object, or null.
|
|
1759
1792
|
|
|
1760
1793
|
module Consent
|
|
@@ -423,6 +423,12 @@ module OursprivacyIngest
|
|
|
423
423
|
# @return [String, nil]
|
|
424
424
|
optional :ttclid, String, nil?: true
|
|
425
425
|
|
|
426
|
+
# @!attribute ttd_impression_id
|
|
427
|
+
# Leading and trailing whitespace is removed before validation.
|
|
428
|
+
#
|
|
429
|
+
# @return [String, nil]
|
|
430
|
+
optional :ttd_impression_id, String, nil?: true
|
|
431
|
+
|
|
426
432
|
# @!attribute twclid
|
|
427
433
|
#
|
|
428
434
|
# @return [String, nil]
|
|
@@ -497,13 +503,18 @@ module OursprivacyIngest
|
|
|
497
503
|
# @return [String, nil]
|
|
498
504
|
optional :wbraid, String, nil?: true
|
|
499
505
|
|
|
506
|
+
# @!attribute ylpcid
|
|
507
|
+
#
|
|
508
|
+
# @return [String, nil]
|
|
509
|
+
optional :ylpcid, String, nil?: true
|
|
510
|
+
|
|
500
511
|
# @!attribute zip
|
|
501
512
|
# Any JSON value: string, number, boolean, array, object, or null.
|
|
502
513
|
#
|
|
503
514
|
# @return [String, Float, Boolean, Array<Object>, Hash{Symbol=>Object}, nil]
|
|
504
515
|
optional :zip, union: -> { OursprivacyIngest::VisitorUpsertParams::UserProperties::Zip }, nil?: true
|
|
505
516
|
|
|
506
|
-
# @!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, graid: nil, grclid: 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, ob_click_id: nil, oppref: 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, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, zip: nil)
|
|
517
|
+
# @!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, graid: nil, grclid: 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, ob_click_id: nil, oppref: nil, phone_number: nil, qclid: nil, rdt_cid: nil, referrer: nil, referring_domain: nil, sacid: nil, sccid: nil, sid: nil, state: nil, ttclid: nil, ttd_impression_id: 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, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, ylpcid: nil, zip: nil)
|
|
507
518
|
# Some parameter documentations has been truncated, see
|
|
508
519
|
# {OursprivacyIngest::Models::VisitorUpsertParams::UserProperties} for more
|
|
509
520
|
# details.
|
|
@@ -618,6 +629,8 @@ module OursprivacyIngest
|
|
|
618
629
|
#
|
|
619
630
|
# @param ttclid [String, nil]
|
|
620
631
|
#
|
|
632
|
+
# @param ttd_impression_id [String, nil] Leading and trailing whitespace is removed before validation.
|
|
633
|
+
#
|
|
621
634
|
# @param twclid [String, nil]
|
|
622
635
|
#
|
|
623
636
|
# @param user_agent [String, nil]
|
|
@@ -642,6 +655,8 @@ module OursprivacyIngest
|
|
|
642
655
|
#
|
|
643
656
|
# @param wbraid [String, nil]
|
|
644
657
|
#
|
|
658
|
+
# @param ylpcid [String, nil]
|
|
659
|
+
#
|
|
645
660
|
# @param zip [String, Float, Boolean, Array<Object>, Hash{Symbol=>Object}, nil] Any JSON value: string, number, boolean, array, object, or null.
|
|
646
661
|
|
|
647
662
|
module Consent
|
|
@@ -1764,6 +1779,14 @@ module OursprivacyIngest
|
|
|
1764
1779
|
# @return [String, nil]
|
|
1765
1780
|
optional :ttclid, String, nil?: true
|
|
1766
1781
|
|
|
1782
|
+
# @!attribute ttd_impression_id
|
|
1783
|
+
# The Trade Desk impression ID, captured from a configured ttd_impression_id URL
|
|
1784
|
+
# parameter using the %%TTD_IMPRESSIONID%% creative macro. Sent as imp on
|
|
1785
|
+
# conversions. Leading and trailing whitespace is removed before validation.
|
|
1786
|
+
#
|
|
1787
|
+
# @return [String, nil]
|
|
1788
|
+
optional :ttd_impression_id, String, nil?: true
|
|
1789
|
+
|
|
1767
1790
|
# @!attribute twclid
|
|
1768
1791
|
# The Twitter Click ID. Ex: twclid123 Leading and trailing whitespace is removed
|
|
1769
1792
|
# before validation.
|
|
@@ -1864,7 +1887,13 @@ module OursprivacyIngest
|
|
|
1864
1887
|
# @return [Boolean, nil]
|
|
1865
1888
|
optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
|
|
1866
1889
|
|
|
1867
|
-
# @!
|
|
1890
|
+
# @!attribute ylpcid
|
|
1891
|
+
# The Yelp Click ID from the landing URL, sent unchanged and unhashed.
|
|
1892
|
+
#
|
|
1893
|
+
# @return [String, nil]
|
|
1894
|
+
optional :ylpcid, String, nil?: true
|
|
1895
|
+
|
|
1896
|
+
# @!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, graid: nil, grclid: 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, ob_click_id: nil, oppref: 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, ttd_impression_id: 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, viant_click_id: nil, viant_impression_id: nil, wbraid: nil, webview: nil, ylpcid: nil)
|
|
1868
1897
|
# Some parameter documentations has been truncated, see
|
|
1869
1898
|
# {OursprivacyIngest::Models::VisitorUpsertParams::DefaultProperties} for more
|
|
1870
1899
|
# details.
|
|
@@ -2006,6 +2035,8 @@ module OursprivacyIngest
|
|
|
2006
2035
|
#
|
|
2007
2036
|
# @param ttclid [String, nil] The TikTok Click ID. Ex: ttclid123 Leading and trailing whitespace is removed be
|
|
2008
2037
|
#
|
|
2038
|
+
# @param ttd_impression_id [String, nil] The Trade Desk impression ID, captured from a configured ttd_impression_id URL p
|
|
2039
|
+
#
|
|
2009
2040
|
# @param twclid [String, nil] The Twitter Click ID. Ex: twclid123 Leading and trailing whitespace is removed b
|
|
2010
2041
|
#
|
|
2011
2042
|
# @param uafvl [String, nil] User agent as a full list of strings. Leading and trailing whitespace is removed
|
|
@@ -2034,6 +2065,8 @@ module OursprivacyIngest
|
|
|
2034
2065
|
# @param wbraid [String, nil] The WBRAID Identifier. The web SDK automatically captures this from the query pa
|
|
2035
2066
|
#
|
|
2036
2067
|
# @param webview [Boolean, nil] Whether the user is in a webview. Ex: true
|
|
2068
|
+
#
|
|
2069
|
+
# @param ylpcid [String, nil] The Yelp Click ID from the landing URL, sent unchanged and unhashed.
|
|
2037
2070
|
|
|
2038
2071
|
# Any JSON value: string, number, boolean, array, object, or null.
|
|
2039
2072
|
#
|
|
@@ -13,8 +13,8 @@ module OursprivacyIngest
|
|
|
13
13
|
|
|
14
14
|
# @api private
|
|
15
15
|
sig do
|
|
16
|
-
params(ns: T.any(Module, T::Class[T.anything])).returns(
|
|
17
|
-
T::Enumerable[T.any(Module, T::Class[T.anything])]
|
|
16
|
+
params(ns: T.any(T::Module[T.anything], T::Class[T.anything])).returns(
|
|
17
|
+
T::Enumerable[T.any(T::Module[T.anything], T::Class[T.anything])]
|
|
18
18
|
)
|
|
19
19
|
end
|
|
20
20
|
def self.walk_namespaces(ns)
|