oursprivacy-ingest 0.3.0 → 0.4.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: a90c40966000a8a8596e6339eabdb71218ada7f9aefaa2c2b74a1fc1d9b204d8
4
- data.tar.gz: 66558ffc08b1c98e445c0c1b22f6fa570aab92f73288441c5d88290fe58a1ad1
3
+ metadata.gz: 338a6db802eed864a04718f0af20545fa170ab041a6fa567289679d123cb65e4
4
+ data.tar.gz: f483a6cdbd771fa24edb5c96cda88ca1bfc95271f48261e0d3a182e50d5e4cf2
5
5
  SHA512:
6
- metadata.gz: a021711f4667f143521e368d695bd0f7aabbb8e8d9e696824e53caadc4253634643a8178bd31be5bc3281ebbe2985fe9c67ee940b166ce73bc2c9f9017d974dd
7
- data.tar.gz: 6fdeeaa489bf03c71c42f3093a8da056e16db18cae5643b2898583e3ba6be2714bb16ca601de2d8e52c78799a337fd1fdd2aab833a7f6721fd18ae1e47ee0f5f
6
+ metadata.gz: a1dd070e8a94bffbfa4c9633e70d361ab048185b72480319745fe2959e6d67eccd742a30cff9569faa289874c5df52b11a03fed010c110a7758679f0e253f430
7
+ data.tar.gz: d32cc73c25c5d3cebac7098bdeb1fc1204ed9684ae3925a917ecb62f448cdefcaf30d426f8dfbfee629ed0eb51a4c50e0de9978f53e9ef623b9edbedc7773edd
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.4.0 (2025-12-11)
4
+
5
+ Full Changelog: [v0.3.0...v0.4.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v0.3.0...v0.4.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([5500b66](https://github.com/with-ours/ingest-sdk-ruby/commit/5500b667b8f79e0936853aed3d0bbd063fbfbfa8))
10
+ * **api:** api update ([128fa8b](https://github.com/with-ours/ingest-sdk-ruby/commit/128fa8b374d76c26ea54cb9f4235ec60be56571f))
11
+
3
12
  ## 0.3.0 (2025-11-21)
4
13
 
5
14
  Full Changelog: [v0.2.0...v0.3.0](https://github.com/with-ours/ingest-sdk-ruby/compare/v0.2.0...v0.3.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", "~> 0.3.0"
20
+ gem "oursprivacy-ingest", "~> 0.4.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -47,10 +47,9 @@ module OursprivacyIngest
47
47
  # @!attribute event_properties
48
48
  # Any additional event properties you want to pass along.
49
49
  #
50
- # @return [Hash{Symbol=>Object, nil}, nil]
50
+ # @return [Hash{Symbol=>String, nil}, nil]
51
51
  optional :event_properties,
52
- OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
53
- nil?: true],
52
+ OursprivacyIngest::Internal::Type::HashOf[String, nil?: true],
54
53
  api_name: :eventProperties,
55
54
  nil?: true
56
55
 
@@ -101,7 +100,7 @@ module OursprivacyIngest
101
100
  #
102
101
  # @param email [String, nil] The email address of a user. We will associate this event with the user or creat
103
102
  #
104
- # @param event_properties [Hash{Symbol=>Object, nil}, nil] Any additional event properties you want to pass along.
103
+ # @param event_properties [Hash{Symbol=>String, nil}, nil] Any additional event properties you want to pass along.
105
104
  #
106
105
  # @param external_id [String, nil] The externalId (the ID in your system) of a user. We will associate this event w
107
106
  #
@@ -133,6 +132,12 @@ module OursprivacyIngest
133
132
  # @return [String, nil]
134
133
  optional :adset_id, String, nil?: true
135
134
 
135
+ # @!attribute basis_cid
136
+ # The Basis DSP Click ID. Ex: basis_cid123
137
+ #
138
+ # @return [String, nil]
139
+ optional :basis_cid, String, nil?: true
140
+
136
141
  # @!attribute browser_language
137
142
  # The language of the browser. Ex: en-US
138
143
  #
@@ -293,6 +298,12 @@ module OursprivacyIngest
293
298
  # @return [Boolean, nil]
294
299
  optional :iframe, OursprivacyIngest::Internal::Type::Boolean, nil?: true
295
300
 
301
+ # @!attribute im_ref
302
+ # The Impact Click ID reference. Ex: im_ref123
303
+ #
304
+ # @return [String, nil]
305
+ optional :im_ref, String, nil?: true
306
+
296
307
  # @!attribute ip
297
308
  # The IP address of the user. Ex: 127.0.0.1
298
309
  #
@@ -309,8 +320,8 @@ module OursprivacyIngest
309
320
  # Whether we have detected that the user is a bot. This is set automatically by
310
321
  # the Ours server primarily for events tracked through the web SDK.
311
322
  #
312
- # @return [Object, nil]
313
- optional :is_bot, OursprivacyIngest::Internal::Type::Unknown
323
+ # @return [String, nil]
324
+ optional :is_bot, String, nil?: true
314
325
 
315
326
  # @!attribute li_fat_id
316
327
  # The LinkedIn Click ID. Ex: li_fat_id123
@@ -517,7 +528,7 @@ module OursprivacyIngest
517
528
  # @return [Boolean, nil]
518
529
  optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
519
530
 
520
- # @!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, 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)
531
+ # @!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)
521
532
  # Some parameter documentations has been truncated, see
522
533
  # {OursprivacyIngest::Models::TrackEventParams::DefaultProperties} for more
523
534
  # details.
@@ -531,6 +542,8 @@ module OursprivacyIngest
531
542
  #
532
543
  # @param adset_id [String, nil] The adset id for detected in the session. This is set by the web sdk automatical
533
544
  #
545
+ # @param basis_cid [String, nil] The Basis DSP Click ID. Ex: basis_cid123
546
+ #
534
547
  # @param browser_language [String, nil] The language of the browser. Ex: en-US
535
548
  #
536
549
  # @param browser_name [String, nil] The name of the browser. Ex: Chrome
@@ -583,11 +596,13 @@ module OursprivacyIngest
583
596
  #
584
597
  # @param iframe [Boolean, nil] Whether the user is in an iframe. Ex: true
585
598
  #
599
+ # @param im_ref [String, nil] The Impact Click ID reference. Ex: im_ref123
600
+ #
586
601
  # @param ip [String, nil] The IP address of the user. Ex: 127.0.0.1
587
602
  #
588
603
  # @param irclickid [String, nil] The Impact Click ID. Ex: irclickid123
589
604
  #
590
- # @param is_bot [Object] Whether we have detected that the user is a bot. This is set automatically by th
605
+ # @param is_bot [String, nil] Whether we have detected that the user is a bot. This is set automatically by th
591
606
  #
592
607
  # @param li_fat_id [String, nil] The LinkedIn Click ID. Ex: li_fat_id123
593
608
  #
@@ -669,6 +684,11 @@ module OursprivacyIngest
669
684
  # @return [String, nil]
670
685
  optional :adset_id, String, nil?: true
671
686
 
687
+ # @!attribute basis_cid
688
+ #
689
+ # @return [String, nil]
690
+ optional :basis_cid, String, nil?: true
691
+
672
692
  # @!attribute campaign_id
673
693
  #
674
694
  # @return [String, nil]
@@ -696,11 +716,8 @@ module OursprivacyIngest
696
716
 
697
717
  # @!attribute consent
698
718
  #
699
- # @return [Hash{Symbol=>Object, nil}, nil]
700
- optional :consent,
701
- OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
702
- nil?: true],
703
- nil?: true
719
+ # @return [Hash{Symbol=>String, nil}, nil]
720
+ optional :consent, OursprivacyIngest::Internal::Type::HashOf[String, nil?: true], nil?: true
704
721
 
705
722
  # @!attribute country
706
723
  #
@@ -709,11 +726,8 @@ module OursprivacyIngest
709
726
 
710
727
  # @!attribute custom_properties
711
728
  #
712
- # @return [Hash{Symbol=>Object, nil}, nil]
713
- optional :custom_properties,
714
- OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
715
- nil?: true],
716
- nil?: true
729
+ # @return [Hash{Symbol=>String, nil}, nil]
730
+ optional :custom_properties, OursprivacyIngest::Internal::Type::HashOf[String, nil?: true], nil?: true
717
731
 
718
732
  # @!attribute date_of_birth
719
733
  #
@@ -780,6 +794,11 @@ module OursprivacyIngest
780
794
  # @return [String, nil]
781
795
  optional :gender, String, nil?: true
782
796
 
797
+ # @!attribute im_ref
798
+ #
799
+ # @return [String, nil]
800
+ optional :im_ref, String, nil?: true
801
+
783
802
  # @!attribute ip
784
803
  # The IP address of the user
785
804
  #
@@ -793,8 +812,8 @@ module OursprivacyIngest
793
812
 
794
813
  # @!attribute is_bot
795
814
  #
796
- # @return [Object, nil]
797
- optional :is_bot, OursprivacyIngest::Internal::Type::Unknown
815
+ # @return [String, nil]
816
+ optional :is_bot, String, nil?: true
798
817
 
799
818
  # @!attribute job_title
800
819
  #
@@ -823,8 +842,8 @@ module OursprivacyIngest
823
842
 
824
843
  # @!attribute phone_number
825
844
  #
826
- # @return [Object, nil]
827
- optional :phone_number, OursprivacyIngest::Internal::Type::Unknown
845
+ # @return [String, nil]
846
+ optional :phone_number, String, nil?: true
828
847
 
829
848
  # @!attribute qclid
830
849
  #
@@ -923,10 +942,10 @@ module OursprivacyIngest
923
942
 
924
943
  # @!attribute zip
925
944
  #
926
- # @return [Object, nil]
927
- optional :zip, OursprivacyIngest::Internal::Type::Unknown
945
+ # @return [String, nil]
946
+ optional :zip, String, nil?: true
928
947
 
929
- # @!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, 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)
948
+ # @!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)
930
949
  # Properties to set on the visitor. (optional) You can also update these
931
950
  # properties via the identify endpoint.
932
951
  #
@@ -934,6 +953,8 @@ module OursprivacyIngest
934
953
  #
935
954
  # @param adset_id [String, nil]
936
955
  #
956
+ # @param basis_cid [String, nil]
957
+ #
937
958
  # @param campaign_id [String, nil]
938
959
  #
939
960
  # @param city [String, nil]
@@ -944,11 +965,11 @@ module OursprivacyIngest
944
965
  #
945
966
  # @param company_name [String, nil]
946
967
  #
947
- # @param consent [Hash{Symbol=>Object, nil}, nil]
968
+ # @param consent [Hash{Symbol=>String, nil}, nil]
948
969
  #
949
970
  # @param country [String, nil]
950
971
  #
951
- # @param custom_properties [Hash{Symbol=>Object, nil}, nil]
972
+ # @param custom_properties [Hash{Symbol=>String, nil}, nil]
952
973
  #
953
974
  # @param date_of_birth [String, nil]
954
975
  #
@@ -976,11 +997,13 @@ module OursprivacyIngest
976
997
  #
977
998
  # @param gender [String, nil]
978
999
  #
1000
+ # @param im_ref [String, nil]
1001
+ #
979
1002
  # @param ip [String, nil] The IP address of the user
980
1003
  #
981
1004
  # @param irclickid [String, nil]
982
1005
  #
983
- # @param is_bot [Object]
1006
+ # @param is_bot [String, nil]
984
1007
  #
985
1008
  # @param job_title [String, nil]
986
1009
  #
@@ -992,7 +1015,7 @@ module OursprivacyIngest
992
1015
  #
993
1016
  # @param ndclid [String, nil]
994
1017
  #
995
- # @param phone_number [Object]
1018
+ # @param phone_number [String, nil]
996
1019
  #
997
1020
  # @param qclid [String, nil]
998
1021
  #
@@ -1032,7 +1055,7 @@ module OursprivacyIngest
1032
1055
  #
1033
1056
  # @param wbraid [String, nil]
1034
1057
  #
1035
- # @param zip [Object]
1058
+ # @param zip [String, nil]
1036
1059
  end
1037
1060
  end
1038
1061
  end
@@ -86,6 +86,11 @@ module OursprivacyIngest
86
86
  # @return [String, nil]
87
87
  optional :adset_id, String, nil?: true
88
88
 
89
+ # @!attribute basis_cid
90
+ #
91
+ # @return [String, nil]
92
+ optional :basis_cid, String, nil?: true
93
+
89
94
  # @!attribute campaign_id
90
95
  #
91
96
  # @return [String, nil]
@@ -113,11 +118,8 @@ module OursprivacyIngest
113
118
 
114
119
  # @!attribute consent
115
120
  #
116
- # @return [Hash{Symbol=>Object, nil}, nil]
117
- optional :consent,
118
- OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
119
- nil?: true],
120
- nil?: true
121
+ # @return [Hash{Symbol=>String, nil}, nil]
122
+ optional :consent, OursprivacyIngest::Internal::Type::HashOf[String, nil?: true], nil?: true
121
123
 
122
124
  # @!attribute country
123
125
  #
@@ -126,11 +128,8 @@ module OursprivacyIngest
126
128
 
127
129
  # @!attribute custom_properties
128
130
  #
129
- # @return [Hash{Symbol=>Object, nil}, nil]
130
- optional :custom_properties,
131
- OursprivacyIngest::Internal::Type::HashOf[OursprivacyIngest::Internal::Type::Unknown,
132
- nil?: true],
133
- nil?: true
131
+ # @return [Hash{Symbol=>String, nil}, nil]
132
+ optional :custom_properties, OursprivacyIngest::Internal::Type::HashOf[String, nil?: true], nil?: true
134
133
 
135
134
  # @!attribute date_of_birth
136
135
  #
@@ -197,6 +196,11 @@ module OursprivacyIngest
197
196
  # @return [String, nil]
198
197
  optional :gender, String, nil?: true
199
198
 
199
+ # @!attribute im_ref
200
+ #
201
+ # @return [String, nil]
202
+ optional :im_ref, String, nil?: true
203
+
200
204
  # @!attribute ip
201
205
  # The IP address of the user
202
206
  #
@@ -210,8 +214,8 @@ module OursprivacyIngest
210
214
 
211
215
  # @!attribute is_bot
212
216
  #
213
- # @return [Object, nil]
214
- optional :is_bot, OursprivacyIngest::Internal::Type::Unknown
217
+ # @return [String, nil]
218
+ optional :is_bot, String, nil?: true
215
219
 
216
220
  # @!attribute job_title
217
221
  #
@@ -240,8 +244,8 @@ module OursprivacyIngest
240
244
 
241
245
  # @!attribute phone_number
242
246
  #
243
- # @return [Object, nil]
244
- optional :phone_number, OursprivacyIngest::Internal::Type::Unknown
247
+ # @return [String, nil]
248
+ optional :phone_number, String, nil?: true
245
249
 
246
250
  # @!attribute qclid
247
251
  #
@@ -340,10 +344,10 @@ module OursprivacyIngest
340
344
 
341
345
  # @!attribute zip
342
346
  #
343
- # @return [Object, nil]
344
- optional :zip, OursprivacyIngest::Internal::Type::Unknown
347
+ # @return [String, nil]
348
+ optional :zip, String, nil?: true
345
349
 
346
- # @!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, 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)
350
+ # @!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)
347
351
  # User properties to associate with this user. The existing user properties will
348
352
  # be updated. And all future events will have these properties associated with
349
353
  # them.
@@ -352,6 +356,8 @@ module OursprivacyIngest
352
356
  #
353
357
  # @param adset_id [String, nil]
354
358
  #
359
+ # @param basis_cid [String, nil]
360
+ #
355
361
  # @param campaign_id [String, nil]
356
362
  #
357
363
  # @param city [String, nil]
@@ -362,11 +368,11 @@ module OursprivacyIngest
362
368
  #
363
369
  # @param company_name [String, nil]
364
370
  #
365
- # @param consent [Hash{Symbol=>Object, nil}, nil]
371
+ # @param consent [Hash{Symbol=>String, nil}, nil]
366
372
  #
367
373
  # @param country [String, nil]
368
374
  #
369
- # @param custom_properties [Hash{Symbol=>Object, nil}, nil]
375
+ # @param custom_properties [Hash{Symbol=>String, nil}, nil]
370
376
  #
371
377
  # @param date_of_birth [String, nil]
372
378
  #
@@ -394,11 +400,13 @@ module OursprivacyIngest
394
400
  #
395
401
  # @param gender [String, nil]
396
402
  #
403
+ # @param im_ref [String, nil]
404
+ #
397
405
  # @param ip [String, nil] The IP address of the user
398
406
  #
399
407
  # @param irclickid [String, nil]
400
408
  #
401
- # @param is_bot [Object]
409
+ # @param is_bot [String, nil]
402
410
  #
403
411
  # @param job_title [String, nil]
404
412
  #
@@ -410,7 +418,7 @@ module OursprivacyIngest
410
418
  #
411
419
  # @param ndclid [String, nil]
412
420
  #
413
- # @param phone_number [Object]
421
+ # @param phone_number [String, nil]
414
422
  #
415
423
  # @param qclid [String, nil]
416
424
  #
@@ -450,7 +458,7 @@ module OursprivacyIngest
450
458
  #
451
459
  # @param wbraid [String, nil]
452
460
  #
453
- # @param zip [Object]
461
+ # @param zip [String, nil]
454
462
  end
455
463
 
456
464
  class DefaultProperties < OursprivacyIngest::Internal::Type::BaseModel
@@ -473,6 +481,12 @@ module OursprivacyIngest
473
481
  # @return [String, nil]
474
482
  optional :adset_id, String, nil?: true
475
483
 
484
+ # @!attribute basis_cid
485
+ # The Basis DSP Click ID. Ex: basis_cid123
486
+ #
487
+ # @return [String, nil]
488
+ optional :basis_cid, String, nil?: true
489
+
476
490
  # @!attribute browser_language
477
491
  # The language of the browser. Ex: en-US
478
492
  #
@@ -633,6 +647,12 @@ module OursprivacyIngest
633
647
  # @return [Boolean, nil]
634
648
  optional :iframe, OursprivacyIngest::Internal::Type::Boolean, nil?: true
635
649
 
650
+ # @!attribute im_ref
651
+ # The Impact Click ID reference. Ex: im_ref123
652
+ #
653
+ # @return [String, nil]
654
+ optional :im_ref, String, nil?: true
655
+
636
656
  # @!attribute ip
637
657
  # The IP address of the user. Ex: 127.0.0.1
638
658
  #
@@ -649,8 +669,8 @@ module OursprivacyIngest
649
669
  # Whether we have detected that the user is a bot. This is set automatically by
650
670
  # the Ours server primarily for events tracked through the web SDK.
651
671
  #
652
- # @return [Object, nil]
653
- optional :is_bot, OursprivacyIngest::Internal::Type::Unknown
672
+ # @return [String, nil]
673
+ optional :is_bot, String, nil?: true
654
674
 
655
675
  # @!attribute li_fat_id
656
676
  # The LinkedIn Click ID. Ex: li_fat_id123
@@ -857,7 +877,7 @@ module OursprivacyIngest
857
877
  # @return [Boolean, nil]
858
878
  optional :webview, OursprivacyIngest::Internal::Type::Boolean, nil?: true
859
879
 
860
- # @!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, 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)
880
+ # @!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)
861
881
  # Some parameter documentations has been truncated, see
862
882
  # {OursprivacyIngest::Models::VisitorUpsertParams::DefaultProperties} for more
863
883
  # details.
@@ -871,6 +891,8 @@ module OursprivacyIngest
871
891
  #
872
892
  # @param adset_id [String, nil] The adset id for detected in the session. This is set by the web sdk automatical
873
893
  #
894
+ # @param basis_cid [String, nil] The Basis DSP Click ID. Ex: basis_cid123
895
+ #
874
896
  # @param browser_language [String, nil] The language of the browser. Ex: en-US
875
897
  #
876
898
  # @param browser_name [String, nil] The name of the browser. Ex: Chrome
@@ -923,11 +945,13 @@ module OursprivacyIngest
923
945
  #
924
946
  # @param iframe [Boolean, nil] Whether the user is in an iframe. Ex: true
925
947
  #
948
+ # @param im_ref [String, nil] The Impact Click ID reference. Ex: im_ref123
949
+ #
926
950
  # @param ip [String, nil] The IP address of the user. Ex: 127.0.0.1
927
951
  #
928
952
  # @param irclickid [String, nil] The Impact Click ID. Ex: irclickid123
929
953
  #
930
- # @param is_bot [Object] Whether we have detected that the user is a bot. This is set automatically by th
954
+ # @param is_bot [String, nil] Whether we have detected that the user is a bot. This is set automatically by th
931
955
  #
932
956
  # @param li_fat_id [String, nil] The LinkedIn Click ID. Ex: li_fat_id123
933
957
  #
@@ -23,7 +23,7 @@ module OursprivacyIngest
23
23
  #
24
24
  # @param email [String, nil] The email address of a user. We will associate this event with the user or creat
25
25
  #
26
- # @param event_properties [Hash{Symbol=>Object, nil}, nil] Any additional event properties you want to pass along.
26
+ # @param event_properties [Hash{Symbol=>String, nil}, nil] Any additional event properties you want to pass along.
27
27
  #
28
28
  # @param external_id [String, nil] The externalId (the ID in your system) of a user. We will associate this event w
29
29
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module OursprivacyIngest
4
- VERSION = "0.3.0"
4
+ VERSION = "0.4.0"
5
5
  end