safetykit 0.31.0 → 0.32.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 +8 -0
- data/README.md +1 -1
- data/lib/safety_kit/models/async_create_async_params.rb +1315 -419
- data/lib/safety_kit/models/beta/event_create_params.rb +1315 -419
- data/lib/safety_kit/version.rb +1 -1
- data/rbi/safety_kit/models/async_create_async_params.rbi +2316 -496
- data/rbi/safety_kit/models/beta/event_create_params.rbi +2311 -477
- data/sig/safety_kit/models/async_create_async_params.rbs +826 -168
- data/sig/safety_kit/models/beta/event_create_params.rbs +826 -168
- metadata +1 -1
|
@@ -126,12 +126,12 @@ module SafetyKit
|
|
|
126
126
|
|
|
127
127
|
# @!attribute resources_used
|
|
128
128
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
129
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
130
|
-
# identifiers.
|
|
129
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
130
|
+
# caller-defined ids, or similar identifiers.
|
|
131
131
|
#
|
|
132
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed>, nil]
|
|
132
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::UnionMember1>, nil]
|
|
133
133
|
optional :resources_used,
|
|
134
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed] }
|
|
134
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed] }
|
|
135
135
|
|
|
136
136
|
# @!method initialize(event_name:, target_user_id:, timestamp:, type:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
137
137
|
# Some parameter documentations has been truncated, see
|
|
@@ -160,7 +160,7 @@ module SafetyKit
|
|
|
160
160
|
#
|
|
161
161
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
162
162
|
#
|
|
163
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
163
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
164
164
|
|
|
165
165
|
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest#type
|
|
166
166
|
module Type
|
|
@@ -355,32 +355,96 @@ module SafetyKit
|
|
|
355
355
|
}]
|
|
356
356
|
end
|
|
357
357
|
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
362
|
-
#
|
|
363
|
-
# @return [String]
|
|
364
|
-
required :type, String
|
|
358
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
359
|
+
module ResourcesUsed
|
|
360
|
+
extend SafetyKit::Internal::Type::Union
|
|
365
361
|
|
|
366
|
-
#
|
|
367
|
-
|
|
368
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
369
|
-
#
|
|
370
|
-
# @return [String]
|
|
371
|
-
required :value, String
|
|
362
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
363
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource }
|
|
372
364
|
|
|
373
|
-
#
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
365
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
366
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::UnionMember1 }
|
|
367
|
+
|
|
368
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
369
|
+
# @!attribute namespace
|
|
370
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
371
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
372
|
+
#
|
|
373
|
+
# @return [String]
|
|
374
|
+
required :namespace, String
|
|
375
|
+
|
|
376
|
+
# @!attribute type
|
|
377
|
+
# Caller-defined entity identifier resource.
|
|
378
|
+
#
|
|
379
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource::Type]
|
|
380
|
+
required :type,
|
|
381
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource::Type }
|
|
382
|
+
|
|
383
|
+
# @!attribute value
|
|
384
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
385
|
+
# encoded namespace/value pair, not the raw value.
|
|
386
|
+
#
|
|
387
|
+
# @return [String]
|
|
388
|
+
required :value, String
|
|
389
|
+
|
|
390
|
+
# @!method initialize(namespace:, type:, value:)
|
|
391
|
+
# Some parameter documentations has been truncated, see
|
|
392
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource}
|
|
393
|
+
# for more details.
|
|
394
|
+
#
|
|
395
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
396
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
397
|
+
#
|
|
398
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
399
|
+
#
|
|
400
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
401
|
+
#
|
|
402
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
403
|
+
|
|
404
|
+
# Caller-defined entity identifier resource.
|
|
405
|
+
#
|
|
406
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource#type
|
|
407
|
+
module Type
|
|
408
|
+
extend SafetyKit::Internal::Type::Enum
|
|
409
|
+
|
|
410
|
+
ID = :id
|
|
411
|
+
|
|
412
|
+
# @!method self.values
|
|
413
|
+
# @return [Array<Symbol>]
|
|
414
|
+
end
|
|
415
|
+
end
|
|
416
|
+
|
|
417
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
418
|
+
# @!attribute type
|
|
419
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
420
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
421
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
422
|
+
#
|
|
423
|
+
# @return [String]
|
|
424
|
+
required :type, String
|
|
425
|
+
|
|
426
|
+
# @!attribute value
|
|
427
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
428
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
429
|
+
#
|
|
430
|
+
# @return [String]
|
|
431
|
+
required :value, String
|
|
432
|
+
|
|
433
|
+
# @!method initialize(type:, value:)
|
|
434
|
+
# Some parameter documentations has been truncated, see
|
|
435
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::UnionMember1}
|
|
436
|
+
# for more details.
|
|
437
|
+
#
|
|
438
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
439
|
+
# number, address, URL, social handle, or payment identifier.
|
|
440
|
+
#
|
|
441
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
442
|
+
#
|
|
443
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
444
|
+
end
|
|
445
|
+
|
|
446
|
+
# @!method self.variants
|
|
447
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest::ResourcesUsed::UnionMember1)]
|
|
384
448
|
end
|
|
385
449
|
end
|
|
386
450
|
|
|
@@ -450,12 +514,12 @@ module SafetyKit
|
|
|
450
514
|
|
|
451
515
|
# @!attribute resources_used
|
|
452
516
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
453
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
454
|
-
# identifiers.
|
|
517
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
518
|
+
# caller-defined ids, or similar identifiers.
|
|
455
519
|
#
|
|
456
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed>, nil]
|
|
520
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::UnionMember1>, nil]
|
|
457
521
|
optional :resources_used,
|
|
458
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed] }
|
|
522
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed] }
|
|
459
523
|
|
|
460
524
|
# @!method initialize(content:, event_name:, timestamp:, type:, user_id:, client_info: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
461
525
|
# Some parameter documentations has been truncated, see
|
|
@@ -482,7 +546,7 @@ module SafetyKit
|
|
|
482
546
|
#
|
|
483
547
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
484
548
|
#
|
|
485
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
549
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
486
550
|
|
|
487
551
|
# User-authored text content associated with an event.
|
|
488
552
|
module Content
|
|
@@ -677,32 +741,96 @@ module SafetyKit
|
|
|
677
741
|
]
|
|
678
742
|
end
|
|
679
743
|
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
684
|
-
#
|
|
685
|
-
# @return [String]
|
|
686
|
-
required :type, String
|
|
744
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
745
|
+
module ResourcesUsed
|
|
746
|
+
extend SafetyKit::Internal::Type::Union
|
|
687
747
|
|
|
688
|
-
#
|
|
689
|
-
|
|
690
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
691
|
-
#
|
|
692
|
-
# @return [String]
|
|
693
|
-
required :value, String
|
|
748
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
749
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::EntityIDResource }
|
|
694
750
|
|
|
695
|
-
#
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
751
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
752
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::UnionMember1 }
|
|
753
|
+
|
|
754
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
755
|
+
# @!attribute namespace
|
|
756
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
757
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
758
|
+
#
|
|
759
|
+
# @return [String]
|
|
760
|
+
required :namespace, String
|
|
761
|
+
|
|
762
|
+
# @!attribute type
|
|
763
|
+
# Caller-defined entity identifier resource.
|
|
764
|
+
#
|
|
765
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::EntityIDResource::Type]
|
|
766
|
+
required :type,
|
|
767
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::EntityIDResource::Type }
|
|
768
|
+
|
|
769
|
+
# @!attribute value
|
|
770
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
771
|
+
# encoded namespace/value pair, not the raw value.
|
|
772
|
+
#
|
|
773
|
+
# @return [String]
|
|
774
|
+
required :value, String
|
|
775
|
+
|
|
776
|
+
# @!method initialize(namespace:, type:, value:)
|
|
777
|
+
# Some parameter documentations has been truncated, see
|
|
778
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::EntityIDResource}
|
|
779
|
+
# for more details.
|
|
780
|
+
#
|
|
781
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
782
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
783
|
+
#
|
|
784
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
785
|
+
#
|
|
786
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
787
|
+
#
|
|
788
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
789
|
+
|
|
790
|
+
# Caller-defined entity identifier resource.
|
|
791
|
+
#
|
|
792
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::EntityIDResource#type
|
|
793
|
+
module Type
|
|
794
|
+
extend SafetyKit::Internal::Type::Enum
|
|
795
|
+
|
|
796
|
+
ID = :id
|
|
797
|
+
|
|
798
|
+
# @!method self.values
|
|
799
|
+
# @return [Array<Symbol>]
|
|
800
|
+
end
|
|
801
|
+
end
|
|
802
|
+
|
|
803
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
804
|
+
# @!attribute type
|
|
805
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
806
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
807
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
808
|
+
#
|
|
809
|
+
# @return [String]
|
|
810
|
+
required :type, String
|
|
811
|
+
|
|
812
|
+
# @!attribute value
|
|
813
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
814
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
815
|
+
#
|
|
816
|
+
# @return [String]
|
|
817
|
+
required :value, String
|
|
818
|
+
|
|
819
|
+
# @!method initialize(type:, value:)
|
|
820
|
+
# Some parameter documentations has been truncated, see
|
|
821
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::UnionMember1}
|
|
822
|
+
# for more details.
|
|
823
|
+
#
|
|
824
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
825
|
+
# number, address, URL, social handle, or payment identifier.
|
|
826
|
+
#
|
|
827
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
828
|
+
#
|
|
829
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
830
|
+
end
|
|
831
|
+
|
|
832
|
+
# @!method self.variants
|
|
833
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest::ResourcesUsed::UnionMember1)]
|
|
706
834
|
end
|
|
707
835
|
end
|
|
708
836
|
|
|
@@ -778,12 +906,12 @@ module SafetyKit
|
|
|
778
906
|
|
|
779
907
|
# @!attribute resources_used
|
|
780
908
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
781
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
782
|
-
# identifiers.
|
|
909
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
910
|
+
# caller-defined ids, or similar identifiers.
|
|
783
911
|
#
|
|
784
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed>, nil]
|
|
912
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::UnionMember1>, nil]
|
|
785
913
|
optional :resources_used,
|
|
786
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed] }
|
|
914
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed] }
|
|
787
915
|
|
|
788
916
|
# @!method initialize(content:, event_name:, product:, timestamp:, type:, user_id:, client_info: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
789
917
|
# Some parameter documentations has been truncated, see
|
|
@@ -812,7 +940,7 @@ module SafetyKit
|
|
|
812
940
|
#
|
|
813
941
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
814
942
|
#
|
|
815
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
943
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
816
944
|
|
|
817
945
|
# User-authored text content associated with an event.
|
|
818
946
|
module Content
|
|
@@ -1119,32 +1247,96 @@ module SafetyKit
|
|
|
1119
1247
|
}]
|
|
1120
1248
|
end
|
|
1121
1249
|
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
1126
|
-
#
|
|
1127
|
-
# @return [String]
|
|
1128
|
-
required :type, String
|
|
1250
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
1251
|
+
module ResourcesUsed
|
|
1252
|
+
extend SafetyKit::Internal::Type::Union
|
|
1129
1253
|
|
|
1130
|
-
#
|
|
1131
|
-
|
|
1132
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1133
|
-
#
|
|
1134
|
-
# @return [String]
|
|
1135
|
-
required :value, String
|
|
1254
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
1255
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::EntityIDResource }
|
|
1136
1256
|
|
|
1137
|
-
#
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1257
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
1258
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::UnionMember1 }
|
|
1259
|
+
|
|
1260
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
1261
|
+
# @!attribute namespace
|
|
1262
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
1263
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
1264
|
+
#
|
|
1265
|
+
# @return [String]
|
|
1266
|
+
required :namespace, String
|
|
1267
|
+
|
|
1268
|
+
# @!attribute type
|
|
1269
|
+
# Caller-defined entity identifier resource.
|
|
1270
|
+
#
|
|
1271
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::EntityIDResource::Type]
|
|
1272
|
+
required :type,
|
|
1273
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::EntityIDResource::Type }
|
|
1274
|
+
|
|
1275
|
+
# @!attribute value
|
|
1276
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
1277
|
+
# encoded namespace/value pair, not the raw value.
|
|
1278
|
+
#
|
|
1279
|
+
# @return [String]
|
|
1280
|
+
required :value, String
|
|
1281
|
+
|
|
1282
|
+
# @!method initialize(namespace:, type:, value:)
|
|
1283
|
+
# Some parameter documentations has been truncated, see
|
|
1284
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::EntityIDResource}
|
|
1285
|
+
# for more details.
|
|
1286
|
+
#
|
|
1287
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
1288
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
1289
|
+
#
|
|
1290
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
1291
|
+
#
|
|
1292
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
1293
|
+
#
|
|
1294
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
1295
|
+
|
|
1296
|
+
# Caller-defined entity identifier resource.
|
|
1297
|
+
#
|
|
1298
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::EntityIDResource#type
|
|
1299
|
+
module Type
|
|
1300
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1301
|
+
|
|
1302
|
+
ID = :id
|
|
1303
|
+
|
|
1304
|
+
# @!method self.values
|
|
1305
|
+
# @return [Array<Symbol>]
|
|
1306
|
+
end
|
|
1307
|
+
end
|
|
1308
|
+
|
|
1309
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
1310
|
+
# @!attribute type
|
|
1311
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
1312
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
1313
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
1314
|
+
#
|
|
1315
|
+
# @return [String]
|
|
1316
|
+
required :type, String
|
|
1317
|
+
|
|
1318
|
+
# @!attribute value
|
|
1319
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1320
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1321
|
+
#
|
|
1322
|
+
# @return [String]
|
|
1323
|
+
required :value, String
|
|
1324
|
+
|
|
1325
|
+
# @!method initialize(type:, value:)
|
|
1326
|
+
# Some parameter documentations has been truncated, see
|
|
1327
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::UnionMember1}
|
|
1328
|
+
# for more details.
|
|
1329
|
+
#
|
|
1330
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
1331
|
+
# number, address, URL, social handle, or payment identifier.
|
|
1332
|
+
#
|
|
1333
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
1334
|
+
#
|
|
1335
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1336
|
+
end
|
|
1337
|
+
|
|
1338
|
+
# @!method self.variants
|
|
1339
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed::UnionMember1)]
|
|
1148
1340
|
end
|
|
1149
1341
|
end
|
|
1150
1342
|
|
|
@@ -1214,12 +1406,12 @@ module SafetyKit
|
|
|
1214
1406
|
|
|
1215
1407
|
# @!attribute resources_used
|
|
1216
1408
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1217
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
1218
|
-
# identifiers.
|
|
1409
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
1410
|
+
# caller-defined ids, or similar identifiers.
|
|
1219
1411
|
#
|
|
1220
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>, nil]
|
|
1412
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::UnionMember1>, nil]
|
|
1221
1413
|
optional :resources_used,
|
|
1222
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed] }
|
|
1414
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed] }
|
|
1223
1415
|
|
|
1224
1416
|
# @!method initialize(event_name:, timestamp:, type:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
1225
1417
|
# Some parameter documentations has been truncated, see
|
|
@@ -1246,7 +1438,7 @@ module SafetyKit
|
|
|
1246
1438
|
#
|
|
1247
1439
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1248
1440
|
#
|
|
1249
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1441
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1250
1442
|
|
|
1251
1443
|
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest#type
|
|
1252
1444
|
module Type
|
|
@@ -1441,32 +1633,96 @@ module SafetyKit
|
|
|
1441
1633
|
}]
|
|
1442
1634
|
end
|
|
1443
1635
|
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
1448
|
-
#
|
|
1449
|
-
# @return [String]
|
|
1450
|
-
required :type, String
|
|
1636
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
1637
|
+
module ResourcesUsed
|
|
1638
|
+
extend SafetyKit::Internal::Type::Union
|
|
1451
1639
|
|
|
1452
|
-
#
|
|
1453
|
-
|
|
1454
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1455
|
-
#
|
|
1456
|
-
# @return [String]
|
|
1457
|
-
required :value, String
|
|
1640
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
1641
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::EntityIDResource }
|
|
1458
1642
|
|
|
1459
|
-
#
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1643
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
1644
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::UnionMember1 }
|
|
1645
|
+
|
|
1646
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
1647
|
+
# @!attribute namespace
|
|
1648
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
1649
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
1650
|
+
#
|
|
1651
|
+
# @return [String]
|
|
1652
|
+
required :namespace, String
|
|
1653
|
+
|
|
1654
|
+
# @!attribute type
|
|
1655
|
+
# Caller-defined entity identifier resource.
|
|
1656
|
+
#
|
|
1657
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::EntityIDResource::Type]
|
|
1658
|
+
required :type,
|
|
1659
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::EntityIDResource::Type }
|
|
1660
|
+
|
|
1661
|
+
# @!attribute value
|
|
1662
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
1663
|
+
# encoded namespace/value pair, not the raw value.
|
|
1664
|
+
#
|
|
1665
|
+
# @return [String]
|
|
1666
|
+
required :value, String
|
|
1667
|
+
|
|
1668
|
+
# @!method initialize(namespace:, type:, value:)
|
|
1669
|
+
# Some parameter documentations has been truncated, see
|
|
1670
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::EntityIDResource}
|
|
1671
|
+
# for more details.
|
|
1672
|
+
#
|
|
1673
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
1674
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
1675
|
+
#
|
|
1676
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
1677
|
+
#
|
|
1678
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
1679
|
+
#
|
|
1680
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
1681
|
+
|
|
1682
|
+
# Caller-defined entity identifier resource.
|
|
1683
|
+
#
|
|
1684
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::EntityIDResource#type
|
|
1685
|
+
module Type
|
|
1686
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1687
|
+
|
|
1688
|
+
ID = :id
|
|
1689
|
+
|
|
1690
|
+
# @!method self.values
|
|
1691
|
+
# @return [Array<Symbol>]
|
|
1692
|
+
end
|
|
1693
|
+
end
|
|
1694
|
+
|
|
1695
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
1696
|
+
# @!attribute type
|
|
1697
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
1698
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
1699
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
1700
|
+
#
|
|
1701
|
+
# @return [String]
|
|
1702
|
+
required :type, String
|
|
1703
|
+
|
|
1704
|
+
# @!attribute value
|
|
1705
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1706
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1707
|
+
#
|
|
1708
|
+
# @return [String]
|
|
1709
|
+
required :value, String
|
|
1710
|
+
|
|
1711
|
+
# @!method initialize(type:, value:)
|
|
1712
|
+
# Some parameter documentations has been truncated, see
|
|
1713
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::UnionMember1}
|
|
1714
|
+
# for more details.
|
|
1715
|
+
#
|
|
1716
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
1717
|
+
# number, address, URL, social handle, or payment identifier.
|
|
1718
|
+
#
|
|
1719
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
1720
|
+
#
|
|
1721
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1722
|
+
end
|
|
1723
|
+
|
|
1724
|
+
# @!method self.variants
|
|
1725
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed::UnionMember1)]
|
|
1470
1726
|
end
|
|
1471
1727
|
end
|
|
1472
1728
|
|
|
@@ -1536,12 +1792,12 @@ module SafetyKit
|
|
|
1536
1792
|
|
|
1537
1793
|
# @!attribute resources_used
|
|
1538
1794
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1539
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
1540
|
-
# identifiers.
|
|
1795
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
1796
|
+
# caller-defined ids, or similar identifiers.
|
|
1541
1797
|
#
|
|
1542
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>, nil]
|
|
1798
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::UnionMember1>, nil]
|
|
1543
1799
|
optional :resources_used,
|
|
1544
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed] }
|
|
1800
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed] }
|
|
1545
1801
|
|
|
1546
1802
|
# @!method initialize(event_name:, timestamp:, type:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
1547
1803
|
# Some parameter documentations has been truncated, see
|
|
@@ -1569,7 +1825,7 @@ module SafetyKit
|
|
|
1569
1825
|
#
|
|
1570
1826
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1571
1827
|
#
|
|
1572
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1828
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1573
1829
|
|
|
1574
1830
|
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest#type
|
|
1575
1831
|
module Type
|
|
@@ -1764,32 +2020,96 @@ module SafetyKit
|
|
|
1764
2020
|
}]
|
|
1765
2021
|
end
|
|
1766
2022
|
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
1771
|
-
#
|
|
1772
|
-
# @return [String]
|
|
1773
|
-
required :type, String
|
|
2023
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
2024
|
+
module ResourcesUsed
|
|
2025
|
+
extend SafetyKit::Internal::Type::Union
|
|
1774
2026
|
|
|
1775
|
-
#
|
|
1776
|
-
|
|
1777
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1778
|
-
#
|
|
1779
|
-
# @return [String]
|
|
1780
|
-
required :value, String
|
|
2027
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
2028
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::EntityIDResource }
|
|
1781
2029
|
|
|
1782
|
-
#
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
2030
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
2031
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::UnionMember1 }
|
|
2032
|
+
|
|
2033
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
2034
|
+
# @!attribute namespace
|
|
2035
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
2036
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
2037
|
+
#
|
|
2038
|
+
# @return [String]
|
|
2039
|
+
required :namespace, String
|
|
2040
|
+
|
|
2041
|
+
# @!attribute type
|
|
2042
|
+
# Caller-defined entity identifier resource.
|
|
2043
|
+
#
|
|
2044
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::EntityIDResource::Type]
|
|
2045
|
+
required :type,
|
|
2046
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::EntityIDResource::Type }
|
|
2047
|
+
|
|
2048
|
+
# @!attribute value
|
|
2049
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
2050
|
+
# encoded namespace/value pair, not the raw value.
|
|
2051
|
+
#
|
|
2052
|
+
# @return [String]
|
|
2053
|
+
required :value, String
|
|
2054
|
+
|
|
2055
|
+
# @!method initialize(namespace:, type:, value:)
|
|
2056
|
+
# Some parameter documentations has been truncated, see
|
|
2057
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::EntityIDResource}
|
|
2058
|
+
# for more details.
|
|
2059
|
+
#
|
|
2060
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
2061
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
2062
|
+
#
|
|
2063
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
2064
|
+
#
|
|
2065
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
2066
|
+
#
|
|
2067
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
2068
|
+
|
|
2069
|
+
# Caller-defined entity identifier resource.
|
|
2070
|
+
#
|
|
2071
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::EntityIDResource#type
|
|
2072
|
+
module Type
|
|
2073
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2074
|
+
|
|
2075
|
+
ID = :id
|
|
2076
|
+
|
|
2077
|
+
# @!method self.values
|
|
2078
|
+
# @return [Array<Symbol>]
|
|
2079
|
+
end
|
|
2080
|
+
end
|
|
2081
|
+
|
|
2082
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
2083
|
+
# @!attribute type
|
|
2084
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
2085
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
2086
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
2087
|
+
#
|
|
2088
|
+
# @return [String]
|
|
2089
|
+
required :type, String
|
|
2090
|
+
|
|
2091
|
+
# @!attribute value
|
|
2092
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2093
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2094
|
+
#
|
|
2095
|
+
# @return [String]
|
|
2096
|
+
required :value, String
|
|
2097
|
+
|
|
2098
|
+
# @!method initialize(type:, value:)
|
|
2099
|
+
# Some parameter documentations has been truncated, see
|
|
2100
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::UnionMember1}
|
|
2101
|
+
# for more details.
|
|
2102
|
+
#
|
|
2103
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
2104
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2105
|
+
#
|
|
2106
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
2107
|
+
#
|
|
2108
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2109
|
+
end
|
|
2110
|
+
|
|
2111
|
+
# @!method self.variants
|
|
2112
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed::UnionMember1)]
|
|
1793
2113
|
end
|
|
1794
2114
|
end
|
|
1795
2115
|
|
|
@@ -1864,12 +2184,12 @@ module SafetyKit
|
|
|
1864
2184
|
|
|
1865
2185
|
# @!attribute resources_used
|
|
1866
2186
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1867
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
1868
|
-
# identifiers.
|
|
2187
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
2188
|
+
# caller-defined ids, or similar identifiers.
|
|
1869
2189
|
#
|
|
1870
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed>, nil]
|
|
2190
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::UnionMember1>, nil]
|
|
1871
2191
|
optional :resources_used,
|
|
1872
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed] }
|
|
2192
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed] }
|
|
1873
2193
|
|
|
1874
2194
|
# @!attribute target_content_id
|
|
1875
2195
|
# Your stable identifier for the content being reported.
|
|
@@ -1913,7 +2233,7 @@ module SafetyKit
|
|
|
1913
2233
|
#
|
|
1914
2234
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1915
2235
|
#
|
|
1916
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2236
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1917
2237
|
#
|
|
1918
2238
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
1919
2239
|
#
|
|
@@ -2098,46 +2418,110 @@ module SafetyKit
|
|
|
2098
2418
|
|
|
2099
2419
|
variant SafetyKit::Internal::Type::Boolean
|
|
2100
2420
|
|
|
2101
|
-
# @!method self.variants
|
|
2102
|
-
# @return [Array(String, Float, Boolean)]
|
|
2421
|
+
# @!method self.variants
|
|
2422
|
+
# @return [Array(String, Float, Boolean)]
|
|
2423
|
+
end
|
|
2424
|
+
|
|
2425
|
+
# @!method self.variants
|
|
2426
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
2427
|
+
|
|
2428
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
2429
|
+
UnionMember3Array =
|
|
2430
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
2431
|
+
SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata::UnionMember3
|
|
2432
|
+
}]
|
|
2433
|
+
end
|
|
2434
|
+
|
|
2435
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
2436
|
+
module ResourcesUsed
|
|
2437
|
+
extend SafetyKit::Internal::Type::Union
|
|
2438
|
+
|
|
2439
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
2440
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::EntityIDResource }
|
|
2441
|
+
|
|
2442
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
2443
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::UnionMember1 }
|
|
2444
|
+
|
|
2445
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
2446
|
+
# @!attribute namespace
|
|
2447
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
2448
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
2449
|
+
#
|
|
2450
|
+
# @return [String]
|
|
2451
|
+
required :namespace, String
|
|
2452
|
+
|
|
2453
|
+
# @!attribute type
|
|
2454
|
+
# Caller-defined entity identifier resource.
|
|
2455
|
+
#
|
|
2456
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::EntityIDResource::Type]
|
|
2457
|
+
required :type,
|
|
2458
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::EntityIDResource::Type }
|
|
2459
|
+
|
|
2460
|
+
# @!attribute value
|
|
2461
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
2462
|
+
# encoded namespace/value pair, not the raw value.
|
|
2463
|
+
#
|
|
2464
|
+
# @return [String]
|
|
2465
|
+
required :value, String
|
|
2466
|
+
|
|
2467
|
+
# @!method initialize(namespace:, type:, value:)
|
|
2468
|
+
# Some parameter documentations has been truncated, see
|
|
2469
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::EntityIDResource}
|
|
2470
|
+
# for more details.
|
|
2471
|
+
#
|
|
2472
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
2473
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
2474
|
+
#
|
|
2475
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
2476
|
+
#
|
|
2477
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
2478
|
+
#
|
|
2479
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
2480
|
+
|
|
2481
|
+
# Caller-defined entity identifier resource.
|
|
2482
|
+
#
|
|
2483
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::EntityIDResource#type
|
|
2484
|
+
module Type
|
|
2485
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2486
|
+
|
|
2487
|
+
ID = :id
|
|
2488
|
+
|
|
2489
|
+
# @!method self.values
|
|
2490
|
+
# @return [Array<Symbol>]
|
|
2491
|
+
end
|
|
2492
|
+
end
|
|
2493
|
+
|
|
2494
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
2495
|
+
# @!attribute type
|
|
2496
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
2497
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
2498
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
2499
|
+
#
|
|
2500
|
+
# @return [String]
|
|
2501
|
+
required :type, String
|
|
2502
|
+
|
|
2503
|
+
# @!attribute value
|
|
2504
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2505
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2506
|
+
#
|
|
2507
|
+
# @return [String]
|
|
2508
|
+
required :value, String
|
|
2509
|
+
|
|
2510
|
+
# @!method initialize(type:, value:)
|
|
2511
|
+
# Some parameter documentations has been truncated, see
|
|
2512
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::UnionMember1}
|
|
2513
|
+
# for more details.
|
|
2514
|
+
#
|
|
2515
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
2516
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2517
|
+
#
|
|
2518
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
2519
|
+
#
|
|
2520
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2103
2521
|
end
|
|
2104
2522
|
|
|
2105
2523
|
# @!method self.variants
|
|
2106
|
-
# @return [Array(
|
|
2107
|
-
|
|
2108
|
-
# @type [SafetyKit::Internal::Type::Converter]
|
|
2109
|
-
UnionMember3Array =
|
|
2110
|
-
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
2111
|
-
SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata::UnionMember3
|
|
2112
|
-
}]
|
|
2113
|
-
end
|
|
2114
|
-
|
|
2115
|
-
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
2116
|
-
# @!attribute type
|
|
2117
|
-
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
2118
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
2119
|
-
#
|
|
2120
|
-
# @return [String]
|
|
2121
|
-
required :type, String
|
|
2122
|
-
|
|
2123
|
-
# @!attribute value
|
|
2124
|
-
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2125
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2126
|
-
#
|
|
2127
|
-
# @return [String]
|
|
2128
|
-
required :value, String
|
|
2129
|
-
|
|
2130
|
-
# @!method initialize(type:, value:)
|
|
2131
|
-
# Some parameter documentations has been truncated, see
|
|
2132
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed}
|
|
2133
|
-
# for more details.
|
|
2134
|
-
#
|
|
2135
|
-
# Real-world or account resource used during the event, such as an email, phone
|
|
2136
|
-
# number, address, URL, social handle, or payment identifier.
|
|
2137
|
-
#
|
|
2138
|
-
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
2139
|
-
#
|
|
2140
|
-
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2524
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed::UnionMember1)]
|
|
2141
2525
|
end
|
|
2142
2526
|
end
|
|
2143
2527
|
|
|
@@ -2227,12 +2611,12 @@ module SafetyKit
|
|
|
2227
2611
|
|
|
2228
2612
|
# @!attribute resources_used
|
|
2229
2613
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2230
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
2231
|
-
# identifiers.
|
|
2614
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
2615
|
+
# caller-defined ids, or similar identifiers.
|
|
2232
2616
|
#
|
|
2233
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed>, nil]
|
|
2617
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1>, nil]
|
|
2234
2618
|
optional :resources_used,
|
|
2235
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed] }
|
|
2619
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed] }
|
|
2236
2620
|
|
|
2237
2621
|
# @!attribute target_content_id
|
|
2238
2622
|
# Your stable identifier for the content being reported.
|
|
@@ -2277,7 +2661,7 @@ module SafetyKit
|
|
|
2277
2661
|
#
|
|
2278
2662
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2279
2663
|
#
|
|
2280
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2664
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2281
2665
|
#
|
|
2282
2666
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
2283
2667
|
#
|
|
@@ -2495,32 +2879,96 @@ module SafetyKit
|
|
|
2495
2879
|
]
|
|
2496
2880
|
end
|
|
2497
2881
|
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
2502
|
-
#
|
|
2503
|
-
# @return [String]
|
|
2504
|
-
required :type, String
|
|
2882
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
2883
|
+
module ResourcesUsed
|
|
2884
|
+
extend SafetyKit::Internal::Type::Union
|
|
2505
2885
|
|
|
2506
|
-
#
|
|
2507
|
-
|
|
2508
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2509
|
-
#
|
|
2510
|
-
# @return [String]
|
|
2511
|
-
required :value, String
|
|
2886
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
2887
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource }
|
|
2512
2888
|
|
|
2513
|
-
#
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
|
|
2889
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
2890
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1 }
|
|
2891
|
+
|
|
2892
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
2893
|
+
# @!attribute namespace
|
|
2894
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
2895
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
2896
|
+
#
|
|
2897
|
+
# @return [String]
|
|
2898
|
+
required :namespace, String
|
|
2899
|
+
|
|
2900
|
+
# @!attribute type
|
|
2901
|
+
# Caller-defined entity identifier resource.
|
|
2902
|
+
#
|
|
2903
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource::Type]
|
|
2904
|
+
required :type,
|
|
2905
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource::Type }
|
|
2906
|
+
|
|
2907
|
+
# @!attribute value
|
|
2908
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
2909
|
+
# encoded namespace/value pair, not the raw value.
|
|
2910
|
+
#
|
|
2911
|
+
# @return [String]
|
|
2912
|
+
required :value, String
|
|
2913
|
+
|
|
2914
|
+
# @!method initialize(namespace:, type:, value:)
|
|
2915
|
+
# Some parameter documentations has been truncated, see
|
|
2916
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource}
|
|
2917
|
+
# for more details.
|
|
2918
|
+
#
|
|
2919
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
2920
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
2921
|
+
#
|
|
2922
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
2923
|
+
#
|
|
2924
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
2925
|
+
#
|
|
2926
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
2927
|
+
|
|
2928
|
+
# Caller-defined entity identifier resource.
|
|
2929
|
+
#
|
|
2930
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource#type
|
|
2931
|
+
module Type
|
|
2932
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2933
|
+
|
|
2934
|
+
ID = :id
|
|
2935
|
+
|
|
2936
|
+
# @!method self.values
|
|
2937
|
+
# @return [Array<Symbol>]
|
|
2938
|
+
end
|
|
2939
|
+
end
|
|
2940
|
+
|
|
2941
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
2942
|
+
# @!attribute type
|
|
2943
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
2944
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
2945
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
2946
|
+
#
|
|
2947
|
+
# @return [String]
|
|
2948
|
+
required :type, String
|
|
2949
|
+
|
|
2950
|
+
# @!attribute value
|
|
2951
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2952
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2953
|
+
#
|
|
2954
|
+
# @return [String]
|
|
2955
|
+
required :value, String
|
|
2956
|
+
|
|
2957
|
+
# @!method initialize(type:, value:)
|
|
2958
|
+
# Some parameter documentations has been truncated, see
|
|
2959
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1}
|
|
2960
|
+
# for more details.
|
|
2961
|
+
#
|
|
2962
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
2963
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2964
|
+
#
|
|
2965
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
2966
|
+
#
|
|
2967
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2968
|
+
end
|
|
2969
|
+
|
|
2970
|
+
# @!method self.variants
|
|
2971
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1)]
|
|
2524
2972
|
end
|
|
2525
2973
|
end
|
|
2526
2974
|
|
|
@@ -2625,12 +3073,12 @@ module SafetyKit
|
|
|
2625
3073
|
|
|
2626
3074
|
# @!attribute resources_used
|
|
2627
3075
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2628
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
2629
|
-
# identifiers.
|
|
3076
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3077
|
+
# caller-defined ids, or similar identifiers.
|
|
2630
3078
|
#
|
|
2631
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed>, nil]
|
|
3079
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::UnionMember1>, nil]
|
|
2632
3080
|
optional :resources_used,
|
|
2633
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed] }
|
|
3081
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed] }
|
|
2634
3082
|
|
|
2635
3083
|
# @!method initialize(event_name:, target_user_id:, timestamp:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :user_contact)
|
|
2636
3084
|
# Some parameter documentations has been truncated, see
|
|
@@ -2657,7 +3105,7 @@ module SafetyKit
|
|
|
2657
3105
|
#
|
|
2658
3106
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2659
3107
|
#
|
|
2660
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3108
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2661
3109
|
#
|
|
2662
3110
|
# @param type [Symbol, :user_contact]
|
|
2663
3111
|
|
|
@@ -2844,32 +3292,96 @@ module SafetyKit
|
|
|
2844
3292
|
}]
|
|
2845
3293
|
end
|
|
2846
3294
|
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
|
|
2850
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
2851
|
-
#
|
|
2852
|
-
# @return [String]
|
|
2853
|
-
required :type, String
|
|
3295
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
3296
|
+
module ResourcesUsed
|
|
3297
|
+
extend SafetyKit::Internal::Type::Union
|
|
2854
3298
|
|
|
2855
|
-
#
|
|
2856
|
-
|
|
2857
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2858
|
-
#
|
|
2859
|
-
# @return [String]
|
|
2860
|
-
required :value, String
|
|
3299
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3300
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::EntityIDResource }
|
|
2861
3301
|
|
|
2862
|
-
#
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2866
|
-
|
|
2867
|
-
|
|
2868
|
-
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
|
|
2872
|
-
|
|
3302
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
3303
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::UnionMember1 }
|
|
3304
|
+
|
|
3305
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
3306
|
+
# @!attribute namespace
|
|
3307
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3308
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
3309
|
+
#
|
|
3310
|
+
# @return [String]
|
|
3311
|
+
required :namespace, String
|
|
3312
|
+
|
|
3313
|
+
# @!attribute type
|
|
3314
|
+
# Caller-defined entity identifier resource.
|
|
3315
|
+
#
|
|
3316
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::EntityIDResource::Type]
|
|
3317
|
+
required :type,
|
|
3318
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::EntityIDResource::Type }
|
|
3319
|
+
|
|
3320
|
+
# @!attribute value
|
|
3321
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
3322
|
+
# encoded namespace/value pair, not the raw value.
|
|
3323
|
+
#
|
|
3324
|
+
# @return [String]
|
|
3325
|
+
required :value, String
|
|
3326
|
+
|
|
3327
|
+
# @!method initialize(namespace:, type:, value:)
|
|
3328
|
+
# Some parameter documentations has been truncated, see
|
|
3329
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::EntityIDResource}
|
|
3330
|
+
# for more details.
|
|
3331
|
+
#
|
|
3332
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
3333
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3334
|
+
#
|
|
3335
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3336
|
+
#
|
|
3337
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
3338
|
+
#
|
|
3339
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
3340
|
+
|
|
3341
|
+
# Caller-defined entity identifier resource.
|
|
3342
|
+
#
|
|
3343
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::EntityIDResource#type
|
|
3344
|
+
module Type
|
|
3345
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3346
|
+
|
|
3347
|
+
ID = :id
|
|
3348
|
+
|
|
3349
|
+
# @!method self.values
|
|
3350
|
+
# @return [Array<Symbol>]
|
|
3351
|
+
end
|
|
3352
|
+
end
|
|
3353
|
+
|
|
3354
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
3355
|
+
# @!attribute type
|
|
3356
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
3357
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
3358
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
3359
|
+
#
|
|
3360
|
+
# @return [String]
|
|
3361
|
+
required :type, String
|
|
3362
|
+
|
|
3363
|
+
# @!attribute value
|
|
3364
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
3365
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
3366
|
+
#
|
|
3367
|
+
# @return [String]
|
|
3368
|
+
required :value, String
|
|
3369
|
+
|
|
3370
|
+
# @!method initialize(type:, value:)
|
|
3371
|
+
# Some parameter documentations has been truncated, see
|
|
3372
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::UnionMember1}
|
|
3373
|
+
# for more details.
|
|
3374
|
+
#
|
|
3375
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
3376
|
+
# number, address, URL, social handle, or payment identifier.
|
|
3377
|
+
#
|
|
3378
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
3379
|
+
#
|
|
3380
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
3381
|
+
end
|
|
3382
|
+
|
|
3383
|
+
# @!method self.variants
|
|
3384
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed::UnionMember1)]
|
|
2873
3385
|
end
|
|
2874
3386
|
end
|
|
2875
3387
|
|
|
@@ -2939,12 +3451,12 @@ module SafetyKit
|
|
|
2939
3451
|
|
|
2940
3452
|
# @!attribute resources_used
|
|
2941
3453
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2942
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
2943
|
-
# identifiers.
|
|
3454
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3455
|
+
# caller-defined ids, or similar identifiers.
|
|
2944
3456
|
#
|
|
2945
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed>, nil]
|
|
3457
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::UnionMember1>, nil]
|
|
2946
3458
|
optional :resources_used,
|
|
2947
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed] }
|
|
3459
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed] }
|
|
2948
3460
|
|
|
2949
3461
|
# @!method initialize(content:, event_name:, timestamp:, user_id:, client_info: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :content_uploaded)
|
|
2950
3462
|
# Some parameter documentations has been truncated, see
|
|
@@ -2969,7 +3481,7 @@ module SafetyKit
|
|
|
2969
3481
|
#
|
|
2970
3482
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2971
3483
|
#
|
|
2972
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3484
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2973
3485
|
#
|
|
2974
3486
|
# @param type [Symbol, :content_uploaded]
|
|
2975
3487
|
|
|
@@ -3156,32 +3668,96 @@ module SafetyKit
|
|
|
3156
3668
|
]
|
|
3157
3669
|
end
|
|
3158
3670
|
|
|
3159
|
-
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
3163
|
-
#
|
|
3164
|
-
# @return [String]
|
|
3165
|
-
required :type, String
|
|
3671
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
3672
|
+
module ResourcesUsed
|
|
3673
|
+
extend SafetyKit::Internal::Type::Union
|
|
3166
3674
|
|
|
3167
|
-
#
|
|
3168
|
-
|
|
3169
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
3170
|
-
#
|
|
3171
|
-
# @return [String]
|
|
3172
|
-
required :value, String
|
|
3675
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3676
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::EntityIDResource }
|
|
3173
3677
|
|
|
3174
|
-
#
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3183
|
-
|
|
3184
|
-
|
|
3678
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
3679
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::UnionMember1 }
|
|
3680
|
+
|
|
3681
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
3682
|
+
# @!attribute namespace
|
|
3683
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3684
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
3685
|
+
#
|
|
3686
|
+
# @return [String]
|
|
3687
|
+
required :namespace, String
|
|
3688
|
+
|
|
3689
|
+
# @!attribute type
|
|
3690
|
+
# Caller-defined entity identifier resource.
|
|
3691
|
+
#
|
|
3692
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::EntityIDResource::Type]
|
|
3693
|
+
required :type,
|
|
3694
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::EntityIDResource::Type }
|
|
3695
|
+
|
|
3696
|
+
# @!attribute value
|
|
3697
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
3698
|
+
# encoded namespace/value pair, not the raw value.
|
|
3699
|
+
#
|
|
3700
|
+
# @return [String]
|
|
3701
|
+
required :value, String
|
|
3702
|
+
|
|
3703
|
+
# @!method initialize(namespace:, type:, value:)
|
|
3704
|
+
# Some parameter documentations has been truncated, see
|
|
3705
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::EntityIDResource}
|
|
3706
|
+
# for more details.
|
|
3707
|
+
#
|
|
3708
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
3709
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3710
|
+
#
|
|
3711
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3712
|
+
#
|
|
3713
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
3714
|
+
#
|
|
3715
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
3716
|
+
|
|
3717
|
+
# Caller-defined entity identifier resource.
|
|
3718
|
+
#
|
|
3719
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::EntityIDResource#type
|
|
3720
|
+
module Type
|
|
3721
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3722
|
+
|
|
3723
|
+
ID = :id
|
|
3724
|
+
|
|
3725
|
+
# @!method self.values
|
|
3726
|
+
# @return [Array<Symbol>]
|
|
3727
|
+
end
|
|
3728
|
+
end
|
|
3729
|
+
|
|
3730
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
3731
|
+
# @!attribute type
|
|
3732
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
3733
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
3734
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
3735
|
+
#
|
|
3736
|
+
# @return [String]
|
|
3737
|
+
required :type, String
|
|
3738
|
+
|
|
3739
|
+
# @!attribute value
|
|
3740
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
3741
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
3742
|
+
#
|
|
3743
|
+
# @return [String]
|
|
3744
|
+
required :value, String
|
|
3745
|
+
|
|
3746
|
+
# @!method initialize(type:, value:)
|
|
3747
|
+
# Some parameter documentations has been truncated, see
|
|
3748
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::UnionMember1}
|
|
3749
|
+
# for more details.
|
|
3750
|
+
#
|
|
3751
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
3752
|
+
# number, address, URL, social handle, or payment identifier.
|
|
3753
|
+
#
|
|
3754
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
3755
|
+
#
|
|
3756
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
3757
|
+
end
|
|
3758
|
+
|
|
3759
|
+
# @!method self.variants
|
|
3760
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed::UnionMember1)]
|
|
3185
3761
|
end
|
|
3186
3762
|
end
|
|
3187
3763
|
|
|
@@ -3257,12 +3833,12 @@ module SafetyKit
|
|
|
3257
3833
|
|
|
3258
3834
|
# @!attribute resources_used
|
|
3259
3835
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3260
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3261
|
-
# identifiers.
|
|
3836
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3837
|
+
# caller-defined ids, or similar identifiers.
|
|
3262
3838
|
#
|
|
3263
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed>, nil]
|
|
3839
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::UnionMember1>, nil]
|
|
3264
3840
|
optional :resources_used,
|
|
3265
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed] }
|
|
3841
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed] }
|
|
3266
3842
|
|
|
3267
3843
|
# @!method initialize(content:, event_name:, product:, timestamp:, user_id:, client_info: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :product_changed)
|
|
3268
3844
|
# Some parameter documentations has been truncated, see
|
|
@@ -3289,7 +3865,7 @@ module SafetyKit
|
|
|
3289
3865
|
#
|
|
3290
3866
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3291
3867
|
#
|
|
3292
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3868
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3293
3869
|
#
|
|
3294
3870
|
# @param type [Symbol, :product_changed]
|
|
3295
3871
|
|
|
@@ -3588,32 +4164,96 @@ module SafetyKit
|
|
|
3588
4164
|
]
|
|
3589
4165
|
end
|
|
3590
4166
|
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
#
|
|
3596
|
-
|
|
3597
|
-
|
|
4167
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
4168
|
+
module ResourcesUsed
|
|
4169
|
+
extend SafetyKit::Internal::Type::Union
|
|
4170
|
+
|
|
4171
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
4172
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::EntityIDResource }
|
|
4173
|
+
|
|
4174
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
4175
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::UnionMember1 }
|
|
4176
|
+
|
|
4177
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
4178
|
+
# @!attribute namespace
|
|
4179
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
4180
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
4181
|
+
#
|
|
4182
|
+
# @return [String]
|
|
4183
|
+
required :namespace, String
|
|
4184
|
+
|
|
4185
|
+
# @!attribute type
|
|
4186
|
+
# Caller-defined entity identifier resource.
|
|
4187
|
+
#
|
|
4188
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::EntityIDResource::Type]
|
|
4189
|
+
required :type,
|
|
4190
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::EntityIDResource::Type }
|
|
4191
|
+
|
|
4192
|
+
# @!attribute value
|
|
4193
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
4194
|
+
# encoded namespace/value pair, not the raw value.
|
|
4195
|
+
#
|
|
4196
|
+
# @return [String]
|
|
4197
|
+
required :value, String
|
|
4198
|
+
|
|
4199
|
+
# @!method initialize(namespace:, type:, value:)
|
|
4200
|
+
# Some parameter documentations has been truncated, see
|
|
4201
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::EntityIDResource}
|
|
4202
|
+
# for more details.
|
|
4203
|
+
#
|
|
4204
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
4205
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
4206
|
+
#
|
|
4207
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
4208
|
+
#
|
|
4209
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
4210
|
+
#
|
|
4211
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
4212
|
+
|
|
4213
|
+
# Caller-defined entity identifier resource.
|
|
4214
|
+
#
|
|
4215
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::EntityIDResource#type
|
|
4216
|
+
module Type
|
|
4217
|
+
extend SafetyKit::Internal::Type::Enum
|
|
4218
|
+
|
|
4219
|
+
ID = :id
|
|
4220
|
+
|
|
4221
|
+
# @!method self.values
|
|
4222
|
+
# @return [Array<Symbol>]
|
|
4223
|
+
end
|
|
4224
|
+
end
|
|
4225
|
+
|
|
4226
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
4227
|
+
# @!attribute type
|
|
4228
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
4229
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
4230
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
4231
|
+
#
|
|
4232
|
+
# @return [String]
|
|
4233
|
+
required :type, String
|
|
4234
|
+
|
|
4235
|
+
# @!attribute value
|
|
4236
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
4237
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
4238
|
+
#
|
|
4239
|
+
# @return [String]
|
|
4240
|
+
required :value, String
|
|
3598
4241
|
|
|
3599
|
-
|
|
3600
|
-
|
|
3601
|
-
|
|
3602
|
-
|
|
3603
|
-
|
|
3604
|
-
|
|
4242
|
+
# @!method initialize(type:, value:)
|
|
4243
|
+
# Some parameter documentations has been truncated, see
|
|
4244
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::UnionMember1}
|
|
4245
|
+
# for more details.
|
|
4246
|
+
#
|
|
4247
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
4248
|
+
# number, address, URL, social handle, or payment identifier.
|
|
4249
|
+
#
|
|
4250
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
4251
|
+
#
|
|
4252
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
4253
|
+
end
|
|
3605
4254
|
|
|
3606
|
-
# @!method
|
|
3607
|
-
#
|
|
3608
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed}
|
|
3609
|
-
# for more details.
|
|
3610
|
-
#
|
|
3611
|
-
# Real-world or account resource used during the event, such as an email, phone
|
|
3612
|
-
# number, address, URL, social handle, or payment identifier.
|
|
3613
|
-
#
|
|
3614
|
-
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
3615
|
-
#
|
|
3616
|
-
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
4255
|
+
# @!method self.variants
|
|
4256
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed::UnionMember1)]
|
|
3617
4257
|
end
|
|
3618
4258
|
end
|
|
3619
4259
|
|
|
@@ -3683,12 +4323,12 @@ module SafetyKit
|
|
|
3683
4323
|
|
|
3684
4324
|
# @!attribute resources_used
|
|
3685
4325
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3686
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3687
|
-
# identifiers.
|
|
4326
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
4327
|
+
# caller-defined ids, or similar identifiers.
|
|
3688
4328
|
#
|
|
3689
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed>, nil]
|
|
4329
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::UnionMember1>, nil]
|
|
3690
4330
|
optional :resources_used,
|
|
3691
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed] }
|
|
4331
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed] }
|
|
3692
4332
|
|
|
3693
4333
|
# @!method initialize(event_name:, timestamp:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :create_account)
|
|
3694
4334
|
# Some parameter documentations has been truncated, see
|
|
@@ -3713,7 +4353,7 @@ module SafetyKit
|
|
|
3713
4353
|
#
|
|
3714
4354
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3715
4355
|
#
|
|
3716
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
4356
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3717
4357
|
#
|
|
3718
4358
|
# @param type [Symbol, :create_account]
|
|
3719
4359
|
|
|
@@ -3900,32 +4540,96 @@ module SafetyKit
|
|
|
3900
4540
|
]
|
|
3901
4541
|
end
|
|
3902
4542
|
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
3907
|
-
#
|
|
3908
|
-
# @return [String]
|
|
3909
|
-
required :type, String
|
|
4543
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
4544
|
+
module ResourcesUsed
|
|
4545
|
+
extend SafetyKit::Internal::Type::Union
|
|
3910
4546
|
|
|
3911
|
-
#
|
|
3912
|
-
|
|
3913
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
3914
|
-
#
|
|
3915
|
-
# @return [String]
|
|
3916
|
-
required :value, String
|
|
4547
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
4548
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::EntityIDResource }
|
|
3917
4549
|
|
|
3918
|
-
#
|
|
3919
|
-
|
|
3920
|
-
|
|
3921
|
-
|
|
3922
|
-
|
|
3923
|
-
|
|
3924
|
-
|
|
3925
|
-
|
|
3926
|
-
|
|
3927
|
-
|
|
3928
|
-
|
|
4550
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
4551
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::UnionMember1 }
|
|
4552
|
+
|
|
4553
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
4554
|
+
# @!attribute namespace
|
|
4555
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
4556
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
4557
|
+
#
|
|
4558
|
+
# @return [String]
|
|
4559
|
+
required :namespace, String
|
|
4560
|
+
|
|
4561
|
+
# @!attribute type
|
|
4562
|
+
# Caller-defined entity identifier resource.
|
|
4563
|
+
#
|
|
4564
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::EntityIDResource::Type]
|
|
4565
|
+
required :type,
|
|
4566
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::EntityIDResource::Type }
|
|
4567
|
+
|
|
4568
|
+
# @!attribute value
|
|
4569
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
4570
|
+
# encoded namespace/value pair, not the raw value.
|
|
4571
|
+
#
|
|
4572
|
+
# @return [String]
|
|
4573
|
+
required :value, String
|
|
4574
|
+
|
|
4575
|
+
# @!method initialize(namespace:, type:, value:)
|
|
4576
|
+
# Some parameter documentations has been truncated, see
|
|
4577
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::EntityIDResource}
|
|
4578
|
+
# for more details.
|
|
4579
|
+
#
|
|
4580
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
4581
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
4582
|
+
#
|
|
4583
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
4584
|
+
#
|
|
4585
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
4586
|
+
#
|
|
4587
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
4588
|
+
|
|
4589
|
+
# Caller-defined entity identifier resource.
|
|
4590
|
+
#
|
|
4591
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::EntityIDResource#type
|
|
4592
|
+
module Type
|
|
4593
|
+
extend SafetyKit::Internal::Type::Enum
|
|
4594
|
+
|
|
4595
|
+
ID = :id
|
|
4596
|
+
|
|
4597
|
+
# @!method self.values
|
|
4598
|
+
# @return [Array<Symbol>]
|
|
4599
|
+
end
|
|
4600
|
+
end
|
|
4601
|
+
|
|
4602
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
4603
|
+
# @!attribute type
|
|
4604
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
4605
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
4606
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
4607
|
+
#
|
|
4608
|
+
# @return [String]
|
|
4609
|
+
required :type, String
|
|
4610
|
+
|
|
4611
|
+
# @!attribute value
|
|
4612
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
4613
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
4614
|
+
#
|
|
4615
|
+
# @return [String]
|
|
4616
|
+
required :value, String
|
|
4617
|
+
|
|
4618
|
+
# @!method initialize(type:, value:)
|
|
4619
|
+
# Some parameter documentations has been truncated, see
|
|
4620
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::UnionMember1}
|
|
4621
|
+
# for more details.
|
|
4622
|
+
#
|
|
4623
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
4624
|
+
# number, address, URL, social handle, or payment identifier.
|
|
4625
|
+
#
|
|
4626
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
4627
|
+
#
|
|
4628
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
4629
|
+
end
|
|
4630
|
+
|
|
4631
|
+
# @!method self.variants
|
|
4632
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed::UnionMember1)]
|
|
3929
4633
|
end
|
|
3930
4634
|
end
|
|
3931
4635
|
|
|
@@ -3995,12 +4699,12 @@ module SafetyKit
|
|
|
3995
4699
|
|
|
3996
4700
|
# @!attribute resources_used
|
|
3997
4701
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3998
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3999
|
-
# identifiers.
|
|
4702
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
4703
|
+
# caller-defined ids, or similar identifiers.
|
|
4000
4704
|
#
|
|
4001
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed>, nil]
|
|
4705
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::UnionMember1>, nil]
|
|
4002
4706
|
optional :resources_used,
|
|
4003
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed] }
|
|
4707
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed] }
|
|
4004
4708
|
|
|
4005
4709
|
# @!method initialize(event_name:, timestamp:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :update_account)
|
|
4006
4710
|
# Some parameter documentations has been truncated, see
|
|
@@ -4026,7 +4730,7 @@ module SafetyKit
|
|
|
4026
4730
|
#
|
|
4027
4731
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
4028
4732
|
#
|
|
4029
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
4733
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
4030
4734
|
#
|
|
4031
4735
|
# @param type [Symbol, :update_account]
|
|
4032
4736
|
|
|
@@ -4213,32 +4917,96 @@ module SafetyKit
|
|
|
4213
4917
|
]
|
|
4214
4918
|
end
|
|
4215
4919
|
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
|
|
4219
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
4220
|
-
#
|
|
4221
|
-
# @return [String]
|
|
4222
|
-
required :type, String
|
|
4920
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
4921
|
+
module ResourcesUsed
|
|
4922
|
+
extend SafetyKit::Internal::Type::Union
|
|
4223
4923
|
|
|
4224
|
-
#
|
|
4225
|
-
|
|
4226
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
4227
|
-
#
|
|
4228
|
-
# @return [String]
|
|
4229
|
-
required :value, String
|
|
4924
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
4925
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::EntityIDResource }
|
|
4230
4926
|
|
|
4231
|
-
#
|
|
4232
|
-
|
|
4233
|
-
|
|
4234
|
-
|
|
4235
|
-
|
|
4236
|
-
|
|
4237
|
-
|
|
4238
|
-
|
|
4239
|
-
|
|
4240
|
-
|
|
4241
|
-
|
|
4927
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
4928
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::UnionMember1 }
|
|
4929
|
+
|
|
4930
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
4931
|
+
# @!attribute namespace
|
|
4932
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
4933
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
4934
|
+
#
|
|
4935
|
+
# @return [String]
|
|
4936
|
+
required :namespace, String
|
|
4937
|
+
|
|
4938
|
+
# @!attribute type
|
|
4939
|
+
# Caller-defined entity identifier resource.
|
|
4940
|
+
#
|
|
4941
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::EntityIDResource::Type]
|
|
4942
|
+
required :type,
|
|
4943
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::EntityIDResource::Type }
|
|
4944
|
+
|
|
4945
|
+
# @!attribute value
|
|
4946
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
4947
|
+
# encoded namespace/value pair, not the raw value.
|
|
4948
|
+
#
|
|
4949
|
+
# @return [String]
|
|
4950
|
+
required :value, String
|
|
4951
|
+
|
|
4952
|
+
# @!method initialize(namespace:, type:, value:)
|
|
4953
|
+
# Some parameter documentations has been truncated, see
|
|
4954
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::EntityIDResource}
|
|
4955
|
+
# for more details.
|
|
4956
|
+
#
|
|
4957
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
4958
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
4959
|
+
#
|
|
4960
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
4961
|
+
#
|
|
4962
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
4963
|
+
#
|
|
4964
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
4965
|
+
|
|
4966
|
+
# Caller-defined entity identifier resource.
|
|
4967
|
+
#
|
|
4968
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::EntityIDResource#type
|
|
4969
|
+
module Type
|
|
4970
|
+
extend SafetyKit::Internal::Type::Enum
|
|
4971
|
+
|
|
4972
|
+
ID = :id
|
|
4973
|
+
|
|
4974
|
+
# @!method self.values
|
|
4975
|
+
# @return [Array<Symbol>]
|
|
4976
|
+
end
|
|
4977
|
+
end
|
|
4978
|
+
|
|
4979
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
4980
|
+
# @!attribute type
|
|
4981
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
4982
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
4983
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
4984
|
+
#
|
|
4985
|
+
# @return [String]
|
|
4986
|
+
required :type, String
|
|
4987
|
+
|
|
4988
|
+
# @!attribute value
|
|
4989
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
4990
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
4991
|
+
#
|
|
4992
|
+
# @return [String]
|
|
4993
|
+
required :value, String
|
|
4994
|
+
|
|
4995
|
+
# @!method initialize(type:, value:)
|
|
4996
|
+
# Some parameter documentations has been truncated, see
|
|
4997
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::UnionMember1}
|
|
4998
|
+
# for more details.
|
|
4999
|
+
#
|
|
5000
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
5001
|
+
# number, address, URL, social handle, or payment identifier.
|
|
5002
|
+
#
|
|
5003
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
5004
|
+
#
|
|
5005
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
5006
|
+
end
|
|
5007
|
+
|
|
5008
|
+
# @!method self.variants
|
|
5009
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed::UnionMember1)]
|
|
4242
5010
|
end
|
|
4243
5011
|
end
|
|
4244
5012
|
|
|
@@ -4314,12 +5082,12 @@ module SafetyKit
|
|
|
4314
5082
|
|
|
4315
5083
|
# @!attribute resources_used
|
|
4316
5084
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
4317
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
4318
|
-
# identifiers.
|
|
5085
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
5086
|
+
# caller-defined ids, or similar identifiers.
|
|
4319
5087
|
#
|
|
4320
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed>, nil]
|
|
5088
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::UnionMember1>, nil]
|
|
4321
5089
|
optional :resources_used,
|
|
4322
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed] }
|
|
5090
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed] }
|
|
4323
5091
|
|
|
4324
5092
|
# @!attribute target_content_id
|
|
4325
5093
|
# Your stable identifier for the content being reported.
|
|
@@ -4361,7 +5129,7 @@ module SafetyKit
|
|
|
4361
5129
|
#
|
|
4362
5130
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
4363
5131
|
#
|
|
4364
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
5132
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
4365
5133
|
#
|
|
4366
5134
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
4367
5135
|
#
|
|
@@ -4552,32 +5320,96 @@ module SafetyKit
|
|
|
4552
5320
|
}]
|
|
4553
5321
|
end
|
|
4554
5322
|
|
|
4555
|
-
|
|
4556
|
-
|
|
4557
|
-
|
|
4558
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
4559
|
-
#
|
|
4560
|
-
# @return [String]
|
|
4561
|
-
required :type, String
|
|
5323
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
5324
|
+
module ResourcesUsed
|
|
5325
|
+
extend SafetyKit::Internal::Type::Union
|
|
4562
5326
|
|
|
4563
|
-
#
|
|
4564
|
-
|
|
4565
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
4566
|
-
#
|
|
4567
|
-
# @return [String]
|
|
4568
|
-
required :value, String
|
|
5327
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
5328
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::EntityIDResource }
|
|
4569
5329
|
|
|
4570
|
-
#
|
|
4571
|
-
|
|
4572
|
-
|
|
4573
|
-
|
|
4574
|
-
|
|
4575
|
-
|
|
4576
|
-
|
|
4577
|
-
|
|
4578
|
-
|
|
4579
|
-
|
|
4580
|
-
|
|
5330
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
5331
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::UnionMember1 }
|
|
5332
|
+
|
|
5333
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
5334
|
+
# @!attribute namespace
|
|
5335
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
5336
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
5337
|
+
#
|
|
5338
|
+
# @return [String]
|
|
5339
|
+
required :namespace, String
|
|
5340
|
+
|
|
5341
|
+
# @!attribute type
|
|
5342
|
+
# Caller-defined entity identifier resource.
|
|
5343
|
+
#
|
|
5344
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::EntityIDResource::Type]
|
|
5345
|
+
required :type,
|
|
5346
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::EntityIDResource::Type }
|
|
5347
|
+
|
|
5348
|
+
# @!attribute value
|
|
5349
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
5350
|
+
# encoded namespace/value pair, not the raw value.
|
|
5351
|
+
#
|
|
5352
|
+
# @return [String]
|
|
5353
|
+
required :value, String
|
|
5354
|
+
|
|
5355
|
+
# @!method initialize(namespace:, type:, value:)
|
|
5356
|
+
# Some parameter documentations has been truncated, see
|
|
5357
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::EntityIDResource}
|
|
5358
|
+
# for more details.
|
|
5359
|
+
#
|
|
5360
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
5361
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
5362
|
+
#
|
|
5363
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
5364
|
+
#
|
|
5365
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
5366
|
+
#
|
|
5367
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
5368
|
+
|
|
5369
|
+
# Caller-defined entity identifier resource.
|
|
5370
|
+
#
|
|
5371
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::EntityIDResource#type
|
|
5372
|
+
module Type
|
|
5373
|
+
extend SafetyKit::Internal::Type::Enum
|
|
5374
|
+
|
|
5375
|
+
ID = :id
|
|
5376
|
+
|
|
5377
|
+
# @!method self.values
|
|
5378
|
+
# @return [Array<Symbol>]
|
|
5379
|
+
end
|
|
5380
|
+
end
|
|
5381
|
+
|
|
5382
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
5383
|
+
# @!attribute type
|
|
5384
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
5385
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
5386
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
5387
|
+
#
|
|
5388
|
+
# @return [String]
|
|
5389
|
+
required :type, String
|
|
5390
|
+
|
|
5391
|
+
# @!attribute value
|
|
5392
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
5393
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
5394
|
+
#
|
|
5395
|
+
# @return [String]
|
|
5396
|
+
required :value, String
|
|
5397
|
+
|
|
5398
|
+
# @!method initialize(type:, value:)
|
|
5399
|
+
# Some parameter documentations has been truncated, see
|
|
5400
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::UnionMember1}
|
|
5401
|
+
# for more details.
|
|
5402
|
+
#
|
|
5403
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
5404
|
+
# number, address, URL, social handle, or payment identifier.
|
|
5405
|
+
#
|
|
5406
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
5407
|
+
#
|
|
5408
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
5409
|
+
end
|
|
5410
|
+
|
|
5411
|
+
# @!method self.variants
|
|
5412
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed::UnionMember1)]
|
|
4581
5413
|
end
|
|
4582
5414
|
end
|
|
4583
5415
|
|
|
@@ -4666,12 +5498,12 @@ module SafetyKit
|
|
|
4666
5498
|
|
|
4667
5499
|
# @!attribute resources_used
|
|
4668
5500
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
4669
|
-
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
4670
|
-
# identifiers.
|
|
5501
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
5502
|
+
# caller-defined ids, or similar identifiers.
|
|
4671
5503
|
#
|
|
4672
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed>, nil]
|
|
5504
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::UnionMember1>, nil]
|
|
4673
5505
|
optional :resources_used,
|
|
4674
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed] }
|
|
5506
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed] }
|
|
4675
5507
|
|
|
4676
5508
|
# @!attribute target_content_id
|
|
4677
5509
|
# Your stable identifier for the content being reported.
|
|
@@ -4714,7 +5546,7 @@ module SafetyKit
|
|
|
4714
5546
|
#
|
|
4715
5547
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
4716
5548
|
#
|
|
4717
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
5549
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
4718
5550
|
#
|
|
4719
5551
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
4720
5552
|
#
|
|
@@ -4924,32 +5756,96 @@ module SafetyKit
|
|
|
4924
5756
|
]
|
|
4925
5757
|
end
|
|
4926
5758
|
|
|
4927
|
-
|
|
4928
|
-
|
|
4929
|
-
|
|
4930
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
4931
|
-
#
|
|
4932
|
-
# @return [String]
|
|
4933
|
-
required :type, String
|
|
5759
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
5760
|
+
module ResourcesUsed
|
|
5761
|
+
extend SafetyKit::Internal::Type::Union
|
|
4934
5762
|
|
|
4935
|
-
#
|
|
4936
|
-
|
|
4937
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
4938
|
-
#
|
|
4939
|
-
# @return [String]
|
|
4940
|
-
required :value, String
|
|
5763
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
5764
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::EntityIDResource }
|
|
4941
5765
|
|
|
4942
|
-
#
|
|
4943
|
-
|
|
4944
|
-
|
|
4945
|
-
|
|
4946
|
-
|
|
4947
|
-
|
|
4948
|
-
|
|
4949
|
-
|
|
4950
|
-
|
|
4951
|
-
|
|
4952
|
-
|
|
5766
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
5767
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::UnionMember1 }
|
|
5768
|
+
|
|
5769
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
5770
|
+
# @!attribute namespace
|
|
5771
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
5772
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
5773
|
+
#
|
|
5774
|
+
# @return [String]
|
|
5775
|
+
required :namespace, String
|
|
5776
|
+
|
|
5777
|
+
# @!attribute type
|
|
5778
|
+
# Caller-defined entity identifier resource.
|
|
5779
|
+
#
|
|
5780
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::EntityIDResource::Type]
|
|
5781
|
+
required :type,
|
|
5782
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::EntityIDResource::Type }
|
|
5783
|
+
|
|
5784
|
+
# @!attribute value
|
|
5785
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
5786
|
+
# encoded namespace/value pair, not the raw value.
|
|
5787
|
+
#
|
|
5788
|
+
# @return [String]
|
|
5789
|
+
required :value, String
|
|
5790
|
+
|
|
5791
|
+
# @!method initialize(namespace:, type:, value:)
|
|
5792
|
+
# Some parameter documentations has been truncated, see
|
|
5793
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::EntityIDResource}
|
|
5794
|
+
# for more details.
|
|
5795
|
+
#
|
|
5796
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
5797
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
5798
|
+
#
|
|
5799
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
5800
|
+
#
|
|
5801
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
5802
|
+
#
|
|
5803
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
5804
|
+
|
|
5805
|
+
# Caller-defined entity identifier resource.
|
|
5806
|
+
#
|
|
5807
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::EntityIDResource#type
|
|
5808
|
+
module Type
|
|
5809
|
+
extend SafetyKit::Internal::Type::Enum
|
|
5810
|
+
|
|
5811
|
+
ID = :id
|
|
5812
|
+
|
|
5813
|
+
# @!method self.values
|
|
5814
|
+
# @return [Array<Symbol>]
|
|
5815
|
+
end
|
|
5816
|
+
end
|
|
5817
|
+
|
|
5818
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
5819
|
+
# @!attribute type
|
|
5820
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
5821
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
5822
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
5823
|
+
#
|
|
5824
|
+
# @return [String]
|
|
5825
|
+
required :type, String
|
|
5826
|
+
|
|
5827
|
+
# @!attribute value
|
|
5828
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
5829
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
5830
|
+
#
|
|
5831
|
+
# @return [String]
|
|
5832
|
+
required :value, String
|
|
5833
|
+
|
|
5834
|
+
# @!method initialize(type:, value:)
|
|
5835
|
+
# Some parameter documentations has been truncated, see
|
|
5836
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::UnionMember1}
|
|
5837
|
+
# for more details.
|
|
5838
|
+
#
|
|
5839
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
5840
|
+
# number, address, URL, social handle, or payment identifier.
|
|
5841
|
+
#
|
|
5842
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
5843
|
+
#
|
|
5844
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
5845
|
+
end
|
|
5846
|
+
|
|
5847
|
+
# @!method self.variants
|
|
5848
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed::UnionMember1)]
|
|
4953
5849
|
end
|
|
4954
5850
|
end
|
|
4955
5851
|
|