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