safetykit 0.25.0 → 0.26.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/beta/event_create_params.rb +1345 -557
- data/lib/safety_kit/resources/beta/events.rb +1 -1
- data/lib/safety_kit/version.rb +1 -1
- data/rbi/safety_kit/models/beta/event_create_params.rbi +2562 -899
- data/rbi/safety_kit/resources/beta/events.rbi +8 -6
- data/sig/safety_kit/models/beta/event_create_params.rbs +882 -272
- metadata +1 -1
|
@@ -13,14 +13,14 @@ module SafetyKit
|
|
|
13
13
|
# your server after an action has happened in your product. Do not send these
|
|
14
14
|
# events directly from a browser or mobile client.
|
|
15
15
|
#
|
|
16
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
16
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision>]
|
|
17
17
|
required :body, union: -> { SafetyKit::Beta::EventCreateParams::Body }
|
|
18
18
|
|
|
19
19
|
# @!method initialize(body:, request_options: {})
|
|
20
20
|
# Some parameter documentations has been truncated, see
|
|
21
21
|
# {SafetyKit::Models::Beta::EventCreateParams} for more details.
|
|
22
22
|
#
|
|
23
|
-
# @param body [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
23
|
+
# @param body [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision>] Backend event or ordered batch of events to send to SafetyKit. Send events from
|
|
24
24
|
#
|
|
25
25
|
# @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}]
|
|
26
26
|
|
|
@@ -36,6 +36,9 @@ module SafetyKit
|
|
|
36
36
|
# A user posts, uploads, publishes, edits, or replaces content.
|
|
37
37
|
variant -> { SafetyKit::Beta::EventCreateParams::Body::ContentUploadedEventRequest }
|
|
38
38
|
|
|
39
|
+
# A product listing is created, updated, or has a discount added.
|
|
40
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest }
|
|
41
|
+
|
|
39
42
|
# A user or account is created.
|
|
40
43
|
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest }
|
|
41
44
|
|
|
@@ -48,7 +51,7 @@ module SafetyKit
|
|
|
48
51
|
# A moderation label or decision from an automated enforcement system or manual review workflow. Do not send user_id; use source_type and source_id for attribution.
|
|
49
52
|
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest }
|
|
50
53
|
|
|
51
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
54
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7Array }
|
|
52
55
|
|
|
53
56
|
class UserContactEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
54
57
|
# @!attribute event_name
|
|
@@ -653,13 +656,28 @@ module SafetyKit
|
|
|
653
656
|
end
|
|
654
657
|
end
|
|
655
658
|
|
|
656
|
-
class
|
|
659
|
+
class ProductChangedEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
660
|
+
# @!attribute content
|
|
661
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
662
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
663
|
+
# analyze.
|
|
664
|
+
#
|
|
665
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent>]
|
|
666
|
+
required :content,
|
|
667
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content] }
|
|
668
|
+
|
|
657
669
|
# @!attribute event_name
|
|
658
|
-
#
|
|
659
|
-
# values in typed fields, content, resources_used, or metadata.
|
|
670
|
+
# Product action that triggered this event.
|
|
660
671
|
#
|
|
661
|
-
# @return [
|
|
662
|
-
required :event_name,
|
|
672
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::EventName]
|
|
673
|
+
required :event_name,
|
|
674
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::EventName }
|
|
675
|
+
|
|
676
|
+
# @!attribute product
|
|
677
|
+
# Commerce details for the product involved in this event.
|
|
678
|
+
#
|
|
679
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product]
|
|
680
|
+
required :product, -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product }
|
|
663
681
|
|
|
664
682
|
# @!attribute timestamp
|
|
665
683
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
@@ -669,8 +687,8 @@ module SafetyKit
|
|
|
669
687
|
|
|
670
688
|
# @!attribute type
|
|
671
689
|
#
|
|
672
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
673
|
-
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
690
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Type]
|
|
691
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Type }
|
|
674
692
|
|
|
675
693
|
# @!attribute user_id
|
|
676
694
|
# Your stable canonical identifier for the user or account.
|
|
@@ -678,15 +696,6 @@ module SafetyKit
|
|
|
678
696
|
# @return [String]
|
|
679
697
|
required :user_id, String
|
|
680
698
|
|
|
681
|
-
# @!attribute content
|
|
682
|
-
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
683
|
-
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
684
|
-
# analyze.
|
|
685
|
-
#
|
|
686
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent>, nil]
|
|
687
|
-
optional :content,
|
|
688
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content] }
|
|
689
|
-
|
|
690
699
|
# @!attribute content_id
|
|
691
700
|
# Your stable identifier for the content involved in this event, such as a
|
|
692
701
|
# message, listing, page, post, profile, or uploaded media item.
|
|
@@ -707,61 +716,53 @@ module SafetyKit
|
|
|
707
716
|
#
|
|
708
717
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
709
718
|
optional :metadata,
|
|
710
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
719
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Metadata] }
|
|
711
720
|
|
|
712
721
|
# @!attribute resources_used
|
|
713
722
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
714
723
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
715
724
|
# identifiers.
|
|
716
725
|
#
|
|
717
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
726
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed>, nil]
|
|
718
727
|
optional :resources_used,
|
|
719
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
728
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed] }
|
|
720
729
|
|
|
721
|
-
# @!method initialize(event_name:, timestamp:, type:, user_id:,
|
|
730
|
+
# @!method initialize(content:, event_name:, product:, timestamp:, type:, user_id:, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
722
731
|
# Some parameter documentations has been truncated, see
|
|
723
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
732
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest}
|
|
724
733
|
# for more details.
|
|
725
734
|
#
|
|
726
|
-
# A
|
|
735
|
+
# A product listing is created, updated, or has a discount added.
|
|
727
736
|
#
|
|
728
|
-
# @param
|
|
737
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
738
|
+
#
|
|
739
|
+
# @param event_name [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::EventName] Product action that triggered this event.
|
|
740
|
+
#
|
|
741
|
+
# @param product [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product] Commerce details for the product involved in this event.
|
|
729
742
|
#
|
|
730
743
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
731
744
|
#
|
|
732
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
745
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Type]
|
|
733
746
|
#
|
|
734
747
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
735
748
|
#
|
|
736
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
737
|
-
#
|
|
738
749
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
739
750
|
#
|
|
740
751
|
# @param idempotency_key [String] Optional caller-provided key used to make retries of this individual event idemp
|
|
741
752
|
#
|
|
742
753
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
743
754
|
#
|
|
744
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
745
|
-
|
|
746
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest#type
|
|
747
|
-
module Type
|
|
748
|
-
extend SafetyKit::Internal::Type::Enum
|
|
749
|
-
|
|
750
|
-
CREATE_ACCOUNT = :create_account
|
|
751
|
-
|
|
752
|
-
# @!method self.values
|
|
753
|
-
# @return [Array<Symbol>]
|
|
754
|
-
end
|
|
755
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
755
756
|
|
|
756
757
|
# User-authored text content associated with an event.
|
|
757
758
|
module Content
|
|
758
759
|
extend SafetyKit::Internal::Type::Union
|
|
759
760
|
|
|
760
761
|
# User-authored text content associated with an event.
|
|
761
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
762
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventTextContent }
|
|
762
763
|
|
|
763
764
|
# User-uploaded image content associated with an event.
|
|
764
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
765
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent }
|
|
765
766
|
|
|
766
767
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
767
768
|
# @!attribute text
|
|
@@ -773,9 +774,9 @@ module SafetyKit
|
|
|
773
774
|
# @!attribute type
|
|
774
775
|
# Text content part.
|
|
775
776
|
#
|
|
776
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
777
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventTextContent::Type]
|
|
777
778
|
required :type,
|
|
778
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
779
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventTextContent::Type }
|
|
779
780
|
|
|
780
781
|
# @!attribute key
|
|
781
782
|
# Stable field key for this content part.
|
|
@@ -788,13 +789,13 @@ module SafetyKit
|
|
|
788
789
|
#
|
|
789
790
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
790
791
|
#
|
|
791
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
792
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventTextContent::Type] Text content part.
|
|
792
793
|
#
|
|
793
794
|
# @param key [String] Stable field key for this content part.
|
|
794
795
|
|
|
795
796
|
# Text content part.
|
|
796
797
|
#
|
|
797
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
798
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventTextContent#type
|
|
798
799
|
module Type
|
|
799
800
|
extend SafetyKit::Internal::Type::Enum
|
|
800
801
|
|
|
@@ -809,16 +810,16 @@ module SafetyKit
|
|
|
809
810
|
# @!attribute source
|
|
810
811
|
# Image source information.
|
|
811
812
|
#
|
|
812
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
813
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Source]
|
|
813
814
|
required :source,
|
|
814
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
815
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Source }
|
|
815
816
|
|
|
816
817
|
# @!attribute type
|
|
817
818
|
# Image content part.
|
|
818
819
|
#
|
|
819
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
820
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Type]
|
|
820
821
|
required :type,
|
|
821
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
822
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Type }
|
|
822
823
|
|
|
823
824
|
# @!attribute key
|
|
824
825
|
# Stable field key for this content part.
|
|
@@ -829,20 +830,20 @@ module SafetyKit
|
|
|
829
830
|
# @!method initialize(source:, type:, key: nil)
|
|
830
831
|
# User-uploaded image content associated with an event.
|
|
831
832
|
#
|
|
832
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
833
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Source] Image source information.
|
|
833
834
|
#
|
|
834
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
835
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Type] Image content part.
|
|
835
836
|
#
|
|
836
837
|
# @param key [String] Stable field key for this content part.
|
|
837
838
|
|
|
838
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
839
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent#source
|
|
839
840
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
840
841
|
# @!attribute type
|
|
841
842
|
# URL image source.
|
|
842
843
|
#
|
|
843
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
844
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Source::Type]
|
|
844
845
|
required :type,
|
|
845
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
846
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Source::Type }
|
|
846
847
|
|
|
847
848
|
# @!attribute url
|
|
848
849
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -853,13 +854,13 @@ module SafetyKit
|
|
|
853
854
|
# @!method initialize(type:, url:)
|
|
854
855
|
# Image source information.
|
|
855
856
|
#
|
|
856
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
857
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
857
858
|
#
|
|
858
859
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
859
860
|
|
|
860
861
|
# URL image source.
|
|
861
862
|
#
|
|
862
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
863
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent::Source#type
|
|
863
864
|
module Type
|
|
864
865
|
extend SafetyKit::Internal::Type::Enum
|
|
865
866
|
|
|
@@ -872,7 +873,7 @@ module SafetyKit
|
|
|
872
873
|
|
|
873
874
|
# Image content part.
|
|
874
875
|
#
|
|
875
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
876
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent#type
|
|
876
877
|
module Type
|
|
877
878
|
extend SafetyKit::Internal::Type::Enum
|
|
878
879
|
|
|
@@ -884,7 +885,108 @@ module SafetyKit
|
|
|
884
885
|
end
|
|
885
886
|
|
|
886
887
|
# @!method self.variants
|
|
887
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
888
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Content::EventImageContent)]
|
|
889
|
+
end
|
|
890
|
+
|
|
891
|
+
# Product action that triggered this event.
|
|
892
|
+
#
|
|
893
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest#event_name
|
|
894
|
+
module EventName
|
|
895
|
+
extend SafetyKit::Internal::Type::Enum
|
|
896
|
+
|
|
897
|
+
PRODUCT_CREATED = :product_created
|
|
898
|
+
PRODUCT_UPDATED = :product_updated
|
|
899
|
+
DISCOUNT_ADDED = :discount_added
|
|
900
|
+
|
|
901
|
+
# @!method self.values
|
|
902
|
+
# @return [Array<Symbol>]
|
|
903
|
+
end
|
|
904
|
+
|
|
905
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest#product
|
|
906
|
+
class Product < SafetyKit::Internal::Type::BaseModel
|
|
907
|
+
# @!attribute price
|
|
908
|
+
# Current listed price of the product.
|
|
909
|
+
#
|
|
910
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product::Price]
|
|
911
|
+
required :price,
|
|
912
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product::Price }
|
|
913
|
+
|
|
914
|
+
# @!attribute discounted_price
|
|
915
|
+
# Discounted price of the product, when a discount applies.
|
|
916
|
+
#
|
|
917
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product::DiscountedPrice, nil]
|
|
918
|
+
optional :discounted_price,
|
|
919
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product::DiscountedPrice }
|
|
920
|
+
|
|
921
|
+
# @!attribute shipping_info
|
|
922
|
+
# Shipping details for the product, such as cost, regions, and carrier.
|
|
923
|
+
#
|
|
924
|
+
# @return [Hash{Symbol=>Object, nil}, nil]
|
|
925
|
+
optional :shipping_info,
|
|
926
|
+
SafetyKit::Internal::Type::HashOf[SafetyKit::Internal::Type::Unknown, nil?: true]
|
|
927
|
+
|
|
928
|
+
# @!method initialize(price:, discounted_price: nil, shipping_info: nil)
|
|
929
|
+
# Commerce details for the product involved in this event.
|
|
930
|
+
#
|
|
931
|
+
# @param price [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product::Price] Current listed price of the product.
|
|
932
|
+
#
|
|
933
|
+
# @param discounted_price [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product::DiscountedPrice] Discounted price of the product, when a discount applies.
|
|
934
|
+
#
|
|
935
|
+
# @param shipping_info [Hash{Symbol=>Object, nil}] Shipping details for the product, such as cost, regions, and carrier.
|
|
936
|
+
|
|
937
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product#price
|
|
938
|
+
class Price < SafetyKit::Internal::Type::BaseModel
|
|
939
|
+
# @!attribute amount
|
|
940
|
+
# Price amount as a decimal string.
|
|
941
|
+
#
|
|
942
|
+
# @return [String]
|
|
943
|
+
required :amount, String
|
|
944
|
+
|
|
945
|
+
# @!attribute currency
|
|
946
|
+
# ISO 4217 currency code.
|
|
947
|
+
#
|
|
948
|
+
# @return [String]
|
|
949
|
+
required :currency, String
|
|
950
|
+
|
|
951
|
+
# @!method initialize(amount:, currency:)
|
|
952
|
+
# Current listed price of the product.
|
|
953
|
+
#
|
|
954
|
+
# @param amount [String] Price amount as a decimal string.
|
|
955
|
+
#
|
|
956
|
+
# @param currency [String] ISO 4217 currency code.
|
|
957
|
+
end
|
|
958
|
+
|
|
959
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product#discounted_price
|
|
960
|
+
class DiscountedPrice < SafetyKit::Internal::Type::BaseModel
|
|
961
|
+
# @!attribute amount
|
|
962
|
+
# Price amount as a decimal string.
|
|
963
|
+
#
|
|
964
|
+
# @return [String]
|
|
965
|
+
required :amount, String
|
|
966
|
+
|
|
967
|
+
# @!attribute currency
|
|
968
|
+
# ISO 4217 currency code.
|
|
969
|
+
#
|
|
970
|
+
# @return [String]
|
|
971
|
+
required :currency, String
|
|
972
|
+
|
|
973
|
+
# @!method initialize(amount:, currency:)
|
|
974
|
+
# Discounted price of the product, when a discount applies.
|
|
975
|
+
#
|
|
976
|
+
# @param amount [String] Price amount as a decimal string.
|
|
977
|
+
#
|
|
978
|
+
# @param currency [String] ISO 4217 currency code.
|
|
979
|
+
end
|
|
980
|
+
end
|
|
981
|
+
|
|
982
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest#type
|
|
983
|
+
module Type
|
|
984
|
+
extend SafetyKit::Internal::Type::Enum
|
|
985
|
+
|
|
986
|
+
PRODUCT_CHANGED = :product_changed
|
|
987
|
+
|
|
988
|
+
# @!method self.values
|
|
989
|
+
# @return [Array<Symbol>]
|
|
888
990
|
end
|
|
889
991
|
|
|
890
992
|
module Metadata
|
|
@@ -896,7 +998,7 @@ module SafetyKit
|
|
|
896
998
|
|
|
897
999
|
variant SafetyKit::Internal::Type::Boolean
|
|
898
1000
|
|
|
899
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1001
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Metadata::UnionMember3Array }
|
|
900
1002
|
|
|
901
1003
|
module UnionMember3
|
|
902
1004
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -917,7 +1019,7 @@ module SafetyKit
|
|
|
917
1019
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
918
1020
|
UnionMember3Array =
|
|
919
1021
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
920
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
1022
|
+
SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Metadata::UnionMember3
|
|
921
1023
|
}]
|
|
922
1024
|
end
|
|
923
1025
|
|
|
@@ -938,7 +1040,7 @@ module SafetyKit
|
|
|
938
1040
|
|
|
939
1041
|
# @!method initialize(type:, value:)
|
|
940
1042
|
# Some parameter documentations has been truncated, see
|
|
941
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1043
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed}
|
|
942
1044
|
# for more details.
|
|
943
1045
|
#
|
|
944
1046
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -950,7 +1052,7 @@ module SafetyKit
|
|
|
950
1052
|
end
|
|
951
1053
|
end
|
|
952
1054
|
|
|
953
|
-
class
|
|
1055
|
+
class CreateAccountEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
954
1056
|
# @!attribute event_name
|
|
955
1057
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
956
1058
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -966,8 +1068,8 @@ module SafetyKit
|
|
|
966
1068
|
|
|
967
1069
|
# @!attribute type
|
|
968
1070
|
#
|
|
969
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
970
|
-
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1071
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type]
|
|
1072
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type }
|
|
971
1073
|
|
|
972
1074
|
# @!attribute user_id
|
|
973
1075
|
# Your stable canonical identifier for the user or account.
|
|
@@ -980,9 +1082,9 @@ module SafetyKit
|
|
|
980
1082
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
981
1083
|
# analyze.
|
|
982
1084
|
#
|
|
983
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1085
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent>, nil]
|
|
984
1086
|
optional :content,
|
|
985
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1087
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content] }
|
|
986
1088
|
|
|
987
1089
|
# @!attribute content_id
|
|
988
1090
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -1004,34 +1106,33 @@ module SafetyKit
|
|
|
1004
1106
|
#
|
|
1005
1107
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1006
1108
|
optional :metadata,
|
|
1007
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1109
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata] }
|
|
1008
1110
|
|
|
1009
1111
|
# @!attribute resources_used
|
|
1010
1112
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1011
1113
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1012
1114
|
# identifiers.
|
|
1013
1115
|
#
|
|
1014
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1116
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>, nil]
|
|
1015
1117
|
optional :resources_used,
|
|
1016
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
1118
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed] }
|
|
1017
1119
|
|
|
1018
1120
|
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
1019
1121
|
# Some parameter documentations has been truncated, see
|
|
1020
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1122
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest}
|
|
1021
1123
|
# for more details.
|
|
1022
1124
|
#
|
|
1023
|
-
# A user or account
|
|
1024
|
-
# changes.
|
|
1125
|
+
# A user or account is created.
|
|
1025
1126
|
#
|
|
1026
1127
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1027
1128
|
#
|
|
1028
1129
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1029
1130
|
#
|
|
1030
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1131
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type]
|
|
1031
1132
|
#
|
|
1032
1133
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1033
1134
|
#
|
|
1034
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1135
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1035
1136
|
#
|
|
1036
1137
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1037
1138
|
#
|
|
@@ -1039,13 +1140,13 @@ module SafetyKit
|
|
|
1039
1140
|
#
|
|
1040
1141
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1041
1142
|
#
|
|
1042
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1143
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1043
1144
|
|
|
1044
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1145
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest#type
|
|
1045
1146
|
module Type
|
|
1046
1147
|
extend SafetyKit::Internal::Type::Enum
|
|
1047
1148
|
|
|
1048
|
-
|
|
1149
|
+
CREATE_ACCOUNT = :create_account
|
|
1049
1150
|
|
|
1050
1151
|
# @!method self.values
|
|
1051
1152
|
# @return [Array<Symbol>]
|
|
@@ -1056,10 +1157,10 @@ module SafetyKit
|
|
|
1056
1157
|
extend SafetyKit::Internal::Type::Union
|
|
1057
1158
|
|
|
1058
1159
|
# User-authored text content associated with an event.
|
|
1059
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1160
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent }
|
|
1060
1161
|
|
|
1061
1162
|
# User-uploaded image content associated with an event.
|
|
1062
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1163
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent }
|
|
1063
1164
|
|
|
1064
1165
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1065
1166
|
# @!attribute text
|
|
@@ -1071,9 +1172,9 @@ module SafetyKit
|
|
|
1071
1172
|
# @!attribute type
|
|
1072
1173
|
# Text content part.
|
|
1073
1174
|
#
|
|
1074
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1175
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent::Type]
|
|
1075
1176
|
required :type,
|
|
1076
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1177
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent::Type }
|
|
1077
1178
|
|
|
1078
1179
|
# @!attribute key
|
|
1079
1180
|
# Stable field key for this content part.
|
|
@@ -1086,13 +1187,13 @@ module SafetyKit
|
|
|
1086
1187
|
#
|
|
1087
1188
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1088
1189
|
#
|
|
1089
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1190
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent::Type] Text content part.
|
|
1090
1191
|
#
|
|
1091
1192
|
# @param key [String] Stable field key for this content part.
|
|
1092
1193
|
|
|
1093
1194
|
# Text content part.
|
|
1094
1195
|
#
|
|
1095
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1196
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent#type
|
|
1096
1197
|
module Type
|
|
1097
1198
|
extend SafetyKit::Internal::Type::Enum
|
|
1098
1199
|
|
|
@@ -1107,16 +1208,16 @@ module SafetyKit
|
|
|
1107
1208
|
# @!attribute source
|
|
1108
1209
|
# Image source information.
|
|
1109
1210
|
#
|
|
1110
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1211
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source]
|
|
1111
1212
|
required :source,
|
|
1112
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1213
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source }
|
|
1113
1214
|
|
|
1114
1215
|
# @!attribute type
|
|
1115
1216
|
# Image content part.
|
|
1116
1217
|
#
|
|
1117
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1218
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Type]
|
|
1118
1219
|
required :type,
|
|
1119
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1220
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Type }
|
|
1120
1221
|
|
|
1121
1222
|
# @!attribute key
|
|
1122
1223
|
# Stable field key for this content part.
|
|
@@ -1127,20 +1228,20 @@ module SafetyKit
|
|
|
1127
1228
|
# @!method initialize(source:, type:, key: nil)
|
|
1128
1229
|
# User-uploaded image content associated with an event.
|
|
1129
1230
|
#
|
|
1130
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1231
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source] Image source information.
|
|
1131
1232
|
#
|
|
1132
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1233
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Type] Image content part.
|
|
1133
1234
|
#
|
|
1134
1235
|
# @param key [String] Stable field key for this content part.
|
|
1135
1236
|
|
|
1136
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1237
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent#source
|
|
1137
1238
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1138
1239
|
# @!attribute type
|
|
1139
1240
|
# URL image source.
|
|
1140
1241
|
#
|
|
1141
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1242
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source::Type]
|
|
1142
1243
|
required :type,
|
|
1143
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1244
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source::Type }
|
|
1144
1245
|
|
|
1145
1246
|
# @!attribute url
|
|
1146
1247
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1151,13 +1252,13 @@ module SafetyKit
|
|
|
1151
1252
|
# @!method initialize(type:, url:)
|
|
1152
1253
|
# Image source information.
|
|
1153
1254
|
#
|
|
1154
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1255
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
1155
1256
|
#
|
|
1156
1257
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1157
1258
|
|
|
1158
1259
|
# URL image source.
|
|
1159
1260
|
#
|
|
1160
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1261
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source#type
|
|
1161
1262
|
module Type
|
|
1162
1263
|
extend SafetyKit::Internal::Type::Enum
|
|
1163
1264
|
|
|
@@ -1170,7 +1271,7 @@ module SafetyKit
|
|
|
1170
1271
|
|
|
1171
1272
|
# Image content part.
|
|
1172
1273
|
#
|
|
1173
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1274
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent#type
|
|
1174
1275
|
module Type
|
|
1175
1276
|
extend SafetyKit::Internal::Type::Enum
|
|
1176
1277
|
|
|
@@ -1182,7 +1283,7 @@ module SafetyKit
|
|
|
1182
1283
|
end
|
|
1183
1284
|
|
|
1184
1285
|
# @!method self.variants
|
|
1185
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1286
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent)]
|
|
1186
1287
|
end
|
|
1187
1288
|
|
|
1188
1289
|
module Metadata
|
|
@@ -1194,7 +1295,7 @@ module SafetyKit
|
|
|
1194
1295
|
|
|
1195
1296
|
variant SafetyKit::Internal::Type::Boolean
|
|
1196
1297
|
|
|
1197
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1298
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata::UnionMember3Array }
|
|
1198
1299
|
|
|
1199
1300
|
module UnionMember3
|
|
1200
1301
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1215,7 +1316,7 @@ module SafetyKit
|
|
|
1215
1316
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1216
1317
|
UnionMember3Array =
|
|
1217
1318
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1218
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
1319
|
+
SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata::UnionMember3
|
|
1219
1320
|
}]
|
|
1220
1321
|
end
|
|
1221
1322
|
|
|
@@ -1236,7 +1337,7 @@ module SafetyKit
|
|
|
1236
1337
|
|
|
1237
1338
|
# @!method initialize(type:, value:)
|
|
1238
1339
|
# Some parameter documentations has been truncated, see
|
|
1239
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1340
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed}
|
|
1240
1341
|
# for more details.
|
|
1241
1342
|
#
|
|
1242
1343
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1248,7 +1349,7 @@ module SafetyKit
|
|
|
1248
1349
|
end
|
|
1249
1350
|
end
|
|
1250
1351
|
|
|
1251
|
-
class
|
|
1352
|
+
class UpdateAccountEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
1252
1353
|
# @!attribute event_name
|
|
1253
1354
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1254
1355
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -1256,12 +1357,6 @@ module SafetyKit
|
|
|
1256
1357
|
# @return [String]
|
|
1257
1358
|
required :event_name, String
|
|
1258
1359
|
|
|
1259
|
-
# @!attribute labels
|
|
1260
|
-
# One or more label categories supplied with the report or moderation decision.
|
|
1261
|
-
#
|
|
1262
|
-
# @return [Array<String>]
|
|
1263
|
-
required :labels, SafetyKit::Internal::Type::ArrayOf[String]
|
|
1264
|
-
|
|
1265
1360
|
# @!attribute timestamp
|
|
1266
1361
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1267
1362
|
#
|
|
@@ -1270,8 +1365,8 @@ module SafetyKit
|
|
|
1270
1365
|
|
|
1271
1366
|
# @!attribute type
|
|
1272
1367
|
#
|
|
1273
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1274
|
-
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1368
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Type]
|
|
1369
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Type }
|
|
1275
1370
|
|
|
1276
1371
|
# @!attribute user_id
|
|
1277
1372
|
# Your stable canonical identifier for the user or account.
|
|
@@ -1284,9 +1379,9 @@ module SafetyKit
|
|
|
1284
1379
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1285
1380
|
# analyze.
|
|
1286
1381
|
#
|
|
1287
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1382
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent>, nil]
|
|
1288
1383
|
optional :content,
|
|
1289
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1384
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content] }
|
|
1290
1385
|
|
|
1291
1386
|
# @!attribute content_id
|
|
1292
1387
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -1308,50 +1403,34 @@ module SafetyKit
|
|
|
1308
1403
|
#
|
|
1309
1404
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1310
1405
|
optional :metadata,
|
|
1311
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1406
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata] }
|
|
1312
1407
|
|
|
1313
1408
|
# @!attribute resources_used
|
|
1314
1409
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1315
1410
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1316
1411
|
# identifiers.
|
|
1317
1412
|
#
|
|
1318
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1413
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>, nil]
|
|
1319
1414
|
optional :resources_used,
|
|
1320
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
1321
|
-
|
|
1322
|
-
# @!attribute target_content_id
|
|
1323
|
-
# Your stable identifier for the content being reported.
|
|
1324
|
-
#
|
|
1325
|
-
# @return [String, nil]
|
|
1326
|
-
optional :target_content_id, String
|
|
1327
|
-
|
|
1328
|
-
# @!attribute target_user_id
|
|
1329
|
-
# Your stable canonical identifier for the user being reported.
|
|
1330
|
-
#
|
|
1331
|
-
# @return [String, nil]
|
|
1332
|
-
optional :target_user_id, String
|
|
1415
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed] }
|
|
1333
1416
|
|
|
1334
|
-
# @!method initialize(event_name:,
|
|
1417
|
+
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
1335
1418
|
# Some parameter documentations has been truncated, see
|
|
1336
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1337
|
-
# more details.
|
|
1419
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest}
|
|
1420
|
+
# for more details.
|
|
1338
1421
|
#
|
|
1339
|
-
# A user
|
|
1340
|
-
#
|
|
1341
|
-
# when the report is about content associated with a user. Use content and
|
|
1342
|
-
# content_id for the report itself.
|
|
1422
|
+
# A user or account profile, contact detail, payment detail, or public bio
|
|
1423
|
+
# changes.
|
|
1343
1424
|
#
|
|
1344
1425
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1345
1426
|
#
|
|
1346
|
-
# @param labels [Array<String>] One or more label categories supplied with the report or moderation decision.
|
|
1347
|
-
#
|
|
1348
1427
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1349
1428
|
#
|
|
1350
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1429
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Type]
|
|
1351
1430
|
#
|
|
1352
1431
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1353
1432
|
#
|
|
1354
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1433
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1355
1434
|
#
|
|
1356
1435
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1357
1436
|
#
|
|
@@ -1359,17 +1438,13 @@ module SafetyKit
|
|
|
1359
1438
|
#
|
|
1360
1439
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1361
1440
|
#
|
|
1362
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1363
|
-
#
|
|
1364
|
-
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
1365
|
-
#
|
|
1366
|
-
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
1441
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1367
1442
|
|
|
1368
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1443
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest#type
|
|
1369
1444
|
module Type
|
|
1370
1445
|
extend SafetyKit::Internal::Type::Enum
|
|
1371
1446
|
|
|
1372
|
-
|
|
1447
|
+
UPDATE_ACCOUNT = :update_account
|
|
1373
1448
|
|
|
1374
1449
|
# @!method self.values
|
|
1375
1450
|
# @return [Array<Symbol>]
|
|
@@ -1380,10 +1455,10 @@ module SafetyKit
|
|
|
1380
1455
|
extend SafetyKit::Internal::Type::Union
|
|
1381
1456
|
|
|
1382
1457
|
# User-authored text content associated with an event.
|
|
1383
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1458
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent }
|
|
1384
1459
|
|
|
1385
1460
|
# User-uploaded image content associated with an event.
|
|
1386
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1461
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent }
|
|
1387
1462
|
|
|
1388
1463
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1389
1464
|
# @!attribute text
|
|
@@ -1395,9 +1470,9 @@ module SafetyKit
|
|
|
1395
1470
|
# @!attribute type
|
|
1396
1471
|
# Text content part.
|
|
1397
1472
|
#
|
|
1398
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1473
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent::Type]
|
|
1399
1474
|
required :type,
|
|
1400
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1475
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent::Type }
|
|
1401
1476
|
|
|
1402
1477
|
# @!attribute key
|
|
1403
1478
|
# Stable field key for this content part.
|
|
@@ -1410,13 +1485,13 @@ module SafetyKit
|
|
|
1410
1485
|
#
|
|
1411
1486
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1412
1487
|
#
|
|
1413
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1488
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent::Type] Text content part.
|
|
1414
1489
|
#
|
|
1415
1490
|
# @param key [String] Stable field key for this content part.
|
|
1416
1491
|
|
|
1417
1492
|
# Text content part.
|
|
1418
1493
|
#
|
|
1419
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1494
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent#type
|
|
1420
1495
|
module Type
|
|
1421
1496
|
extend SafetyKit::Internal::Type::Enum
|
|
1422
1497
|
|
|
@@ -1431,16 +1506,16 @@ module SafetyKit
|
|
|
1431
1506
|
# @!attribute source
|
|
1432
1507
|
# Image source information.
|
|
1433
1508
|
#
|
|
1434
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1509
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source]
|
|
1435
1510
|
required :source,
|
|
1436
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1511
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source }
|
|
1437
1512
|
|
|
1438
1513
|
# @!attribute type
|
|
1439
1514
|
# Image content part.
|
|
1440
1515
|
#
|
|
1441
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1516
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Type]
|
|
1442
1517
|
required :type,
|
|
1443
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1518
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Type }
|
|
1444
1519
|
|
|
1445
1520
|
# @!attribute key
|
|
1446
1521
|
# Stable field key for this content part.
|
|
@@ -1451,20 +1526,20 @@ module SafetyKit
|
|
|
1451
1526
|
# @!method initialize(source:, type:, key: nil)
|
|
1452
1527
|
# User-uploaded image content associated with an event.
|
|
1453
1528
|
#
|
|
1454
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1529
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source] Image source information.
|
|
1455
1530
|
#
|
|
1456
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1531
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Type] Image content part.
|
|
1457
1532
|
#
|
|
1458
1533
|
# @param key [String] Stable field key for this content part.
|
|
1459
1534
|
|
|
1460
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1535
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent#source
|
|
1461
1536
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1462
1537
|
# @!attribute type
|
|
1463
1538
|
# URL image source.
|
|
1464
1539
|
#
|
|
1465
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1540
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source::Type]
|
|
1466
1541
|
required :type,
|
|
1467
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1542
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source::Type }
|
|
1468
1543
|
|
|
1469
1544
|
# @!attribute url
|
|
1470
1545
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1475,13 +1550,13 @@ module SafetyKit
|
|
|
1475
1550
|
# @!method initialize(type:, url:)
|
|
1476
1551
|
# Image source information.
|
|
1477
1552
|
#
|
|
1478
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1553
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
1479
1554
|
#
|
|
1480
1555
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1481
1556
|
|
|
1482
1557
|
# URL image source.
|
|
1483
1558
|
#
|
|
1484
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1559
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source#type
|
|
1485
1560
|
module Type
|
|
1486
1561
|
extend SafetyKit::Internal::Type::Enum
|
|
1487
1562
|
|
|
@@ -1494,7 +1569,7 @@ module SafetyKit
|
|
|
1494
1569
|
|
|
1495
1570
|
# Image content part.
|
|
1496
1571
|
#
|
|
1497
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1572
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent#type
|
|
1498
1573
|
module Type
|
|
1499
1574
|
extend SafetyKit::Internal::Type::Enum
|
|
1500
1575
|
|
|
@@ -1506,7 +1581,7 @@ module SafetyKit
|
|
|
1506
1581
|
end
|
|
1507
1582
|
|
|
1508
1583
|
# @!method self.variants
|
|
1509
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1584
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent)]
|
|
1510
1585
|
end
|
|
1511
1586
|
|
|
1512
1587
|
module Metadata
|
|
@@ -1518,7 +1593,7 @@ module SafetyKit
|
|
|
1518
1593
|
|
|
1519
1594
|
variant SafetyKit::Internal::Type::Boolean
|
|
1520
1595
|
|
|
1521
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1596
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata::UnionMember3Array }
|
|
1522
1597
|
|
|
1523
1598
|
module UnionMember3
|
|
1524
1599
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1539,7 +1614,7 @@ module SafetyKit
|
|
|
1539
1614
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1540
1615
|
UnionMember3Array =
|
|
1541
1616
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1542
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
1617
|
+
SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata::UnionMember3
|
|
1543
1618
|
}]
|
|
1544
1619
|
end
|
|
1545
1620
|
|
|
@@ -1560,7 +1635,7 @@ module SafetyKit
|
|
|
1560
1635
|
|
|
1561
1636
|
# @!method initialize(type:, value:)
|
|
1562
1637
|
# Some parameter documentations has been truncated, see
|
|
1563
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1638
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed}
|
|
1564
1639
|
# for more details.
|
|
1565
1640
|
#
|
|
1566
1641
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1572,7 +1647,7 @@ module SafetyKit
|
|
|
1572
1647
|
end
|
|
1573
1648
|
end
|
|
1574
1649
|
|
|
1575
|
-
class
|
|
1650
|
+
class UserReportEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
1576
1651
|
# @!attribute event_name
|
|
1577
1652
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1578
1653
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -1586,25 +1661,6 @@ module SafetyKit
|
|
|
1586
1661
|
# @return [Array<String>]
|
|
1587
1662
|
required :labels, SafetyKit::Internal::Type::ArrayOf[String]
|
|
1588
1663
|
|
|
1589
|
-
# @!attribute source_id
|
|
1590
|
-
# Stable identifier within source_type. Examples: moderator@example.com or
|
|
1591
|
-
# 550e8400-e29b-41d4-a716-446655440000 for expert_labeler or human_moderator,
|
|
1592
|
-
# automated_review_v2026_06_04 for automation, or <vendor_name>-v2.1 for vendor.
|
|
1593
|
-
#
|
|
1594
|
-
# @return [String]
|
|
1595
|
-
required :source_id, String
|
|
1596
|
-
|
|
1597
|
-
# @!attribute source_type
|
|
1598
|
-
# Coarse attribution category for the moderation decision source. Supported
|
|
1599
|
-
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
1600
|
-
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
1601
|
-
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
1602
|
-
# review or moderation provider).
|
|
1603
|
-
#
|
|
1604
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType]
|
|
1605
|
-
required :source_type,
|
|
1606
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType }
|
|
1607
|
-
|
|
1608
1664
|
# @!attribute timestamp
|
|
1609
1665
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1610
1666
|
#
|
|
@@ -1613,18 +1669,23 @@ module SafetyKit
|
|
|
1613
1669
|
|
|
1614
1670
|
# @!attribute type
|
|
1615
1671
|
#
|
|
1616
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1617
|
-
required :type,
|
|
1618
|
-
|
|
1672
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Type]
|
|
1673
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Type }
|
|
1674
|
+
|
|
1675
|
+
# @!attribute user_id
|
|
1676
|
+
# Your stable canonical identifier for the user or account.
|
|
1677
|
+
#
|
|
1678
|
+
# @return [String]
|
|
1679
|
+
required :user_id, String
|
|
1619
1680
|
|
|
1620
1681
|
# @!attribute content
|
|
1621
1682
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1622
1683
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1623
1684
|
# analyze.
|
|
1624
1685
|
#
|
|
1625
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1686
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent>, nil]
|
|
1626
1687
|
optional :content,
|
|
1627
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1688
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content] }
|
|
1628
1689
|
|
|
1629
1690
|
# @!attribute content_id
|
|
1630
1691
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -1646,16 +1707,16 @@ module SafetyKit
|
|
|
1646
1707
|
#
|
|
1647
1708
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1648
1709
|
optional :metadata,
|
|
1649
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1710
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata] }
|
|
1650
1711
|
|
|
1651
1712
|
# @!attribute resources_used
|
|
1652
1713
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1653
1714
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1654
1715
|
# identifiers.
|
|
1655
1716
|
#
|
|
1656
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1717
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed>, nil]
|
|
1657
1718
|
optional :resources_used,
|
|
1658
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
1719
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed] }
|
|
1659
1720
|
|
|
1660
1721
|
# @!attribute target_content_id
|
|
1661
1722
|
# Your stable identifier for the content being reported.
|
|
@@ -1669,28 +1730,27 @@ module SafetyKit
|
|
|
1669
1730
|
# @return [String, nil]
|
|
1670
1731
|
optional :target_user_id, String
|
|
1671
1732
|
|
|
1672
|
-
# @!method initialize(event_name:, labels:,
|
|
1733
|
+
# @!method initialize(event_name:, labels:, timestamp:, type:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil)
|
|
1673
1734
|
# Some parameter documentations has been truncated, see
|
|
1674
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1675
|
-
#
|
|
1735
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest} for
|
|
1736
|
+
# more details.
|
|
1676
1737
|
#
|
|
1677
|
-
# A
|
|
1678
|
-
#
|
|
1679
|
-
#
|
|
1738
|
+
# A user-submitted report. Use user_id for the reporter. Include target_user_id
|
|
1739
|
+
# when a user is reported, target_content_id when content is reported, and both
|
|
1740
|
+
# when the report is about content associated with a user. Use content and
|
|
1741
|
+
# content_id for the report itself.
|
|
1680
1742
|
#
|
|
1681
1743
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1682
1744
|
#
|
|
1683
1745
|
# @param labels [Array<String>] One or more label categories supplied with the report or moderation decision.
|
|
1684
1746
|
#
|
|
1685
|
-
# @param source_id [String] Stable identifier within source_type. Examples: moderator@example.com or 550e840
|
|
1686
|
-
#
|
|
1687
|
-
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType] Coarse attribution category for the moderation decision source. Supported values
|
|
1688
|
-
#
|
|
1689
1747
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1690
1748
|
#
|
|
1691
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1749
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Type]
|
|
1692
1750
|
#
|
|
1693
|
-
# @param
|
|
1751
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1752
|
+
#
|
|
1753
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1694
1754
|
#
|
|
1695
1755
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1696
1756
|
#
|
|
@@ -1698,36 +1758,17 @@ module SafetyKit
|
|
|
1698
1758
|
#
|
|
1699
1759
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1700
1760
|
#
|
|
1701
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1761
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1702
1762
|
#
|
|
1703
1763
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
1704
1764
|
#
|
|
1705
1765
|
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
1706
1766
|
|
|
1707
|
-
#
|
|
1708
|
-
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
1709
|
-
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
1710
|
-
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
1711
|
-
# review or moderation provider).
|
|
1712
|
-
#
|
|
1713
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#source_type
|
|
1714
|
-
module SourceType
|
|
1715
|
-
extend SafetyKit::Internal::Type::Enum
|
|
1716
|
-
|
|
1717
|
-
HUMAN_MODERATOR = :human_moderator
|
|
1718
|
-
EXPERT_LABELER = :expert_labeler
|
|
1719
|
-
AUTOMATION = :automation
|
|
1720
|
-
VENDOR = :vendor
|
|
1721
|
-
|
|
1722
|
-
# @!method self.values
|
|
1723
|
-
# @return [Array<Symbol>]
|
|
1724
|
-
end
|
|
1725
|
-
|
|
1726
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#type
|
|
1767
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest#type
|
|
1727
1768
|
module Type
|
|
1728
1769
|
extend SafetyKit::Internal::Type::Enum
|
|
1729
1770
|
|
|
1730
|
-
|
|
1771
|
+
USER_REPORT = :user_report
|
|
1731
1772
|
|
|
1732
1773
|
# @!method self.values
|
|
1733
1774
|
# @return [Array<Symbol>]
|
|
@@ -1738,10 +1779,10 @@ module SafetyKit
|
|
|
1738
1779
|
extend SafetyKit::Internal::Type::Union
|
|
1739
1780
|
|
|
1740
1781
|
# User-authored text content associated with an event.
|
|
1741
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1782
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent }
|
|
1742
1783
|
|
|
1743
1784
|
# User-uploaded image content associated with an event.
|
|
1744
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1785
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent }
|
|
1745
1786
|
|
|
1746
1787
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1747
1788
|
# @!attribute text
|
|
@@ -1753,9 +1794,9 @@ module SafetyKit
|
|
|
1753
1794
|
# @!attribute type
|
|
1754
1795
|
# Text content part.
|
|
1755
1796
|
#
|
|
1756
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1797
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent::Type]
|
|
1757
1798
|
required :type,
|
|
1758
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1799
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent::Type }
|
|
1759
1800
|
|
|
1760
1801
|
# @!attribute key
|
|
1761
1802
|
# Stable field key for this content part.
|
|
@@ -1768,13 +1809,13 @@ module SafetyKit
|
|
|
1768
1809
|
#
|
|
1769
1810
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1770
1811
|
#
|
|
1771
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1812
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent::Type] Text content part.
|
|
1772
1813
|
#
|
|
1773
1814
|
# @param key [String] Stable field key for this content part.
|
|
1774
1815
|
|
|
1775
1816
|
# Text content part.
|
|
1776
1817
|
#
|
|
1777
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1818
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent#type
|
|
1778
1819
|
module Type
|
|
1779
1820
|
extend SafetyKit::Internal::Type::Enum
|
|
1780
1821
|
|
|
@@ -1789,16 +1830,16 @@ module SafetyKit
|
|
|
1789
1830
|
# @!attribute source
|
|
1790
1831
|
# Image source information.
|
|
1791
1832
|
#
|
|
1792
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1833
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source]
|
|
1793
1834
|
required :source,
|
|
1794
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1835
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source }
|
|
1795
1836
|
|
|
1796
1837
|
# @!attribute type
|
|
1797
1838
|
# Image content part.
|
|
1798
1839
|
#
|
|
1799
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1840
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Type]
|
|
1800
1841
|
required :type,
|
|
1801
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1842
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Type }
|
|
1802
1843
|
|
|
1803
1844
|
# @!attribute key
|
|
1804
1845
|
# Stable field key for this content part.
|
|
@@ -1809,20 +1850,20 @@ module SafetyKit
|
|
|
1809
1850
|
# @!method initialize(source:, type:, key: nil)
|
|
1810
1851
|
# User-uploaded image content associated with an event.
|
|
1811
1852
|
#
|
|
1812
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1853
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source] Image source information.
|
|
1813
1854
|
#
|
|
1814
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1855
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Type] Image content part.
|
|
1815
1856
|
#
|
|
1816
1857
|
# @param key [String] Stable field key for this content part.
|
|
1817
1858
|
|
|
1818
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1859
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent#source
|
|
1819
1860
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1820
1861
|
# @!attribute type
|
|
1821
1862
|
# URL image source.
|
|
1822
1863
|
#
|
|
1823
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1864
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type]
|
|
1824
1865
|
required :type,
|
|
1825
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1866
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type }
|
|
1826
1867
|
|
|
1827
1868
|
# @!attribute url
|
|
1828
1869
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1830,55 +1871,726 @@ module SafetyKit
|
|
|
1830
1871
|
# @return [String]
|
|
1831
1872
|
required :url, String
|
|
1832
1873
|
|
|
1833
|
-
# @!method initialize(type:, url:)
|
|
1834
|
-
# Image source information.
|
|
1874
|
+
# @!method initialize(type:, url:)
|
|
1875
|
+
# Image source information.
|
|
1876
|
+
#
|
|
1877
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
1878
|
+
#
|
|
1879
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1880
|
+
|
|
1881
|
+
# URL image source.
|
|
1882
|
+
#
|
|
1883
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source#type
|
|
1884
|
+
module Type
|
|
1885
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1886
|
+
|
|
1887
|
+
URL = :url
|
|
1888
|
+
|
|
1889
|
+
# @!method self.values
|
|
1890
|
+
# @return [Array<Symbol>]
|
|
1891
|
+
end
|
|
1892
|
+
end
|
|
1893
|
+
|
|
1894
|
+
# Image content part.
|
|
1895
|
+
#
|
|
1896
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent#type
|
|
1897
|
+
module Type
|
|
1898
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1899
|
+
|
|
1900
|
+
IMAGE = :image
|
|
1901
|
+
|
|
1902
|
+
# @!method self.values
|
|
1903
|
+
# @return [Array<Symbol>]
|
|
1904
|
+
end
|
|
1905
|
+
end
|
|
1906
|
+
|
|
1907
|
+
# @!method self.variants
|
|
1908
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent)]
|
|
1909
|
+
end
|
|
1910
|
+
|
|
1911
|
+
module Metadata
|
|
1912
|
+
extend SafetyKit::Internal::Type::Union
|
|
1913
|
+
|
|
1914
|
+
variant String
|
|
1915
|
+
|
|
1916
|
+
variant Float
|
|
1917
|
+
|
|
1918
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1919
|
+
|
|
1920
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata::UnionMember3Array }
|
|
1921
|
+
|
|
1922
|
+
module UnionMember3
|
|
1923
|
+
extend SafetyKit::Internal::Type::Union
|
|
1924
|
+
|
|
1925
|
+
variant String
|
|
1926
|
+
|
|
1927
|
+
variant Float
|
|
1928
|
+
|
|
1929
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1930
|
+
|
|
1931
|
+
# @!method self.variants
|
|
1932
|
+
# @return [Array(String, Float, Boolean)]
|
|
1933
|
+
end
|
|
1934
|
+
|
|
1935
|
+
# @!method self.variants
|
|
1936
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
1937
|
+
|
|
1938
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
1939
|
+
UnionMember3Array =
|
|
1940
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1941
|
+
SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata::UnionMember3
|
|
1942
|
+
}]
|
|
1943
|
+
end
|
|
1944
|
+
|
|
1945
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
1946
|
+
# @!attribute type
|
|
1947
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
1948
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
1949
|
+
#
|
|
1950
|
+
# @return [String]
|
|
1951
|
+
required :type, String
|
|
1952
|
+
|
|
1953
|
+
# @!attribute value
|
|
1954
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1955
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1956
|
+
#
|
|
1957
|
+
# @return [String]
|
|
1958
|
+
required :value, String
|
|
1959
|
+
|
|
1960
|
+
# @!method initialize(type:, value:)
|
|
1961
|
+
# Some parameter documentations has been truncated, see
|
|
1962
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed}
|
|
1963
|
+
# for more details.
|
|
1964
|
+
#
|
|
1965
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
1966
|
+
# number, address, URL, social handle, or payment identifier.
|
|
1967
|
+
#
|
|
1968
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
1969
|
+
#
|
|
1970
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1971
|
+
end
|
|
1972
|
+
end
|
|
1973
|
+
|
|
1974
|
+
class ModerationDecisionEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
1975
|
+
# @!attribute event_name
|
|
1976
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1977
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
1978
|
+
#
|
|
1979
|
+
# @return [String]
|
|
1980
|
+
required :event_name, String
|
|
1981
|
+
|
|
1982
|
+
# @!attribute labels
|
|
1983
|
+
# One or more label categories supplied with the report or moderation decision.
|
|
1984
|
+
#
|
|
1985
|
+
# @return [Array<String>]
|
|
1986
|
+
required :labels, SafetyKit::Internal::Type::ArrayOf[String]
|
|
1987
|
+
|
|
1988
|
+
# @!attribute source_id
|
|
1989
|
+
# Stable identifier within source_type. Examples: moderator@example.com or
|
|
1990
|
+
# 550e8400-e29b-41d4-a716-446655440000 for expert_labeler or human_moderator,
|
|
1991
|
+
# automated_review_v2026_06_04 for automation, or <vendor_name>-v2.1 for vendor.
|
|
1992
|
+
#
|
|
1993
|
+
# @return [String]
|
|
1994
|
+
required :source_id, String
|
|
1995
|
+
|
|
1996
|
+
# @!attribute source_type
|
|
1997
|
+
# Coarse attribution category for the moderation decision source. Supported
|
|
1998
|
+
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
1999
|
+
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
2000
|
+
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
2001
|
+
# review or moderation provider).
|
|
2002
|
+
#
|
|
2003
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType]
|
|
2004
|
+
required :source_type,
|
|
2005
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType }
|
|
2006
|
+
|
|
2007
|
+
# @!attribute timestamp
|
|
2008
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2009
|
+
#
|
|
2010
|
+
# @return [Time]
|
|
2011
|
+
required :timestamp, Time
|
|
2012
|
+
|
|
2013
|
+
# @!attribute type
|
|
2014
|
+
#
|
|
2015
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Type]
|
|
2016
|
+
required :type,
|
|
2017
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Type }
|
|
2018
|
+
|
|
2019
|
+
# @!attribute content
|
|
2020
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2021
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2022
|
+
# analyze.
|
|
2023
|
+
#
|
|
2024
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent>, nil]
|
|
2025
|
+
optional :content,
|
|
2026
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content] }
|
|
2027
|
+
|
|
2028
|
+
# @!attribute content_id
|
|
2029
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
2030
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
2031
|
+
#
|
|
2032
|
+
# @return [String, nil]
|
|
2033
|
+
optional :content_id, String
|
|
2034
|
+
|
|
2035
|
+
# @!attribute idempotency_key
|
|
2036
|
+
# Optional caller-provided key used to make retries of this individual event
|
|
2037
|
+
# idempotent. Reuse the same key only for retries of the same logical event.
|
|
2038
|
+
#
|
|
2039
|
+
# @return [String, nil]
|
|
2040
|
+
optional :idempotency_key, String
|
|
2041
|
+
|
|
2042
|
+
# @!attribute metadata
|
|
2043
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
2044
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
2045
|
+
#
|
|
2046
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2047
|
+
optional :metadata,
|
|
2048
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata] }
|
|
2049
|
+
|
|
2050
|
+
# @!attribute resources_used
|
|
2051
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
2052
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2053
|
+
# identifiers.
|
|
2054
|
+
#
|
|
2055
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed>, nil]
|
|
2056
|
+
optional :resources_used,
|
|
2057
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed] }
|
|
2058
|
+
|
|
2059
|
+
# @!attribute target_content_id
|
|
2060
|
+
# Your stable identifier for the content being reported.
|
|
2061
|
+
#
|
|
2062
|
+
# @return [String, nil]
|
|
2063
|
+
optional :target_content_id, String
|
|
2064
|
+
|
|
2065
|
+
# @!attribute target_user_id
|
|
2066
|
+
# Your stable canonical identifier for the user being reported.
|
|
2067
|
+
#
|
|
2068
|
+
# @return [String, nil]
|
|
2069
|
+
optional :target_user_id, String
|
|
2070
|
+
|
|
2071
|
+
# @!method initialize(event_name:, labels:, source_id:, source_type:, timestamp:, type:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil)
|
|
2072
|
+
# Some parameter documentations has been truncated, see
|
|
2073
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest}
|
|
2074
|
+
# for more details.
|
|
2075
|
+
#
|
|
2076
|
+
# A moderation label or decision from an automated enforcement system or manual
|
|
2077
|
+
# review workflow. Do not send user_id; use source_type and source_id for
|
|
2078
|
+
# attribution.
|
|
2079
|
+
#
|
|
2080
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
2081
|
+
#
|
|
2082
|
+
# @param labels [Array<String>] One or more label categories supplied with the report or moderation decision.
|
|
2083
|
+
#
|
|
2084
|
+
# @param source_id [String] Stable identifier within source_type. Examples: moderator@example.com or 550e840
|
|
2085
|
+
#
|
|
2086
|
+
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType] Coarse attribution category for the moderation decision source. Supported values
|
|
2087
|
+
#
|
|
2088
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2089
|
+
#
|
|
2090
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Type]
|
|
2091
|
+
#
|
|
2092
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2093
|
+
#
|
|
2094
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2095
|
+
#
|
|
2096
|
+
# @param idempotency_key [String] Optional caller-provided key used to make retries of this individual event idemp
|
|
2097
|
+
#
|
|
2098
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2099
|
+
#
|
|
2100
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2101
|
+
#
|
|
2102
|
+
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
2103
|
+
#
|
|
2104
|
+
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
2105
|
+
|
|
2106
|
+
# Coarse attribution category for the moderation decision source. Supported
|
|
2107
|
+
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
2108
|
+
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
2109
|
+
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
2110
|
+
# review or moderation provider).
|
|
2111
|
+
#
|
|
2112
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#source_type
|
|
2113
|
+
module SourceType
|
|
2114
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2115
|
+
|
|
2116
|
+
HUMAN_MODERATOR = :human_moderator
|
|
2117
|
+
EXPERT_LABELER = :expert_labeler
|
|
2118
|
+
AUTOMATION = :automation
|
|
2119
|
+
VENDOR = :vendor
|
|
2120
|
+
|
|
2121
|
+
# @!method self.values
|
|
2122
|
+
# @return [Array<Symbol>]
|
|
2123
|
+
end
|
|
2124
|
+
|
|
2125
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#type
|
|
2126
|
+
module Type
|
|
2127
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2128
|
+
|
|
2129
|
+
MODERATION_DECISION = :moderation_decision
|
|
2130
|
+
|
|
2131
|
+
# @!method self.values
|
|
2132
|
+
# @return [Array<Symbol>]
|
|
2133
|
+
end
|
|
2134
|
+
|
|
2135
|
+
# User-authored text content associated with an event.
|
|
2136
|
+
module Content
|
|
2137
|
+
extend SafetyKit::Internal::Type::Union
|
|
2138
|
+
|
|
2139
|
+
# User-authored text content associated with an event.
|
|
2140
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent }
|
|
2141
|
+
|
|
2142
|
+
# User-uploaded image content associated with an event.
|
|
2143
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent }
|
|
2144
|
+
|
|
2145
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2146
|
+
# @!attribute text
|
|
2147
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
2148
|
+
#
|
|
2149
|
+
# @return [String]
|
|
2150
|
+
required :text, String
|
|
2151
|
+
|
|
2152
|
+
# @!attribute type
|
|
2153
|
+
# Text content part.
|
|
2154
|
+
#
|
|
2155
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent::Type]
|
|
2156
|
+
required :type,
|
|
2157
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent::Type }
|
|
2158
|
+
|
|
2159
|
+
# @!attribute key
|
|
2160
|
+
# Stable field key for this content part.
|
|
2161
|
+
#
|
|
2162
|
+
# @return [String, nil]
|
|
2163
|
+
optional :key, String
|
|
2164
|
+
|
|
2165
|
+
# @!method initialize(text:, type:, key: nil)
|
|
2166
|
+
# User-authored text content associated with an event.
|
|
2167
|
+
#
|
|
2168
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2169
|
+
#
|
|
2170
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent::Type] Text content part.
|
|
2171
|
+
#
|
|
2172
|
+
# @param key [String] Stable field key for this content part.
|
|
2173
|
+
|
|
2174
|
+
# Text content part.
|
|
2175
|
+
#
|
|
2176
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent#type
|
|
2177
|
+
module Type
|
|
2178
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2179
|
+
|
|
2180
|
+
TEXT = :text
|
|
2181
|
+
|
|
2182
|
+
# @!method self.values
|
|
2183
|
+
# @return [Array<Symbol>]
|
|
2184
|
+
end
|
|
2185
|
+
end
|
|
2186
|
+
|
|
2187
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
2188
|
+
# @!attribute source
|
|
2189
|
+
# Image source information.
|
|
2190
|
+
#
|
|
2191
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source]
|
|
2192
|
+
required :source,
|
|
2193
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source }
|
|
2194
|
+
|
|
2195
|
+
# @!attribute type
|
|
2196
|
+
# Image content part.
|
|
2197
|
+
#
|
|
2198
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Type]
|
|
2199
|
+
required :type,
|
|
2200
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Type }
|
|
2201
|
+
|
|
2202
|
+
# @!attribute key
|
|
2203
|
+
# Stable field key for this content part.
|
|
2204
|
+
#
|
|
2205
|
+
# @return [String, nil]
|
|
2206
|
+
optional :key, String
|
|
2207
|
+
|
|
2208
|
+
# @!method initialize(source:, type:, key: nil)
|
|
2209
|
+
# User-uploaded image content associated with an event.
|
|
2210
|
+
#
|
|
2211
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source] Image source information.
|
|
2212
|
+
#
|
|
2213
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Type] Image content part.
|
|
2214
|
+
#
|
|
2215
|
+
# @param key [String] Stable field key for this content part.
|
|
2216
|
+
|
|
2217
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent#source
|
|
2218
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2219
|
+
# @!attribute type
|
|
2220
|
+
# URL image source.
|
|
2221
|
+
#
|
|
2222
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source::Type]
|
|
2223
|
+
required :type,
|
|
2224
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source::Type }
|
|
2225
|
+
|
|
2226
|
+
# @!attribute url
|
|
2227
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
2228
|
+
#
|
|
2229
|
+
# @return [String]
|
|
2230
|
+
required :url, String
|
|
2231
|
+
|
|
2232
|
+
# @!method initialize(type:, url:)
|
|
2233
|
+
# Image source information.
|
|
2234
|
+
#
|
|
2235
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
2236
|
+
#
|
|
2237
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2238
|
+
|
|
2239
|
+
# URL image source.
|
|
2240
|
+
#
|
|
2241
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source#type
|
|
2242
|
+
module Type
|
|
2243
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2244
|
+
|
|
2245
|
+
URL = :url
|
|
2246
|
+
|
|
2247
|
+
# @!method self.values
|
|
2248
|
+
# @return [Array<Symbol>]
|
|
2249
|
+
end
|
|
2250
|
+
end
|
|
2251
|
+
|
|
2252
|
+
# Image content part.
|
|
2253
|
+
#
|
|
2254
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent#type
|
|
2255
|
+
module Type
|
|
2256
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2257
|
+
|
|
2258
|
+
IMAGE = :image
|
|
2259
|
+
|
|
2260
|
+
# @!method self.values
|
|
2261
|
+
# @return [Array<Symbol>]
|
|
2262
|
+
end
|
|
2263
|
+
end
|
|
2264
|
+
|
|
2265
|
+
# @!method self.variants
|
|
2266
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent)]
|
|
2267
|
+
end
|
|
2268
|
+
|
|
2269
|
+
module Metadata
|
|
2270
|
+
extend SafetyKit::Internal::Type::Union
|
|
2271
|
+
|
|
2272
|
+
variant String
|
|
2273
|
+
|
|
2274
|
+
variant Float
|
|
2275
|
+
|
|
2276
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2277
|
+
|
|
2278
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata::UnionMember3Array }
|
|
2279
|
+
|
|
2280
|
+
module UnionMember3
|
|
2281
|
+
extend SafetyKit::Internal::Type::Union
|
|
2282
|
+
|
|
2283
|
+
variant String
|
|
2284
|
+
|
|
2285
|
+
variant Float
|
|
2286
|
+
|
|
2287
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2288
|
+
|
|
2289
|
+
# @!method self.variants
|
|
2290
|
+
# @return [Array(String, Float, Boolean)]
|
|
2291
|
+
end
|
|
2292
|
+
|
|
2293
|
+
# @!method self.variants
|
|
2294
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
2295
|
+
|
|
2296
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
2297
|
+
UnionMember3Array =
|
|
2298
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
2299
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata::UnionMember3 }
|
|
2300
|
+
]
|
|
2301
|
+
end
|
|
2302
|
+
|
|
2303
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
2304
|
+
# @!attribute type
|
|
2305
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
2306
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
2307
|
+
#
|
|
2308
|
+
# @return [String]
|
|
2309
|
+
required :type, String
|
|
2310
|
+
|
|
2311
|
+
# @!attribute value
|
|
2312
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2313
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2314
|
+
#
|
|
2315
|
+
# @return [String]
|
|
2316
|
+
required :value, String
|
|
2317
|
+
|
|
2318
|
+
# @!method initialize(type:, value:)
|
|
2319
|
+
# Some parameter documentations has been truncated, see
|
|
2320
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed}
|
|
2321
|
+
# for more details.
|
|
2322
|
+
#
|
|
2323
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
2324
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2325
|
+
#
|
|
2326
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
2327
|
+
#
|
|
2328
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2329
|
+
end
|
|
2330
|
+
end
|
|
2331
|
+
|
|
2332
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
2333
|
+
module UnionMember7
|
|
2334
|
+
extend SafetyKit::Internal::Type::Union
|
|
2335
|
+
|
|
2336
|
+
discriminator :type
|
|
2337
|
+
|
|
2338
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
2339
|
+
variant :user_contact, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact }
|
|
2340
|
+
|
|
2341
|
+
# A user posts, uploads, publishes, edits, or replaces content.
|
|
2342
|
+
variant :content_uploaded, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded }
|
|
2343
|
+
|
|
2344
|
+
# A product listing is created, updated, or has a discount added.
|
|
2345
|
+
variant :product_changed, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged }
|
|
2346
|
+
|
|
2347
|
+
# A user or account is created.
|
|
2348
|
+
variant :create_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount }
|
|
2349
|
+
|
|
2350
|
+
# A user or account profile, contact detail, payment detail, or public bio changes.
|
|
2351
|
+
variant :update_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount }
|
|
2352
|
+
|
|
2353
|
+
# A user-submitted report. Use user_id for the reporter. Include target_user_id when a user is reported, target_content_id when content is reported, and both when the report is about content associated with a user. Use content and content_id for the report itself.
|
|
2354
|
+
variant :user_report, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport }
|
|
2355
|
+
|
|
2356
|
+
# A moderation label or decision from an automated enforcement system or manual review workflow. Do not send user_id; use source_type and source_id for attribution.
|
|
2357
|
+
variant :moderation_decision,
|
|
2358
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision }
|
|
2359
|
+
|
|
2360
|
+
class UserContact < SafetyKit::Internal::Type::BaseModel
|
|
2361
|
+
# @!attribute event_name
|
|
2362
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
2363
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
2364
|
+
#
|
|
2365
|
+
# @return [String]
|
|
2366
|
+
required :event_name, String
|
|
2367
|
+
|
|
2368
|
+
# @!attribute target_user_id
|
|
2369
|
+
# Your stable canonical identifier for the other user in a user-to-user
|
|
2370
|
+
# interaction.
|
|
2371
|
+
#
|
|
2372
|
+
# @return [String]
|
|
2373
|
+
required :target_user_id, String
|
|
2374
|
+
|
|
2375
|
+
# @!attribute timestamp
|
|
2376
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2377
|
+
#
|
|
2378
|
+
# @return [Time]
|
|
2379
|
+
required :timestamp, Time
|
|
2380
|
+
|
|
2381
|
+
# @!attribute type
|
|
2382
|
+
#
|
|
2383
|
+
# @return [Symbol, :user_contact]
|
|
2384
|
+
required :type, const: :user_contact
|
|
2385
|
+
|
|
2386
|
+
# @!attribute user_id
|
|
2387
|
+
# Your stable canonical identifier for the user or account.
|
|
2388
|
+
#
|
|
2389
|
+
# @return [String]
|
|
2390
|
+
required :user_id, String
|
|
2391
|
+
|
|
2392
|
+
# @!attribute content
|
|
2393
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2394
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2395
|
+
# analyze.
|
|
2396
|
+
#
|
|
2397
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent>, nil]
|
|
2398
|
+
optional :content,
|
|
2399
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content] }
|
|
2400
|
+
|
|
2401
|
+
# @!attribute content_id
|
|
2402
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
2403
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
2404
|
+
#
|
|
2405
|
+
# @return [String, nil]
|
|
2406
|
+
optional :content_id, String
|
|
2407
|
+
|
|
2408
|
+
# @!attribute idempotency_key
|
|
2409
|
+
# Optional caller-provided key used to make retries of this individual event
|
|
2410
|
+
# idempotent. Reuse the same key only for retries of the same logical event.
|
|
2411
|
+
#
|
|
2412
|
+
# @return [String, nil]
|
|
2413
|
+
optional :idempotency_key, String
|
|
2414
|
+
|
|
2415
|
+
# @!attribute metadata
|
|
2416
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
2417
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
2418
|
+
#
|
|
2419
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2420
|
+
optional :metadata,
|
|
2421
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Metadata] }
|
|
2422
|
+
|
|
2423
|
+
# @!attribute resources_used
|
|
2424
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
2425
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2426
|
+
# identifiers.
|
|
2427
|
+
#
|
|
2428
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed>, nil]
|
|
2429
|
+
optional :resources_used,
|
|
2430
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed] }
|
|
2431
|
+
|
|
2432
|
+
# @!method initialize(event_name:, target_user_id:, timestamp:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :user_contact)
|
|
2433
|
+
# Some parameter documentations has been truncated, see
|
|
2434
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact}
|
|
2435
|
+
# for more details.
|
|
2436
|
+
#
|
|
2437
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
2438
|
+
#
|
|
2439
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
2440
|
+
#
|
|
2441
|
+
# @param target_user_id [String] Your stable canonical identifier for the other user in a user-to-user interactio
|
|
2442
|
+
#
|
|
2443
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2444
|
+
#
|
|
2445
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2446
|
+
#
|
|
2447
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2448
|
+
#
|
|
2449
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2450
|
+
#
|
|
2451
|
+
# @param idempotency_key [String] Optional caller-provided key used to make retries of this individual event idemp
|
|
2452
|
+
#
|
|
2453
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2454
|
+
#
|
|
2455
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2456
|
+
#
|
|
2457
|
+
# @param type [Symbol, :user_contact]
|
|
2458
|
+
|
|
2459
|
+
# User-authored text content associated with an event.
|
|
2460
|
+
module Content
|
|
2461
|
+
extend SafetyKit::Internal::Type::Union
|
|
2462
|
+
|
|
2463
|
+
# User-authored text content associated with an event.
|
|
2464
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent }
|
|
2465
|
+
|
|
2466
|
+
# User-uploaded image content associated with an event.
|
|
2467
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent }
|
|
2468
|
+
|
|
2469
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2470
|
+
# @!attribute text
|
|
2471
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
2472
|
+
#
|
|
2473
|
+
# @return [String]
|
|
2474
|
+
required :text, String
|
|
2475
|
+
|
|
2476
|
+
# @!attribute type
|
|
2477
|
+
# Text content part.
|
|
2478
|
+
#
|
|
2479
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent::Type]
|
|
2480
|
+
required :type,
|
|
2481
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent::Type }
|
|
2482
|
+
|
|
2483
|
+
# @!attribute key
|
|
2484
|
+
# Stable field key for this content part.
|
|
2485
|
+
#
|
|
2486
|
+
# @return [String, nil]
|
|
2487
|
+
optional :key, String
|
|
2488
|
+
|
|
2489
|
+
# @!method initialize(text:, type:, key: nil)
|
|
2490
|
+
# User-authored text content associated with an event.
|
|
2491
|
+
#
|
|
2492
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2493
|
+
#
|
|
2494
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent::Type] Text content part.
|
|
2495
|
+
#
|
|
2496
|
+
# @param key [String] Stable field key for this content part.
|
|
2497
|
+
|
|
2498
|
+
# Text content part.
|
|
2499
|
+
#
|
|
2500
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent#type
|
|
2501
|
+
module Type
|
|
2502
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2503
|
+
|
|
2504
|
+
TEXT = :text
|
|
2505
|
+
|
|
2506
|
+
# @!method self.values
|
|
2507
|
+
# @return [Array<Symbol>]
|
|
2508
|
+
end
|
|
2509
|
+
end
|
|
2510
|
+
|
|
2511
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
2512
|
+
# @!attribute source
|
|
2513
|
+
# Image source information.
|
|
2514
|
+
#
|
|
2515
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source]
|
|
2516
|
+
required :source,
|
|
2517
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source }
|
|
2518
|
+
|
|
2519
|
+
# @!attribute type
|
|
2520
|
+
# Image content part.
|
|
2521
|
+
#
|
|
2522
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Type]
|
|
2523
|
+
required :type,
|
|
2524
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Type }
|
|
2525
|
+
|
|
2526
|
+
# @!attribute key
|
|
2527
|
+
# Stable field key for this content part.
|
|
2528
|
+
#
|
|
2529
|
+
# @return [String, nil]
|
|
2530
|
+
optional :key, String
|
|
2531
|
+
|
|
2532
|
+
# @!method initialize(source:, type:, key: nil)
|
|
2533
|
+
# User-uploaded image content associated with an event.
|
|
1835
2534
|
#
|
|
1836
|
-
# @param
|
|
2535
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source] Image source information.
|
|
1837
2536
|
#
|
|
1838
|
-
# @param
|
|
2537
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Type] Image content part.
|
|
2538
|
+
#
|
|
2539
|
+
# @param key [String] Stable field key for this content part.
|
|
1839
2540
|
|
|
1840
|
-
#
|
|
2541
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent#source
|
|
2542
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2543
|
+
# @!attribute type
|
|
2544
|
+
# URL image source.
|
|
2545
|
+
#
|
|
2546
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source::Type]
|
|
2547
|
+
required :type,
|
|
2548
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source::Type }
|
|
2549
|
+
|
|
2550
|
+
# @!attribute url
|
|
2551
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
2552
|
+
#
|
|
2553
|
+
# @return [String]
|
|
2554
|
+
required :url, String
|
|
2555
|
+
|
|
2556
|
+
# @!method initialize(type:, url:)
|
|
2557
|
+
# Image source information.
|
|
2558
|
+
#
|
|
2559
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source::Type] URL image source.
|
|
2560
|
+
#
|
|
2561
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2562
|
+
|
|
2563
|
+
# URL image source.
|
|
2564
|
+
#
|
|
2565
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source#type
|
|
2566
|
+
module Type
|
|
2567
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2568
|
+
|
|
2569
|
+
URL = :url
|
|
2570
|
+
|
|
2571
|
+
# @!method self.values
|
|
2572
|
+
# @return [Array<Symbol>]
|
|
2573
|
+
end
|
|
2574
|
+
end
|
|
2575
|
+
|
|
2576
|
+
# Image content part.
|
|
1841
2577
|
#
|
|
1842
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2578
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent#type
|
|
1843
2579
|
module Type
|
|
1844
2580
|
extend SafetyKit::Internal::Type::Enum
|
|
1845
2581
|
|
|
1846
|
-
|
|
2582
|
+
IMAGE = :image
|
|
1847
2583
|
|
|
1848
2584
|
# @!method self.values
|
|
1849
2585
|
# @return [Array<Symbol>]
|
|
1850
2586
|
end
|
|
1851
2587
|
end
|
|
1852
2588
|
|
|
1853
|
-
#
|
|
1854
|
-
#
|
|
1855
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent#type
|
|
1856
|
-
module Type
|
|
1857
|
-
extend SafetyKit::Internal::Type::Enum
|
|
1858
|
-
|
|
1859
|
-
IMAGE = :image
|
|
1860
|
-
|
|
1861
|
-
# @!method self.values
|
|
1862
|
-
# @return [Array<Symbol>]
|
|
1863
|
-
end
|
|
2589
|
+
# @!method self.variants
|
|
2590
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent)]
|
|
1864
2591
|
end
|
|
1865
2592
|
|
|
1866
|
-
|
|
1867
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent)]
|
|
1868
|
-
end
|
|
1869
|
-
|
|
1870
|
-
module Metadata
|
|
1871
|
-
extend SafetyKit::Internal::Type::Union
|
|
1872
|
-
|
|
1873
|
-
variant String
|
|
1874
|
-
|
|
1875
|
-
variant Float
|
|
1876
|
-
|
|
1877
|
-
variant SafetyKit::Internal::Type::Boolean
|
|
1878
|
-
|
|
1879
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata::UnionMember3Array }
|
|
1880
|
-
|
|
1881
|
-
module UnionMember3
|
|
2593
|
+
module Metadata
|
|
1882
2594
|
extend SafetyKit::Internal::Type::Union
|
|
1883
2595
|
|
|
1884
2596
|
variant String
|
|
@@ -1887,75 +2599,70 @@ module SafetyKit
|
|
|
1887
2599
|
|
|
1888
2600
|
variant SafetyKit::Internal::Type::Boolean
|
|
1889
2601
|
|
|
1890
|
-
|
|
1891
|
-
# @return [Array(String, Float, Boolean)]
|
|
1892
|
-
end
|
|
1893
|
-
|
|
1894
|
-
# @!method self.variants
|
|
1895
|
-
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
1896
|
-
|
|
1897
|
-
# @type [SafetyKit::Internal::Type::Converter]
|
|
1898
|
-
UnionMember3Array =
|
|
1899
|
-
SafetyKit::Internal::Type::ArrayOf[
|
|
1900
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata::UnionMember3 }
|
|
1901
|
-
]
|
|
1902
|
-
end
|
|
2602
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Metadata::UnionMember3Array }
|
|
1903
2603
|
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
|
-
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
1907
|
-
# youtube, linkedin, or another stable snake_case identifier.
|
|
1908
|
-
#
|
|
1909
|
-
# @return [String]
|
|
1910
|
-
required :type, String
|
|
2604
|
+
module UnionMember3
|
|
2605
|
+
extend SafetyKit::Internal::Type::Union
|
|
1911
2606
|
|
|
1912
|
-
|
|
1913
|
-
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1914
|
-
# value, not the raw value. When type is url, this must be a valid URL.
|
|
1915
|
-
#
|
|
1916
|
-
# @return [String]
|
|
1917
|
-
required :value, String
|
|
2607
|
+
variant String
|
|
1918
2608
|
|
|
1919
|
-
|
|
1920
|
-
# Some parameter documentations has been truncated, see
|
|
1921
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed}
|
|
1922
|
-
# for more details.
|
|
1923
|
-
#
|
|
1924
|
-
# Real-world or account resource used during the event, such as an email, phone
|
|
1925
|
-
# number, address, URL, social handle, or payment identifier.
|
|
1926
|
-
#
|
|
1927
|
-
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
1928
|
-
#
|
|
1929
|
-
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
1930
|
-
end
|
|
1931
|
-
end
|
|
2609
|
+
variant Float
|
|
1932
2610
|
|
|
1933
|
-
|
|
1934
|
-
module UnionMember6
|
|
1935
|
-
extend SafetyKit::Internal::Type::Union
|
|
2611
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
1936
2612
|
|
|
1937
|
-
|
|
2613
|
+
# @!method self.variants
|
|
2614
|
+
# @return [Array(String, Float, Boolean)]
|
|
2615
|
+
end
|
|
1938
2616
|
|
|
1939
|
-
|
|
1940
|
-
|
|
2617
|
+
# @!method self.variants
|
|
2618
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
1941
2619
|
|
|
1942
|
-
|
|
1943
|
-
|
|
2620
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
2621
|
+
UnionMember3Array =
|
|
2622
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
2623
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Metadata::UnionMember3
|
|
2624
|
+
}]
|
|
2625
|
+
end
|
|
1944
2626
|
|
|
1945
|
-
|
|
1946
|
-
|
|
2627
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
2628
|
+
# @!attribute type
|
|
2629
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
2630
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
2631
|
+
#
|
|
2632
|
+
# @return [String]
|
|
2633
|
+
required :type, String
|
|
1947
2634
|
|
|
1948
|
-
|
|
1949
|
-
|
|
2635
|
+
# @!attribute value
|
|
2636
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2637
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2638
|
+
#
|
|
2639
|
+
# @return [String]
|
|
2640
|
+
required :value, String
|
|
1950
2641
|
|
|
1951
|
-
|
|
1952
|
-
|
|
2642
|
+
# @!method initialize(type:, value:)
|
|
2643
|
+
# Some parameter documentations has been truncated, see
|
|
2644
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed}
|
|
2645
|
+
# for more details.
|
|
2646
|
+
#
|
|
2647
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
2648
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2649
|
+
#
|
|
2650
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
2651
|
+
#
|
|
2652
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2653
|
+
end
|
|
2654
|
+
end
|
|
1953
2655
|
|
|
1954
|
-
|
|
1955
|
-
|
|
1956
|
-
|
|
2656
|
+
class ContentUploaded < SafetyKit::Internal::Type::BaseModel
|
|
2657
|
+
# @!attribute content
|
|
2658
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2659
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2660
|
+
# analyze.
|
|
2661
|
+
#
|
|
2662
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent>]
|
|
2663
|
+
required :content,
|
|
2664
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content] }
|
|
1957
2665
|
|
|
1958
|
-
class UserContact < SafetyKit::Internal::Type::BaseModel
|
|
1959
2666
|
# @!attribute event_name
|
|
1960
2667
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1961
2668
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -1963,13 +2670,6 @@ module SafetyKit
|
|
|
1963
2670
|
# @return [String]
|
|
1964
2671
|
required :event_name, String
|
|
1965
2672
|
|
|
1966
|
-
# @!attribute target_user_id
|
|
1967
|
-
# Your stable canonical identifier for the other user in a user-to-user
|
|
1968
|
-
# interaction.
|
|
1969
|
-
#
|
|
1970
|
-
# @return [String]
|
|
1971
|
-
required :target_user_id, String
|
|
1972
|
-
|
|
1973
2673
|
# @!attribute timestamp
|
|
1974
2674
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1975
2675
|
#
|
|
@@ -1978,8 +2678,8 @@ module SafetyKit
|
|
|
1978
2678
|
|
|
1979
2679
|
# @!attribute type
|
|
1980
2680
|
#
|
|
1981
|
-
# @return [Symbol, :
|
|
1982
|
-
required :type, const: :
|
|
2681
|
+
# @return [Symbol, :content_uploaded]
|
|
2682
|
+
required :type, const: :content_uploaded
|
|
1983
2683
|
|
|
1984
2684
|
# @!attribute user_id
|
|
1985
2685
|
# Your stable canonical identifier for the user or account.
|
|
@@ -1987,15 +2687,6 @@ module SafetyKit
|
|
|
1987
2687
|
# @return [String]
|
|
1988
2688
|
required :user_id, String
|
|
1989
2689
|
|
|
1990
|
-
# @!attribute content
|
|
1991
|
-
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1992
|
-
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1993
|
-
# analyze.
|
|
1994
|
-
#
|
|
1995
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember6::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember6::UserContact::Content::EventImageContent>, nil]
|
|
1996
|
-
optional :content,
|
|
1997
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember6::UserContact::Content] }
|
|
1998
|
-
|
|
1999
2690
|
# @!attribute content_id
|
|
2000
2691
|
# Your stable identifier for the content involved in this event, such as a
|
|
2001
2692
|
# message, listing, page, post, profile, or uploaded media item.
|
|
@@ -2016,53 +2707,51 @@ module SafetyKit
|
|
|
2016
2707
|
#
|
|
2017
2708
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2018
2709
|
optional :metadata,
|
|
2019
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2710
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Metadata] }
|
|
2020
2711
|
|
|
2021
2712
|
# @!attribute resources_used
|
|
2022
2713
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2023
2714
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2024
2715
|
# identifiers.
|
|
2025
2716
|
#
|
|
2026
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2717
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed>, nil]
|
|
2027
2718
|
optional :resources_used,
|
|
2028
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
2719
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed] }
|
|
2029
2720
|
|
|
2030
|
-
# @!method initialize(
|
|
2721
|
+
# @!method initialize(content:, event_name:, timestamp:, user_id:, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :content_uploaded)
|
|
2031
2722
|
# Some parameter documentations has been truncated, see
|
|
2032
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2723
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded}
|
|
2033
2724
|
# for more details.
|
|
2034
2725
|
#
|
|
2035
|
-
# A user
|
|
2726
|
+
# A user posts, uploads, publishes, edits, or replaces content.
|
|
2036
2727
|
#
|
|
2037
|
-
# @param
|
|
2728
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2038
2729
|
#
|
|
2039
|
-
# @param
|
|
2730
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
2040
2731
|
#
|
|
2041
2732
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2042
2733
|
#
|
|
2043
2734
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2044
2735
|
#
|
|
2045
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember6::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember6::UserContact::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2046
|
-
#
|
|
2047
2736
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2048
2737
|
#
|
|
2049
2738
|
# @param idempotency_key [String] Optional caller-provided key used to make retries of this individual event idemp
|
|
2050
2739
|
#
|
|
2051
2740
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2052
2741
|
#
|
|
2053
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2742
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2054
2743
|
#
|
|
2055
|
-
# @param type [Symbol, :
|
|
2744
|
+
# @param type [Symbol, :content_uploaded]
|
|
2056
2745
|
|
|
2057
2746
|
# User-authored text content associated with an event.
|
|
2058
2747
|
module Content
|
|
2059
2748
|
extend SafetyKit::Internal::Type::Union
|
|
2060
2749
|
|
|
2061
2750
|
# User-authored text content associated with an event.
|
|
2062
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2751
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent }
|
|
2063
2752
|
|
|
2064
2753
|
# User-uploaded image content associated with an event.
|
|
2065
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2754
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent }
|
|
2066
2755
|
|
|
2067
2756
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2068
2757
|
# @!attribute text
|
|
@@ -2074,9 +2763,9 @@ module SafetyKit
|
|
|
2074
2763
|
# @!attribute type
|
|
2075
2764
|
# Text content part.
|
|
2076
2765
|
#
|
|
2077
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2766
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent::Type]
|
|
2078
2767
|
required :type,
|
|
2079
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2768
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent::Type }
|
|
2080
2769
|
|
|
2081
2770
|
# @!attribute key
|
|
2082
2771
|
# Stable field key for this content part.
|
|
@@ -2089,13 +2778,13 @@ module SafetyKit
|
|
|
2089
2778
|
#
|
|
2090
2779
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2091
2780
|
#
|
|
2092
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2781
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent::Type] Text content part.
|
|
2093
2782
|
#
|
|
2094
2783
|
# @param key [String] Stable field key for this content part.
|
|
2095
2784
|
|
|
2096
2785
|
# Text content part.
|
|
2097
2786
|
#
|
|
2098
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2787
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent#type
|
|
2099
2788
|
module Type
|
|
2100
2789
|
extend SafetyKit::Internal::Type::Enum
|
|
2101
2790
|
|
|
@@ -2110,16 +2799,16 @@ module SafetyKit
|
|
|
2110
2799
|
# @!attribute source
|
|
2111
2800
|
# Image source information.
|
|
2112
2801
|
#
|
|
2113
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2802
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source]
|
|
2114
2803
|
required :source,
|
|
2115
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2804
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source }
|
|
2116
2805
|
|
|
2117
2806
|
# @!attribute type
|
|
2118
2807
|
# Image content part.
|
|
2119
2808
|
#
|
|
2120
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2809
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Type]
|
|
2121
2810
|
required :type,
|
|
2122
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2811
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Type }
|
|
2123
2812
|
|
|
2124
2813
|
# @!attribute key
|
|
2125
2814
|
# Stable field key for this content part.
|
|
@@ -2130,20 +2819,20 @@ module SafetyKit
|
|
|
2130
2819
|
# @!method initialize(source:, type:, key: nil)
|
|
2131
2820
|
# User-uploaded image content associated with an event.
|
|
2132
2821
|
#
|
|
2133
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2822
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source] Image source information.
|
|
2134
2823
|
#
|
|
2135
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2824
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Type] Image content part.
|
|
2136
2825
|
#
|
|
2137
2826
|
# @param key [String] Stable field key for this content part.
|
|
2138
2827
|
|
|
2139
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2828
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent#source
|
|
2140
2829
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2141
2830
|
# @!attribute type
|
|
2142
2831
|
# URL image source.
|
|
2143
2832
|
#
|
|
2144
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2833
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source::Type]
|
|
2145
2834
|
required :type,
|
|
2146
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2835
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source::Type }
|
|
2147
2836
|
|
|
2148
2837
|
# @!attribute url
|
|
2149
2838
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -2154,13 +2843,13 @@ module SafetyKit
|
|
|
2154
2843
|
# @!method initialize(type:, url:)
|
|
2155
2844
|
# Image source information.
|
|
2156
2845
|
#
|
|
2157
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2846
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source::Type] URL image source.
|
|
2158
2847
|
#
|
|
2159
2848
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2160
2849
|
|
|
2161
2850
|
# URL image source.
|
|
2162
2851
|
#
|
|
2163
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2852
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source#type
|
|
2164
2853
|
module Type
|
|
2165
2854
|
extend SafetyKit::Internal::Type::Enum
|
|
2166
2855
|
|
|
@@ -2173,7 +2862,7 @@ module SafetyKit
|
|
|
2173
2862
|
|
|
2174
2863
|
# Image content part.
|
|
2175
2864
|
#
|
|
2176
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2865
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent#type
|
|
2177
2866
|
module Type
|
|
2178
2867
|
extend SafetyKit::Internal::Type::Enum
|
|
2179
2868
|
|
|
@@ -2185,7 +2874,7 @@ module SafetyKit
|
|
|
2185
2874
|
end
|
|
2186
2875
|
|
|
2187
2876
|
# @!method self.variants
|
|
2188
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2877
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent)]
|
|
2189
2878
|
end
|
|
2190
2879
|
|
|
2191
2880
|
module Metadata
|
|
@@ -2197,7 +2886,7 @@ module SafetyKit
|
|
|
2197
2886
|
|
|
2198
2887
|
variant SafetyKit::Internal::Type::Boolean
|
|
2199
2888
|
|
|
2200
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2889
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Metadata::UnionMember3Array }
|
|
2201
2890
|
|
|
2202
2891
|
module UnionMember3
|
|
2203
2892
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2217,9 +2906,9 @@ module SafetyKit
|
|
|
2217
2906
|
|
|
2218
2907
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2219
2908
|
UnionMember3Array =
|
|
2220
|
-
SafetyKit::Internal::Type::ArrayOf[
|
|
2221
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
2222
|
-
|
|
2909
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
2910
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Metadata::UnionMember3 }
|
|
2911
|
+
]
|
|
2223
2912
|
end
|
|
2224
2913
|
|
|
2225
2914
|
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
@@ -2239,7 +2928,7 @@ module SafetyKit
|
|
|
2239
2928
|
|
|
2240
2929
|
# @!method initialize(type:, value:)
|
|
2241
2930
|
# Some parameter documentations has been truncated, see
|
|
2242
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2931
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed}
|
|
2243
2932
|
# for more details.
|
|
2244
2933
|
#
|
|
2245
2934
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2251,22 +2940,28 @@ module SafetyKit
|
|
|
2251
2940
|
end
|
|
2252
2941
|
end
|
|
2253
2942
|
|
|
2254
|
-
class
|
|
2943
|
+
class ProductChanged < SafetyKit::Internal::Type::BaseModel
|
|
2255
2944
|
# @!attribute content
|
|
2256
2945
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2257
2946
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2258
2947
|
# analyze.
|
|
2259
2948
|
#
|
|
2260
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2949
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent>]
|
|
2261
2950
|
required :content,
|
|
2262
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2951
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content] }
|
|
2263
2952
|
|
|
2264
2953
|
# @!attribute event_name
|
|
2265
|
-
#
|
|
2266
|
-
# values in typed fields, content, resources_used, or metadata.
|
|
2954
|
+
# Product action that triggered this event.
|
|
2267
2955
|
#
|
|
2268
|
-
# @return [
|
|
2269
|
-
required :event_name,
|
|
2956
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::EventName]
|
|
2957
|
+
required :event_name,
|
|
2958
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::EventName }
|
|
2959
|
+
|
|
2960
|
+
# @!attribute product
|
|
2961
|
+
# Commerce details for the product involved in this event.
|
|
2962
|
+
#
|
|
2963
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product]
|
|
2964
|
+
required :product, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product }
|
|
2270
2965
|
|
|
2271
2966
|
# @!attribute timestamp
|
|
2272
2967
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
@@ -2276,8 +2971,8 @@ module SafetyKit
|
|
|
2276
2971
|
|
|
2277
2972
|
# @!attribute type
|
|
2278
2973
|
#
|
|
2279
|
-
# @return [Symbol, :
|
|
2280
|
-
required :type, const: :
|
|
2974
|
+
# @return [Symbol, :product_changed]
|
|
2975
|
+
required :type, const: :product_changed
|
|
2281
2976
|
|
|
2282
2977
|
# @!attribute user_id
|
|
2283
2978
|
# Your stable canonical identifier for the user or account.
|
|
@@ -2305,27 +3000,29 @@ module SafetyKit
|
|
|
2305
3000
|
#
|
|
2306
3001
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2307
3002
|
optional :metadata,
|
|
2308
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3003
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Metadata] }
|
|
2309
3004
|
|
|
2310
3005
|
# @!attribute resources_used
|
|
2311
3006
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2312
3007
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2313
3008
|
# identifiers.
|
|
2314
3009
|
#
|
|
2315
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3010
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed>, nil]
|
|
2316
3011
|
optional :resources_used,
|
|
2317
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
3012
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed] }
|
|
2318
3013
|
|
|
2319
|
-
# @!method initialize(content:, event_name:, timestamp:, user_id:, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :
|
|
3014
|
+
# @!method initialize(content:, event_name:, product:, timestamp:, user_id:, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :product_changed)
|
|
2320
3015
|
# Some parameter documentations has been truncated, see
|
|
2321
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3016
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged}
|
|
2322
3017
|
# for more details.
|
|
2323
3018
|
#
|
|
2324
|
-
# A
|
|
3019
|
+
# A product listing is created, updated, or has a discount added.
|
|
2325
3020
|
#
|
|
2326
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3021
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2327
3022
|
#
|
|
2328
|
-
# @param event_name [
|
|
3023
|
+
# @param event_name [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::EventName] Product action that triggered this event.
|
|
3024
|
+
#
|
|
3025
|
+
# @param product [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product] Commerce details for the product involved in this event.
|
|
2329
3026
|
#
|
|
2330
3027
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2331
3028
|
#
|
|
@@ -2337,19 +3034,19 @@ module SafetyKit
|
|
|
2337
3034
|
#
|
|
2338
3035
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2339
3036
|
#
|
|
2340
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3037
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2341
3038
|
#
|
|
2342
|
-
# @param type [Symbol, :
|
|
3039
|
+
# @param type [Symbol, :product_changed]
|
|
2343
3040
|
|
|
2344
3041
|
# User-authored text content associated with an event.
|
|
2345
3042
|
module Content
|
|
2346
3043
|
extend SafetyKit::Internal::Type::Union
|
|
2347
3044
|
|
|
2348
3045
|
# User-authored text content associated with an event.
|
|
2349
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3046
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent }
|
|
2350
3047
|
|
|
2351
3048
|
# User-uploaded image content associated with an event.
|
|
2352
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3049
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent }
|
|
2353
3050
|
|
|
2354
3051
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2355
3052
|
# @!attribute text
|
|
@@ -2361,9 +3058,9 @@ module SafetyKit
|
|
|
2361
3058
|
# @!attribute type
|
|
2362
3059
|
# Text content part.
|
|
2363
3060
|
#
|
|
2364
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3061
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent::Type]
|
|
2365
3062
|
required :type,
|
|
2366
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3063
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent::Type }
|
|
2367
3064
|
|
|
2368
3065
|
# @!attribute key
|
|
2369
3066
|
# Stable field key for this content part.
|
|
@@ -2376,13 +3073,13 @@ module SafetyKit
|
|
|
2376
3073
|
#
|
|
2377
3074
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2378
3075
|
#
|
|
2379
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3076
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent::Type] Text content part.
|
|
2380
3077
|
#
|
|
2381
3078
|
# @param key [String] Stable field key for this content part.
|
|
2382
3079
|
|
|
2383
3080
|
# Text content part.
|
|
2384
3081
|
#
|
|
2385
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3082
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent#type
|
|
2386
3083
|
module Type
|
|
2387
3084
|
extend SafetyKit::Internal::Type::Enum
|
|
2388
3085
|
|
|
@@ -2397,16 +3094,16 @@ module SafetyKit
|
|
|
2397
3094
|
# @!attribute source
|
|
2398
3095
|
# Image source information.
|
|
2399
3096
|
#
|
|
2400
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3097
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source]
|
|
2401
3098
|
required :source,
|
|
2402
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3099
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source }
|
|
2403
3100
|
|
|
2404
3101
|
# @!attribute type
|
|
2405
3102
|
# Image content part.
|
|
2406
3103
|
#
|
|
2407
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3104
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Type]
|
|
2408
3105
|
required :type,
|
|
2409
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3106
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Type }
|
|
2410
3107
|
|
|
2411
3108
|
# @!attribute key
|
|
2412
3109
|
# Stable field key for this content part.
|
|
@@ -2417,20 +3114,20 @@ module SafetyKit
|
|
|
2417
3114
|
# @!method initialize(source:, type:, key: nil)
|
|
2418
3115
|
# User-uploaded image content associated with an event.
|
|
2419
3116
|
#
|
|
2420
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3117
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source] Image source information.
|
|
2421
3118
|
#
|
|
2422
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3119
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Type] Image content part.
|
|
2423
3120
|
#
|
|
2424
3121
|
# @param key [String] Stable field key for this content part.
|
|
2425
3122
|
|
|
2426
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3123
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent#source
|
|
2427
3124
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2428
3125
|
# @!attribute type
|
|
2429
3126
|
# URL image source.
|
|
2430
3127
|
#
|
|
2431
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3128
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source::Type]
|
|
2432
3129
|
required :type,
|
|
2433
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3130
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source::Type }
|
|
2434
3131
|
|
|
2435
3132
|
# @!attribute url
|
|
2436
3133
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -2441,13 +3138,13 @@ module SafetyKit
|
|
|
2441
3138
|
# @!method initialize(type:, url:)
|
|
2442
3139
|
# Image source information.
|
|
2443
3140
|
#
|
|
2444
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3141
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source::Type] URL image source.
|
|
2445
3142
|
#
|
|
2446
3143
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2447
3144
|
|
|
2448
3145
|
# URL image source.
|
|
2449
3146
|
#
|
|
2450
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3147
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source#type
|
|
2451
3148
|
module Type
|
|
2452
3149
|
extend SafetyKit::Internal::Type::Enum
|
|
2453
3150
|
|
|
@@ -2460,7 +3157,7 @@ module SafetyKit
|
|
|
2460
3157
|
|
|
2461
3158
|
# Image content part.
|
|
2462
3159
|
#
|
|
2463
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3160
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent#type
|
|
2464
3161
|
module Type
|
|
2465
3162
|
extend SafetyKit::Internal::Type::Enum
|
|
2466
3163
|
|
|
@@ -2472,7 +3169,98 @@ module SafetyKit
|
|
|
2472
3169
|
end
|
|
2473
3170
|
|
|
2474
3171
|
# @!method self.variants
|
|
2475
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3172
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent)]
|
|
3173
|
+
end
|
|
3174
|
+
|
|
3175
|
+
# Product action that triggered this event.
|
|
3176
|
+
#
|
|
3177
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged#event_name
|
|
3178
|
+
module EventName
|
|
3179
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3180
|
+
|
|
3181
|
+
PRODUCT_CREATED = :product_created
|
|
3182
|
+
PRODUCT_UPDATED = :product_updated
|
|
3183
|
+
DISCOUNT_ADDED = :discount_added
|
|
3184
|
+
|
|
3185
|
+
# @!method self.values
|
|
3186
|
+
# @return [Array<Symbol>]
|
|
3187
|
+
end
|
|
3188
|
+
|
|
3189
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged#product
|
|
3190
|
+
class Product < SafetyKit::Internal::Type::BaseModel
|
|
3191
|
+
# @!attribute price
|
|
3192
|
+
# Current listed price of the product.
|
|
3193
|
+
#
|
|
3194
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::Price]
|
|
3195
|
+
required :price,
|
|
3196
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::Price }
|
|
3197
|
+
|
|
3198
|
+
# @!attribute discounted_price
|
|
3199
|
+
# Discounted price of the product, when a discount applies.
|
|
3200
|
+
#
|
|
3201
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::DiscountedPrice, nil]
|
|
3202
|
+
optional :discounted_price,
|
|
3203
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::DiscountedPrice }
|
|
3204
|
+
|
|
3205
|
+
# @!attribute shipping_info
|
|
3206
|
+
# Shipping details for the product, such as cost, regions, and carrier.
|
|
3207
|
+
#
|
|
3208
|
+
# @return [Hash{Symbol=>Object, nil}, nil]
|
|
3209
|
+
optional :shipping_info,
|
|
3210
|
+
SafetyKit::Internal::Type::HashOf[SafetyKit::Internal::Type::Unknown, nil?: true]
|
|
3211
|
+
|
|
3212
|
+
# @!method initialize(price:, discounted_price: nil, shipping_info: nil)
|
|
3213
|
+
# Commerce details for the product involved in this event.
|
|
3214
|
+
#
|
|
3215
|
+
# @param price [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::Price] Current listed price of the product.
|
|
3216
|
+
#
|
|
3217
|
+
# @param discounted_price [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::DiscountedPrice] Discounted price of the product, when a discount applies.
|
|
3218
|
+
#
|
|
3219
|
+
# @param shipping_info [Hash{Symbol=>Object, nil}] Shipping details for the product, such as cost, regions, and carrier.
|
|
3220
|
+
|
|
3221
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product#price
|
|
3222
|
+
class Price < SafetyKit::Internal::Type::BaseModel
|
|
3223
|
+
# @!attribute amount
|
|
3224
|
+
# Price amount as a decimal string.
|
|
3225
|
+
#
|
|
3226
|
+
# @return [String]
|
|
3227
|
+
required :amount, String
|
|
3228
|
+
|
|
3229
|
+
# @!attribute currency
|
|
3230
|
+
# ISO 4217 currency code.
|
|
3231
|
+
#
|
|
3232
|
+
# @return [String]
|
|
3233
|
+
required :currency, String
|
|
3234
|
+
|
|
3235
|
+
# @!method initialize(amount:, currency:)
|
|
3236
|
+
# Current listed price of the product.
|
|
3237
|
+
#
|
|
3238
|
+
# @param amount [String] Price amount as a decimal string.
|
|
3239
|
+
#
|
|
3240
|
+
# @param currency [String] ISO 4217 currency code.
|
|
3241
|
+
end
|
|
3242
|
+
|
|
3243
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product#discounted_price
|
|
3244
|
+
class DiscountedPrice < SafetyKit::Internal::Type::BaseModel
|
|
3245
|
+
# @!attribute amount
|
|
3246
|
+
# Price amount as a decimal string.
|
|
3247
|
+
#
|
|
3248
|
+
# @return [String]
|
|
3249
|
+
required :amount, String
|
|
3250
|
+
|
|
3251
|
+
# @!attribute currency
|
|
3252
|
+
# ISO 4217 currency code.
|
|
3253
|
+
#
|
|
3254
|
+
# @return [String]
|
|
3255
|
+
required :currency, String
|
|
3256
|
+
|
|
3257
|
+
# @!method initialize(amount:, currency:)
|
|
3258
|
+
# Discounted price of the product, when a discount applies.
|
|
3259
|
+
#
|
|
3260
|
+
# @param amount [String] Price amount as a decimal string.
|
|
3261
|
+
#
|
|
3262
|
+
# @param currency [String] ISO 4217 currency code.
|
|
3263
|
+
end
|
|
2476
3264
|
end
|
|
2477
3265
|
|
|
2478
3266
|
module Metadata
|
|
@@ -2484,7 +3272,7 @@ module SafetyKit
|
|
|
2484
3272
|
|
|
2485
3273
|
variant SafetyKit::Internal::Type::Boolean
|
|
2486
3274
|
|
|
2487
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3275
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Metadata::UnionMember3Array }
|
|
2488
3276
|
|
|
2489
3277
|
module UnionMember3
|
|
2490
3278
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2505,7 +3293,7 @@ module SafetyKit
|
|
|
2505
3293
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2506
3294
|
UnionMember3Array =
|
|
2507
3295
|
SafetyKit::Internal::Type::ArrayOf[
|
|
2508
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3296
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Metadata::UnionMember3 }
|
|
2509
3297
|
]
|
|
2510
3298
|
end
|
|
2511
3299
|
|
|
@@ -2526,7 +3314,7 @@ module SafetyKit
|
|
|
2526
3314
|
|
|
2527
3315
|
# @!method initialize(type:, value:)
|
|
2528
3316
|
# Some parameter documentations has been truncated, see
|
|
2529
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3317
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed}
|
|
2530
3318
|
# for more details.
|
|
2531
3319
|
#
|
|
2532
3320
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2568,9 +3356,9 @@ module SafetyKit
|
|
|
2568
3356
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2569
3357
|
# analyze.
|
|
2570
3358
|
#
|
|
2571
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3359
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent>, nil]
|
|
2572
3360
|
optional :content,
|
|
2573
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3361
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content] }
|
|
2574
3362
|
|
|
2575
3363
|
# @!attribute content_id
|
|
2576
3364
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -2592,20 +3380,20 @@ module SafetyKit
|
|
|
2592
3380
|
#
|
|
2593
3381
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2594
3382
|
optional :metadata,
|
|
2595
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3383
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Metadata] }
|
|
2596
3384
|
|
|
2597
3385
|
# @!attribute resources_used
|
|
2598
3386
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2599
3387
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2600
3388
|
# identifiers.
|
|
2601
3389
|
#
|
|
2602
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3390
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed>, nil]
|
|
2603
3391
|
optional :resources_used,
|
|
2604
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
3392
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed] }
|
|
2605
3393
|
|
|
2606
3394
|
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :create_account)
|
|
2607
3395
|
# Some parameter documentations has been truncated, see
|
|
2608
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3396
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount}
|
|
2609
3397
|
# for more details.
|
|
2610
3398
|
#
|
|
2611
3399
|
# A user or account is created.
|
|
@@ -2616,7 +3404,7 @@ module SafetyKit
|
|
|
2616
3404
|
#
|
|
2617
3405
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2618
3406
|
#
|
|
2619
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3407
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2620
3408
|
#
|
|
2621
3409
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2622
3410
|
#
|
|
@@ -2624,7 +3412,7 @@ module SafetyKit
|
|
|
2624
3412
|
#
|
|
2625
3413
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2626
3414
|
#
|
|
2627
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3415
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2628
3416
|
#
|
|
2629
3417
|
# @param type [Symbol, :create_account]
|
|
2630
3418
|
|
|
@@ -2633,10 +3421,10 @@ module SafetyKit
|
|
|
2633
3421
|
extend SafetyKit::Internal::Type::Union
|
|
2634
3422
|
|
|
2635
3423
|
# User-authored text content associated with an event.
|
|
2636
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3424
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent }
|
|
2637
3425
|
|
|
2638
3426
|
# User-uploaded image content associated with an event.
|
|
2639
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3427
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent }
|
|
2640
3428
|
|
|
2641
3429
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2642
3430
|
# @!attribute text
|
|
@@ -2648,9 +3436,9 @@ module SafetyKit
|
|
|
2648
3436
|
# @!attribute type
|
|
2649
3437
|
# Text content part.
|
|
2650
3438
|
#
|
|
2651
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3439
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent::Type]
|
|
2652
3440
|
required :type,
|
|
2653
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3441
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent::Type }
|
|
2654
3442
|
|
|
2655
3443
|
# @!attribute key
|
|
2656
3444
|
# Stable field key for this content part.
|
|
@@ -2663,13 +3451,13 @@ module SafetyKit
|
|
|
2663
3451
|
#
|
|
2664
3452
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2665
3453
|
#
|
|
2666
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3454
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent::Type] Text content part.
|
|
2667
3455
|
#
|
|
2668
3456
|
# @param key [String] Stable field key for this content part.
|
|
2669
3457
|
|
|
2670
3458
|
# Text content part.
|
|
2671
3459
|
#
|
|
2672
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3460
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent#type
|
|
2673
3461
|
module Type
|
|
2674
3462
|
extend SafetyKit::Internal::Type::Enum
|
|
2675
3463
|
|
|
@@ -2684,16 +3472,16 @@ module SafetyKit
|
|
|
2684
3472
|
# @!attribute source
|
|
2685
3473
|
# Image source information.
|
|
2686
3474
|
#
|
|
2687
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3475
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source]
|
|
2688
3476
|
required :source,
|
|
2689
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3477
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source }
|
|
2690
3478
|
|
|
2691
3479
|
# @!attribute type
|
|
2692
3480
|
# Image content part.
|
|
2693
3481
|
#
|
|
2694
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3482
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Type]
|
|
2695
3483
|
required :type,
|
|
2696
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3484
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Type }
|
|
2697
3485
|
|
|
2698
3486
|
# @!attribute key
|
|
2699
3487
|
# Stable field key for this content part.
|
|
@@ -2704,20 +3492,20 @@ module SafetyKit
|
|
|
2704
3492
|
# @!method initialize(source:, type:, key: nil)
|
|
2705
3493
|
# User-uploaded image content associated with an event.
|
|
2706
3494
|
#
|
|
2707
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3495
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source] Image source information.
|
|
2708
3496
|
#
|
|
2709
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3497
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Type] Image content part.
|
|
2710
3498
|
#
|
|
2711
3499
|
# @param key [String] Stable field key for this content part.
|
|
2712
3500
|
|
|
2713
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3501
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent#source
|
|
2714
3502
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2715
3503
|
# @!attribute type
|
|
2716
3504
|
# URL image source.
|
|
2717
3505
|
#
|
|
2718
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3506
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source::Type]
|
|
2719
3507
|
required :type,
|
|
2720
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3508
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source::Type }
|
|
2721
3509
|
|
|
2722
3510
|
# @!attribute url
|
|
2723
3511
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -2728,13 +3516,13 @@ module SafetyKit
|
|
|
2728
3516
|
# @!method initialize(type:, url:)
|
|
2729
3517
|
# Image source information.
|
|
2730
3518
|
#
|
|
2731
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3519
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
2732
3520
|
#
|
|
2733
3521
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2734
3522
|
|
|
2735
3523
|
# URL image source.
|
|
2736
3524
|
#
|
|
2737
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3525
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source#type
|
|
2738
3526
|
module Type
|
|
2739
3527
|
extend SafetyKit::Internal::Type::Enum
|
|
2740
3528
|
|
|
@@ -2747,7 +3535,7 @@ module SafetyKit
|
|
|
2747
3535
|
|
|
2748
3536
|
# Image content part.
|
|
2749
3537
|
#
|
|
2750
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3538
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent#type
|
|
2751
3539
|
module Type
|
|
2752
3540
|
extend SafetyKit::Internal::Type::Enum
|
|
2753
3541
|
|
|
@@ -2759,7 +3547,7 @@ module SafetyKit
|
|
|
2759
3547
|
end
|
|
2760
3548
|
|
|
2761
3549
|
# @!method self.variants
|
|
2762
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3550
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent)]
|
|
2763
3551
|
end
|
|
2764
3552
|
|
|
2765
3553
|
module Metadata
|
|
@@ -2771,7 +3559,7 @@ module SafetyKit
|
|
|
2771
3559
|
|
|
2772
3560
|
variant SafetyKit::Internal::Type::Boolean
|
|
2773
3561
|
|
|
2774
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3562
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Metadata::UnionMember3Array }
|
|
2775
3563
|
|
|
2776
3564
|
module UnionMember3
|
|
2777
3565
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2792,7 +3580,7 @@ module SafetyKit
|
|
|
2792
3580
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2793
3581
|
UnionMember3Array =
|
|
2794
3582
|
SafetyKit::Internal::Type::ArrayOf[
|
|
2795
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3583
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Metadata::UnionMember3 }
|
|
2796
3584
|
]
|
|
2797
3585
|
end
|
|
2798
3586
|
|
|
@@ -2813,7 +3601,7 @@ module SafetyKit
|
|
|
2813
3601
|
|
|
2814
3602
|
# @!method initialize(type:, value:)
|
|
2815
3603
|
# Some parameter documentations has been truncated, see
|
|
2816
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3604
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed}
|
|
2817
3605
|
# for more details.
|
|
2818
3606
|
#
|
|
2819
3607
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2855,9 +3643,9 @@ module SafetyKit
|
|
|
2855
3643
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2856
3644
|
# analyze.
|
|
2857
3645
|
#
|
|
2858
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3646
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent>, nil]
|
|
2859
3647
|
optional :content,
|
|
2860
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3648
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content] }
|
|
2861
3649
|
|
|
2862
3650
|
# @!attribute content_id
|
|
2863
3651
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -2879,20 +3667,20 @@ module SafetyKit
|
|
|
2879
3667
|
#
|
|
2880
3668
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2881
3669
|
optional :metadata,
|
|
2882
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3670
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Metadata] }
|
|
2883
3671
|
|
|
2884
3672
|
# @!attribute resources_used
|
|
2885
3673
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2886
3674
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2887
3675
|
# identifiers.
|
|
2888
3676
|
#
|
|
2889
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3677
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed>, nil]
|
|
2890
3678
|
optional :resources_used,
|
|
2891
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
3679
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed] }
|
|
2892
3680
|
|
|
2893
3681
|
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :update_account)
|
|
2894
3682
|
# Some parameter documentations has been truncated, see
|
|
2895
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3683
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount}
|
|
2896
3684
|
# for more details.
|
|
2897
3685
|
#
|
|
2898
3686
|
# A user or account profile, contact detail, payment detail, or public bio
|
|
@@ -2904,7 +3692,7 @@ module SafetyKit
|
|
|
2904
3692
|
#
|
|
2905
3693
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2906
3694
|
#
|
|
2907
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3695
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2908
3696
|
#
|
|
2909
3697
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2910
3698
|
#
|
|
@@ -2912,7 +3700,7 @@ module SafetyKit
|
|
|
2912
3700
|
#
|
|
2913
3701
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2914
3702
|
#
|
|
2915
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3703
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2916
3704
|
#
|
|
2917
3705
|
# @param type [Symbol, :update_account]
|
|
2918
3706
|
|
|
@@ -2921,10 +3709,10 @@ module SafetyKit
|
|
|
2921
3709
|
extend SafetyKit::Internal::Type::Union
|
|
2922
3710
|
|
|
2923
3711
|
# User-authored text content associated with an event.
|
|
2924
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3712
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent }
|
|
2925
3713
|
|
|
2926
3714
|
# User-uploaded image content associated with an event.
|
|
2927
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3715
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent }
|
|
2928
3716
|
|
|
2929
3717
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2930
3718
|
# @!attribute text
|
|
@@ -2936,9 +3724,9 @@ module SafetyKit
|
|
|
2936
3724
|
# @!attribute type
|
|
2937
3725
|
# Text content part.
|
|
2938
3726
|
#
|
|
2939
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3727
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent::Type]
|
|
2940
3728
|
required :type,
|
|
2941
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3729
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent::Type }
|
|
2942
3730
|
|
|
2943
3731
|
# @!attribute key
|
|
2944
3732
|
# Stable field key for this content part.
|
|
@@ -2951,13 +3739,13 @@ module SafetyKit
|
|
|
2951
3739
|
#
|
|
2952
3740
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2953
3741
|
#
|
|
2954
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3742
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent::Type] Text content part.
|
|
2955
3743
|
#
|
|
2956
3744
|
# @param key [String] Stable field key for this content part.
|
|
2957
3745
|
|
|
2958
3746
|
# Text content part.
|
|
2959
3747
|
#
|
|
2960
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3748
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent#type
|
|
2961
3749
|
module Type
|
|
2962
3750
|
extend SafetyKit::Internal::Type::Enum
|
|
2963
3751
|
|
|
@@ -2972,16 +3760,16 @@ module SafetyKit
|
|
|
2972
3760
|
# @!attribute source
|
|
2973
3761
|
# Image source information.
|
|
2974
3762
|
#
|
|
2975
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3763
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source]
|
|
2976
3764
|
required :source,
|
|
2977
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3765
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source }
|
|
2978
3766
|
|
|
2979
3767
|
# @!attribute type
|
|
2980
3768
|
# Image content part.
|
|
2981
3769
|
#
|
|
2982
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3770
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Type]
|
|
2983
3771
|
required :type,
|
|
2984
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3772
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Type }
|
|
2985
3773
|
|
|
2986
3774
|
# @!attribute key
|
|
2987
3775
|
# Stable field key for this content part.
|
|
@@ -2992,20 +3780,20 @@ module SafetyKit
|
|
|
2992
3780
|
# @!method initialize(source:, type:, key: nil)
|
|
2993
3781
|
# User-uploaded image content associated with an event.
|
|
2994
3782
|
#
|
|
2995
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3783
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source] Image source information.
|
|
2996
3784
|
#
|
|
2997
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3785
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Type] Image content part.
|
|
2998
3786
|
#
|
|
2999
3787
|
# @param key [String] Stable field key for this content part.
|
|
3000
3788
|
|
|
3001
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3789
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent#source
|
|
3002
3790
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3003
3791
|
# @!attribute type
|
|
3004
3792
|
# URL image source.
|
|
3005
3793
|
#
|
|
3006
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3794
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source::Type]
|
|
3007
3795
|
required :type,
|
|
3008
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3796
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source::Type }
|
|
3009
3797
|
|
|
3010
3798
|
# @!attribute url
|
|
3011
3799
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -3016,13 +3804,13 @@ module SafetyKit
|
|
|
3016
3804
|
# @!method initialize(type:, url:)
|
|
3017
3805
|
# Image source information.
|
|
3018
3806
|
#
|
|
3019
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3807
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
3020
3808
|
#
|
|
3021
3809
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3022
3810
|
|
|
3023
3811
|
# URL image source.
|
|
3024
3812
|
#
|
|
3025
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3813
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source#type
|
|
3026
3814
|
module Type
|
|
3027
3815
|
extend SafetyKit::Internal::Type::Enum
|
|
3028
3816
|
|
|
@@ -3035,7 +3823,7 @@ module SafetyKit
|
|
|
3035
3823
|
|
|
3036
3824
|
# Image content part.
|
|
3037
3825
|
#
|
|
3038
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3826
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent#type
|
|
3039
3827
|
module Type
|
|
3040
3828
|
extend SafetyKit::Internal::Type::Enum
|
|
3041
3829
|
|
|
@@ -3047,7 +3835,7 @@ module SafetyKit
|
|
|
3047
3835
|
end
|
|
3048
3836
|
|
|
3049
3837
|
# @!method self.variants
|
|
3050
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3838
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent)]
|
|
3051
3839
|
end
|
|
3052
3840
|
|
|
3053
3841
|
module Metadata
|
|
@@ -3059,7 +3847,7 @@ module SafetyKit
|
|
|
3059
3847
|
|
|
3060
3848
|
variant SafetyKit::Internal::Type::Boolean
|
|
3061
3849
|
|
|
3062
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3850
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Metadata::UnionMember3Array }
|
|
3063
3851
|
|
|
3064
3852
|
module UnionMember3
|
|
3065
3853
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -3080,7 +3868,7 @@ module SafetyKit
|
|
|
3080
3868
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3081
3869
|
UnionMember3Array =
|
|
3082
3870
|
SafetyKit::Internal::Type::ArrayOf[
|
|
3083
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3871
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Metadata::UnionMember3 }
|
|
3084
3872
|
]
|
|
3085
3873
|
end
|
|
3086
3874
|
|
|
@@ -3101,7 +3889,7 @@ module SafetyKit
|
|
|
3101
3889
|
|
|
3102
3890
|
# @!method initialize(type:, value:)
|
|
3103
3891
|
# Some parameter documentations has been truncated, see
|
|
3104
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3892
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed}
|
|
3105
3893
|
# for more details.
|
|
3106
3894
|
#
|
|
3107
3895
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -3149,9 +3937,9 @@ module SafetyKit
|
|
|
3149
3937
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
3150
3938
|
# analyze.
|
|
3151
3939
|
#
|
|
3152
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3940
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent>, nil]
|
|
3153
3941
|
optional :content,
|
|
3154
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3942
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content] }
|
|
3155
3943
|
|
|
3156
3944
|
# @!attribute content_id
|
|
3157
3945
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -3173,16 +3961,16 @@ module SafetyKit
|
|
|
3173
3961
|
#
|
|
3174
3962
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
3175
3963
|
optional :metadata,
|
|
3176
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3964
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Metadata] }
|
|
3177
3965
|
|
|
3178
3966
|
# @!attribute resources_used
|
|
3179
3967
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3180
3968
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
3181
3969
|
# identifiers.
|
|
3182
3970
|
#
|
|
3183
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3971
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed>, nil]
|
|
3184
3972
|
optional :resources_used,
|
|
3185
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
3973
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed] }
|
|
3186
3974
|
|
|
3187
3975
|
# @!attribute target_content_id
|
|
3188
3976
|
# Your stable identifier for the content being reported.
|
|
@@ -3198,7 +3986,7 @@ module SafetyKit
|
|
|
3198
3986
|
|
|
3199
3987
|
# @!method initialize(event_name:, labels:, timestamp:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil, type: :user_report)
|
|
3200
3988
|
# Some parameter documentations has been truncated, see
|
|
3201
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3989
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport} for
|
|
3202
3990
|
# more details.
|
|
3203
3991
|
#
|
|
3204
3992
|
# A user-submitted report. Use user_id for the reporter. Include target_user_id
|
|
@@ -3214,7 +4002,7 @@ module SafetyKit
|
|
|
3214
4002
|
#
|
|
3215
4003
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
3216
4004
|
#
|
|
3217
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4005
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3218
4006
|
#
|
|
3219
4007
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
3220
4008
|
#
|
|
@@ -3222,7 +4010,7 @@ module SafetyKit
|
|
|
3222
4010
|
#
|
|
3223
4011
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3224
4012
|
#
|
|
3225
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4013
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3226
4014
|
#
|
|
3227
4015
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
3228
4016
|
#
|
|
@@ -3235,10 +4023,10 @@ module SafetyKit
|
|
|
3235
4023
|
extend SafetyKit::Internal::Type::Union
|
|
3236
4024
|
|
|
3237
4025
|
# User-authored text content associated with an event.
|
|
3238
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4026
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent }
|
|
3239
4027
|
|
|
3240
4028
|
# User-uploaded image content associated with an event.
|
|
3241
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4029
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent }
|
|
3242
4030
|
|
|
3243
4031
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
3244
4032
|
# @!attribute text
|
|
@@ -3250,9 +4038,9 @@ module SafetyKit
|
|
|
3250
4038
|
# @!attribute type
|
|
3251
4039
|
# Text content part.
|
|
3252
4040
|
#
|
|
3253
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4041
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent::Type]
|
|
3254
4042
|
required :type,
|
|
3255
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4043
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent::Type }
|
|
3256
4044
|
|
|
3257
4045
|
# @!attribute key
|
|
3258
4046
|
# Stable field key for this content part.
|
|
@@ -3265,13 +4053,13 @@ module SafetyKit
|
|
|
3265
4053
|
#
|
|
3266
4054
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
3267
4055
|
#
|
|
3268
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4056
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent::Type] Text content part.
|
|
3269
4057
|
#
|
|
3270
4058
|
# @param key [String] Stable field key for this content part.
|
|
3271
4059
|
|
|
3272
4060
|
# Text content part.
|
|
3273
4061
|
#
|
|
3274
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4062
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent#type
|
|
3275
4063
|
module Type
|
|
3276
4064
|
extend SafetyKit::Internal::Type::Enum
|
|
3277
4065
|
|
|
@@ -3286,16 +4074,16 @@ module SafetyKit
|
|
|
3286
4074
|
# @!attribute source
|
|
3287
4075
|
# Image source information.
|
|
3288
4076
|
#
|
|
3289
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4077
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source]
|
|
3290
4078
|
required :source,
|
|
3291
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4079
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source }
|
|
3292
4080
|
|
|
3293
4081
|
# @!attribute type
|
|
3294
4082
|
# Image content part.
|
|
3295
4083
|
#
|
|
3296
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4084
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Type]
|
|
3297
4085
|
required :type,
|
|
3298
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4086
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Type }
|
|
3299
4087
|
|
|
3300
4088
|
# @!attribute key
|
|
3301
4089
|
# Stable field key for this content part.
|
|
@@ -3306,20 +4094,20 @@ module SafetyKit
|
|
|
3306
4094
|
# @!method initialize(source:, type:, key: nil)
|
|
3307
4095
|
# User-uploaded image content associated with an event.
|
|
3308
4096
|
#
|
|
3309
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4097
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source] Image source information.
|
|
3310
4098
|
#
|
|
3311
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4099
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Type] Image content part.
|
|
3312
4100
|
#
|
|
3313
4101
|
# @param key [String] Stable field key for this content part.
|
|
3314
4102
|
|
|
3315
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4103
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent#source
|
|
3316
4104
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3317
4105
|
# @!attribute type
|
|
3318
4106
|
# URL image source.
|
|
3319
4107
|
#
|
|
3320
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4108
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source::Type]
|
|
3321
4109
|
required :type,
|
|
3322
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4110
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source::Type }
|
|
3323
4111
|
|
|
3324
4112
|
# @!attribute url
|
|
3325
4113
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -3330,13 +4118,13 @@ module SafetyKit
|
|
|
3330
4118
|
# @!method initialize(type:, url:)
|
|
3331
4119
|
# Image source information.
|
|
3332
4120
|
#
|
|
3333
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4121
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source::Type] URL image source.
|
|
3334
4122
|
#
|
|
3335
4123
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3336
4124
|
|
|
3337
4125
|
# URL image source.
|
|
3338
4126
|
#
|
|
3339
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4127
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source#type
|
|
3340
4128
|
module Type
|
|
3341
4129
|
extend SafetyKit::Internal::Type::Enum
|
|
3342
4130
|
|
|
@@ -3349,7 +4137,7 @@ module SafetyKit
|
|
|
3349
4137
|
|
|
3350
4138
|
# Image content part.
|
|
3351
4139
|
#
|
|
3352
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4140
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent#type
|
|
3353
4141
|
module Type
|
|
3354
4142
|
extend SafetyKit::Internal::Type::Enum
|
|
3355
4143
|
|
|
@@ -3361,7 +4149,7 @@ module SafetyKit
|
|
|
3361
4149
|
end
|
|
3362
4150
|
|
|
3363
4151
|
# @!method self.variants
|
|
3364
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4152
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent)]
|
|
3365
4153
|
end
|
|
3366
4154
|
|
|
3367
4155
|
module Metadata
|
|
@@ -3373,7 +4161,7 @@ module SafetyKit
|
|
|
3373
4161
|
|
|
3374
4162
|
variant SafetyKit::Internal::Type::Boolean
|
|
3375
4163
|
|
|
3376
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4164
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Metadata::UnionMember3Array }
|
|
3377
4165
|
|
|
3378
4166
|
module UnionMember3
|
|
3379
4167
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -3394,7 +4182,7 @@ module SafetyKit
|
|
|
3394
4182
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3395
4183
|
UnionMember3Array =
|
|
3396
4184
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
3397
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
4185
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Metadata::UnionMember3
|
|
3398
4186
|
}]
|
|
3399
4187
|
end
|
|
3400
4188
|
|
|
@@ -3415,7 +4203,7 @@ module SafetyKit
|
|
|
3415
4203
|
|
|
3416
4204
|
# @!method initialize(type:, value:)
|
|
3417
4205
|
# Some parameter documentations has been truncated, see
|
|
3418
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4206
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed}
|
|
3419
4207
|
# for more details.
|
|
3420
4208
|
#
|
|
3421
4209
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -3456,9 +4244,9 @@ module SafetyKit
|
|
|
3456
4244
|
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
3457
4245
|
# review or moderation provider).
|
|
3458
4246
|
#
|
|
3459
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4247
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::SourceType]
|
|
3460
4248
|
required :source_type,
|
|
3461
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4249
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::SourceType }
|
|
3462
4250
|
|
|
3463
4251
|
# @!attribute timestamp
|
|
3464
4252
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
@@ -3476,9 +4264,9 @@ module SafetyKit
|
|
|
3476
4264
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
3477
4265
|
# analyze.
|
|
3478
4266
|
#
|
|
3479
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4267
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent>, nil]
|
|
3480
4268
|
optional :content,
|
|
3481
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4269
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content] }
|
|
3482
4270
|
|
|
3483
4271
|
# @!attribute content_id
|
|
3484
4272
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -3500,16 +4288,16 @@ module SafetyKit
|
|
|
3500
4288
|
#
|
|
3501
4289
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
3502
4290
|
optional :metadata,
|
|
3503
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4291
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Metadata] }
|
|
3504
4292
|
|
|
3505
4293
|
# @!attribute resources_used
|
|
3506
4294
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3507
4295
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
3508
4296
|
# identifiers.
|
|
3509
4297
|
#
|
|
3510
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4298
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed>, nil]
|
|
3511
4299
|
optional :resources_used,
|
|
3512
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
4300
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed] }
|
|
3513
4301
|
|
|
3514
4302
|
# @!attribute target_content_id
|
|
3515
4303
|
# Your stable identifier for the content being reported.
|
|
@@ -3525,7 +4313,7 @@ module SafetyKit
|
|
|
3525
4313
|
|
|
3526
4314
|
# @!method initialize(event_name:, labels:, source_id:, source_type:, timestamp:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil, type: :moderation_decision)
|
|
3527
4315
|
# Some parameter documentations has been truncated, see
|
|
3528
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4316
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision}
|
|
3529
4317
|
# for more details.
|
|
3530
4318
|
#
|
|
3531
4319
|
# A moderation label or decision from an automated enforcement system or manual
|
|
@@ -3538,11 +4326,11 @@ module SafetyKit
|
|
|
3538
4326
|
#
|
|
3539
4327
|
# @param source_id [String] Stable identifier within source_type. Examples: moderator@example.com or 550e840
|
|
3540
4328
|
#
|
|
3541
|
-
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4329
|
+
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::SourceType] Coarse attribution category for the moderation decision source. Supported values
|
|
3542
4330
|
#
|
|
3543
4331
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
3544
4332
|
#
|
|
3545
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4333
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3546
4334
|
#
|
|
3547
4335
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
3548
4336
|
#
|
|
@@ -3550,7 +4338,7 @@ module SafetyKit
|
|
|
3550
4338
|
#
|
|
3551
4339
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3552
4340
|
#
|
|
3553
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4341
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3554
4342
|
#
|
|
3555
4343
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
3556
4344
|
#
|
|
@@ -3564,7 +4352,7 @@ module SafetyKit
|
|
|
3564
4352
|
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
3565
4353
|
# review or moderation provider).
|
|
3566
4354
|
#
|
|
3567
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4355
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision#source_type
|
|
3568
4356
|
module SourceType
|
|
3569
4357
|
extend SafetyKit::Internal::Type::Enum
|
|
3570
4358
|
|
|
@@ -3582,10 +4370,10 @@ module SafetyKit
|
|
|
3582
4370
|
extend SafetyKit::Internal::Type::Union
|
|
3583
4371
|
|
|
3584
4372
|
# User-authored text content associated with an event.
|
|
3585
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4373
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent }
|
|
3586
4374
|
|
|
3587
4375
|
# User-uploaded image content associated with an event.
|
|
3588
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4376
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent }
|
|
3589
4377
|
|
|
3590
4378
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
3591
4379
|
# @!attribute text
|
|
@@ -3597,9 +4385,9 @@ module SafetyKit
|
|
|
3597
4385
|
# @!attribute type
|
|
3598
4386
|
# Text content part.
|
|
3599
4387
|
#
|
|
3600
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4388
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent::Type]
|
|
3601
4389
|
required :type,
|
|
3602
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4390
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent::Type }
|
|
3603
4391
|
|
|
3604
4392
|
# @!attribute key
|
|
3605
4393
|
# Stable field key for this content part.
|
|
@@ -3612,13 +4400,13 @@ module SafetyKit
|
|
|
3612
4400
|
#
|
|
3613
4401
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
3614
4402
|
#
|
|
3615
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4403
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent::Type] Text content part.
|
|
3616
4404
|
#
|
|
3617
4405
|
# @param key [String] Stable field key for this content part.
|
|
3618
4406
|
|
|
3619
4407
|
# Text content part.
|
|
3620
4408
|
#
|
|
3621
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4409
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent#type
|
|
3622
4410
|
module Type
|
|
3623
4411
|
extend SafetyKit::Internal::Type::Enum
|
|
3624
4412
|
|
|
@@ -3633,16 +4421,16 @@ module SafetyKit
|
|
|
3633
4421
|
# @!attribute source
|
|
3634
4422
|
# Image source information.
|
|
3635
4423
|
#
|
|
3636
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4424
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source]
|
|
3637
4425
|
required :source,
|
|
3638
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4426
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source }
|
|
3639
4427
|
|
|
3640
4428
|
# @!attribute type
|
|
3641
4429
|
# Image content part.
|
|
3642
4430
|
#
|
|
3643
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4431
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Type]
|
|
3644
4432
|
required :type,
|
|
3645
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4433
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Type }
|
|
3646
4434
|
|
|
3647
4435
|
# @!attribute key
|
|
3648
4436
|
# Stable field key for this content part.
|
|
@@ -3653,20 +4441,20 @@ module SafetyKit
|
|
|
3653
4441
|
# @!method initialize(source:, type:, key: nil)
|
|
3654
4442
|
# User-uploaded image content associated with an event.
|
|
3655
4443
|
#
|
|
3656
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4444
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source] Image source information.
|
|
3657
4445
|
#
|
|
3658
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4446
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Type] Image content part.
|
|
3659
4447
|
#
|
|
3660
4448
|
# @param key [String] Stable field key for this content part.
|
|
3661
4449
|
|
|
3662
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4450
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent#source
|
|
3663
4451
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3664
4452
|
# @!attribute type
|
|
3665
4453
|
# URL image source.
|
|
3666
4454
|
#
|
|
3667
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4455
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source::Type]
|
|
3668
4456
|
required :type,
|
|
3669
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4457
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source::Type }
|
|
3670
4458
|
|
|
3671
4459
|
# @!attribute url
|
|
3672
4460
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -3677,13 +4465,13 @@ module SafetyKit
|
|
|
3677
4465
|
# @!method initialize(type:, url:)
|
|
3678
4466
|
# Image source information.
|
|
3679
4467
|
#
|
|
3680
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4468
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source::Type] URL image source.
|
|
3681
4469
|
#
|
|
3682
4470
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3683
4471
|
|
|
3684
4472
|
# URL image source.
|
|
3685
4473
|
#
|
|
3686
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4474
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source#type
|
|
3687
4475
|
module Type
|
|
3688
4476
|
extend SafetyKit::Internal::Type::Enum
|
|
3689
4477
|
|
|
@@ -3696,7 +4484,7 @@ module SafetyKit
|
|
|
3696
4484
|
|
|
3697
4485
|
# Image content part.
|
|
3698
4486
|
#
|
|
3699
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4487
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent#type
|
|
3700
4488
|
module Type
|
|
3701
4489
|
extend SafetyKit::Internal::Type::Enum
|
|
3702
4490
|
|
|
@@ -3708,7 +4496,7 @@ module SafetyKit
|
|
|
3708
4496
|
end
|
|
3709
4497
|
|
|
3710
4498
|
# @!method self.variants
|
|
3711
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4499
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent)]
|
|
3712
4500
|
end
|
|
3713
4501
|
|
|
3714
4502
|
module Metadata
|
|
@@ -3720,7 +4508,7 @@ module SafetyKit
|
|
|
3720
4508
|
|
|
3721
4509
|
variant SafetyKit::Internal::Type::Boolean
|
|
3722
4510
|
|
|
3723
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4511
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Metadata::UnionMember3Array }
|
|
3724
4512
|
|
|
3725
4513
|
module UnionMember3
|
|
3726
4514
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -3741,7 +4529,7 @@ module SafetyKit
|
|
|
3741
4529
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3742
4530
|
UnionMember3Array =
|
|
3743
4531
|
SafetyKit::Internal::Type::ArrayOf[
|
|
3744
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4532
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Metadata::UnionMember3 }
|
|
3745
4533
|
]
|
|
3746
4534
|
end
|
|
3747
4535
|
|
|
@@ -3762,7 +4550,7 @@ module SafetyKit
|
|
|
3762
4550
|
|
|
3763
4551
|
# @!method initialize(type:, value:)
|
|
3764
4552
|
# Some parameter documentations has been truncated, see
|
|
3765
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4553
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed}
|
|
3766
4554
|
# for more details.
|
|
3767
4555
|
#
|
|
3768
4556
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -3775,16 +4563,16 @@ module SafetyKit
|
|
|
3775
4563
|
end
|
|
3776
4564
|
|
|
3777
4565
|
# @!method self.variants
|
|
3778
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4566
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision)]
|
|
3779
4567
|
end
|
|
3780
4568
|
|
|
3781
4569
|
# @!method self.variants
|
|
3782
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4570
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision>)]
|
|
3783
4571
|
|
|
3784
4572
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3785
|
-
|
|
4573
|
+
UnionMember7Array =
|
|
3786
4574
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
3787
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
4575
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember7
|
|
3788
4576
|
}]
|
|
3789
4577
|
end
|
|
3790
4578
|
end
|