safetykit 0.25.0 → 0.27.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 +16 -0
- data/README.md +1 -1
- data/lib/safety_kit/models/beta/event_create_params.rb +1326 -494
- 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 +2660 -899
- data/rbi/safety_kit/resources/beta/events.rbi +8 -6
- data/sig/safety_kit/models/beta/event_create_params.rbs +922 -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,130 @@ 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.
|
|
923
|
+
#
|
|
924
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product::ShippingInfo, nil]
|
|
925
|
+
optional :shipping_info,
|
|
926
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product::ShippingInfo }
|
|
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 [SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product::ShippingInfo] Shipping details for the product.
|
|
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
|
+
|
|
981
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Product#shipping_info
|
|
982
|
+
class ShippingInfo < SafetyKit::Internal::Type::BaseModel
|
|
983
|
+
# @!attribute ships_from
|
|
984
|
+
# Location the product ships from.
|
|
985
|
+
#
|
|
986
|
+
# @return [String]
|
|
987
|
+
required :ships_from, String
|
|
988
|
+
|
|
989
|
+
# @!attribute ships_to
|
|
990
|
+
# Locations the product ships to.
|
|
991
|
+
#
|
|
992
|
+
# @return [Array<String>]
|
|
993
|
+
required :ships_to, SafetyKit::Internal::Type::ArrayOf[String]
|
|
994
|
+
|
|
995
|
+
# @!method initialize(ships_from:, ships_to:)
|
|
996
|
+
# Shipping details for the product.
|
|
997
|
+
#
|
|
998
|
+
# @param ships_from [String] Location the product ships from.
|
|
999
|
+
#
|
|
1000
|
+
# @param ships_to [Array<String>] Locations the product ships to.
|
|
1001
|
+
end
|
|
1002
|
+
end
|
|
1003
|
+
|
|
1004
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest#type
|
|
1005
|
+
module Type
|
|
1006
|
+
extend SafetyKit::Internal::Type::Enum
|
|
1007
|
+
|
|
1008
|
+
PRODUCT_CHANGED = :product_changed
|
|
1009
|
+
|
|
1010
|
+
# @!method self.values
|
|
1011
|
+
# @return [Array<Symbol>]
|
|
888
1012
|
end
|
|
889
1013
|
|
|
890
1014
|
module Metadata
|
|
@@ -896,7 +1020,7 @@ module SafetyKit
|
|
|
896
1020
|
|
|
897
1021
|
variant SafetyKit::Internal::Type::Boolean
|
|
898
1022
|
|
|
899
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1023
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::Metadata::UnionMember3Array }
|
|
900
1024
|
|
|
901
1025
|
module UnionMember3
|
|
902
1026
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -917,7 +1041,7 @@ module SafetyKit
|
|
|
917
1041
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
918
1042
|
UnionMember3Array =
|
|
919
1043
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
920
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
1044
|
+
SafetyKit::Beta::EventCreateParams::Body::ProductChangedEventRequest::Metadata::UnionMember3
|
|
921
1045
|
}]
|
|
922
1046
|
end
|
|
923
1047
|
|
|
@@ -938,7 +1062,7 @@ module SafetyKit
|
|
|
938
1062
|
|
|
939
1063
|
# @!method initialize(type:, value:)
|
|
940
1064
|
# Some parameter documentations has been truncated, see
|
|
941
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1065
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest::ResourcesUsed}
|
|
942
1066
|
# for more details.
|
|
943
1067
|
#
|
|
944
1068
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -950,7 +1074,7 @@ module SafetyKit
|
|
|
950
1074
|
end
|
|
951
1075
|
end
|
|
952
1076
|
|
|
953
|
-
class
|
|
1077
|
+
class CreateAccountEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
954
1078
|
# @!attribute event_name
|
|
955
1079
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
956
1080
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -966,8 +1090,8 @@ module SafetyKit
|
|
|
966
1090
|
|
|
967
1091
|
# @!attribute type
|
|
968
1092
|
#
|
|
969
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
970
|
-
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1093
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type]
|
|
1094
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type }
|
|
971
1095
|
|
|
972
1096
|
# @!attribute user_id
|
|
973
1097
|
# Your stable canonical identifier for the user or account.
|
|
@@ -980,9 +1104,9 @@ module SafetyKit
|
|
|
980
1104
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
981
1105
|
# analyze.
|
|
982
1106
|
#
|
|
983
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1107
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent>, nil]
|
|
984
1108
|
optional :content,
|
|
985
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1109
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content] }
|
|
986
1110
|
|
|
987
1111
|
# @!attribute content_id
|
|
988
1112
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -1004,34 +1128,33 @@ module SafetyKit
|
|
|
1004
1128
|
#
|
|
1005
1129
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1006
1130
|
optional :metadata,
|
|
1007
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1131
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata] }
|
|
1008
1132
|
|
|
1009
1133
|
# @!attribute resources_used
|
|
1010
1134
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1011
1135
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1012
1136
|
# identifiers.
|
|
1013
1137
|
#
|
|
1014
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1138
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>, nil]
|
|
1015
1139
|
optional :resources_used,
|
|
1016
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
1140
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed] }
|
|
1017
1141
|
|
|
1018
1142
|
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
1019
1143
|
# Some parameter documentations has been truncated, see
|
|
1020
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1144
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest}
|
|
1021
1145
|
# for more details.
|
|
1022
1146
|
#
|
|
1023
|
-
# A user or account
|
|
1024
|
-
# changes.
|
|
1147
|
+
# A user or account is created.
|
|
1025
1148
|
#
|
|
1026
1149
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1027
1150
|
#
|
|
1028
1151
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1029
1152
|
#
|
|
1030
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1153
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type]
|
|
1031
1154
|
#
|
|
1032
1155
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1033
1156
|
#
|
|
1034
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1157
|
+
# @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
1158
|
#
|
|
1036
1159
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1037
1160
|
#
|
|
@@ -1039,13 +1162,13 @@ module SafetyKit
|
|
|
1039
1162
|
#
|
|
1040
1163
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1041
1164
|
#
|
|
1042
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1165
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1043
1166
|
|
|
1044
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1167
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest#type
|
|
1045
1168
|
module Type
|
|
1046
1169
|
extend SafetyKit::Internal::Type::Enum
|
|
1047
1170
|
|
|
1048
|
-
|
|
1171
|
+
CREATE_ACCOUNT = :create_account
|
|
1049
1172
|
|
|
1050
1173
|
# @!method self.values
|
|
1051
1174
|
# @return [Array<Symbol>]
|
|
@@ -1056,10 +1179,10 @@ module SafetyKit
|
|
|
1056
1179
|
extend SafetyKit::Internal::Type::Union
|
|
1057
1180
|
|
|
1058
1181
|
# User-authored text content associated with an event.
|
|
1059
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1182
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent }
|
|
1060
1183
|
|
|
1061
1184
|
# User-uploaded image content associated with an event.
|
|
1062
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1185
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent }
|
|
1063
1186
|
|
|
1064
1187
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1065
1188
|
# @!attribute text
|
|
@@ -1071,9 +1194,9 @@ module SafetyKit
|
|
|
1071
1194
|
# @!attribute type
|
|
1072
1195
|
# Text content part.
|
|
1073
1196
|
#
|
|
1074
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1197
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent::Type]
|
|
1075
1198
|
required :type,
|
|
1076
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1199
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent::Type }
|
|
1077
1200
|
|
|
1078
1201
|
# @!attribute key
|
|
1079
1202
|
# Stable field key for this content part.
|
|
@@ -1086,13 +1209,13 @@ module SafetyKit
|
|
|
1086
1209
|
#
|
|
1087
1210
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1088
1211
|
#
|
|
1089
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1212
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent::Type] Text content part.
|
|
1090
1213
|
#
|
|
1091
1214
|
# @param key [String] Stable field key for this content part.
|
|
1092
1215
|
|
|
1093
1216
|
# Text content part.
|
|
1094
1217
|
#
|
|
1095
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1218
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent#type
|
|
1096
1219
|
module Type
|
|
1097
1220
|
extend SafetyKit::Internal::Type::Enum
|
|
1098
1221
|
|
|
@@ -1107,16 +1230,16 @@ module SafetyKit
|
|
|
1107
1230
|
# @!attribute source
|
|
1108
1231
|
# Image source information.
|
|
1109
1232
|
#
|
|
1110
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1233
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source]
|
|
1111
1234
|
required :source,
|
|
1112
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1235
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source }
|
|
1113
1236
|
|
|
1114
1237
|
# @!attribute type
|
|
1115
1238
|
# Image content part.
|
|
1116
1239
|
#
|
|
1117
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1240
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Type]
|
|
1118
1241
|
required :type,
|
|
1119
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1242
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Type }
|
|
1120
1243
|
|
|
1121
1244
|
# @!attribute key
|
|
1122
1245
|
# Stable field key for this content part.
|
|
@@ -1127,20 +1250,20 @@ module SafetyKit
|
|
|
1127
1250
|
# @!method initialize(source:, type:, key: nil)
|
|
1128
1251
|
# User-uploaded image content associated with an event.
|
|
1129
1252
|
#
|
|
1130
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1253
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source] Image source information.
|
|
1131
1254
|
#
|
|
1132
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1255
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Type] Image content part.
|
|
1133
1256
|
#
|
|
1134
1257
|
# @param key [String] Stable field key for this content part.
|
|
1135
1258
|
|
|
1136
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1259
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent#source
|
|
1137
1260
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1138
1261
|
# @!attribute type
|
|
1139
1262
|
# URL image source.
|
|
1140
1263
|
#
|
|
1141
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1264
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source::Type]
|
|
1142
1265
|
required :type,
|
|
1143
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1266
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source::Type }
|
|
1144
1267
|
|
|
1145
1268
|
# @!attribute url
|
|
1146
1269
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1151,13 +1274,13 @@ module SafetyKit
|
|
|
1151
1274
|
# @!method initialize(type:, url:)
|
|
1152
1275
|
# Image source information.
|
|
1153
1276
|
#
|
|
1154
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1277
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
1155
1278
|
#
|
|
1156
1279
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1157
1280
|
|
|
1158
1281
|
# URL image source.
|
|
1159
1282
|
#
|
|
1160
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1283
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent::Source#type
|
|
1161
1284
|
module Type
|
|
1162
1285
|
extend SafetyKit::Internal::Type::Enum
|
|
1163
1286
|
|
|
@@ -1170,7 +1293,7 @@ module SafetyKit
|
|
|
1170
1293
|
|
|
1171
1294
|
# Image content part.
|
|
1172
1295
|
#
|
|
1173
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1296
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent#type
|
|
1174
1297
|
module Type
|
|
1175
1298
|
extend SafetyKit::Internal::Type::Enum
|
|
1176
1299
|
|
|
@@ -1182,7 +1305,7 @@ module SafetyKit
|
|
|
1182
1305
|
end
|
|
1183
1306
|
|
|
1184
1307
|
# @!method self.variants
|
|
1185
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1308
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent)]
|
|
1186
1309
|
end
|
|
1187
1310
|
|
|
1188
1311
|
module Metadata
|
|
@@ -1194,7 +1317,7 @@ module SafetyKit
|
|
|
1194
1317
|
|
|
1195
1318
|
variant SafetyKit::Internal::Type::Boolean
|
|
1196
1319
|
|
|
1197
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1320
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata::UnionMember3Array }
|
|
1198
1321
|
|
|
1199
1322
|
module UnionMember3
|
|
1200
1323
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1215,7 +1338,7 @@ module SafetyKit
|
|
|
1215
1338
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1216
1339
|
UnionMember3Array =
|
|
1217
1340
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1218
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
1341
|
+
SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata::UnionMember3
|
|
1219
1342
|
}]
|
|
1220
1343
|
end
|
|
1221
1344
|
|
|
@@ -1236,7 +1359,7 @@ module SafetyKit
|
|
|
1236
1359
|
|
|
1237
1360
|
# @!method initialize(type:, value:)
|
|
1238
1361
|
# Some parameter documentations has been truncated, see
|
|
1239
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1362
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed}
|
|
1240
1363
|
# for more details.
|
|
1241
1364
|
#
|
|
1242
1365
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1248,7 +1371,7 @@ module SafetyKit
|
|
|
1248
1371
|
end
|
|
1249
1372
|
end
|
|
1250
1373
|
|
|
1251
|
-
class
|
|
1374
|
+
class UpdateAccountEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
1252
1375
|
# @!attribute event_name
|
|
1253
1376
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1254
1377
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -1256,12 +1379,6 @@ module SafetyKit
|
|
|
1256
1379
|
# @return [String]
|
|
1257
1380
|
required :event_name, String
|
|
1258
1381
|
|
|
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
1382
|
# @!attribute timestamp
|
|
1266
1383
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1267
1384
|
#
|
|
@@ -1270,8 +1387,8 @@ module SafetyKit
|
|
|
1270
1387
|
|
|
1271
1388
|
# @!attribute type
|
|
1272
1389
|
#
|
|
1273
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1274
|
-
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1390
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Type]
|
|
1391
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Type }
|
|
1275
1392
|
|
|
1276
1393
|
# @!attribute user_id
|
|
1277
1394
|
# Your stable canonical identifier for the user or account.
|
|
@@ -1284,9 +1401,9 @@ module SafetyKit
|
|
|
1284
1401
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1285
1402
|
# analyze.
|
|
1286
1403
|
#
|
|
1287
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1404
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent>, nil]
|
|
1288
1405
|
optional :content,
|
|
1289
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1406
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content] }
|
|
1290
1407
|
|
|
1291
1408
|
# @!attribute content_id
|
|
1292
1409
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -1308,50 +1425,34 @@ module SafetyKit
|
|
|
1308
1425
|
#
|
|
1309
1426
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1310
1427
|
optional :metadata,
|
|
1311
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1428
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata] }
|
|
1312
1429
|
|
|
1313
1430
|
# @!attribute resources_used
|
|
1314
1431
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1315
1432
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1316
1433
|
# identifiers.
|
|
1317
1434
|
#
|
|
1318
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1435
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>, nil]
|
|
1319
1436
|
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
|
|
1437
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed] }
|
|
1333
1438
|
|
|
1334
|
-
# @!method initialize(event_name:,
|
|
1439
|
+
# @!method initialize(event_name:, timestamp:, type:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
1335
1440
|
# Some parameter documentations has been truncated, see
|
|
1336
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1337
|
-
# more details.
|
|
1441
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest}
|
|
1442
|
+
# for more details.
|
|
1338
1443
|
#
|
|
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.
|
|
1444
|
+
# A user or account profile, contact detail, payment detail, or public bio
|
|
1445
|
+
# changes.
|
|
1343
1446
|
#
|
|
1344
1447
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1345
1448
|
#
|
|
1346
|
-
# @param labels [Array<String>] One or more label categories supplied with the report or moderation decision.
|
|
1347
|
-
#
|
|
1348
1449
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1349
1450
|
#
|
|
1350
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1451
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Type]
|
|
1351
1452
|
#
|
|
1352
1453
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1353
1454
|
#
|
|
1354
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1455
|
+
# @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
1456
|
#
|
|
1356
1457
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1357
1458
|
#
|
|
@@ -1359,17 +1460,13 @@ module SafetyKit
|
|
|
1359
1460
|
#
|
|
1360
1461
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1361
1462
|
#
|
|
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.
|
|
1463
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1367
1464
|
|
|
1368
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1465
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest#type
|
|
1369
1466
|
module Type
|
|
1370
1467
|
extend SafetyKit::Internal::Type::Enum
|
|
1371
1468
|
|
|
1372
|
-
|
|
1469
|
+
UPDATE_ACCOUNT = :update_account
|
|
1373
1470
|
|
|
1374
1471
|
# @!method self.values
|
|
1375
1472
|
# @return [Array<Symbol>]
|
|
@@ -1380,10 +1477,10 @@ module SafetyKit
|
|
|
1380
1477
|
extend SafetyKit::Internal::Type::Union
|
|
1381
1478
|
|
|
1382
1479
|
# User-authored text content associated with an event.
|
|
1383
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1480
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent }
|
|
1384
1481
|
|
|
1385
1482
|
# User-uploaded image content associated with an event.
|
|
1386
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1483
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent }
|
|
1387
1484
|
|
|
1388
1485
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1389
1486
|
# @!attribute text
|
|
@@ -1395,9 +1492,9 @@ module SafetyKit
|
|
|
1395
1492
|
# @!attribute type
|
|
1396
1493
|
# Text content part.
|
|
1397
1494
|
#
|
|
1398
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1495
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent::Type]
|
|
1399
1496
|
required :type,
|
|
1400
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1497
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent::Type }
|
|
1401
1498
|
|
|
1402
1499
|
# @!attribute key
|
|
1403
1500
|
# Stable field key for this content part.
|
|
@@ -1410,13 +1507,13 @@ module SafetyKit
|
|
|
1410
1507
|
#
|
|
1411
1508
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1412
1509
|
#
|
|
1413
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1510
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent::Type] Text content part.
|
|
1414
1511
|
#
|
|
1415
1512
|
# @param key [String] Stable field key for this content part.
|
|
1416
1513
|
|
|
1417
1514
|
# Text content part.
|
|
1418
1515
|
#
|
|
1419
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1516
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent#type
|
|
1420
1517
|
module Type
|
|
1421
1518
|
extend SafetyKit::Internal::Type::Enum
|
|
1422
1519
|
|
|
@@ -1431,16 +1528,16 @@ module SafetyKit
|
|
|
1431
1528
|
# @!attribute source
|
|
1432
1529
|
# Image source information.
|
|
1433
1530
|
#
|
|
1434
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1531
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source]
|
|
1435
1532
|
required :source,
|
|
1436
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1533
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source }
|
|
1437
1534
|
|
|
1438
1535
|
# @!attribute type
|
|
1439
1536
|
# Image content part.
|
|
1440
1537
|
#
|
|
1441
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1538
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Type]
|
|
1442
1539
|
required :type,
|
|
1443
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1540
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Type }
|
|
1444
1541
|
|
|
1445
1542
|
# @!attribute key
|
|
1446
1543
|
# Stable field key for this content part.
|
|
@@ -1451,20 +1548,20 @@ module SafetyKit
|
|
|
1451
1548
|
# @!method initialize(source:, type:, key: nil)
|
|
1452
1549
|
# User-uploaded image content associated with an event.
|
|
1453
1550
|
#
|
|
1454
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1551
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source] Image source information.
|
|
1455
1552
|
#
|
|
1456
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1553
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Type] Image content part.
|
|
1457
1554
|
#
|
|
1458
1555
|
# @param key [String] Stable field key for this content part.
|
|
1459
1556
|
|
|
1460
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1557
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent#source
|
|
1461
1558
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1462
1559
|
# @!attribute type
|
|
1463
1560
|
# URL image source.
|
|
1464
1561
|
#
|
|
1465
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1562
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source::Type]
|
|
1466
1563
|
required :type,
|
|
1467
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1564
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source::Type }
|
|
1468
1565
|
|
|
1469
1566
|
# @!attribute url
|
|
1470
1567
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1475,13 +1572,13 @@ module SafetyKit
|
|
|
1475
1572
|
# @!method initialize(type:, url:)
|
|
1476
1573
|
# Image source information.
|
|
1477
1574
|
#
|
|
1478
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1575
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
1479
1576
|
#
|
|
1480
1577
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1481
1578
|
|
|
1482
1579
|
# URL image source.
|
|
1483
1580
|
#
|
|
1484
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1581
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent::Source#type
|
|
1485
1582
|
module Type
|
|
1486
1583
|
extend SafetyKit::Internal::Type::Enum
|
|
1487
1584
|
|
|
@@ -1494,7 +1591,7 @@ module SafetyKit
|
|
|
1494
1591
|
|
|
1495
1592
|
# Image content part.
|
|
1496
1593
|
#
|
|
1497
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1594
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent#type
|
|
1498
1595
|
module Type
|
|
1499
1596
|
extend SafetyKit::Internal::Type::Enum
|
|
1500
1597
|
|
|
@@ -1506,7 +1603,7 @@ module SafetyKit
|
|
|
1506
1603
|
end
|
|
1507
1604
|
|
|
1508
1605
|
# @!method self.variants
|
|
1509
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1606
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Content::EventImageContent)]
|
|
1510
1607
|
end
|
|
1511
1608
|
|
|
1512
1609
|
module Metadata
|
|
@@ -1518,7 +1615,7 @@ module SafetyKit
|
|
|
1518
1615
|
|
|
1519
1616
|
variant SafetyKit::Internal::Type::Boolean
|
|
1520
1617
|
|
|
1521
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1618
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata::UnionMember3Array }
|
|
1522
1619
|
|
|
1523
1620
|
module UnionMember3
|
|
1524
1621
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1539,7 +1636,7 @@ module SafetyKit
|
|
|
1539
1636
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1540
1637
|
UnionMember3Array =
|
|
1541
1638
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1542
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
1639
|
+
SafetyKit::Beta::EventCreateParams::Body::UpdateAccountEventRequest::Metadata::UnionMember3
|
|
1543
1640
|
}]
|
|
1544
1641
|
end
|
|
1545
1642
|
|
|
@@ -1560,7 +1657,7 @@ module SafetyKit
|
|
|
1560
1657
|
|
|
1561
1658
|
# @!method initialize(type:, value:)
|
|
1562
1659
|
# Some parameter documentations has been truncated, see
|
|
1563
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1660
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest::ResourcesUsed}
|
|
1564
1661
|
# for more details.
|
|
1565
1662
|
#
|
|
1566
1663
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1572,7 +1669,7 @@ module SafetyKit
|
|
|
1572
1669
|
end
|
|
1573
1670
|
end
|
|
1574
1671
|
|
|
1575
|
-
class
|
|
1672
|
+
class UserReportEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
1576
1673
|
# @!attribute event_name
|
|
1577
1674
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1578
1675
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -1586,25 +1683,6 @@ module SafetyKit
|
|
|
1586
1683
|
# @return [Array<String>]
|
|
1587
1684
|
required :labels, SafetyKit::Internal::Type::ArrayOf[String]
|
|
1588
1685
|
|
|
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
1686
|
# @!attribute timestamp
|
|
1609
1687
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1610
1688
|
#
|
|
@@ -1613,18 +1691,23 @@ module SafetyKit
|
|
|
1613
1691
|
|
|
1614
1692
|
# @!attribute type
|
|
1615
1693
|
#
|
|
1616
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1617
|
-
required :type,
|
|
1618
|
-
|
|
1694
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Type]
|
|
1695
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Type }
|
|
1696
|
+
|
|
1697
|
+
# @!attribute user_id
|
|
1698
|
+
# Your stable canonical identifier for the user or account.
|
|
1699
|
+
#
|
|
1700
|
+
# @return [String]
|
|
1701
|
+
required :user_id, String
|
|
1619
1702
|
|
|
1620
1703
|
# @!attribute content
|
|
1621
1704
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
1622
1705
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
1623
1706
|
# analyze.
|
|
1624
1707
|
#
|
|
1625
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1708
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent>, nil]
|
|
1626
1709
|
optional :content,
|
|
1627
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1710
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content] }
|
|
1628
1711
|
|
|
1629
1712
|
# @!attribute content_id
|
|
1630
1713
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -1646,16 +1729,16 @@ module SafetyKit
|
|
|
1646
1729
|
#
|
|
1647
1730
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
1648
1731
|
optional :metadata,
|
|
1649
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
1732
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata] }
|
|
1650
1733
|
|
|
1651
1734
|
# @!attribute resources_used
|
|
1652
1735
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
1653
1736
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
1654
1737
|
# identifiers.
|
|
1655
1738
|
#
|
|
1656
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1739
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed>, nil]
|
|
1657
1740
|
optional :resources_used,
|
|
1658
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
1741
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed] }
|
|
1659
1742
|
|
|
1660
1743
|
# @!attribute target_content_id
|
|
1661
1744
|
# Your stable identifier for the content being reported.
|
|
@@ -1669,28 +1752,27 @@ module SafetyKit
|
|
|
1669
1752
|
# @return [String, nil]
|
|
1670
1753
|
optional :target_user_id, String
|
|
1671
1754
|
|
|
1672
|
-
# @!method initialize(event_name:, labels:,
|
|
1755
|
+
# @!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
1756
|
# Some parameter documentations has been truncated, see
|
|
1674
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1675
|
-
#
|
|
1757
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest} for
|
|
1758
|
+
# more details.
|
|
1676
1759
|
#
|
|
1677
|
-
# A
|
|
1678
|
-
#
|
|
1679
|
-
#
|
|
1760
|
+
# A user-submitted report. Use user_id for the reporter. Include target_user_id
|
|
1761
|
+
# when a user is reported, target_content_id when content is reported, and both
|
|
1762
|
+
# when the report is about content associated with a user. Use content and
|
|
1763
|
+
# content_id for the report itself.
|
|
1680
1764
|
#
|
|
1681
1765
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
1682
1766
|
#
|
|
1683
1767
|
# @param labels [Array<String>] One or more label categories supplied with the report or moderation decision.
|
|
1684
1768
|
#
|
|
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
1769
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
1690
1770
|
#
|
|
1691
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1771
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Type]
|
|
1692
1772
|
#
|
|
1693
|
-
# @param
|
|
1773
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
1774
|
+
#
|
|
1775
|
+
# @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
1776
|
#
|
|
1695
1777
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
1696
1778
|
#
|
|
@@ -1698,36 +1780,17 @@ module SafetyKit
|
|
|
1698
1780
|
#
|
|
1699
1781
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
1700
1782
|
#
|
|
1701
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1783
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
1702
1784
|
#
|
|
1703
1785
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
1704
1786
|
#
|
|
1705
1787
|
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
1706
1788
|
|
|
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
|
|
1789
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest#type
|
|
1727
1790
|
module Type
|
|
1728
1791
|
extend SafetyKit::Internal::Type::Enum
|
|
1729
1792
|
|
|
1730
|
-
|
|
1793
|
+
USER_REPORT = :user_report
|
|
1731
1794
|
|
|
1732
1795
|
# @!method self.values
|
|
1733
1796
|
# @return [Array<Symbol>]
|
|
@@ -1738,10 +1801,10 @@ module SafetyKit
|
|
|
1738
1801
|
extend SafetyKit::Internal::Type::Union
|
|
1739
1802
|
|
|
1740
1803
|
# User-authored text content associated with an event.
|
|
1741
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1804
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent }
|
|
1742
1805
|
|
|
1743
1806
|
# User-uploaded image content associated with an event.
|
|
1744
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1807
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent }
|
|
1745
1808
|
|
|
1746
1809
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
1747
1810
|
# @!attribute text
|
|
@@ -1753,9 +1816,9 @@ module SafetyKit
|
|
|
1753
1816
|
# @!attribute type
|
|
1754
1817
|
# Text content part.
|
|
1755
1818
|
#
|
|
1756
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1819
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent::Type]
|
|
1757
1820
|
required :type,
|
|
1758
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1821
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent::Type }
|
|
1759
1822
|
|
|
1760
1823
|
# @!attribute key
|
|
1761
1824
|
# Stable field key for this content part.
|
|
@@ -1768,13 +1831,13 @@ module SafetyKit
|
|
|
1768
1831
|
#
|
|
1769
1832
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
1770
1833
|
#
|
|
1771
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1834
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent::Type] Text content part.
|
|
1772
1835
|
#
|
|
1773
1836
|
# @param key [String] Stable field key for this content part.
|
|
1774
1837
|
|
|
1775
1838
|
# Text content part.
|
|
1776
1839
|
#
|
|
1777
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1840
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent#type
|
|
1778
1841
|
module Type
|
|
1779
1842
|
extend SafetyKit::Internal::Type::Enum
|
|
1780
1843
|
|
|
@@ -1789,16 +1852,16 @@ module SafetyKit
|
|
|
1789
1852
|
# @!attribute source
|
|
1790
1853
|
# Image source information.
|
|
1791
1854
|
#
|
|
1792
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1855
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source]
|
|
1793
1856
|
required :source,
|
|
1794
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1857
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source }
|
|
1795
1858
|
|
|
1796
1859
|
# @!attribute type
|
|
1797
1860
|
# Image content part.
|
|
1798
1861
|
#
|
|
1799
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1862
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Type]
|
|
1800
1863
|
required :type,
|
|
1801
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1864
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Type }
|
|
1802
1865
|
|
|
1803
1866
|
# @!attribute key
|
|
1804
1867
|
# Stable field key for this content part.
|
|
@@ -1809,20 +1872,20 @@ module SafetyKit
|
|
|
1809
1872
|
# @!method initialize(source:, type:, key: nil)
|
|
1810
1873
|
# User-uploaded image content associated with an event.
|
|
1811
1874
|
#
|
|
1812
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1875
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source] Image source information.
|
|
1813
1876
|
#
|
|
1814
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1877
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Type] Image content part.
|
|
1815
1878
|
#
|
|
1816
1879
|
# @param key [String] Stable field key for this content part.
|
|
1817
1880
|
|
|
1818
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1881
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent#source
|
|
1819
1882
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
1820
1883
|
# @!attribute type
|
|
1821
1884
|
# URL image source.
|
|
1822
1885
|
#
|
|
1823
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1886
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type]
|
|
1824
1887
|
required :type,
|
|
1825
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
1888
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type }
|
|
1826
1889
|
|
|
1827
1890
|
# @!attribute url
|
|
1828
1891
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -1833,13 +1896,13 @@ module SafetyKit
|
|
|
1833
1896
|
# @!method initialize(type:, url:)
|
|
1834
1897
|
# Image source information.
|
|
1835
1898
|
#
|
|
1836
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1899
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
1837
1900
|
#
|
|
1838
1901
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
1839
1902
|
|
|
1840
1903
|
# URL image source.
|
|
1841
1904
|
#
|
|
1842
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1905
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent::Source#type
|
|
1843
1906
|
module Type
|
|
1844
1907
|
extend SafetyKit::Internal::Type::Enum
|
|
1845
1908
|
|
|
@@ -1852,7 +1915,7 @@ module SafetyKit
|
|
|
1852
1915
|
|
|
1853
1916
|
# Image content part.
|
|
1854
1917
|
#
|
|
1855
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1918
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent#type
|
|
1856
1919
|
module Type
|
|
1857
1920
|
extend SafetyKit::Internal::Type::Enum
|
|
1858
1921
|
|
|
@@ -1864,7 +1927,7 @@ module SafetyKit
|
|
|
1864
1927
|
end
|
|
1865
1928
|
|
|
1866
1929
|
# @!method self.variants
|
|
1867
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1930
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent)]
|
|
1868
1931
|
end
|
|
1869
1932
|
|
|
1870
1933
|
module Metadata
|
|
@@ -1876,7 +1939,7 @@ module SafetyKit
|
|
|
1876
1939
|
|
|
1877
1940
|
variant SafetyKit::Internal::Type::Boolean
|
|
1878
1941
|
|
|
1879
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1942
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata::UnionMember3Array }
|
|
1880
1943
|
|
|
1881
1944
|
module UnionMember3
|
|
1882
1945
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -1896,9 +1959,9 @@ module SafetyKit
|
|
|
1896
1959
|
|
|
1897
1960
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
1898
1961
|
UnionMember3Array =
|
|
1899
|
-
SafetyKit::Internal::Type::ArrayOf[
|
|
1900
|
-
|
|
1901
|
-
]
|
|
1962
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
1963
|
+
SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Metadata::UnionMember3
|
|
1964
|
+
}]
|
|
1902
1965
|
end
|
|
1903
1966
|
|
|
1904
1967
|
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
@@ -1918,7 +1981,7 @@ module SafetyKit
|
|
|
1918
1981
|
|
|
1919
1982
|
# @!method initialize(type:, value:)
|
|
1920
1983
|
# Some parameter documentations has been truncated, see
|
|
1921
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
1984
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed}
|
|
1922
1985
|
# for more details.
|
|
1923
1986
|
#
|
|
1924
1987
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -1930,45 +1993,704 @@ module SafetyKit
|
|
|
1930
1993
|
end
|
|
1931
1994
|
end
|
|
1932
1995
|
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
|
-
|
|
1996
|
+
class ModerationDecisionEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
1997
|
+
# @!attribute event_name
|
|
1998
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1999
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
2000
|
+
#
|
|
2001
|
+
# @return [String]
|
|
2002
|
+
required :event_name, String
|
|
1936
2003
|
|
|
1937
|
-
|
|
2004
|
+
# @!attribute labels
|
|
2005
|
+
# One or more label categories supplied with the report or moderation decision.
|
|
2006
|
+
#
|
|
2007
|
+
# @return [Array<String>]
|
|
2008
|
+
required :labels, SafetyKit::Internal::Type::ArrayOf[String]
|
|
1938
2009
|
|
|
1939
|
-
#
|
|
1940
|
-
|
|
2010
|
+
# @!attribute source_id
|
|
2011
|
+
# Stable identifier within source_type. Examples: moderator@example.com or
|
|
2012
|
+
# 550e8400-e29b-41d4-a716-446655440000 for expert_labeler or human_moderator,
|
|
2013
|
+
# automated_review_v2026_06_04 for automation, or <vendor_name>-v2.1 for vendor.
|
|
2014
|
+
#
|
|
2015
|
+
# @return [String]
|
|
2016
|
+
required :source_id, String
|
|
1941
2017
|
|
|
1942
|
-
#
|
|
1943
|
-
|
|
2018
|
+
# @!attribute source_type
|
|
2019
|
+
# Coarse attribution category for the moderation decision source. Supported
|
|
2020
|
+
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
2021
|
+
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
2022
|
+
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
2023
|
+
# review or moderation provider).
|
|
2024
|
+
#
|
|
2025
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType]
|
|
2026
|
+
required :source_type,
|
|
2027
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType }
|
|
1944
2028
|
|
|
1945
|
-
#
|
|
1946
|
-
|
|
2029
|
+
# @!attribute timestamp
|
|
2030
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2031
|
+
#
|
|
2032
|
+
# @return [Time]
|
|
2033
|
+
required :timestamp, Time
|
|
1947
2034
|
|
|
1948
|
-
#
|
|
1949
|
-
|
|
2035
|
+
# @!attribute type
|
|
2036
|
+
#
|
|
2037
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Type]
|
|
2038
|
+
required :type,
|
|
2039
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Type }
|
|
1950
2040
|
|
|
1951
|
-
#
|
|
1952
|
-
|
|
2041
|
+
# @!attribute content
|
|
2042
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2043
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2044
|
+
# analyze.
|
|
2045
|
+
#
|
|
2046
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent>, nil]
|
|
2047
|
+
optional :content,
|
|
2048
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content] }
|
|
1953
2049
|
|
|
1954
|
-
#
|
|
1955
|
-
|
|
1956
|
-
|
|
2050
|
+
# @!attribute content_id
|
|
2051
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
2052
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
2053
|
+
#
|
|
2054
|
+
# @return [String, nil]
|
|
2055
|
+
optional :content_id, String
|
|
1957
2056
|
|
|
1958
|
-
|
|
1959
|
-
|
|
1960
|
-
|
|
2057
|
+
# @!attribute idempotency_key
|
|
2058
|
+
# Optional caller-provided key used to make retries of this individual event
|
|
2059
|
+
# idempotent. Reuse the same key only for retries of the same logical event.
|
|
2060
|
+
#
|
|
2061
|
+
# @return [String, nil]
|
|
2062
|
+
optional :idempotency_key, String
|
|
2063
|
+
|
|
2064
|
+
# @!attribute metadata
|
|
2065
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
2066
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
2067
|
+
#
|
|
2068
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2069
|
+
optional :metadata,
|
|
2070
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata] }
|
|
2071
|
+
|
|
2072
|
+
# @!attribute resources_used
|
|
2073
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
2074
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2075
|
+
# identifiers.
|
|
2076
|
+
#
|
|
2077
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed>, nil]
|
|
2078
|
+
optional :resources_used,
|
|
2079
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed] }
|
|
2080
|
+
|
|
2081
|
+
# @!attribute target_content_id
|
|
2082
|
+
# Your stable identifier for the content being reported.
|
|
2083
|
+
#
|
|
2084
|
+
# @return [String, nil]
|
|
2085
|
+
optional :target_content_id, String
|
|
2086
|
+
|
|
2087
|
+
# @!attribute target_user_id
|
|
2088
|
+
# Your stable canonical identifier for the user being reported.
|
|
2089
|
+
#
|
|
2090
|
+
# @return [String, nil]
|
|
2091
|
+
optional :target_user_id, String
|
|
2092
|
+
|
|
2093
|
+
# @!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)
|
|
2094
|
+
# Some parameter documentations has been truncated, see
|
|
2095
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest}
|
|
2096
|
+
# for more details.
|
|
2097
|
+
#
|
|
2098
|
+
# A moderation label or decision from an automated enforcement system or manual
|
|
2099
|
+
# review workflow. Do not send user_id; use source_type and source_id for
|
|
2100
|
+
# attribution.
|
|
2101
|
+
#
|
|
2102
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
2103
|
+
#
|
|
2104
|
+
# @param labels [Array<String>] One or more label categories supplied with the report or moderation decision.
|
|
2105
|
+
#
|
|
2106
|
+
# @param source_id [String] Stable identifier within source_type. Examples: moderator@example.com or 550e840
|
|
2107
|
+
#
|
|
2108
|
+
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType] Coarse attribution category for the moderation decision source. Supported values
|
|
2109
|
+
#
|
|
2110
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2111
|
+
#
|
|
2112
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Type]
|
|
2113
|
+
#
|
|
2114
|
+
# @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,
|
|
2115
|
+
#
|
|
2116
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2117
|
+
#
|
|
2118
|
+
# @param idempotency_key [String] Optional caller-provided key used to make retries of this individual event idemp
|
|
2119
|
+
#
|
|
2120
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2121
|
+
#
|
|
2122
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2123
|
+
#
|
|
2124
|
+
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
2125
|
+
#
|
|
2126
|
+
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
2127
|
+
|
|
2128
|
+
# Coarse attribution category for the moderation decision source. Supported
|
|
2129
|
+
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
2130
|
+
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
2131
|
+
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
2132
|
+
# review or moderation provider).
|
|
2133
|
+
#
|
|
2134
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#source_type
|
|
2135
|
+
module SourceType
|
|
2136
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2137
|
+
|
|
2138
|
+
HUMAN_MODERATOR = :human_moderator
|
|
2139
|
+
EXPERT_LABELER = :expert_labeler
|
|
2140
|
+
AUTOMATION = :automation
|
|
2141
|
+
VENDOR = :vendor
|
|
2142
|
+
|
|
2143
|
+
# @!method self.values
|
|
2144
|
+
# @return [Array<Symbol>]
|
|
2145
|
+
end
|
|
2146
|
+
|
|
2147
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#type
|
|
2148
|
+
module Type
|
|
2149
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2150
|
+
|
|
2151
|
+
MODERATION_DECISION = :moderation_decision
|
|
2152
|
+
|
|
2153
|
+
# @!method self.values
|
|
2154
|
+
# @return [Array<Symbol>]
|
|
2155
|
+
end
|
|
2156
|
+
|
|
2157
|
+
# User-authored text content associated with an event.
|
|
2158
|
+
module Content
|
|
2159
|
+
extend SafetyKit::Internal::Type::Union
|
|
2160
|
+
|
|
2161
|
+
# User-authored text content associated with an event.
|
|
2162
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent }
|
|
2163
|
+
|
|
2164
|
+
# User-uploaded image content associated with an event.
|
|
2165
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent }
|
|
2166
|
+
|
|
2167
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2168
|
+
# @!attribute text
|
|
2169
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
2170
|
+
#
|
|
2171
|
+
# @return [String]
|
|
2172
|
+
required :text, String
|
|
2173
|
+
|
|
2174
|
+
# @!attribute type
|
|
2175
|
+
# Text content part.
|
|
2176
|
+
#
|
|
2177
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent::Type]
|
|
2178
|
+
required :type,
|
|
2179
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent::Type }
|
|
2180
|
+
|
|
2181
|
+
# @!attribute key
|
|
2182
|
+
# Stable field key for this content part.
|
|
2183
|
+
#
|
|
2184
|
+
# @return [String, nil]
|
|
2185
|
+
optional :key, String
|
|
2186
|
+
|
|
2187
|
+
# @!method initialize(text:, type:, key: nil)
|
|
2188
|
+
# User-authored text content associated with an event.
|
|
2189
|
+
#
|
|
2190
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2191
|
+
#
|
|
2192
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent::Type] Text content part.
|
|
2193
|
+
#
|
|
2194
|
+
# @param key [String] Stable field key for this content part.
|
|
2195
|
+
|
|
2196
|
+
# Text content part.
|
|
2197
|
+
#
|
|
2198
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent#type
|
|
2199
|
+
module Type
|
|
2200
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2201
|
+
|
|
2202
|
+
TEXT = :text
|
|
2203
|
+
|
|
2204
|
+
# @!method self.values
|
|
2205
|
+
# @return [Array<Symbol>]
|
|
2206
|
+
end
|
|
2207
|
+
end
|
|
2208
|
+
|
|
2209
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
2210
|
+
# @!attribute source
|
|
2211
|
+
# Image source information.
|
|
2212
|
+
#
|
|
2213
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source]
|
|
2214
|
+
required :source,
|
|
2215
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source }
|
|
2216
|
+
|
|
2217
|
+
# @!attribute type
|
|
2218
|
+
# Image content part.
|
|
2219
|
+
#
|
|
2220
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Type]
|
|
2221
|
+
required :type,
|
|
2222
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Type }
|
|
2223
|
+
|
|
2224
|
+
# @!attribute key
|
|
2225
|
+
# Stable field key for this content part.
|
|
2226
|
+
#
|
|
2227
|
+
# @return [String, nil]
|
|
2228
|
+
optional :key, String
|
|
2229
|
+
|
|
2230
|
+
# @!method initialize(source:, type:, key: nil)
|
|
2231
|
+
# User-uploaded image content associated with an event.
|
|
2232
|
+
#
|
|
2233
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source] Image source information.
|
|
2234
|
+
#
|
|
2235
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Type] Image content part.
|
|
2236
|
+
#
|
|
2237
|
+
# @param key [String] Stable field key for this content part.
|
|
2238
|
+
|
|
2239
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent#source
|
|
2240
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2241
|
+
# @!attribute type
|
|
2242
|
+
# URL image source.
|
|
2243
|
+
#
|
|
2244
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source::Type]
|
|
2245
|
+
required :type,
|
|
2246
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source::Type }
|
|
2247
|
+
|
|
2248
|
+
# @!attribute url
|
|
2249
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
2250
|
+
#
|
|
2251
|
+
# @return [String]
|
|
2252
|
+
required :url, String
|
|
2253
|
+
|
|
2254
|
+
# @!method initialize(type:, url:)
|
|
2255
|
+
# Image source information.
|
|
2256
|
+
#
|
|
2257
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
2258
|
+
#
|
|
2259
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2260
|
+
|
|
2261
|
+
# URL image source.
|
|
2262
|
+
#
|
|
2263
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source#type
|
|
2264
|
+
module Type
|
|
2265
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2266
|
+
|
|
2267
|
+
URL = :url
|
|
2268
|
+
|
|
2269
|
+
# @!method self.values
|
|
2270
|
+
# @return [Array<Symbol>]
|
|
2271
|
+
end
|
|
2272
|
+
end
|
|
2273
|
+
|
|
2274
|
+
# Image content part.
|
|
2275
|
+
#
|
|
2276
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent#type
|
|
2277
|
+
module Type
|
|
2278
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2279
|
+
|
|
2280
|
+
IMAGE = :image
|
|
2281
|
+
|
|
2282
|
+
# @!method self.values
|
|
2283
|
+
# @return [Array<Symbol>]
|
|
2284
|
+
end
|
|
2285
|
+
end
|
|
2286
|
+
|
|
2287
|
+
# @!method self.variants
|
|
2288
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent)]
|
|
2289
|
+
end
|
|
2290
|
+
|
|
2291
|
+
module Metadata
|
|
2292
|
+
extend SafetyKit::Internal::Type::Union
|
|
2293
|
+
|
|
2294
|
+
variant String
|
|
2295
|
+
|
|
2296
|
+
variant Float
|
|
2297
|
+
|
|
2298
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2299
|
+
|
|
2300
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata::UnionMember3Array }
|
|
2301
|
+
|
|
2302
|
+
module UnionMember3
|
|
2303
|
+
extend SafetyKit::Internal::Type::Union
|
|
2304
|
+
|
|
2305
|
+
variant String
|
|
2306
|
+
|
|
2307
|
+
variant Float
|
|
2308
|
+
|
|
2309
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2310
|
+
|
|
2311
|
+
# @!method self.variants
|
|
2312
|
+
# @return [Array(String, Float, Boolean)]
|
|
2313
|
+
end
|
|
2314
|
+
|
|
2315
|
+
# @!method self.variants
|
|
2316
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
2317
|
+
|
|
2318
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
2319
|
+
UnionMember3Array =
|
|
2320
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
2321
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata::UnionMember3 }
|
|
2322
|
+
]
|
|
2323
|
+
end
|
|
2324
|
+
|
|
2325
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
2326
|
+
# @!attribute type
|
|
2327
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
2328
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
2329
|
+
#
|
|
2330
|
+
# @return [String]
|
|
2331
|
+
required :type, String
|
|
2332
|
+
|
|
2333
|
+
# @!attribute value
|
|
2334
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2335
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2336
|
+
#
|
|
2337
|
+
# @return [String]
|
|
2338
|
+
required :value, String
|
|
2339
|
+
|
|
2340
|
+
# @!method initialize(type:, value:)
|
|
2341
|
+
# Some parameter documentations has been truncated, see
|
|
2342
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed}
|
|
2343
|
+
# for more details.
|
|
2344
|
+
#
|
|
2345
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
2346
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2347
|
+
#
|
|
2348
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
2349
|
+
#
|
|
2350
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2351
|
+
end
|
|
2352
|
+
end
|
|
2353
|
+
|
|
2354
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
2355
|
+
module UnionMember7
|
|
2356
|
+
extend SafetyKit::Internal::Type::Union
|
|
2357
|
+
|
|
2358
|
+
discriminator :type
|
|
2359
|
+
|
|
2360
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
2361
|
+
variant :user_contact, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact }
|
|
2362
|
+
|
|
2363
|
+
# A user posts, uploads, publishes, edits, or replaces content.
|
|
2364
|
+
variant :content_uploaded, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded }
|
|
2365
|
+
|
|
2366
|
+
# A product listing is created, updated, or has a discount added.
|
|
2367
|
+
variant :product_changed, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged }
|
|
2368
|
+
|
|
2369
|
+
# A user or account is created.
|
|
2370
|
+
variant :create_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount }
|
|
2371
|
+
|
|
2372
|
+
# A user or account profile, contact detail, payment detail, or public bio changes.
|
|
2373
|
+
variant :update_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount }
|
|
2374
|
+
|
|
2375
|
+
# 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.
|
|
2376
|
+
variant :user_report, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport }
|
|
2377
|
+
|
|
2378
|
+
# 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.
|
|
2379
|
+
variant :moderation_decision,
|
|
2380
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision }
|
|
2381
|
+
|
|
2382
|
+
class UserContact < SafetyKit::Internal::Type::BaseModel
|
|
2383
|
+
# @!attribute event_name
|
|
2384
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
1961
2385
|
# values in typed fields, content, resources_used, or metadata.
|
|
1962
2386
|
#
|
|
1963
|
-
# @return [String]
|
|
1964
|
-
required :event_name, String
|
|
2387
|
+
# @return [String]
|
|
2388
|
+
required :event_name, String
|
|
2389
|
+
|
|
2390
|
+
# @!attribute target_user_id
|
|
2391
|
+
# Your stable canonical identifier for the other user in a user-to-user
|
|
2392
|
+
# interaction.
|
|
2393
|
+
#
|
|
2394
|
+
# @return [String]
|
|
2395
|
+
required :target_user_id, String
|
|
2396
|
+
|
|
2397
|
+
# @!attribute timestamp
|
|
2398
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2399
|
+
#
|
|
2400
|
+
# @return [Time]
|
|
2401
|
+
required :timestamp, Time
|
|
2402
|
+
|
|
2403
|
+
# @!attribute type
|
|
2404
|
+
#
|
|
2405
|
+
# @return [Symbol, :user_contact]
|
|
2406
|
+
required :type, const: :user_contact
|
|
2407
|
+
|
|
2408
|
+
# @!attribute user_id
|
|
2409
|
+
# Your stable canonical identifier for the user or account.
|
|
2410
|
+
#
|
|
2411
|
+
# @return [String]
|
|
2412
|
+
required :user_id, String
|
|
2413
|
+
|
|
2414
|
+
# @!attribute content
|
|
2415
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2416
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2417
|
+
# analyze.
|
|
2418
|
+
#
|
|
2419
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent>, nil]
|
|
2420
|
+
optional :content,
|
|
2421
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content] }
|
|
2422
|
+
|
|
2423
|
+
# @!attribute content_id
|
|
2424
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
2425
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
2426
|
+
#
|
|
2427
|
+
# @return [String, nil]
|
|
2428
|
+
optional :content_id, String
|
|
2429
|
+
|
|
2430
|
+
# @!attribute idempotency_key
|
|
2431
|
+
# Optional caller-provided key used to make retries of this individual event
|
|
2432
|
+
# idempotent. Reuse the same key only for retries of the same logical event.
|
|
2433
|
+
#
|
|
2434
|
+
# @return [String, nil]
|
|
2435
|
+
optional :idempotency_key, String
|
|
2436
|
+
|
|
2437
|
+
# @!attribute metadata
|
|
2438
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
2439
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
2440
|
+
#
|
|
2441
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2442
|
+
optional :metadata,
|
|
2443
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Metadata] }
|
|
2444
|
+
|
|
2445
|
+
# @!attribute resources_used
|
|
2446
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
2447
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2448
|
+
# identifiers.
|
|
2449
|
+
#
|
|
2450
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed>, nil]
|
|
2451
|
+
optional :resources_used,
|
|
2452
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed] }
|
|
2453
|
+
|
|
2454
|
+
# @!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)
|
|
2455
|
+
# Some parameter documentations has been truncated, see
|
|
2456
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact}
|
|
2457
|
+
# for more details.
|
|
2458
|
+
#
|
|
2459
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
2460
|
+
#
|
|
2461
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
2462
|
+
#
|
|
2463
|
+
# @param target_user_id [String] Your stable canonical identifier for the other user in a user-to-user interactio
|
|
2464
|
+
#
|
|
2465
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2466
|
+
#
|
|
2467
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2468
|
+
#
|
|
2469
|
+
# @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,
|
|
2470
|
+
#
|
|
2471
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2472
|
+
#
|
|
2473
|
+
# @param idempotency_key [String] Optional caller-provided key used to make retries of this individual event idemp
|
|
2474
|
+
#
|
|
2475
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2476
|
+
#
|
|
2477
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2478
|
+
#
|
|
2479
|
+
# @param type [Symbol, :user_contact]
|
|
2480
|
+
|
|
2481
|
+
# User-authored text content associated with an event.
|
|
2482
|
+
module Content
|
|
2483
|
+
extend SafetyKit::Internal::Type::Union
|
|
2484
|
+
|
|
2485
|
+
# User-authored text content associated with an event.
|
|
2486
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent }
|
|
2487
|
+
|
|
2488
|
+
# User-uploaded image content associated with an event.
|
|
2489
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent }
|
|
2490
|
+
|
|
2491
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2492
|
+
# @!attribute text
|
|
2493
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
2494
|
+
#
|
|
2495
|
+
# @return [String]
|
|
2496
|
+
required :text, String
|
|
2497
|
+
|
|
2498
|
+
# @!attribute type
|
|
2499
|
+
# Text content part.
|
|
2500
|
+
#
|
|
2501
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent::Type]
|
|
2502
|
+
required :type,
|
|
2503
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent::Type }
|
|
2504
|
+
|
|
2505
|
+
# @!attribute key
|
|
2506
|
+
# Stable field key for this content part.
|
|
2507
|
+
#
|
|
2508
|
+
# @return [String, nil]
|
|
2509
|
+
optional :key, String
|
|
2510
|
+
|
|
2511
|
+
# @!method initialize(text:, type:, key: nil)
|
|
2512
|
+
# User-authored text content associated with an event.
|
|
2513
|
+
#
|
|
2514
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2515
|
+
#
|
|
2516
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent::Type] Text content part.
|
|
2517
|
+
#
|
|
2518
|
+
# @param key [String] Stable field key for this content part.
|
|
2519
|
+
|
|
2520
|
+
# Text content part.
|
|
2521
|
+
#
|
|
2522
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent#type
|
|
2523
|
+
module Type
|
|
2524
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2525
|
+
|
|
2526
|
+
TEXT = :text
|
|
2527
|
+
|
|
2528
|
+
# @!method self.values
|
|
2529
|
+
# @return [Array<Symbol>]
|
|
2530
|
+
end
|
|
2531
|
+
end
|
|
2532
|
+
|
|
2533
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
2534
|
+
# @!attribute source
|
|
2535
|
+
# Image source information.
|
|
2536
|
+
#
|
|
2537
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source]
|
|
2538
|
+
required :source,
|
|
2539
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source }
|
|
2540
|
+
|
|
2541
|
+
# @!attribute type
|
|
2542
|
+
# Image content part.
|
|
2543
|
+
#
|
|
2544
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Type]
|
|
2545
|
+
required :type,
|
|
2546
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Type }
|
|
2547
|
+
|
|
2548
|
+
# @!attribute key
|
|
2549
|
+
# Stable field key for this content part.
|
|
2550
|
+
#
|
|
2551
|
+
# @return [String, nil]
|
|
2552
|
+
optional :key, String
|
|
2553
|
+
|
|
2554
|
+
# @!method initialize(source:, type:, key: nil)
|
|
2555
|
+
# User-uploaded image content associated with an event.
|
|
2556
|
+
#
|
|
2557
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source] Image source information.
|
|
2558
|
+
#
|
|
2559
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Type] Image content part.
|
|
2560
|
+
#
|
|
2561
|
+
# @param key [String] Stable field key for this content part.
|
|
2562
|
+
|
|
2563
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent#source
|
|
2564
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2565
|
+
# @!attribute type
|
|
2566
|
+
# URL image source.
|
|
2567
|
+
#
|
|
2568
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source::Type]
|
|
2569
|
+
required :type,
|
|
2570
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source::Type }
|
|
2571
|
+
|
|
2572
|
+
# @!attribute url
|
|
2573
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
2574
|
+
#
|
|
2575
|
+
# @return [String]
|
|
2576
|
+
required :url, String
|
|
2577
|
+
|
|
2578
|
+
# @!method initialize(type:, url:)
|
|
2579
|
+
# Image source information.
|
|
2580
|
+
#
|
|
2581
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source::Type] URL image source.
|
|
2582
|
+
#
|
|
2583
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2584
|
+
|
|
2585
|
+
# URL image source.
|
|
2586
|
+
#
|
|
2587
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent::Source#type
|
|
2588
|
+
module Type
|
|
2589
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2590
|
+
|
|
2591
|
+
URL = :url
|
|
2592
|
+
|
|
2593
|
+
# @!method self.values
|
|
2594
|
+
# @return [Array<Symbol>]
|
|
2595
|
+
end
|
|
2596
|
+
end
|
|
2597
|
+
|
|
2598
|
+
# Image content part.
|
|
2599
|
+
#
|
|
2600
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent#type
|
|
2601
|
+
module Type
|
|
2602
|
+
extend SafetyKit::Internal::Type::Enum
|
|
2603
|
+
|
|
2604
|
+
IMAGE = :image
|
|
2605
|
+
|
|
2606
|
+
# @!method self.values
|
|
2607
|
+
# @return [Array<Symbol>]
|
|
2608
|
+
end
|
|
2609
|
+
end
|
|
2610
|
+
|
|
2611
|
+
# @!method self.variants
|
|
2612
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent)]
|
|
2613
|
+
end
|
|
2614
|
+
|
|
2615
|
+
module Metadata
|
|
2616
|
+
extend SafetyKit::Internal::Type::Union
|
|
2617
|
+
|
|
2618
|
+
variant String
|
|
2619
|
+
|
|
2620
|
+
variant Float
|
|
2621
|
+
|
|
2622
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2623
|
+
|
|
2624
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Metadata::UnionMember3Array }
|
|
2625
|
+
|
|
2626
|
+
module UnionMember3
|
|
2627
|
+
extend SafetyKit::Internal::Type::Union
|
|
2628
|
+
|
|
2629
|
+
variant String
|
|
2630
|
+
|
|
2631
|
+
variant Float
|
|
2632
|
+
|
|
2633
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
2634
|
+
|
|
2635
|
+
# @!method self.variants
|
|
2636
|
+
# @return [Array(String, Float, Boolean)]
|
|
2637
|
+
end
|
|
2638
|
+
|
|
2639
|
+
# @!method self.variants
|
|
2640
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
2641
|
+
|
|
2642
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
2643
|
+
UnionMember3Array =
|
|
2644
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
2645
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Metadata::UnionMember3
|
|
2646
|
+
}]
|
|
2647
|
+
end
|
|
2648
|
+
|
|
2649
|
+
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
2650
|
+
# @!attribute type
|
|
2651
|
+
# Resource family, such as email, phone, name, address, url, instagram, tiktok,
|
|
2652
|
+
# youtube, linkedin, or another stable snake_case identifier.
|
|
2653
|
+
#
|
|
2654
|
+
# @return [String]
|
|
2655
|
+
required :type, String
|
|
2656
|
+
|
|
2657
|
+
# @!attribute value
|
|
2658
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2659
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
2660
|
+
#
|
|
2661
|
+
# @return [String]
|
|
2662
|
+
required :value, String
|
|
2663
|
+
|
|
2664
|
+
# @!method initialize(type:, value:)
|
|
2665
|
+
# Some parameter documentations has been truncated, see
|
|
2666
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::ResourcesUsed}
|
|
2667
|
+
# for more details.
|
|
2668
|
+
#
|
|
2669
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
2670
|
+
# number, address, URL, social handle, or payment identifier.
|
|
2671
|
+
#
|
|
2672
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, instagram, tiktok, yo
|
|
2673
|
+
#
|
|
2674
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
2675
|
+
end
|
|
2676
|
+
end
|
|
2677
|
+
|
|
2678
|
+
class ContentUploaded < SafetyKit::Internal::Type::BaseModel
|
|
2679
|
+
# @!attribute content
|
|
2680
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2681
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2682
|
+
# analyze.
|
|
2683
|
+
#
|
|
2684
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent>]
|
|
2685
|
+
required :content,
|
|
2686
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content] }
|
|
1965
2687
|
|
|
1966
|
-
# @!attribute
|
|
1967
|
-
#
|
|
1968
|
-
#
|
|
2688
|
+
# @!attribute event_name
|
|
2689
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
2690
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
1969
2691
|
#
|
|
1970
2692
|
# @return [String]
|
|
1971
|
-
required :
|
|
2693
|
+
required :event_name, String
|
|
1972
2694
|
|
|
1973
2695
|
# @!attribute timestamp
|
|
1974
2696
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
@@ -1978,8 +2700,8 @@ module SafetyKit
|
|
|
1978
2700
|
|
|
1979
2701
|
# @!attribute type
|
|
1980
2702
|
#
|
|
1981
|
-
# @return [Symbol, :
|
|
1982
|
-
required :type, const: :
|
|
2703
|
+
# @return [Symbol, :content_uploaded]
|
|
2704
|
+
required :type, const: :content_uploaded
|
|
1983
2705
|
|
|
1984
2706
|
# @!attribute user_id
|
|
1985
2707
|
# Your stable canonical identifier for the user or account.
|
|
@@ -1987,15 +2709,6 @@ module SafetyKit
|
|
|
1987
2709
|
# @return [String]
|
|
1988
2710
|
required :user_id, String
|
|
1989
2711
|
|
|
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
2712
|
# @!attribute content_id
|
|
2000
2713
|
# Your stable identifier for the content involved in this event, such as a
|
|
2001
2714
|
# message, listing, page, post, profile, or uploaded media item.
|
|
@@ -2016,53 +2729,51 @@ module SafetyKit
|
|
|
2016
2729
|
#
|
|
2017
2730
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2018
2731
|
optional :metadata,
|
|
2019
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2732
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Metadata] }
|
|
2020
2733
|
|
|
2021
2734
|
# @!attribute resources_used
|
|
2022
2735
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2023
2736
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2024
2737
|
# identifiers.
|
|
2025
2738
|
#
|
|
2026
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2739
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed>, nil]
|
|
2027
2740
|
optional :resources_used,
|
|
2028
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
2741
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed] }
|
|
2029
2742
|
|
|
2030
|
-
# @!method initialize(
|
|
2743
|
+
# @!method initialize(content:, event_name:, timestamp:, user_id:, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :content_uploaded)
|
|
2031
2744
|
# Some parameter documentations has been truncated, see
|
|
2032
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2745
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded}
|
|
2033
2746
|
# for more details.
|
|
2034
2747
|
#
|
|
2035
|
-
# A user
|
|
2748
|
+
# A user posts, uploads, publishes, edits, or replaces content.
|
|
2036
2749
|
#
|
|
2037
|
-
# @param
|
|
2750
|
+
# @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
2751
|
#
|
|
2039
|
-
# @param
|
|
2752
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
2040
2753
|
#
|
|
2041
2754
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2042
2755
|
#
|
|
2043
2756
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2044
2757
|
#
|
|
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
2758
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2048
2759
|
#
|
|
2049
2760
|
# @param idempotency_key [String] Optional caller-provided key used to make retries of this individual event idemp
|
|
2050
2761
|
#
|
|
2051
2762
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2052
2763
|
#
|
|
2053
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2764
|
+
# @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
2765
|
#
|
|
2055
|
-
# @param type [Symbol, :
|
|
2766
|
+
# @param type [Symbol, :content_uploaded]
|
|
2056
2767
|
|
|
2057
2768
|
# User-authored text content associated with an event.
|
|
2058
2769
|
module Content
|
|
2059
2770
|
extend SafetyKit::Internal::Type::Union
|
|
2060
2771
|
|
|
2061
2772
|
# User-authored text content associated with an event.
|
|
2062
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2773
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent }
|
|
2063
2774
|
|
|
2064
2775
|
# User-uploaded image content associated with an event.
|
|
2065
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2776
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent }
|
|
2066
2777
|
|
|
2067
2778
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2068
2779
|
# @!attribute text
|
|
@@ -2074,9 +2785,9 @@ module SafetyKit
|
|
|
2074
2785
|
# @!attribute type
|
|
2075
2786
|
# Text content part.
|
|
2076
2787
|
#
|
|
2077
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2788
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent::Type]
|
|
2078
2789
|
required :type,
|
|
2079
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2790
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent::Type }
|
|
2080
2791
|
|
|
2081
2792
|
# @!attribute key
|
|
2082
2793
|
# Stable field key for this content part.
|
|
@@ -2089,13 +2800,13 @@ module SafetyKit
|
|
|
2089
2800
|
#
|
|
2090
2801
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2091
2802
|
#
|
|
2092
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2803
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent::Type] Text content part.
|
|
2093
2804
|
#
|
|
2094
2805
|
# @param key [String] Stable field key for this content part.
|
|
2095
2806
|
|
|
2096
2807
|
# Text content part.
|
|
2097
2808
|
#
|
|
2098
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2809
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent#type
|
|
2099
2810
|
module Type
|
|
2100
2811
|
extend SafetyKit::Internal::Type::Enum
|
|
2101
2812
|
|
|
@@ -2110,16 +2821,16 @@ module SafetyKit
|
|
|
2110
2821
|
# @!attribute source
|
|
2111
2822
|
# Image source information.
|
|
2112
2823
|
#
|
|
2113
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2824
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source]
|
|
2114
2825
|
required :source,
|
|
2115
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2826
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source }
|
|
2116
2827
|
|
|
2117
2828
|
# @!attribute type
|
|
2118
2829
|
# Image content part.
|
|
2119
2830
|
#
|
|
2120
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2831
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Type]
|
|
2121
2832
|
required :type,
|
|
2122
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2833
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Type }
|
|
2123
2834
|
|
|
2124
2835
|
# @!attribute key
|
|
2125
2836
|
# Stable field key for this content part.
|
|
@@ -2130,20 +2841,20 @@ module SafetyKit
|
|
|
2130
2841
|
# @!method initialize(source:, type:, key: nil)
|
|
2131
2842
|
# User-uploaded image content associated with an event.
|
|
2132
2843
|
#
|
|
2133
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2844
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source] Image source information.
|
|
2134
2845
|
#
|
|
2135
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2846
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Type] Image content part.
|
|
2136
2847
|
#
|
|
2137
2848
|
# @param key [String] Stable field key for this content part.
|
|
2138
2849
|
|
|
2139
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2850
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent#source
|
|
2140
2851
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2141
2852
|
# @!attribute type
|
|
2142
2853
|
# URL image source.
|
|
2143
2854
|
#
|
|
2144
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2855
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source::Type]
|
|
2145
2856
|
required :type,
|
|
2146
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2857
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source::Type }
|
|
2147
2858
|
|
|
2148
2859
|
# @!attribute url
|
|
2149
2860
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -2154,13 +2865,13 @@ module SafetyKit
|
|
|
2154
2865
|
# @!method initialize(type:, url:)
|
|
2155
2866
|
# Image source information.
|
|
2156
2867
|
#
|
|
2157
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2868
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source::Type] URL image source.
|
|
2158
2869
|
#
|
|
2159
2870
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2160
2871
|
|
|
2161
2872
|
# URL image source.
|
|
2162
2873
|
#
|
|
2163
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2874
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent::Source#type
|
|
2164
2875
|
module Type
|
|
2165
2876
|
extend SafetyKit::Internal::Type::Enum
|
|
2166
2877
|
|
|
@@ -2173,7 +2884,7 @@ module SafetyKit
|
|
|
2173
2884
|
|
|
2174
2885
|
# Image content part.
|
|
2175
2886
|
#
|
|
2176
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2887
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent#type
|
|
2177
2888
|
module Type
|
|
2178
2889
|
extend SafetyKit::Internal::Type::Enum
|
|
2179
2890
|
|
|
@@ -2185,7 +2896,7 @@ module SafetyKit
|
|
|
2185
2896
|
end
|
|
2186
2897
|
|
|
2187
2898
|
# @!method self.variants
|
|
2188
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2899
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Content::EventImageContent)]
|
|
2189
2900
|
end
|
|
2190
2901
|
|
|
2191
2902
|
module Metadata
|
|
@@ -2197,7 +2908,7 @@ module SafetyKit
|
|
|
2197
2908
|
|
|
2198
2909
|
variant SafetyKit::Internal::Type::Boolean
|
|
2199
2910
|
|
|
2200
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2911
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Metadata::UnionMember3Array }
|
|
2201
2912
|
|
|
2202
2913
|
module UnionMember3
|
|
2203
2914
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2217,9 +2928,9 @@ module SafetyKit
|
|
|
2217
2928
|
|
|
2218
2929
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2219
2930
|
UnionMember3Array =
|
|
2220
|
-
SafetyKit::Internal::Type::ArrayOf[
|
|
2221
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
2222
|
-
|
|
2931
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
2932
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::Metadata::UnionMember3 }
|
|
2933
|
+
]
|
|
2223
2934
|
end
|
|
2224
2935
|
|
|
2225
2936
|
class ResourcesUsed < SafetyKit::Internal::Type::BaseModel
|
|
@@ -2239,7 +2950,7 @@ module SafetyKit
|
|
|
2239
2950
|
|
|
2240
2951
|
# @!method initialize(type:, value:)
|
|
2241
2952
|
# Some parameter documentations has been truncated, see
|
|
2242
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2953
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded::ResourcesUsed}
|
|
2243
2954
|
# for more details.
|
|
2244
2955
|
#
|
|
2245
2956
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2251,22 +2962,28 @@ module SafetyKit
|
|
|
2251
2962
|
end
|
|
2252
2963
|
end
|
|
2253
2964
|
|
|
2254
|
-
class
|
|
2965
|
+
class ProductChanged < SafetyKit::Internal::Type::BaseModel
|
|
2255
2966
|
# @!attribute content
|
|
2256
2967
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2257
2968
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2258
2969
|
# analyze.
|
|
2259
2970
|
#
|
|
2260
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2971
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent>]
|
|
2261
2972
|
required :content,
|
|
2262
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2973
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content] }
|
|
2263
2974
|
|
|
2264
2975
|
# @!attribute event_name
|
|
2265
|
-
#
|
|
2266
|
-
# values in typed fields, content, resources_used, or metadata.
|
|
2976
|
+
# Product action that triggered this event.
|
|
2267
2977
|
#
|
|
2268
|
-
# @return [
|
|
2269
|
-
required :event_name,
|
|
2978
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::EventName]
|
|
2979
|
+
required :event_name,
|
|
2980
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::EventName }
|
|
2981
|
+
|
|
2982
|
+
# @!attribute product
|
|
2983
|
+
# Commerce details for the product involved in this event.
|
|
2984
|
+
#
|
|
2985
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product]
|
|
2986
|
+
required :product, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product }
|
|
2270
2987
|
|
|
2271
2988
|
# @!attribute timestamp
|
|
2272
2989
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
@@ -2276,8 +2993,8 @@ module SafetyKit
|
|
|
2276
2993
|
|
|
2277
2994
|
# @!attribute type
|
|
2278
2995
|
#
|
|
2279
|
-
# @return [Symbol, :
|
|
2280
|
-
required :type, const: :
|
|
2996
|
+
# @return [Symbol, :product_changed]
|
|
2997
|
+
required :type, const: :product_changed
|
|
2281
2998
|
|
|
2282
2999
|
# @!attribute user_id
|
|
2283
3000
|
# Your stable canonical identifier for the user or account.
|
|
@@ -2305,27 +3022,29 @@ module SafetyKit
|
|
|
2305
3022
|
#
|
|
2306
3023
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2307
3024
|
optional :metadata,
|
|
2308
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3025
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Metadata] }
|
|
2309
3026
|
|
|
2310
3027
|
# @!attribute resources_used
|
|
2311
3028
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2312
3029
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2313
3030
|
# identifiers.
|
|
2314
3031
|
#
|
|
2315
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3032
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed>, nil]
|
|
2316
3033
|
optional :resources_used,
|
|
2317
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
3034
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed] }
|
|
2318
3035
|
|
|
2319
|
-
# @!method initialize(content:, event_name:, timestamp:, user_id:, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :
|
|
3036
|
+
# @!method initialize(content:, event_name:, product:, timestamp:, user_id:, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :product_changed)
|
|
2320
3037
|
# Some parameter documentations has been truncated, see
|
|
2321
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3038
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged}
|
|
2322
3039
|
# for more details.
|
|
2323
3040
|
#
|
|
2324
|
-
# A
|
|
3041
|
+
# A product listing is created, updated, or has a discount added.
|
|
2325
3042
|
#
|
|
2326
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3043
|
+
# @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
3044
|
#
|
|
2328
|
-
# @param event_name [
|
|
3045
|
+
# @param event_name [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::EventName] Product action that triggered this event.
|
|
3046
|
+
#
|
|
3047
|
+
# @param product [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product] Commerce details for the product involved in this event.
|
|
2329
3048
|
#
|
|
2330
3049
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2331
3050
|
#
|
|
@@ -2337,19 +3056,19 @@ module SafetyKit
|
|
|
2337
3056
|
#
|
|
2338
3057
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2339
3058
|
#
|
|
2340
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3059
|
+
# @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
3060
|
#
|
|
2342
|
-
# @param type [Symbol, :
|
|
3061
|
+
# @param type [Symbol, :product_changed]
|
|
2343
3062
|
|
|
2344
3063
|
# User-authored text content associated with an event.
|
|
2345
3064
|
module Content
|
|
2346
3065
|
extend SafetyKit::Internal::Type::Union
|
|
2347
3066
|
|
|
2348
3067
|
# User-authored text content associated with an event.
|
|
2349
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3068
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent }
|
|
2350
3069
|
|
|
2351
3070
|
# User-uploaded image content associated with an event.
|
|
2352
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3071
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent }
|
|
2353
3072
|
|
|
2354
3073
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2355
3074
|
# @!attribute text
|
|
@@ -2361,9 +3080,9 @@ module SafetyKit
|
|
|
2361
3080
|
# @!attribute type
|
|
2362
3081
|
# Text content part.
|
|
2363
3082
|
#
|
|
2364
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3083
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent::Type]
|
|
2365
3084
|
required :type,
|
|
2366
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3085
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent::Type }
|
|
2367
3086
|
|
|
2368
3087
|
# @!attribute key
|
|
2369
3088
|
# Stable field key for this content part.
|
|
@@ -2376,13 +3095,13 @@ module SafetyKit
|
|
|
2376
3095
|
#
|
|
2377
3096
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2378
3097
|
#
|
|
2379
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3098
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent::Type] Text content part.
|
|
2380
3099
|
#
|
|
2381
3100
|
# @param key [String] Stable field key for this content part.
|
|
2382
3101
|
|
|
2383
3102
|
# Text content part.
|
|
2384
3103
|
#
|
|
2385
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3104
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent#type
|
|
2386
3105
|
module Type
|
|
2387
3106
|
extend SafetyKit::Internal::Type::Enum
|
|
2388
3107
|
|
|
@@ -2397,16 +3116,16 @@ module SafetyKit
|
|
|
2397
3116
|
# @!attribute source
|
|
2398
3117
|
# Image source information.
|
|
2399
3118
|
#
|
|
2400
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3119
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source]
|
|
2401
3120
|
required :source,
|
|
2402
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3121
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source }
|
|
2403
3122
|
|
|
2404
3123
|
# @!attribute type
|
|
2405
3124
|
# Image content part.
|
|
2406
3125
|
#
|
|
2407
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3126
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Type]
|
|
2408
3127
|
required :type,
|
|
2409
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3128
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Type }
|
|
2410
3129
|
|
|
2411
3130
|
# @!attribute key
|
|
2412
3131
|
# Stable field key for this content part.
|
|
@@ -2417,20 +3136,20 @@ module SafetyKit
|
|
|
2417
3136
|
# @!method initialize(source:, type:, key: nil)
|
|
2418
3137
|
# User-uploaded image content associated with an event.
|
|
2419
3138
|
#
|
|
2420
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3139
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source] Image source information.
|
|
2421
3140
|
#
|
|
2422
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3141
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Type] Image content part.
|
|
2423
3142
|
#
|
|
2424
3143
|
# @param key [String] Stable field key for this content part.
|
|
2425
3144
|
|
|
2426
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3145
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent#source
|
|
2427
3146
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2428
3147
|
# @!attribute type
|
|
2429
3148
|
# URL image source.
|
|
2430
3149
|
#
|
|
2431
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3150
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source::Type]
|
|
2432
3151
|
required :type,
|
|
2433
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3152
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source::Type }
|
|
2434
3153
|
|
|
2435
3154
|
# @!attribute url
|
|
2436
3155
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -2441,13 +3160,13 @@ module SafetyKit
|
|
|
2441
3160
|
# @!method initialize(type:, url:)
|
|
2442
3161
|
# Image source information.
|
|
2443
3162
|
#
|
|
2444
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3163
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source::Type] URL image source.
|
|
2445
3164
|
#
|
|
2446
3165
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2447
3166
|
|
|
2448
3167
|
# URL image source.
|
|
2449
3168
|
#
|
|
2450
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3169
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent::Source#type
|
|
2451
3170
|
module Type
|
|
2452
3171
|
extend SafetyKit::Internal::Type::Enum
|
|
2453
3172
|
|
|
@@ -2460,7 +3179,7 @@ module SafetyKit
|
|
|
2460
3179
|
|
|
2461
3180
|
# Image content part.
|
|
2462
3181
|
#
|
|
2463
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3182
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent#type
|
|
2464
3183
|
module Type
|
|
2465
3184
|
extend SafetyKit::Internal::Type::Enum
|
|
2466
3185
|
|
|
@@ -2472,7 +3191,120 @@ module SafetyKit
|
|
|
2472
3191
|
end
|
|
2473
3192
|
|
|
2474
3193
|
# @!method self.variants
|
|
2475
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3194
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent)]
|
|
3195
|
+
end
|
|
3196
|
+
|
|
3197
|
+
# Product action that triggered this event.
|
|
3198
|
+
#
|
|
3199
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged#event_name
|
|
3200
|
+
module EventName
|
|
3201
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3202
|
+
|
|
3203
|
+
PRODUCT_CREATED = :product_created
|
|
3204
|
+
PRODUCT_UPDATED = :product_updated
|
|
3205
|
+
DISCOUNT_ADDED = :discount_added
|
|
3206
|
+
|
|
3207
|
+
# @!method self.values
|
|
3208
|
+
# @return [Array<Symbol>]
|
|
3209
|
+
end
|
|
3210
|
+
|
|
3211
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged#product
|
|
3212
|
+
class Product < SafetyKit::Internal::Type::BaseModel
|
|
3213
|
+
# @!attribute price
|
|
3214
|
+
# Current listed price of the product.
|
|
3215
|
+
#
|
|
3216
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::Price]
|
|
3217
|
+
required :price,
|
|
3218
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::Price }
|
|
3219
|
+
|
|
3220
|
+
# @!attribute discounted_price
|
|
3221
|
+
# Discounted price of the product, when a discount applies.
|
|
3222
|
+
#
|
|
3223
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::DiscountedPrice, nil]
|
|
3224
|
+
optional :discounted_price,
|
|
3225
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::DiscountedPrice }
|
|
3226
|
+
|
|
3227
|
+
# @!attribute shipping_info
|
|
3228
|
+
# Shipping details for the product.
|
|
3229
|
+
#
|
|
3230
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::ShippingInfo, nil]
|
|
3231
|
+
optional :shipping_info,
|
|
3232
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::ShippingInfo }
|
|
3233
|
+
|
|
3234
|
+
# @!method initialize(price:, discounted_price: nil, shipping_info: nil)
|
|
3235
|
+
# Commerce details for the product involved in this event.
|
|
3236
|
+
#
|
|
3237
|
+
# @param price [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::Price] Current listed price of the product.
|
|
3238
|
+
#
|
|
3239
|
+
# @param discounted_price [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::DiscountedPrice] Discounted price of the product, when a discount applies.
|
|
3240
|
+
#
|
|
3241
|
+
# @param shipping_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::ShippingInfo] Shipping details for the product.
|
|
3242
|
+
|
|
3243
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product#price
|
|
3244
|
+
class Price < 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
|
+
# Current listed price of the product.
|
|
3259
|
+
#
|
|
3260
|
+
# @param amount [String] Price amount as a decimal string.
|
|
3261
|
+
#
|
|
3262
|
+
# @param currency [String] ISO 4217 currency code.
|
|
3263
|
+
end
|
|
3264
|
+
|
|
3265
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product#discounted_price
|
|
3266
|
+
class DiscountedPrice < SafetyKit::Internal::Type::BaseModel
|
|
3267
|
+
# @!attribute amount
|
|
3268
|
+
# Price amount as a decimal string.
|
|
3269
|
+
#
|
|
3270
|
+
# @return [String]
|
|
3271
|
+
required :amount, String
|
|
3272
|
+
|
|
3273
|
+
# @!attribute currency
|
|
3274
|
+
# ISO 4217 currency code.
|
|
3275
|
+
#
|
|
3276
|
+
# @return [String]
|
|
3277
|
+
required :currency, String
|
|
3278
|
+
|
|
3279
|
+
# @!method initialize(amount:, currency:)
|
|
3280
|
+
# Discounted price of the product, when a discount applies.
|
|
3281
|
+
#
|
|
3282
|
+
# @param amount [String] Price amount as a decimal string.
|
|
3283
|
+
#
|
|
3284
|
+
# @param currency [String] ISO 4217 currency code.
|
|
3285
|
+
end
|
|
3286
|
+
|
|
3287
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product#shipping_info
|
|
3288
|
+
class ShippingInfo < SafetyKit::Internal::Type::BaseModel
|
|
3289
|
+
# @!attribute ships_from
|
|
3290
|
+
# Location the product ships from.
|
|
3291
|
+
#
|
|
3292
|
+
# @return [String]
|
|
3293
|
+
required :ships_from, String
|
|
3294
|
+
|
|
3295
|
+
# @!attribute ships_to
|
|
3296
|
+
# Locations the product ships to.
|
|
3297
|
+
#
|
|
3298
|
+
# @return [Array<String>]
|
|
3299
|
+
required :ships_to, SafetyKit::Internal::Type::ArrayOf[String]
|
|
3300
|
+
|
|
3301
|
+
# @!method initialize(ships_from:, ships_to:)
|
|
3302
|
+
# Shipping details for the product.
|
|
3303
|
+
#
|
|
3304
|
+
# @param ships_from [String] Location the product ships from.
|
|
3305
|
+
#
|
|
3306
|
+
# @param ships_to [Array<String>] Locations the product ships to.
|
|
3307
|
+
end
|
|
2476
3308
|
end
|
|
2477
3309
|
|
|
2478
3310
|
module Metadata
|
|
@@ -2484,7 +3316,7 @@ module SafetyKit
|
|
|
2484
3316
|
|
|
2485
3317
|
variant SafetyKit::Internal::Type::Boolean
|
|
2486
3318
|
|
|
2487
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3319
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Metadata::UnionMember3Array }
|
|
2488
3320
|
|
|
2489
3321
|
module UnionMember3
|
|
2490
3322
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2505,7 +3337,7 @@ module SafetyKit
|
|
|
2505
3337
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2506
3338
|
UnionMember3Array =
|
|
2507
3339
|
SafetyKit::Internal::Type::ArrayOf[
|
|
2508
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3340
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Metadata::UnionMember3 }
|
|
2509
3341
|
]
|
|
2510
3342
|
end
|
|
2511
3343
|
|
|
@@ -2526,7 +3358,7 @@ module SafetyKit
|
|
|
2526
3358
|
|
|
2527
3359
|
# @!method initialize(type:, value:)
|
|
2528
3360
|
# Some parameter documentations has been truncated, see
|
|
2529
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3361
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::ResourcesUsed}
|
|
2530
3362
|
# for more details.
|
|
2531
3363
|
#
|
|
2532
3364
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2568,9 +3400,9 @@ module SafetyKit
|
|
|
2568
3400
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2569
3401
|
# analyze.
|
|
2570
3402
|
#
|
|
2571
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3403
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent>, nil]
|
|
2572
3404
|
optional :content,
|
|
2573
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3405
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content] }
|
|
2574
3406
|
|
|
2575
3407
|
# @!attribute content_id
|
|
2576
3408
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -2592,20 +3424,20 @@ module SafetyKit
|
|
|
2592
3424
|
#
|
|
2593
3425
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2594
3426
|
optional :metadata,
|
|
2595
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3427
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Metadata] }
|
|
2596
3428
|
|
|
2597
3429
|
# @!attribute resources_used
|
|
2598
3430
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2599
3431
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2600
3432
|
# identifiers.
|
|
2601
3433
|
#
|
|
2602
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3434
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed>, nil]
|
|
2603
3435
|
optional :resources_used,
|
|
2604
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
3436
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed] }
|
|
2605
3437
|
|
|
2606
3438
|
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :create_account)
|
|
2607
3439
|
# Some parameter documentations has been truncated, see
|
|
2608
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3440
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount}
|
|
2609
3441
|
# for more details.
|
|
2610
3442
|
#
|
|
2611
3443
|
# A user or account is created.
|
|
@@ -2616,7 +3448,7 @@ module SafetyKit
|
|
|
2616
3448
|
#
|
|
2617
3449
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2618
3450
|
#
|
|
2619
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3451
|
+
# @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
3452
|
#
|
|
2621
3453
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2622
3454
|
#
|
|
@@ -2624,7 +3456,7 @@ module SafetyKit
|
|
|
2624
3456
|
#
|
|
2625
3457
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2626
3458
|
#
|
|
2627
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3459
|
+
# @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
3460
|
#
|
|
2629
3461
|
# @param type [Symbol, :create_account]
|
|
2630
3462
|
|
|
@@ -2633,10 +3465,10 @@ module SafetyKit
|
|
|
2633
3465
|
extend SafetyKit::Internal::Type::Union
|
|
2634
3466
|
|
|
2635
3467
|
# User-authored text content associated with an event.
|
|
2636
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3468
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent }
|
|
2637
3469
|
|
|
2638
3470
|
# User-uploaded image content associated with an event.
|
|
2639
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3471
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent }
|
|
2640
3472
|
|
|
2641
3473
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2642
3474
|
# @!attribute text
|
|
@@ -2648,9 +3480,9 @@ module SafetyKit
|
|
|
2648
3480
|
# @!attribute type
|
|
2649
3481
|
# Text content part.
|
|
2650
3482
|
#
|
|
2651
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3483
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent::Type]
|
|
2652
3484
|
required :type,
|
|
2653
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3485
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent::Type }
|
|
2654
3486
|
|
|
2655
3487
|
# @!attribute key
|
|
2656
3488
|
# Stable field key for this content part.
|
|
@@ -2663,13 +3495,13 @@ module SafetyKit
|
|
|
2663
3495
|
#
|
|
2664
3496
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2665
3497
|
#
|
|
2666
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3498
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent::Type] Text content part.
|
|
2667
3499
|
#
|
|
2668
3500
|
# @param key [String] Stable field key for this content part.
|
|
2669
3501
|
|
|
2670
3502
|
# Text content part.
|
|
2671
3503
|
#
|
|
2672
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3504
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent#type
|
|
2673
3505
|
module Type
|
|
2674
3506
|
extend SafetyKit::Internal::Type::Enum
|
|
2675
3507
|
|
|
@@ -2684,16 +3516,16 @@ module SafetyKit
|
|
|
2684
3516
|
# @!attribute source
|
|
2685
3517
|
# Image source information.
|
|
2686
3518
|
#
|
|
2687
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3519
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source]
|
|
2688
3520
|
required :source,
|
|
2689
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3521
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source }
|
|
2690
3522
|
|
|
2691
3523
|
# @!attribute type
|
|
2692
3524
|
# Image content part.
|
|
2693
3525
|
#
|
|
2694
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3526
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Type]
|
|
2695
3527
|
required :type,
|
|
2696
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3528
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Type }
|
|
2697
3529
|
|
|
2698
3530
|
# @!attribute key
|
|
2699
3531
|
# Stable field key for this content part.
|
|
@@ -2704,20 +3536,20 @@ module SafetyKit
|
|
|
2704
3536
|
# @!method initialize(source:, type:, key: nil)
|
|
2705
3537
|
# User-uploaded image content associated with an event.
|
|
2706
3538
|
#
|
|
2707
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3539
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source] Image source information.
|
|
2708
3540
|
#
|
|
2709
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3541
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Type] Image content part.
|
|
2710
3542
|
#
|
|
2711
3543
|
# @param key [String] Stable field key for this content part.
|
|
2712
3544
|
|
|
2713
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3545
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent#source
|
|
2714
3546
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2715
3547
|
# @!attribute type
|
|
2716
3548
|
# URL image source.
|
|
2717
3549
|
#
|
|
2718
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3550
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source::Type]
|
|
2719
3551
|
required :type,
|
|
2720
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3552
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source::Type }
|
|
2721
3553
|
|
|
2722
3554
|
# @!attribute url
|
|
2723
3555
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -2728,13 +3560,13 @@ module SafetyKit
|
|
|
2728
3560
|
# @!method initialize(type:, url:)
|
|
2729
3561
|
# Image source information.
|
|
2730
3562
|
#
|
|
2731
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3563
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
2732
3564
|
#
|
|
2733
3565
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2734
3566
|
|
|
2735
3567
|
# URL image source.
|
|
2736
3568
|
#
|
|
2737
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3569
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent::Source#type
|
|
2738
3570
|
module Type
|
|
2739
3571
|
extend SafetyKit::Internal::Type::Enum
|
|
2740
3572
|
|
|
@@ -2747,7 +3579,7 @@ module SafetyKit
|
|
|
2747
3579
|
|
|
2748
3580
|
# Image content part.
|
|
2749
3581
|
#
|
|
2750
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3582
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent#type
|
|
2751
3583
|
module Type
|
|
2752
3584
|
extend SafetyKit::Internal::Type::Enum
|
|
2753
3585
|
|
|
@@ -2759,7 +3591,7 @@ module SafetyKit
|
|
|
2759
3591
|
end
|
|
2760
3592
|
|
|
2761
3593
|
# @!method self.variants
|
|
2762
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3594
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Content::EventImageContent)]
|
|
2763
3595
|
end
|
|
2764
3596
|
|
|
2765
3597
|
module Metadata
|
|
@@ -2771,7 +3603,7 @@ module SafetyKit
|
|
|
2771
3603
|
|
|
2772
3604
|
variant SafetyKit::Internal::Type::Boolean
|
|
2773
3605
|
|
|
2774
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3606
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Metadata::UnionMember3Array }
|
|
2775
3607
|
|
|
2776
3608
|
module UnionMember3
|
|
2777
3609
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2792,7 +3624,7 @@ module SafetyKit
|
|
|
2792
3624
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2793
3625
|
UnionMember3Array =
|
|
2794
3626
|
SafetyKit::Internal::Type::ArrayOf[
|
|
2795
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3627
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::Metadata::UnionMember3 }
|
|
2796
3628
|
]
|
|
2797
3629
|
end
|
|
2798
3630
|
|
|
@@ -2813,7 +3645,7 @@ module SafetyKit
|
|
|
2813
3645
|
|
|
2814
3646
|
# @!method initialize(type:, value:)
|
|
2815
3647
|
# Some parameter documentations has been truncated, see
|
|
2816
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3648
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount::ResourcesUsed}
|
|
2817
3649
|
# for more details.
|
|
2818
3650
|
#
|
|
2819
3651
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2855,9 +3687,9 @@ module SafetyKit
|
|
|
2855
3687
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2856
3688
|
# analyze.
|
|
2857
3689
|
#
|
|
2858
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3690
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent>, nil]
|
|
2859
3691
|
optional :content,
|
|
2860
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3692
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content] }
|
|
2861
3693
|
|
|
2862
3694
|
# @!attribute content_id
|
|
2863
3695
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -2879,20 +3711,20 @@ module SafetyKit
|
|
|
2879
3711
|
#
|
|
2880
3712
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2881
3713
|
optional :metadata,
|
|
2882
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3714
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Metadata] }
|
|
2883
3715
|
|
|
2884
3716
|
# @!attribute resources_used
|
|
2885
3717
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2886
3718
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
2887
3719
|
# identifiers.
|
|
2888
3720
|
#
|
|
2889
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3721
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed>, nil]
|
|
2890
3722
|
optional :resources_used,
|
|
2891
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
3723
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed] }
|
|
2892
3724
|
|
|
2893
3725
|
# @!method initialize(event_name:, timestamp:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :update_account)
|
|
2894
3726
|
# Some parameter documentations has been truncated, see
|
|
2895
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3727
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount}
|
|
2896
3728
|
# for more details.
|
|
2897
3729
|
#
|
|
2898
3730
|
# A user or account profile, contact detail, payment detail, or public bio
|
|
@@ -2904,7 +3736,7 @@ module SafetyKit
|
|
|
2904
3736
|
#
|
|
2905
3737
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2906
3738
|
#
|
|
2907
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3739
|
+
# @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
3740
|
#
|
|
2909
3741
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2910
3742
|
#
|
|
@@ -2912,7 +3744,7 @@ module SafetyKit
|
|
|
2912
3744
|
#
|
|
2913
3745
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2914
3746
|
#
|
|
2915
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3747
|
+
# @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
3748
|
#
|
|
2917
3749
|
# @param type [Symbol, :update_account]
|
|
2918
3750
|
|
|
@@ -2921,10 +3753,10 @@ module SafetyKit
|
|
|
2921
3753
|
extend SafetyKit::Internal::Type::Union
|
|
2922
3754
|
|
|
2923
3755
|
# User-authored text content associated with an event.
|
|
2924
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3756
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent }
|
|
2925
3757
|
|
|
2926
3758
|
# User-uploaded image content associated with an event.
|
|
2927
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3759
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent }
|
|
2928
3760
|
|
|
2929
3761
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2930
3762
|
# @!attribute text
|
|
@@ -2936,9 +3768,9 @@ module SafetyKit
|
|
|
2936
3768
|
# @!attribute type
|
|
2937
3769
|
# Text content part.
|
|
2938
3770
|
#
|
|
2939
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3771
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent::Type]
|
|
2940
3772
|
required :type,
|
|
2941
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3773
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent::Type }
|
|
2942
3774
|
|
|
2943
3775
|
# @!attribute key
|
|
2944
3776
|
# Stable field key for this content part.
|
|
@@ -2951,13 +3783,13 @@ module SafetyKit
|
|
|
2951
3783
|
#
|
|
2952
3784
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2953
3785
|
#
|
|
2954
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3786
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent::Type] Text content part.
|
|
2955
3787
|
#
|
|
2956
3788
|
# @param key [String] Stable field key for this content part.
|
|
2957
3789
|
|
|
2958
3790
|
# Text content part.
|
|
2959
3791
|
#
|
|
2960
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3792
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent#type
|
|
2961
3793
|
module Type
|
|
2962
3794
|
extend SafetyKit::Internal::Type::Enum
|
|
2963
3795
|
|
|
@@ -2972,16 +3804,16 @@ module SafetyKit
|
|
|
2972
3804
|
# @!attribute source
|
|
2973
3805
|
# Image source information.
|
|
2974
3806
|
#
|
|
2975
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3807
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source]
|
|
2976
3808
|
required :source,
|
|
2977
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3809
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source }
|
|
2978
3810
|
|
|
2979
3811
|
# @!attribute type
|
|
2980
3812
|
# Image content part.
|
|
2981
3813
|
#
|
|
2982
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3814
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Type]
|
|
2983
3815
|
required :type,
|
|
2984
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3816
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Type }
|
|
2985
3817
|
|
|
2986
3818
|
# @!attribute key
|
|
2987
3819
|
# Stable field key for this content part.
|
|
@@ -2992,20 +3824,20 @@ module SafetyKit
|
|
|
2992
3824
|
# @!method initialize(source:, type:, key: nil)
|
|
2993
3825
|
# User-uploaded image content associated with an event.
|
|
2994
3826
|
#
|
|
2995
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3827
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source] Image source information.
|
|
2996
3828
|
#
|
|
2997
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3829
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Type] Image content part.
|
|
2998
3830
|
#
|
|
2999
3831
|
# @param key [String] Stable field key for this content part.
|
|
3000
3832
|
|
|
3001
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3833
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent#source
|
|
3002
3834
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3003
3835
|
# @!attribute type
|
|
3004
3836
|
# URL image source.
|
|
3005
3837
|
#
|
|
3006
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3838
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source::Type]
|
|
3007
3839
|
required :type,
|
|
3008
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3840
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source::Type }
|
|
3009
3841
|
|
|
3010
3842
|
# @!attribute url
|
|
3011
3843
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -3016,13 +3848,13 @@ module SafetyKit
|
|
|
3016
3848
|
# @!method initialize(type:, url:)
|
|
3017
3849
|
# Image source information.
|
|
3018
3850
|
#
|
|
3019
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3851
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
3020
3852
|
#
|
|
3021
3853
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3022
3854
|
|
|
3023
3855
|
# URL image source.
|
|
3024
3856
|
#
|
|
3025
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3857
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent::Source#type
|
|
3026
3858
|
module Type
|
|
3027
3859
|
extend SafetyKit::Internal::Type::Enum
|
|
3028
3860
|
|
|
@@ -3035,7 +3867,7 @@ module SafetyKit
|
|
|
3035
3867
|
|
|
3036
3868
|
# Image content part.
|
|
3037
3869
|
#
|
|
3038
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3870
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent#type
|
|
3039
3871
|
module Type
|
|
3040
3872
|
extend SafetyKit::Internal::Type::Enum
|
|
3041
3873
|
|
|
@@ -3047,7 +3879,7 @@ module SafetyKit
|
|
|
3047
3879
|
end
|
|
3048
3880
|
|
|
3049
3881
|
# @!method self.variants
|
|
3050
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3882
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Content::EventImageContent)]
|
|
3051
3883
|
end
|
|
3052
3884
|
|
|
3053
3885
|
module Metadata
|
|
@@ -3059,7 +3891,7 @@ module SafetyKit
|
|
|
3059
3891
|
|
|
3060
3892
|
variant SafetyKit::Internal::Type::Boolean
|
|
3061
3893
|
|
|
3062
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3894
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Metadata::UnionMember3Array }
|
|
3063
3895
|
|
|
3064
3896
|
module UnionMember3
|
|
3065
3897
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -3080,7 +3912,7 @@ module SafetyKit
|
|
|
3080
3912
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3081
3913
|
UnionMember3Array =
|
|
3082
3914
|
SafetyKit::Internal::Type::ArrayOf[
|
|
3083
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3915
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::Metadata::UnionMember3 }
|
|
3084
3916
|
]
|
|
3085
3917
|
end
|
|
3086
3918
|
|
|
@@ -3101,7 +3933,7 @@ module SafetyKit
|
|
|
3101
3933
|
|
|
3102
3934
|
# @!method initialize(type:, value:)
|
|
3103
3935
|
# Some parameter documentations has been truncated, see
|
|
3104
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3936
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount::ResourcesUsed}
|
|
3105
3937
|
# for more details.
|
|
3106
3938
|
#
|
|
3107
3939
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -3149,9 +3981,9 @@ module SafetyKit
|
|
|
3149
3981
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
3150
3982
|
# analyze.
|
|
3151
3983
|
#
|
|
3152
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3984
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent>, nil]
|
|
3153
3985
|
optional :content,
|
|
3154
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3986
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content] }
|
|
3155
3987
|
|
|
3156
3988
|
# @!attribute content_id
|
|
3157
3989
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -3173,16 +4005,16 @@ module SafetyKit
|
|
|
3173
4005
|
#
|
|
3174
4006
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
3175
4007
|
optional :metadata,
|
|
3176
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4008
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Metadata] }
|
|
3177
4009
|
|
|
3178
4010
|
# @!attribute resources_used
|
|
3179
4011
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3180
4012
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
3181
4013
|
# identifiers.
|
|
3182
4014
|
#
|
|
3183
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4015
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed>, nil]
|
|
3184
4016
|
optional :resources_used,
|
|
3185
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
4017
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed] }
|
|
3186
4018
|
|
|
3187
4019
|
# @!attribute target_content_id
|
|
3188
4020
|
# Your stable identifier for the content being reported.
|
|
@@ -3198,7 +4030,7 @@ module SafetyKit
|
|
|
3198
4030
|
|
|
3199
4031
|
# @!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
4032
|
# Some parameter documentations has been truncated, see
|
|
3201
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4033
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport} for
|
|
3202
4034
|
# more details.
|
|
3203
4035
|
#
|
|
3204
4036
|
# A user-submitted report. Use user_id for the reporter. Include target_user_id
|
|
@@ -3214,7 +4046,7 @@ module SafetyKit
|
|
|
3214
4046
|
#
|
|
3215
4047
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
3216
4048
|
#
|
|
3217
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4049
|
+
# @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
4050
|
#
|
|
3219
4051
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
3220
4052
|
#
|
|
@@ -3222,7 +4054,7 @@ module SafetyKit
|
|
|
3222
4054
|
#
|
|
3223
4055
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3224
4056
|
#
|
|
3225
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4057
|
+
# @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
4058
|
#
|
|
3227
4059
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
3228
4060
|
#
|
|
@@ -3235,10 +4067,10 @@ module SafetyKit
|
|
|
3235
4067
|
extend SafetyKit::Internal::Type::Union
|
|
3236
4068
|
|
|
3237
4069
|
# User-authored text content associated with an event.
|
|
3238
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4070
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent }
|
|
3239
4071
|
|
|
3240
4072
|
# User-uploaded image content associated with an event.
|
|
3241
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4073
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent }
|
|
3242
4074
|
|
|
3243
4075
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
3244
4076
|
# @!attribute text
|
|
@@ -3250,9 +4082,9 @@ module SafetyKit
|
|
|
3250
4082
|
# @!attribute type
|
|
3251
4083
|
# Text content part.
|
|
3252
4084
|
#
|
|
3253
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4085
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent::Type]
|
|
3254
4086
|
required :type,
|
|
3255
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4087
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent::Type }
|
|
3256
4088
|
|
|
3257
4089
|
# @!attribute key
|
|
3258
4090
|
# Stable field key for this content part.
|
|
@@ -3265,13 +4097,13 @@ module SafetyKit
|
|
|
3265
4097
|
#
|
|
3266
4098
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
3267
4099
|
#
|
|
3268
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4100
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent::Type] Text content part.
|
|
3269
4101
|
#
|
|
3270
4102
|
# @param key [String] Stable field key for this content part.
|
|
3271
4103
|
|
|
3272
4104
|
# Text content part.
|
|
3273
4105
|
#
|
|
3274
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4106
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent#type
|
|
3275
4107
|
module Type
|
|
3276
4108
|
extend SafetyKit::Internal::Type::Enum
|
|
3277
4109
|
|
|
@@ -3286,16 +4118,16 @@ module SafetyKit
|
|
|
3286
4118
|
# @!attribute source
|
|
3287
4119
|
# Image source information.
|
|
3288
4120
|
#
|
|
3289
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4121
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source]
|
|
3290
4122
|
required :source,
|
|
3291
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4123
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source }
|
|
3292
4124
|
|
|
3293
4125
|
# @!attribute type
|
|
3294
4126
|
# Image content part.
|
|
3295
4127
|
#
|
|
3296
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4128
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Type]
|
|
3297
4129
|
required :type,
|
|
3298
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4130
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Type }
|
|
3299
4131
|
|
|
3300
4132
|
# @!attribute key
|
|
3301
4133
|
# Stable field key for this content part.
|
|
@@ -3306,20 +4138,20 @@ module SafetyKit
|
|
|
3306
4138
|
# @!method initialize(source:, type:, key: nil)
|
|
3307
4139
|
# User-uploaded image content associated with an event.
|
|
3308
4140
|
#
|
|
3309
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4141
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source] Image source information.
|
|
3310
4142
|
#
|
|
3311
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4143
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Type] Image content part.
|
|
3312
4144
|
#
|
|
3313
4145
|
# @param key [String] Stable field key for this content part.
|
|
3314
4146
|
|
|
3315
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4147
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent#source
|
|
3316
4148
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3317
4149
|
# @!attribute type
|
|
3318
4150
|
# URL image source.
|
|
3319
4151
|
#
|
|
3320
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4152
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source::Type]
|
|
3321
4153
|
required :type,
|
|
3322
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4154
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source::Type }
|
|
3323
4155
|
|
|
3324
4156
|
# @!attribute url
|
|
3325
4157
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -3330,13 +4162,13 @@ module SafetyKit
|
|
|
3330
4162
|
# @!method initialize(type:, url:)
|
|
3331
4163
|
# Image source information.
|
|
3332
4164
|
#
|
|
3333
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4165
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source::Type] URL image source.
|
|
3334
4166
|
#
|
|
3335
4167
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3336
4168
|
|
|
3337
4169
|
# URL image source.
|
|
3338
4170
|
#
|
|
3339
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4171
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent::Source#type
|
|
3340
4172
|
module Type
|
|
3341
4173
|
extend SafetyKit::Internal::Type::Enum
|
|
3342
4174
|
|
|
@@ -3349,7 +4181,7 @@ module SafetyKit
|
|
|
3349
4181
|
|
|
3350
4182
|
# Image content part.
|
|
3351
4183
|
#
|
|
3352
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4184
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent#type
|
|
3353
4185
|
module Type
|
|
3354
4186
|
extend SafetyKit::Internal::Type::Enum
|
|
3355
4187
|
|
|
@@ -3361,7 +4193,7 @@ module SafetyKit
|
|
|
3361
4193
|
end
|
|
3362
4194
|
|
|
3363
4195
|
# @!method self.variants
|
|
3364
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4196
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Content::EventImageContent)]
|
|
3365
4197
|
end
|
|
3366
4198
|
|
|
3367
4199
|
module Metadata
|
|
@@ -3373,7 +4205,7 @@ module SafetyKit
|
|
|
3373
4205
|
|
|
3374
4206
|
variant SafetyKit::Internal::Type::Boolean
|
|
3375
4207
|
|
|
3376
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4208
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::Metadata::UnionMember3Array }
|
|
3377
4209
|
|
|
3378
4210
|
module UnionMember3
|
|
3379
4211
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -3394,7 +4226,7 @@ module SafetyKit
|
|
|
3394
4226
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3395
4227
|
UnionMember3Array =
|
|
3396
4228
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
3397
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
4229
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::Metadata::UnionMember3
|
|
3398
4230
|
}]
|
|
3399
4231
|
end
|
|
3400
4232
|
|
|
@@ -3415,7 +4247,7 @@ module SafetyKit
|
|
|
3415
4247
|
|
|
3416
4248
|
# @!method initialize(type:, value:)
|
|
3417
4249
|
# Some parameter documentations has been truncated, see
|
|
3418
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4250
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport::ResourcesUsed}
|
|
3419
4251
|
# for more details.
|
|
3420
4252
|
#
|
|
3421
4253
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -3456,9 +4288,9 @@ module SafetyKit
|
|
|
3456
4288
|
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
3457
4289
|
# review or moderation provider).
|
|
3458
4290
|
#
|
|
3459
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4291
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::SourceType]
|
|
3460
4292
|
required :source_type,
|
|
3461
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4293
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::SourceType }
|
|
3462
4294
|
|
|
3463
4295
|
# @!attribute timestamp
|
|
3464
4296
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
@@ -3476,9 +4308,9 @@ module SafetyKit
|
|
|
3476
4308
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
3477
4309
|
# analyze.
|
|
3478
4310
|
#
|
|
3479
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4311
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent>, nil]
|
|
3480
4312
|
optional :content,
|
|
3481
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4313
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content] }
|
|
3482
4314
|
|
|
3483
4315
|
# @!attribute content_id
|
|
3484
4316
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -3500,16 +4332,16 @@ module SafetyKit
|
|
|
3500
4332
|
#
|
|
3501
4333
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
3502
4334
|
optional :metadata,
|
|
3503
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4335
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Metadata] }
|
|
3504
4336
|
|
|
3505
4337
|
# @!attribute resources_used
|
|
3506
4338
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3507
4339
|
# numbers, names, addresses, social handles, URLs, payment identifiers, or similar
|
|
3508
4340
|
# identifiers.
|
|
3509
4341
|
#
|
|
3510
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4342
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed>, nil]
|
|
3511
4343
|
optional :resources_used,
|
|
3512
|
-
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::
|
|
4344
|
+
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed] }
|
|
3513
4345
|
|
|
3514
4346
|
# @!attribute target_content_id
|
|
3515
4347
|
# Your stable identifier for the content being reported.
|
|
@@ -3525,7 +4357,7 @@ module SafetyKit
|
|
|
3525
4357
|
|
|
3526
4358
|
# @!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
4359
|
# Some parameter documentations has been truncated, see
|
|
3528
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4360
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision}
|
|
3529
4361
|
# for more details.
|
|
3530
4362
|
#
|
|
3531
4363
|
# A moderation label or decision from an automated enforcement system or manual
|
|
@@ -3538,11 +4370,11 @@ module SafetyKit
|
|
|
3538
4370
|
#
|
|
3539
4371
|
# @param source_id [String] Stable identifier within source_type. Examples: moderator@example.com or 550e840
|
|
3540
4372
|
#
|
|
3541
|
-
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4373
|
+
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::SourceType] Coarse attribution category for the moderation decision source. Supported values
|
|
3542
4374
|
#
|
|
3543
4375
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
3544
4376
|
#
|
|
3545
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4377
|
+
# @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
4378
|
#
|
|
3547
4379
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
3548
4380
|
#
|
|
@@ -3550,7 +4382,7 @@ module SafetyKit
|
|
|
3550
4382
|
#
|
|
3551
4383
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3552
4384
|
#
|
|
3553
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4385
|
+
# @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
4386
|
#
|
|
3555
4387
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
3556
4388
|
#
|
|
@@ -3564,7 +4396,7 @@ module SafetyKit
|
|
|
3564
4396
|
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
3565
4397
|
# review or moderation provider).
|
|
3566
4398
|
#
|
|
3567
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4399
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision#source_type
|
|
3568
4400
|
module SourceType
|
|
3569
4401
|
extend SafetyKit::Internal::Type::Enum
|
|
3570
4402
|
|
|
@@ -3582,10 +4414,10 @@ module SafetyKit
|
|
|
3582
4414
|
extend SafetyKit::Internal::Type::Union
|
|
3583
4415
|
|
|
3584
4416
|
# User-authored text content associated with an event.
|
|
3585
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4417
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent }
|
|
3586
4418
|
|
|
3587
4419
|
# User-uploaded image content associated with an event.
|
|
3588
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4420
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent }
|
|
3589
4421
|
|
|
3590
4422
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
3591
4423
|
# @!attribute text
|
|
@@ -3597,9 +4429,9 @@ module SafetyKit
|
|
|
3597
4429
|
# @!attribute type
|
|
3598
4430
|
# Text content part.
|
|
3599
4431
|
#
|
|
3600
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4432
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent::Type]
|
|
3601
4433
|
required :type,
|
|
3602
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4434
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent::Type }
|
|
3603
4435
|
|
|
3604
4436
|
# @!attribute key
|
|
3605
4437
|
# Stable field key for this content part.
|
|
@@ -3612,13 +4444,13 @@ module SafetyKit
|
|
|
3612
4444
|
#
|
|
3613
4445
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
3614
4446
|
#
|
|
3615
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4447
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent::Type] Text content part.
|
|
3616
4448
|
#
|
|
3617
4449
|
# @param key [String] Stable field key for this content part.
|
|
3618
4450
|
|
|
3619
4451
|
# Text content part.
|
|
3620
4452
|
#
|
|
3621
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4453
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent#type
|
|
3622
4454
|
module Type
|
|
3623
4455
|
extend SafetyKit::Internal::Type::Enum
|
|
3624
4456
|
|
|
@@ -3633,16 +4465,16 @@ module SafetyKit
|
|
|
3633
4465
|
# @!attribute source
|
|
3634
4466
|
# Image source information.
|
|
3635
4467
|
#
|
|
3636
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4468
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source]
|
|
3637
4469
|
required :source,
|
|
3638
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4470
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source }
|
|
3639
4471
|
|
|
3640
4472
|
# @!attribute type
|
|
3641
4473
|
# Image content part.
|
|
3642
4474
|
#
|
|
3643
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4475
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Type]
|
|
3644
4476
|
required :type,
|
|
3645
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4477
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Type }
|
|
3646
4478
|
|
|
3647
4479
|
# @!attribute key
|
|
3648
4480
|
# Stable field key for this content part.
|
|
@@ -3653,20 +4485,20 @@ module SafetyKit
|
|
|
3653
4485
|
# @!method initialize(source:, type:, key: nil)
|
|
3654
4486
|
# User-uploaded image content associated with an event.
|
|
3655
4487
|
#
|
|
3656
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4488
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source] Image source information.
|
|
3657
4489
|
#
|
|
3658
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4490
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Type] Image content part.
|
|
3659
4491
|
#
|
|
3660
4492
|
# @param key [String] Stable field key for this content part.
|
|
3661
4493
|
|
|
3662
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4494
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent#source
|
|
3663
4495
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3664
4496
|
# @!attribute type
|
|
3665
4497
|
# URL image source.
|
|
3666
4498
|
#
|
|
3667
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4499
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source::Type]
|
|
3668
4500
|
required :type,
|
|
3669
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4501
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source::Type }
|
|
3670
4502
|
|
|
3671
4503
|
# @!attribute url
|
|
3672
4504
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -3677,13 +4509,13 @@ module SafetyKit
|
|
|
3677
4509
|
# @!method initialize(type:, url:)
|
|
3678
4510
|
# Image source information.
|
|
3679
4511
|
#
|
|
3680
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4512
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source::Type] URL image source.
|
|
3681
4513
|
#
|
|
3682
4514
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3683
4515
|
|
|
3684
4516
|
# URL image source.
|
|
3685
4517
|
#
|
|
3686
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4518
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent::Source#type
|
|
3687
4519
|
module Type
|
|
3688
4520
|
extend SafetyKit::Internal::Type::Enum
|
|
3689
4521
|
|
|
@@ -3696,7 +4528,7 @@ module SafetyKit
|
|
|
3696
4528
|
|
|
3697
4529
|
# Image content part.
|
|
3698
4530
|
#
|
|
3699
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4531
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent#type
|
|
3700
4532
|
module Type
|
|
3701
4533
|
extend SafetyKit::Internal::Type::Enum
|
|
3702
4534
|
|
|
@@ -3708,7 +4540,7 @@ module SafetyKit
|
|
|
3708
4540
|
end
|
|
3709
4541
|
|
|
3710
4542
|
# @!method self.variants
|
|
3711
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4543
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Content::EventImageContent)]
|
|
3712
4544
|
end
|
|
3713
4545
|
|
|
3714
4546
|
module Metadata
|
|
@@ -3720,7 +4552,7 @@ module SafetyKit
|
|
|
3720
4552
|
|
|
3721
4553
|
variant SafetyKit::Internal::Type::Boolean
|
|
3722
4554
|
|
|
3723
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4555
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Metadata::UnionMember3Array }
|
|
3724
4556
|
|
|
3725
4557
|
module UnionMember3
|
|
3726
4558
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -3741,7 +4573,7 @@ module SafetyKit
|
|
|
3741
4573
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3742
4574
|
UnionMember3Array =
|
|
3743
4575
|
SafetyKit::Internal::Type::ArrayOf[
|
|
3744
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4576
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::Metadata::UnionMember3 }
|
|
3745
4577
|
]
|
|
3746
4578
|
end
|
|
3747
4579
|
|
|
@@ -3762,7 +4594,7 @@ module SafetyKit
|
|
|
3762
4594
|
|
|
3763
4595
|
# @!method initialize(type:, value:)
|
|
3764
4596
|
# Some parameter documentations has been truncated, see
|
|
3765
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4597
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision::ResourcesUsed}
|
|
3766
4598
|
# for more details.
|
|
3767
4599
|
#
|
|
3768
4600
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -3775,16 +4607,16 @@ module SafetyKit
|
|
|
3775
4607
|
end
|
|
3776
4608
|
|
|
3777
4609
|
# @!method self.variants
|
|
3778
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4610
|
+
# @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
4611
|
end
|
|
3780
4612
|
|
|
3781
4613
|
# @!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::
|
|
4614
|
+
# @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
4615
|
|
|
3784
4616
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3785
|
-
|
|
4617
|
+
UnionMember7Array =
|
|
3786
4618
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
3787
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
4619
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember7
|
|
3788
4620
|
}]
|
|
3789
4621
|
end
|
|
3790
4622
|
end
|