safetykit 0.39.0 → 0.40.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/safety_kit/client.rb +2 -2
- data/lib/safety_kit/models/async_create_async_params.rb +1505 -715
- data/lib/safety_kit/models/beta/event_create_params.rb +1503 -713
- data/lib/safety_kit/resources/async.rb +3 -3
- data/lib/safety_kit/resources/beta/events.rb +5 -5
- data/lib/safety_kit/resources/beta.rb +2 -2
- data/lib/safety_kit/version.rb +1 -1
- data/rbi/safety_kit/client.rbi +2 -2
- data/rbi/safety_kit/models/async_create_async_params.rbi +3369 -1726
- data/rbi/safety_kit/models/beta/event_create_params.rbi +3370 -1725
- data/rbi/safety_kit/resources/async.rbi +11 -9
- data/rbi/safety_kit/resources/beta/events.rbi +13 -11
- data/rbi/safety_kit/resources/beta.rbi +2 -2
- data/sig/safety_kit/models/async_create_async_params.rbs +1054 -438
- data/sig/safety_kit/models/beta/event_create_params.rbs +1054 -438
- 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::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::
|
|
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::AppealEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::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::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::
|
|
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::AppealEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::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
|
|
|
@@ -48,10 +48,13 @@ module SafetyKit
|
|
|
48
48
|
# 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.
|
|
49
49
|
variant -> { SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest }
|
|
50
50
|
|
|
51
|
+
# A user appeals a moderation action taken against them. Use user_id for the appealing user, appealed_decision_id to reference the decision being appealed, and content and content_id for the appeal itself.
|
|
52
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest }
|
|
53
|
+
|
|
51
54
|
# 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.
|
|
52
55
|
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest }
|
|
53
56
|
|
|
54
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
57
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8Array }
|
|
55
58
|
|
|
56
59
|
class UserContactEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
57
60
|
# @!attribute event_name
|
|
@@ -2525,7 +2528,7 @@ module SafetyKit
|
|
|
2525
2528
|
end
|
|
2526
2529
|
end
|
|
2527
2530
|
|
|
2528
|
-
class
|
|
2531
|
+
class AppealEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
2529
2532
|
# @!attribute event_name
|
|
2530
2533
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
2531
2534
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -2533,31 +2536,6 @@ module SafetyKit
|
|
|
2533
2536
|
# @return [String]
|
|
2534
2537
|
required :event_name, String
|
|
2535
2538
|
|
|
2536
|
-
# @!attribute labels
|
|
2537
|
-
# One or more label categories supplied with the report or moderation decision.
|
|
2538
|
-
#
|
|
2539
|
-
# @return [Array<String>]
|
|
2540
|
-
required :labels, SafetyKit::Internal::Type::ArrayOf[String]
|
|
2541
|
-
|
|
2542
|
-
# @!attribute source_id
|
|
2543
|
-
# Stable identifier within source_type. Examples: moderator@example.com or
|
|
2544
|
-
# 550e8400-e29b-41d4-a716-446655440000 for expert_labeler or human_moderator,
|
|
2545
|
-
# automated_review_v2026_06_04 for automation, or <vendor_name>-v2.1 for vendor.
|
|
2546
|
-
#
|
|
2547
|
-
# @return [String]
|
|
2548
|
-
required :source_id, String
|
|
2549
|
-
|
|
2550
|
-
# @!attribute source_type
|
|
2551
|
-
# Coarse attribution category for the moderation decision source. Supported
|
|
2552
|
-
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
2553
|
-
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
2554
|
-
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
2555
|
-
# review or moderation provider).
|
|
2556
|
-
#
|
|
2557
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType]
|
|
2558
|
-
required :source_type,
|
|
2559
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType }
|
|
2560
|
-
|
|
2561
2539
|
# @!attribute timestamp
|
|
2562
2540
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2563
2541
|
#
|
|
@@ -2566,26 +2544,38 @@ module SafetyKit
|
|
|
2566
2544
|
|
|
2567
2545
|
# @!attribute type
|
|
2568
2546
|
#
|
|
2569
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2570
|
-
required :type,
|
|
2571
|
-
|
|
2547
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Type]
|
|
2548
|
+
required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Type }
|
|
2549
|
+
|
|
2550
|
+
# @!attribute user_id
|
|
2551
|
+
# Your stable canonical identifier for the user or account.
|
|
2552
|
+
#
|
|
2553
|
+
# @return [String]
|
|
2554
|
+
required :user_id, String
|
|
2555
|
+
|
|
2556
|
+
# @!attribute appealed_decision_id
|
|
2557
|
+
# Your stable identifier for the moderation decision or enforcement action being
|
|
2558
|
+
# appealed, such as the content_id of a moderation_decision event you previously
|
|
2559
|
+
# sent.
|
|
2560
|
+
#
|
|
2561
|
+
# @return [String, nil]
|
|
2562
|
+
optional :appealed_decision_id, String
|
|
2572
2563
|
|
|
2573
2564
|
# @!attribute client_info
|
|
2574
2565
|
# Client context observed by your backend for the user action that triggered the
|
|
2575
2566
|
# event.
|
|
2576
2567
|
#
|
|
2577
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2578
|
-
optional :client_info,
|
|
2579
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ClientInfo }
|
|
2568
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ClientInfo, nil]
|
|
2569
|
+
optional :client_info, -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::ClientInfo }
|
|
2580
2570
|
|
|
2581
2571
|
# @!attribute content
|
|
2582
2572
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2583
2573
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2584
2574
|
# analyze.
|
|
2585
2575
|
#
|
|
2586
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2576
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent>, nil]
|
|
2587
2577
|
optional :content,
|
|
2588
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2578
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Content] }
|
|
2589
2579
|
|
|
2590
2580
|
# @!attribute content_id
|
|
2591
2581
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -2607,53 +2597,39 @@ module SafetyKit
|
|
|
2607
2597
|
#
|
|
2608
2598
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
2609
2599
|
optional :metadata,
|
|
2610
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2600
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Metadata] }
|
|
2611
2601
|
|
|
2612
2602
|
# @!attribute resources_used
|
|
2613
2603
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
2614
2604
|
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
2615
2605
|
# caller-defined ids, or similar identifiers.
|
|
2616
2606
|
#
|
|
2617
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2607
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::UnionMember1>, nil]
|
|
2618
2608
|
optional :resources_used,
|
|
2619
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
2620
|
-
|
|
2621
|
-
# @!attribute target_content_id
|
|
2622
|
-
# Your stable identifier for the content being reported.
|
|
2623
|
-
#
|
|
2624
|
-
# @return [String, nil]
|
|
2625
|
-
optional :target_content_id, String
|
|
2626
|
-
|
|
2627
|
-
# @!attribute target_user_id
|
|
2628
|
-
# Your stable canonical identifier for the user being reported.
|
|
2629
|
-
#
|
|
2630
|
-
# @return [String, nil]
|
|
2631
|
-
optional :target_user_id, String
|
|
2609
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed] }
|
|
2632
2610
|
|
|
2633
|
-
# @!method initialize(event_name:,
|
|
2611
|
+
# @!method initialize(event_name:, timestamp:, type:, user_id:, appealed_decision_id: nil, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil)
|
|
2634
2612
|
# Some parameter documentations has been truncated, see
|
|
2635
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2636
|
-
#
|
|
2613
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest} for more
|
|
2614
|
+
# details.
|
|
2637
2615
|
#
|
|
2638
|
-
# A
|
|
2639
|
-
#
|
|
2640
|
-
#
|
|
2616
|
+
# A user appeals a moderation action taken against them. Use user_id for the
|
|
2617
|
+
# appealing user, appealed_decision_id to reference the decision being appealed,
|
|
2618
|
+
# and content and content_id for the appeal itself.
|
|
2641
2619
|
#
|
|
2642
2620
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
2643
2621
|
#
|
|
2644
|
-
# @param
|
|
2645
|
-
#
|
|
2646
|
-
# @param source_id [String] Stable identifier within source_type. Examples: moderator@example.com or 550e840
|
|
2622
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2647
2623
|
#
|
|
2648
|
-
# @param
|
|
2624
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Type]
|
|
2649
2625
|
#
|
|
2650
|
-
# @param
|
|
2626
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
2651
2627
|
#
|
|
2652
|
-
# @param
|
|
2628
|
+
# @param appealed_decision_id [String] Your stable identifier for the moderation decision or enforcement action being a
|
|
2653
2629
|
#
|
|
2654
|
-
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2630
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
2655
2631
|
#
|
|
2656
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2632
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2657
2633
|
#
|
|
2658
2634
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
2659
2635
|
#
|
|
@@ -2661,42 +2637,19 @@ module SafetyKit
|
|
|
2661
2637
|
#
|
|
2662
2638
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
2663
2639
|
#
|
|
2664
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2665
|
-
#
|
|
2666
|
-
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
2667
|
-
#
|
|
2668
|
-
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
2669
|
-
|
|
2670
|
-
# Coarse attribution category for the moderation decision source. Supported
|
|
2671
|
-
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
2672
|
-
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
2673
|
-
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
2674
|
-
# review or moderation provider).
|
|
2675
|
-
#
|
|
2676
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#source_type
|
|
2677
|
-
module SourceType
|
|
2678
|
-
extend SafetyKit::Internal::Type::Enum
|
|
2679
|
-
|
|
2680
|
-
HUMAN_MODERATOR = :human_moderator
|
|
2681
|
-
EXPERT_LABELER = :expert_labeler
|
|
2682
|
-
AUTOMATION = :automation
|
|
2683
|
-
VENDOR = :vendor
|
|
2684
|
-
|
|
2685
|
-
# @!method self.values
|
|
2686
|
-
# @return [Array<Symbol>]
|
|
2687
|
-
end
|
|
2640
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
2688
2641
|
|
|
2689
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2642
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest#type
|
|
2690
2643
|
module Type
|
|
2691
2644
|
extend SafetyKit::Internal::Type::Enum
|
|
2692
2645
|
|
|
2693
|
-
|
|
2646
|
+
APPEAL = :appeal
|
|
2694
2647
|
|
|
2695
2648
|
# @!method self.values
|
|
2696
2649
|
# @return [Array<Symbol>]
|
|
2697
2650
|
end
|
|
2698
2651
|
|
|
2699
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2652
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest#client_info
|
|
2700
2653
|
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
2701
2654
|
# @!attribute ip
|
|
2702
2655
|
# IP address observed by your backend for the client that triggered the event.
|
|
@@ -2716,10 +2669,10 @@ module SafetyKit
|
|
|
2716
2669
|
extend SafetyKit::Internal::Type::Union
|
|
2717
2670
|
|
|
2718
2671
|
# User-authored text content associated with an event.
|
|
2719
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2672
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventTextContent }
|
|
2720
2673
|
|
|
2721
2674
|
# User-uploaded image content associated with an event.
|
|
2722
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2675
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent }
|
|
2723
2676
|
|
|
2724
2677
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
2725
2678
|
# @!attribute text
|
|
@@ -2731,9 +2684,9 @@ module SafetyKit
|
|
|
2731
2684
|
# @!attribute type
|
|
2732
2685
|
# Text content part.
|
|
2733
2686
|
#
|
|
2734
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2687
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventTextContent::Type]
|
|
2735
2688
|
required :type,
|
|
2736
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2689
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventTextContent::Type }
|
|
2737
2690
|
|
|
2738
2691
|
# @!attribute key
|
|
2739
2692
|
# Stable field key for this content part.
|
|
@@ -2746,13 +2699,13 @@ module SafetyKit
|
|
|
2746
2699
|
#
|
|
2747
2700
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
2748
2701
|
#
|
|
2749
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2702
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventTextContent::Type] Text content part.
|
|
2750
2703
|
#
|
|
2751
2704
|
# @param key [String] Stable field key for this content part.
|
|
2752
2705
|
|
|
2753
2706
|
# Text content part.
|
|
2754
2707
|
#
|
|
2755
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2708
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventTextContent#type
|
|
2756
2709
|
module Type
|
|
2757
2710
|
extend SafetyKit::Internal::Type::Enum
|
|
2758
2711
|
|
|
@@ -2767,16 +2720,16 @@ module SafetyKit
|
|
|
2767
2720
|
# @!attribute source
|
|
2768
2721
|
# Image source information.
|
|
2769
2722
|
#
|
|
2770
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2723
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Source]
|
|
2771
2724
|
required :source,
|
|
2772
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2725
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Source }
|
|
2773
2726
|
|
|
2774
2727
|
# @!attribute type
|
|
2775
2728
|
# Image content part.
|
|
2776
2729
|
#
|
|
2777
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2730
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Type]
|
|
2778
2731
|
required :type,
|
|
2779
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2732
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Type }
|
|
2780
2733
|
|
|
2781
2734
|
# @!attribute key
|
|
2782
2735
|
# Stable field key for this content part.
|
|
@@ -2787,20 +2740,20 @@ module SafetyKit
|
|
|
2787
2740
|
# @!method initialize(source:, type:, key: nil)
|
|
2788
2741
|
# User-uploaded image content associated with an event.
|
|
2789
2742
|
#
|
|
2790
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2743
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Source] Image source information.
|
|
2791
2744
|
#
|
|
2792
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2745
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Type] Image content part.
|
|
2793
2746
|
#
|
|
2794
2747
|
# @param key [String] Stable field key for this content part.
|
|
2795
2748
|
|
|
2796
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2749
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent#source
|
|
2797
2750
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
2798
2751
|
# @!attribute type
|
|
2799
2752
|
# URL image source.
|
|
2800
2753
|
#
|
|
2801
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2754
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Source::Type]
|
|
2802
2755
|
required :type,
|
|
2803
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2756
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Source::Type }
|
|
2804
2757
|
|
|
2805
2758
|
# @!attribute url
|
|
2806
2759
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -2811,13 +2764,13 @@ module SafetyKit
|
|
|
2811
2764
|
# @!method initialize(type:, url:)
|
|
2812
2765
|
# Image source information.
|
|
2813
2766
|
#
|
|
2814
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2767
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
2815
2768
|
#
|
|
2816
2769
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
2817
2770
|
|
|
2818
2771
|
# URL image source.
|
|
2819
2772
|
#
|
|
2820
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2773
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent::Source#type
|
|
2821
2774
|
module Type
|
|
2822
2775
|
extend SafetyKit::Internal::Type::Enum
|
|
2823
2776
|
|
|
@@ -2830,7 +2783,7 @@ module SafetyKit
|
|
|
2830
2783
|
|
|
2831
2784
|
# Image content part.
|
|
2832
2785
|
#
|
|
2833
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2786
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent#type
|
|
2834
2787
|
module Type
|
|
2835
2788
|
extend SafetyKit::Internal::Type::Enum
|
|
2836
2789
|
|
|
@@ -2842,7 +2795,7 @@ module SafetyKit
|
|
|
2842
2795
|
end
|
|
2843
2796
|
|
|
2844
2797
|
# @!method self.variants
|
|
2845
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2798
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Content::EventImageContent)]
|
|
2846
2799
|
end
|
|
2847
2800
|
|
|
2848
2801
|
module Metadata
|
|
@@ -2854,7 +2807,7 @@ module SafetyKit
|
|
|
2854
2807
|
|
|
2855
2808
|
variant SafetyKit::Internal::Type::Boolean
|
|
2856
2809
|
|
|
2857
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2810
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::Metadata::UnionMember3Array }
|
|
2858
2811
|
|
|
2859
2812
|
module UnionMember3
|
|
2860
2813
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -2874,9 +2827,9 @@ module SafetyKit
|
|
|
2874
2827
|
|
|
2875
2828
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
2876
2829
|
UnionMember3Array =
|
|
2877
|
-
SafetyKit::Internal::Type::ArrayOf[
|
|
2878
|
-
|
|
2879
|
-
]
|
|
2830
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
2831
|
+
SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::Metadata::UnionMember3
|
|
2832
|
+
}]
|
|
2880
2833
|
end
|
|
2881
2834
|
|
|
2882
2835
|
# Real-world, account, social, or caller-defined resource used during the event.
|
|
@@ -2884,10 +2837,10 @@ module SafetyKit
|
|
|
2884
2837
|
extend SafetyKit::Internal::Type::Union
|
|
2885
2838
|
|
|
2886
2839
|
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
2887
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2840
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::EntityIDResource }
|
|
2888
2841
|
|
|
2889
2842
|
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
2890
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2843
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::UnionMember1 }
|
|
2891
2844
|
|
|
2892
2845
|
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
2893
2846
|
# @!attribute namespace
|
|
@@ -2900,9 +2853,9 @@ module SafetyKit
|
|
|
2900
2853
|
# @!attribute type
|
|
2901
2854
|
# Caller-defined entity identifier resource.
|
|
2902
2855
|
#
|
|
2903
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2856
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::EntityIDResource::Type]
|
|
2904
2857
|
required :type,
|
|
2905
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
2858
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::EntityIDResource::Type }
|
|
2906
2859
|
|
|
2907
2860
|
# @!attribute value
|
|
2908
2861
|
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
@@ -2913,7 +2866,7 @@ module SafetyKit
|
|
|
2913
2866
|
|
|
2914
2867
|
# @!method initialize(namespace:, type:, value:)
|
|
2915
2868
|
# Some parameter documentations has been truncated, see
|
|
2916
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2869
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::EntityIDResource}
|
|
2917
2870
|
# for more details.
|
|
2918
2871
|
#
|
|
2919
2872
|
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
@@ -2921,13 +2874,13 @@ module SafetyKit
|
|
|
2921
2874
|
#
|
|
2922
2875
|
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
2923
2876
|
#
|
|
2924
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2877
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
2925
2878
|
#
|
|
2926
2879
|
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
2927
2880
|
|
|
2928
2881
|
# Caller-defined entity identifier resource.
|
|
2929
2882
|
#
|
|
2930
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2883
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::EntityIDResource#type
|
|
2931
2884
|
module Type
|
|
2932
2885
|
extend SafetyKit::Internal::Type::Enum
|
|
2933
2886
|
|
|
@@ -2956,7 +2909,7 @@ module SafetyKit
|
|
|
2956
2909
|
|
|
2957
2910
|
# @!method initialize(type:, value:)
|
|
2958
2911
|
# Some parameter documentations has been truncated, see
|
|
2959
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2912
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::UnionMember1}
|
|
2960
2913
|
# for more details.
|
|
2961
2914
|
#
|
|
2962
2915
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -2968,65 +2921,902 @@ module SafetyKit
|
|
|
2968
2921
|
end
|
|
2969
2922
|
|
|
2970
2923
|
# @!method self.variants
|
|
2971
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
2924
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest::ResourcesUsed::UnionMember1)]
|
|
2972
2925
|
end
|
|
2973
2926
|
end
|
|
2974
2927
|
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2928
|
+
class ModerationDecisionEventRequest < SafetyKit::Internal::Type::BaseModel
|
|
2929
|
+
# @!attribute event_name
|
|
2930
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
2931
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
2932
|
+
#
|
|
2933
|
+
# @return [String]
|
|
2934
|
+
required :event_name, String
|
|
2978
2935
|
|
|
2979
|
-
|
|
2936
|
+
# @!attribute labels
|
|
2937
|
+
# One or more label categories supplied with the report or moderation decision.
|
|
2938
|
+
#
|
|
2939
|
+
# @return [Array<String>]
|
|
2940
|
+
required :labels, SafetyKit::Internal::Type::ArrayOf[String]
|
|
2980
2941
|
|
|
2981
|
-
#
|
|
2982
|
-
|
|
2942
|
+
# @!attribute source_id
|
|
2943
|
+
# Stable identifier within source_type. Examples: moderator@example.com or
|
|
2944
|
+
# 550e8400-e29b-41d4-a716-446655440000 for expert_labeler or human_moderator,
|
|
2945
|
+
# automated_review_v2026_06_04 for automation, or <vendor_name>-v2.1 for vendor.
|
|
2946
|
+
#
|
|
2947
|
+
# @return [String]
|
|
2948
|
+
required :source_id, String
|
|
2983
2949
|
|
|
2984
|
-
#
|
|
2985
|
-
|
|
2950
|
+
# @!attribute source_type
|
|
2951
|
+
# Coarse attribution category for the moderation decision source. Supported
|
|
2952
|
+
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
2953
|
+
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
2954
|
+
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
2955
|
+
# review or moderation provider).
|
|
2956
|
+
#
|
|
2957
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType]
|
|
2958
|
+
required :source_type,
|
|
2959
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType }
|
|
2986
2960
|
|
|
2987
|
-
#
|
|
2988
|
-
|
|
2961
|
+
# @!attribute timestamp
|
|
2962
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
2963
|
+
#
|
|
2964
|
+
# @return [Time]
|
|
2965
|
+
required :timestamp, Time
|
|
2989
2966
|
|
|
2990
|
-
#
|
|
2991
|
-
|
|
2967
|
+
# @!attribute type
|
|
2968
|
+
#
|
|
2969
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Type]
|
|
2970
|
+
required :type,
|
|
2971
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Type }
|
|
2992
2972
|
|
|
2993
|
-
#
|
|
2994
|
-
|
|
2973
|
+
# @!attribute client_info
|
|
2974
|
+
# Client context observed by your backend for the user action that triggered the
|
|
2975
|
+
# event.
|
|
2976
|
+
#
|
|
2977
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ClientInfo, nil]
|
|
2978
|
+
optional :client_info,
|
|
2979
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ClientInfo }
|
|
2995
2980
|
|
|
2996
|
-
#
|
|
2997
|
-
|
|
2981
|
+
# @!attribute content
|
|
2982
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
2983
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
2984
|
+
# analyze.
|
|
2985
|
+
#
|
|
2986
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent>, nil]
|
|
2987
|
+
optional :content,
|
|
2988
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content] }
|
|
2998
2989
|
|
|
2999
|
-
#
|
|
3000
|
-
|
|
3001
|
-
|
|
2990
|
+
# @!attribute content_id
|
|
2991
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
2992
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
2993
|
+
#
|
|
2994
|
+
# @return [String, nil]
|
|
2995
|
+
optional :content_id, String
|
|
3002
2996
|
|
|
3003
|
-
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
|
|
3008
|
-
|
|
3009
|
-
required :event_name, String
|
|
2997
|
+
# @!attribute idempotency_key
|
|
2998
|
+
# Optional caller-provided key used to make retries of this individual event
|
|
2999
|
+
# idempotent. Reuse the same key only for retries of the same logical event.
|
|
3000
|
+
#
|
|
3001
|
+
# @return [String, nil]
|
|
3002
|
+
optional :idempotency_key, String
|
|
3010
3003
|
|
|
3011
|
-
|
|
3012
|
-
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3004
|
+
# @!attribute metadata
|
|
3005
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
3006
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
3007
|
+
#
|
|
3008
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
3009
|
+
optional :metadata,
|
|
3010
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata] }
|
|
3017
3011
|
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
|
|
3021
|
-
|
|
3022
|
-
|
|
3012
|
+
# @!attribute resources_used
|
|
3013
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
3014
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3015
|
+
# caller-defined ids, or similar identifiers.
|
|
3016
|
+
#
|
|
3017
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1>, nil]
|
|
3018
|
+
optional :resources_used,
|
|
3019
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed] }
|
|
3023
3020
|
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
|
|
3021
|
+
# @!attribute target_content_id
|
|
3022
|
+
# Your stable identifier for the content being reported.
|
|
3023
|
+
#
|
|
3024
|
+
# @return [String, nil]
|
|
3025
|
+
optional :target_content_id, String
|
|
3028
3026
|
|
|
3029
|
-
|
|
3027
|
+
# @!attribute target_user_id
|
|
3028
|
+
# Your stable canonical identifier for the user being reported.
|
|
3029
|
+
#
|
|
3030
|
+
# @return [String, nil]
|
|
3031
|
+
optional :target_user_id, String
|
|
3032
|
+
|
|
3033
|
+
# @!method initialize(event_name:, labels:, source_id:, source_type:, timestamp:, type:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil)
|
|
3034
|
+
# Some parameter documentations has been truncated, see
|
|
3035
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest}
|
|
3036
|
+
# for more details.
|
|
3037
|
+
#
|
|
3038
|
+
# A moderation label or decision from an automated enforcement system or manual
|
|
3039
|
+
# review workflow. Do not send user_id; use source_type and source_id for
|
|
3040
|
+
# attribution.
|
|
3041
|
+
#
|
|
3042
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
3043
|
+
#
|
|
3044
|
+
# @param labels [Array<String>] One or more label categories supplied with the report or moderation decision.
|
|
3045
|
+
#
|
|
3046
|
+
# @param source_id [String] Stable identifier within source_type. Examples: moderator@example.com or 550e840
|
|
3047
|
+
#
|
|
3048
|
+
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::SourceType] Coarse attribution category for the moderation decision source. Supported values
|
|
3049
|
+
#
|
|
3050
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
3051
|
+
#
|
|
3052
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Type]
|
|
3053
|
+
#
|
|
3054
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
3055
|
+
#
|
|
3056
|
+
# @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,
|
|
3057
|
+
#
|
|
3058
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
3059
|
+
#
|
|
3060
|
+
# @param idempotency_key [String] Optional caller-provided key used to make retries of this individual event idemp
|
|
3061
|
+
#
|
|
3062
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3063
|
+
#
|
|
3064
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3065
|
+
#
|
|
3066
|
+
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
3067
|
+
#
|
|
3068
|
+
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
3069
|
+
|
|
3070
|
+
# Coarse attribution category for the moderation decision source. Supported
|
|
3071
|
+
# values: human_moderator (a human reviewer in your moderation workflow),
|
|
3072
|
+
# expert_labeler (an expert human labeler or specialist reviewer), automation (an
|
|
3073
|
+
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
3074
|
+
# review or moderation provider).
|
|
3075
|
+
#
|
|
3076
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#source_type
|
|
3077
|
+
module SourceType
|
|
3078
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3079
|
+
|
|
3080
|
+
HUMAN_MODERATOR = :human_moderator
|
|
3081
|
+
EXPERT_LABELER = :expert_labeler
|
|
3082
|
+
AUTOMATION = :automation
|
|
3083
|
+
VENDOR = :vendor
|
|
3084
|
+
|
|
3085
|
+
# @!method self.values
|
|
3086
|
+
# @return [Array<Symbol>]
|
|
3087
|
+
end
|
|
3088
|
+
|
|
3089
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#type
|
|
3090
|
+
module Type
|
|
3091
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3092
|
+
|
|
3093
|
+
MODERATION_DECISION = :moderation_decision
|
|
3094
|
+
|
|
3095
|
+
# @!method self.values
|
|
3096
|
+
# @return [Array<Symbol>]
|
|
3097
|
+
end
|
|
3098
|
+
|
|
3099
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest#client_info
|
|
3100
|
+
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
3101
|
+
# @!attribute ip
|
|
3102
|
+
# IP address observed by your backend for the client that triggered the event.
|
|
3103
|
+
#
|
|
3104
|
+
# @return [String, nil]
|
|
3105
|
+
optional :ip, String
|
|
3106
|
+
|
|
3107
|
+
# @!method initialize(ip: nil)
|
|
3108
|
+
# Client context observed by your backend for the user action that triggered the
|
|
3109
|
+
# event.
|
|
3110
|
+
#
|
|
3111
|
+
# @param ip [String] IP address observed by your backend for the client that triggered the event.
|
|
3112
|
+
end
|
|
3113
|
+
|
|
3114
|
+
# User-authored text content associated with an event.
|
|
3115
|
+
module Content
|
|
3116
|
+
extend SafetyKit::Internal::Type::Union
|
|
3117
|
+
|
|
3118
|
+
# User-authored text content associated with an event.
|
|
3119
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent }
|
|
3120
|
+
|
|
3121
|
+
# User-uploaded image content associated with an event.
|
|
3122
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent }
|
|
3123
|
+
|
|
3124
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
3125
|
+
# @!attribute text
|
|
3126
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
3127
|
+
#
|
|
3128
|
+
# @return [String]
|
|
3129
|
+
required :text, String
|
|
3130
|
+
|
|
3131
|
+
# @!attribute type
|
|
3132
|
+
# Text content part.
|
|
3133
|
+
#
|
|
3134
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent::Type]
|
|
3135
|
+
required :type,
|
|
3136
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent::Type }
|
|
3137
|
+
|
|
3138
|
+
# @!attribute key
|
|
3139
|
+
# Stable field key for this content part.
|
|
3140
|
+
#
|
|
3141
|
+
# @return [String, nil]
|
|
3142
|
+
optional :key, String
|
|
3143
|
+
|
|
3144
|
+
# @!method initialize(text:, type:, key: nil)
|
|
3145
|
+
# User-authored text content associated with an event.
|
|
3146
|
+
#
|
|
3147
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
3148
|
+
#
|
|
3149
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent::Type] Text content part.
|
|
3150
|
+
#
|
|
3151
|
+
# @param key [String] Stable field key for this content part.
|
|
3152
|
+
|
|
3153
|
+
# Text content part.
|
|
3154
|
+
#
|
|
3155
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent#type
|
|
3156
|
+
module Type
|
|
3157
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3158
|
+
|
|
3159
|
+
TEXT = :text
|
|
3160
|
+
|
|
3161
|
+
# @!method self.values
|
|
3162
|
+
# @return [Array<Symbol>]
|
|
3163
|
+
end
|
|
3164
|
+
end
|
|
3165
|
+
|
|
3166
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
3167
|
+
# @!attribute source
|
|
3168
|
+
# Image source information.
|
|
3169
|
+
#
|
|
3170
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source]
|
|
3171
|
+
required :source,
|
|
3172
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source }
|
|
3173
|
+
|
|
3174
|
+
# @!attribute type
|
|
3175
|
+
# Image content part.
|
|
3176
|
+
#
|
|
3177
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Type]
|
|
3178
|
+
required :type,
|
|
3179
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Type }
|
|
3180
|
+
|
|
3181
|
+
# @!attribute key
|
|
3182
|
+
# Stable field key for this content part.
|
|
3183
|
+
#
|
|
3184
|
+
# @return [String, nil]
|
|
3185
|
+
optional :key, String
|
|
3186
|
+
|
|
3187
|
+
# @!method initialize(source:, type:, key: nil)
|
|
3188
|
+
# User-uploaded image content associated with an event.
|
|
3189
|
+
#
|
|
3190
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source] Image source information.
|
|
3191
|
+
#
|
|
3192
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Type] Image content part.
|
|
3193
|
+
#
|
|
3194
|
+
# @param key [String] Stable field key for this content part.
|
|
3195
|
+
|
|
3196
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent#source
|
|
3197
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3198
|
+
# @!attribute type
|
|
3199
|
+
# URL image source.
|
|
3200
|
+
#
|
|
3201
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source::Type]
|
|
3202
|
+
required :type,
|
|
3203
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source::Type }
|
|
3204
|
+
|
|
3205
|
+
# @!attribute url
|
|
3206
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
3207
|
+
#
|
|
3208
|
+
# @return [String]
|
|
3209
|
+
required :url, String
|
|
3210
|
+
|
|
3211
|
+
# @!method initialize(type:, url:)
|
|
3212
|
+
# Image source information.
|
|
3213
|
+
#
|
|
3214
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source::Type] URL image source.
|
|
3215
|
+
#
|
|
3216
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3217
|
+
|
|
3218
|
+
# URL image source.
|
|
3219
|
+
#
|
|
3220
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent::Source#type
|
|
3221
|
+
module Type
|
|
3222
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3223
|
+
|
|
3224
|
+
URL = :url
|
|
3225
|
+
|
|
3226
|
+
# @!method self.values
|
|
3227
|
+
# @return [Array<Symbol>]
|
|
3228
|
+
end
|
|
3229
|
+
end
|
|
3230
|
+
|
|
3231
|
+
# Image content part.
|
|
3232
|
+
#
|
|
3233
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent#type
|
|
3234
|
+
module Type
|
|
3235
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3236
|
+
|
|
3237
|
+
IMAGE = :image
|
|
3238
|
+
|
|
3239
|
+
# @!method self.values
|
|
3240
|
+
# @return [Array<Symbol>]
|
|
3241
|
+
end
|
|
3242
|
+
end
|
|
3243
|
+
|
|
3244
|
+
# @!method self.variants
|
|
3245
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Content::EventImageContent)]
|
|
3246
|
+
end
|
|
3247
|
+
|
|
3248
|
+
module Metadata
|
|
3249
|
+
extend SafetyKit::Internal::Type::Union
|
|
3250
|
+
|
|
3251
|
+
variant String
|
|
3252
|
+
|
|
3253
|
+
variant Float
|
|
3254
|
+
|
|
3255
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
3256
|
+
|
|
3257
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata::UnionMember3Array }
|
|
3258
|
+
|
|
3259
|
+
module UnionMember3
|
|
3260
|
+
extend SafetyKit::Internal::Type::Union
|
|
3261
|
+
|
|
3262
|
+
variant String
|
|
3263
|
+
|
|
3264
|
+
variant Float
|
|
3265
|
+
|
|
3266
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
3267
|
+
|
|
3268
|
+
# @!method self.variants
|
|
3269
|
+
# @return [Array(String, Float, Boolean)]
|
|
3270
|
+
end
|
|
3271
|
+
|
|
3272
|
+
# @!method self.variants
|
|
3273
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
3274
|
+
|
|
3275
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
3276
|
+
UnionMember3Array =
|
|
3277
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
3278
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::Metadata::UnionMember3 }
|
|
3279
|
+
]
|
|
3280
|
+
end
|
|
3281
|
+
|
|
3282
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
3283
|
+
module ResourcesUsed
|
|
3284
|
+
extend SafetyKit::Internal::Type::Union
|
|
3285
|
+
|
|
3286
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3287
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource }
|
|
3288
|
+
|
|
3289
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
3290
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1 }
|
|
3291
|
+
|
|
3292
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
3293
|
+
# @!attribute namespace
|
|
3294
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3295
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
3296
|
+
#
|
|
3297
|
+
# @return [String]
|
|
3298
|
+
required :namespace, String
|
|
3299
|
+
|
|
3300
|
+
# @!attribute type
|
|
3301
|
+
# Caller-defined entity identifier resource.
|
|
3302
|
+
#
|
|
3303
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource::Type]
|
|
3304
|
+
required :type,
|
|
3305
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource::Type }
|
|
3306
|
+
|
|
3307
|
+
# @!attribute value
|
|
3308
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
3309
|
+
# encoded namespace/value pair, not the raw value.
|
|
3310
|
+
#
|
|
3311
|
+
# @return [String]
|
|
3312
|
+
required :value, String
|
|
3313
|
+
|
|
3314
|
+
# @!method initialize(namespace:, type:, value:)
|
|
3315
|
+
# Some parameter documentations has been truncated, see
|
|
3316
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource}
|
|
3317
|
+
# for more details.
|
|
3318
|
+
#
|
|
3319
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
3320
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3321
|
+
#
|
|
3322
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3323
|
+
#
|
|
3324
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
3325
|
+
#
|
|
3326
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
3327
|
+
|
|
3328
|
+
# Caller-defined entity identifier resource.
|
|
3329
|
+
#
|
|
3330
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource#type
|
|
3331
|
+
module Type
|
|
3332
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3333
|
+
|
|
3334
|
+
ID = :id
|
|
3335
|
+
|
|
3336
|
+
# @!method self.values
|
|
3337
|
+
# @return [Array<Symbol>]
|
|
3338
|
+
end
|
|
3339
|
+
end
|
|
3340
|
+
|
|
3341
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
3342
|
+
# @!attribute type
|
|
3343
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
3344
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
3345
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
3346
|
+
#
|
|
3347
|
+
# @return [String]
|
|
3348
|
+
required :type, String
|
|
3349
|
+
|
|
3350
|
+
# @!attribute value
|
|
3351
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
3352
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
3353
|
+
#
|
|
3354
|
+
# @return [String]
|
|
3355
|
+
required :value, String
|
|
3356
|
+
|
|
3357
|
+
# @!method initialize(type:, value:)
|
|
3358
|
+
# Some parameter documentations has been truncated, see
|
|
3359
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1}
|
|
3360
|
+
# for more details.
|
|
3361
|
+
#
|
|
3362
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
3363
|
+
# number, address, URL, social handle, or payment identifier.
|
|
3364
|
+
#
|
|
3365
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
3366
|
+
#
|
|
3367
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
3368
|
+
end
|
|
3369
|
+
|
|
3370
|
+
# @!method self.variants
|
|
3371
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest::ResourcesUsed::UnionMember1)]
|
|
3372
|
+
end
|
|
3373
|
+
end
|
|
3374
|
+
|
|
3375
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
3376
|
+
module UnionMember8
|
|
3377
|
+
extend SafetyKit::Internal::Type::Union
|
|
3378
|
+
|
|
3379
|
+
discriminator :type
|
|
3380
|
+
|
|
3381
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
3382
|
+
variant :user_contact, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact }
|
|
3383
|
+
|
|
3384
|
+
# A user posts, uploads, publishes, edits, or replaces content.
|
|
3385
|
+
variant :content_uploaded, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded }
|
|
3386
|
+
|
|
3387
|
+
# A product listing is created, updated, or has a discount added.
|
|
3388
|
+
variant :product_changed, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged }
|
|
3389
|
+
|
|
3390
|
+
# A user or account is created.
|
|
3391
|
+
variant :create_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount }
|
|
3392
|
+
|
|
3393
|
+
# A user or account profile, contact detail, payment detail, or public bio changes.
|
|
3394
|
+
variant :update_account, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount }
|
|
3395
|
+
|
|
3396
|
+
# 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.
|
|
3397
|
+
variant :user_report, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport }
|
|
3398
|
+
|
|
3399
|
+
# A user appeals a moderation action taken against them. Use user_id for the appealing user, appealed_decision_id to reference the decision being appealed, and content and content_id for the appeal itself.
|
|
3400
|
+
variant :appeal, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal }
|
|
3401
|
+
|
|
3402
|
+
# 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.
|
|
3403
|
+
variant :moderation_decision,
|
|
3404
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision }
|
|
3405
|
+
|
|
3406
|
+
class UserContact < SafetyKit::Internal::Type::BaseModel
|
|
3407
|
+
# @!attribute event_name
|
|
3408
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
3409
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
3410
|
+
#
|
|
3411
|
+
# @return [String]
|
|
3412
|
+
required :event_name, String
|
|
3413
|
+
|
|
3414
|
+
# @!attribute target_user_id
|
|
3415
|
+
# Your stable canonical identifier for the other user in a user-to-user
|
|
3416
|
+
# interaction.
|
|
3417
|
+
#
|
|
3418
|
+
# @return [String]
|
|
3419
|
+
required :target_user_id, String
|
|
3420
|
+
|
|
3421
|
+
# @!attribute timestamp
|
|
3422
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
3423
|
+
#
|
|
3424
|
+
# @return [Time]
|
|
3425
|
+
required :timestamp, Time
|
|
3426
|
+
|
|
3427
|
+
# @!attribute type
|
|
3428
|
+
#
|
|
3429
|
+
# @return [Symbol, :user_contact]
|
|
3430
|
+
required :type, const: :user_contact
|
|
3431
|
+
|
|
3432
|
+
# @!attribute user_id
|
|
3433
|
+
# Your stable canonical identifier for the user or account.
|
|
3434
|
+
#
|
|
3435
|
+
# @return [String]
|
|
3436
|
+
required :user_id, String
|
|
3437
|
+
|
|
3438
|
+
# @!attribute client_info
|
|
3439
|
+
# Client context observed by your backend for the user action that triggered the
|
|
3440
|
+
# event.
|
|
3441
|
+
#
|
|
3442
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ClientInfo, nil]
|
|
3443
|
+
optional :client_info,
|
|
3444
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::ClientInfo }
|
|
3445
|
+
|
|
3446
|
+
# @!attribute content
|
|
3447
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3448
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
3449
|
+
# analyze.
|
|
3450
|
+
#
|
|
3451
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent>, nil]
|
|
3452
|
+
optional :content,
|
|
3453
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content] }
|
|
3454
|
+
|
|
3455
|
+
# @!attribute content_id
|
|
3456
|
+
# Your stable identifier for the content involved in this event, such as a
|
|
3457
|
+
# message, listing, page, post, profile, or uploaded media item.
|
|
3458
|
+
#
|
|
3459
|
+
# @return [String, nil]
|
|
3460
|
+
optional :content_id, String
|
|
3461
|
+
|
|
3462
|
+
# @!attribute idempotency_key
|
|
3463
|
+
# Optional caller-provided key used to make retries of this individual event
|
|
3464
|
+
# idempotent. Reuse the same key only for retries of the same logical event.
|
|
3465
|
+
#
|
|
3466
|
+
# @return [String, nil]
|
|
3467
|
+
optional :idempotency_key, String
|
|
3468
|
+
|
|
3469
|
+
# @!attribute metadata
|
|
3470
|
+
# Non-PII product context for filtering, segmentation, and debugging. Values may
|
|
3471
|
+
# be strings, numbers, booleans, or arrays of those scalar values.
|
|
3472
|
+
#
|
|
3473
|
+
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
3474
|
+
optional :metadata,
|
|
3475
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::Metadata] }
|
|
3476
|
+
|
|
3477
|
+
# @!attribute resources_used
|
|
3478
|
+
# Reusable resources observed during the event. Use this for emails, phone
|
|
3479
|
+
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3480
|
+
# caller-defined ids, or similar identifiers.
|
|
3481
|
+
#
|
|
3482
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::UnionMember1>, nil]
|
|
3483
|
+
optional :resources_used,
|
|
3484
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed] }
|
|
3485
|
+
|
|
3486
|
+
# @!method initialize(event_name:, target_user_id:, timestamp:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :user_contact)
|
|
3487
|
+
# Some parameter documentations has been truncated, see
|
|
3488
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact}
|
|
3489
|
+
# for more details.
|
|
3490
|
+
#
|
|
3491
|
+
# A user contacts, transacts with, or otherwise interacts with another user.
|
|
3492
|
+
#
|
|
3493
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
3494
|
+
#
|
|
3495
|
+
# @param target_user_id [String] Your stable canonical identifier for the other user in a user-to-user interactio
|
|
3496
|
+
#
|
|
3497
|
+
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
3498
|
+
#
|
|
3499
|
+
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
3500
|
+
#
|
|
3501
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
3502
|
+
#
|
|
3503
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3504
|
+
#
|
|
3505
|
+
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
3506
|
+
#
|
|
3507
|
+
# @param idempotency_key [String] Optional caller-provided key used to make retries of this individual event idemp
|
|
3508
|
+
#
|
|
3509
|
+
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3510
|
+
#
|
|
3511
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3512
|
+
#
|
|
3513
|
+
# @param type [Symbol, :user_contact]
|
|
3514
|
+
|
|
3515
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact#client_info
|
|
3516
|
+
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
3517
|
+
# @!attribute ip
|
|
3518
|
+
# IP address observed by your backend for the client that triggered the event.
|
|
3519
|
+
#
|
|
3520
|
+
# @return [String, nil]
|
|
3521
|
+
optional :ip, String
|
|
3522
|
+
|
|
3523
|
+
# @!method initialize(ip: nil)
|
|
3524
|
+
# Client context observed by your backend for the user action that triggered the
|
|
3525
|
+
# event.
|
|
3526
|
+
#
|
|
3527
|
+
# @param ip [String] IP address observed by your backend for the client that triggered the event.
|
|
3528
|
+
end
|
|
3529
|
+
|
|
3530
|
+
# User-authored text content associated with an event.
|
|
3531
|
+
module Content
|
|
3532
|
+
extend SafetyKit::Internal::Type::Union
|
|
3533
|
+
|
|
3534
|
+
# User-authored text content associated with an event.
|
|
3535
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventTextContent }
|
|
3536
|
+
|
|
3537
|
+
# User-uploaded image content associated with an event.
|
|
3538
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent }
|
|
3539
|
+
|
|
3540
|
+
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
3541
|
+
# @!attribute text
|
|
3542
|
+
# User-authored text SafetyKit should compare or analyze.
|
|
3543
|
+
#
|
|
3544
|
+
# @return [String]
|
|
3545
|
+
required :text, String
|
|
3546
|
+
|
|
3547
|
+
# @!attribute type
|
|
3548
|
+
# Text content part.
|
|
3549
|
+
#
|
|
3550
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventTextContent::Type]
|
|
3551
|
+
required :type,
|
|
3552
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventTextContent::Type }
|
|
3553
|
+
|
|
3554
|
+
# @!attribute key
|
|
3555
|
+
# Stable field key for this content part.
|
|
3556
|
+
#
|
|
3557
|
+
# @return [String, nil]
|
|
3558
|
+
optional :key, String
|
|
3559
|
+
|
|
3560
|
+
# @!method initialize(text:, type:, key: nil)
|
|
3561
|
+
# User-authored text content associated with an event.
|
|
3562
|
+
#
|
|
3563
|
+
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
3564
|
+
#
|
|
3565
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventTextContent::Type] Text content part.
|
|
3566
|
+
#
|
|
3567
|
+
# @param key [String] Stable field key for this content part.
|
|
3568
|
+
|
|
3569
|
+
# Text content part.
|
|
3570
|
+
#
|
|
3571
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventTextContent#type
|
|
3572
|
+
module Type
|
|
3573
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3574
|
+
|
|
3575
|
+
TEXT = :text
|
|
3576
|
+
|
|
3577
|
+
# @!method self.values
|
|
3578
|
+
# @return [Array<Symbol>]
|
|
3579
|
+
end
|
|
3580
|
+
end
|
|
3581
|
+
|
|
3582
|
+
class EventImageContent < SafetyKit::Internal::Type::BaseModel
|
|
3583
|
+
# @!attribute source
|
|
3584
|
+
# Image source information.
|
|
3585
|
+
#
|
|
3586
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Source]
|
|
3587
|
+
required :source,
|
|
3588
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Source }
|
|
3589
|
+
|
|
3590
|
+
# @!attribute type
|
|
3591
|
+
# Image content part.
|
|
3592
|
+
#
|
|
3593
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Type]
|
|
3594
|
+
required :type,
|
|
3595
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Type }
|
|
3596
|
+
|
|
3597
|
+
# @!attribute key
|
|
3598
|
+
# Stable field key for this content part.
|
|
3599
|
+
#
|
|
3600
|
+
# @return [String, nil]
|
|
3601
|
+
optional :key, String
|
|
3602
|
+
|
|
3603
|
+
# @!method initialize(source:, type:, key: nil)
|
|
3604
|
+
# User-uploaded image content associated with an event.
|
|
3605
|
+
#
|
|
3606
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Source] Image source information.
|
|
3607
|
+
#
|
|
3608
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Type] Image content part.
|
|
3609
|
+
#
|
|
3610
|
+
# @param key [String] Stable field key for this content part.
|
|
3611
|
+
|
|
3612
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent#source
|
|
3613
|
+
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3614
|
+
# @!attribute type
|
|
3615
|
+
# URL image source.
|
|
3616
|
+
#
|
|
3617
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Source::Type]
|
|
3618
|
+
required :type,
|
|
3619
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Source::Type }
|
|
3620
|
+
|
|
3621
|
+
# @!attribute url
|
|
3622
|
+
# URL of the image SafetyKit should compare or analyze.
|
|
3623
|
+
#
|
|
3624
|
+
# @return [String]
|
|
3625
|
+
required :url, String
|
|
3626
|
+
|
|
3627
|
+
# @!method initialize(type:, url:)
|
|
3628
|
+
# Image source information.
|
|
3629
|
+
#
|
|
3630
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Source::Type] URL image source.
|
|
3631
|
+
#
|
|
3632
|
+
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3633
|
+
|
|
3634
|
+
# URL image source.
|
|
3635
|
+
#
|
|
3636
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent::Source#type
|
|
3637
|
+
module Type
|
|
3638
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3639
|
+
|
|
3640
|
+
URL = :url
|
|
3641
|
+
|
|
3642
|
+
# @!method self.values
|
|
3643
|
+
# @return [Array<Symbol>]
|
|
3644
|
+
end
|
|
3645
|
+
end
|
|
3646
|
+
|
|
3647
|
+
# Image content part.
|
|
3648
|
+
#
|
|
3649
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent#type
|
|
3650
|
+
module Type
|
|
3651
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3652
|
+
|
|
3653
|
+
IMAGE = :image
|
|
3654
|
+
|
|
3655
|
+
# @!method self.values
|
|
3656
|
+
# @return [Array<Symbol>]
|
|
3657
|
+
end
|
|
3658
|
+
end
|
|
3659
|
+
|
|
3660
|
+
# @!method self.variants
|
|
3661
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Content::EventImageContent)]
|
|
3662
|
+
end
|
|
3663
|
+
|
|
3664
|
+
module Metadata
|
|
3665
|
+
extend SafetyKit::Internal::Type::Union
|
|
3666
|
+
|
|
3667
|
+
variant String
|
|
3668
|
+
|
|
3669
|
+
variant Float
|
|
3670
|
+
|
|
3671
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
3672
|
+
|
|
3673
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::Metadata::UnionMember3Array }
|
|
3674
|
+
|
|
3675
|
+
module UnionMember3
|
|
3676
|
+
extend SafetyKit::Internal::Type::Union
|
|
3677
|
+
|
|
3678
|
+
variant String
|
|
3679
|
+
|
|
3680
|
+
variant Float
|
|
3681
|
+
|
|
3682
|
+
variant SafetyKit::Internal::Type::Boolean
|
|
3683
|
+
|
|
3684
|
+
# @!method self.variants
|
|
3685
|
+
# @return [Array(String, Float, Boolean)]
|
|
3686
|
+
end
|
|
3687
|
+
|
|
3688
|
+
# @!method self.variants
|
|
3689
|
+
# @return [Array(String, Float, Boolean, Array<String, Float, Boolean>)]
|
|
3690
|
+
|
|
3691
|
+
# @type [SafetyKit::Internal::Type::Converter]
|
|
3692
|
+
UnionMember3Array =
|
|
3693
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
3694
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::Metadata::UnionMember3
|
|
3695
|
+
}]
|
|
3696
|
+
end
|
|
3697
|
+
|
|
3698
|
+
# Real-world, account, social, or caller-defined resource used during the event.
|
|
3699
|
+
module ResourcesUsed
|
|
3700
|
+
extend SafetyKit::Internal::Type::Union
|
|
3701
|
+
|
|
3702
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3703
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::EntityIDResource }
|
|
3704
|
+
|
|
3705
|
+
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
3706
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::UnionMember1 }
|
|
3707
|
+
|
|
3708
|
+
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
3709
|
+
# @!attribute namespace
|
|
3710
|
+
# Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3711
|
+
# urlEncode(namespace) + '/' + urlEncode(value).
|
|
3712
|
+
#
|
|
3713
|
+
# @return [String]
|
|
3714
|
+
required :namespace, String
|
|
3715
|
+
|
|
3716
|
+
# @!attribute type
|
|
3717
|
+
# Caller-defined entity identifier resource.
|
|
3718
|
+
#
|
|
3719
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::EntityIDResource::Type]
|
|
3720
|
+
required :type,
|
|
3721
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::EntityIDResource::Type }
|
|
3722
|
+
|
|
3723
|
+
# @!attribute value
|
|
3724
|
+
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
3725
|
+
# encoded namespace/value pair, not the raw value.
|
|
3726
|
+
#
|
|
3727
|
+
# @return [String]
|
|
3728
|
+
required :value, String
|
|
3729
|
+
|
|
3730
|
+
# @!method initialize(namespace:, type:, value:)
|
|
3731
|
+
# Some parameter documentations has been truncated, see
|
|
3732
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::EntityIDResource}
|
|
3733
|
+
# for more details.
|
|
3734
|
+
#
|
|
3735
|
+
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
3736
|
+
# resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3737
|
+
#
|
|
3738
|
+
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3739
|
+
#
|
|
3740
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
3741
|
+
#
|
|
3742
|
+
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
3743
|
+
|
|
3744
|
+
# Caller-defined entity identifier resource.
|
|
3745
|
+
#
|
|
3746
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::EntityIDResource#type
|
|
3747
|
+
module Type
|
|
3748
|
+
extend SafetyKit::Internal::Type::Enum
|
|
3749
|
+
|
|
3750
|
+
ID = :id
|
|
3751
|
+
|
|
3752
|
+
# @!method self.values
|
|
3753
|
+
# @return [Array<Symbol>]
|
|
3754
|
+
end
|
|
3755
|
+
end
|
|
3756
|
+
|
|
3757
|
+
class UnionMember1 < SafetyKit::Internal::Type::BaseModel
|
|
3758
|
+
# @!attribute type
|
|
3759
|
+
# Resource family, such as email, phone, name, address, url, social handles,
|
|
3760
|
+
# payment identifiers, or another stable snake_case identifier. Use the entity ID
|
|
3761
|
+
# resource shape when the value belongs to a caller-defined namespace.
|
|
3762
|
+
#
|
|
3763
|
+
# @return [String]
|
|
3764
|
+
required :type, String
|
|
3765
|
+
|
|
3766
|
+
# @!attribute value
|
|
3767
|
+
# Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
3768
|
+
# value, not the raw value. When type is url, this must be a valid URL.
|
|
3769
|
+
#
|
|
3770
|
+
# @return [String]
|
|
3771
|
+
required :value, String
|
|
3772
|
+
|
|
3773
|
+
# @!method initialize(type:, value:)
|
|
3774
|
+
# Some parameter documentations has been truncated, see
|
|
3775
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::UnionMember1}
|
|
3776
|
+
# for more details.
|
|
3777
|
+
#
|
|
3778
|
+
# Real-world or account resource used during the event, such as an email, phone
|
|
3779
|
+
# number, address, URL, social handle, or payment identifier.
|
|
3780
|
+
#
|
|
3781
|
+
# @param type [String] Resource family, such as email, phone, name, address, url, social handles, payme
|
|
3782
|
+
#
|
|
3783
|
+
# @param value [String] Resource value used during the event. SafetyKit stores a normalized hash of this
|
|
3784
|
+
end
|
|
3785
|
+
|
|
3786
|
+
# @!method self.variants
|
|
3787
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact::ResourcesUsed::UnionMember1)]
|
|
3788
|
+
end
|
|
3789
|
+
end
|
|
3790
|
+
|
|
3791
|
+
class ContentUploaded < SafetyKit::Internal::Type::BaseModel
|
|
3792
|
+
# @!attribute content
|
|
3793
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3794
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
3795
|
+
# analyze.
|
|
3796
|
+
#
|
|
3797
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent>]
|
|
3798
|
+
required :content,
|
|
3799
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content] }
|
|
3800
|
+
|
|
3801
|
+
# @!attribute event_name
|
|
3802
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
3803
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
3804
|
+
#
|
|
3805
|
+
# @return [String]
|
|
3806
|
+
required :event_name, String
|
|
3807
|
+
|
|
3808
|
+
# @!attribute timestamp
|
|
3809
|
+
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
3810
|
+
#
|
|
3811
|
+
# @return [Time]
|
|
3812
|
+
required :timestamp, Time
|
|
3813
|
+
|
|
3814
|
+
# @!attribute type
|
|
3815
|
+
#
|
|
3816
|
+
# @return [Symbol, :content_uploaded]
|
|
3817
|
+
required :type, const: :content_uploaded
|
|
3818
|
+
|
|
3819
|
+
# @!attribute user_id
|
|
3030
3820
|
# Your stable canonical identifier for the user or account.
|
|
3031
3821
|
#
|
|
3032
3822
|
# @return [String]
|
|
@@ -3036,18 +3826,9 @@ module SafetyKit
|
|
|
3036
3826
|
# Client context observed by your backend for the user action that triggered the
|
|
3037
3827
|
# event.
|
|
3038
3828
|
#
|
|
3039
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3829
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ClientInfo, nil]
|
|
3040
3830
|
optional :client_info,
|
|
3041
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3042
|
-
|
|
3043
|
-
# @!attribute content
|
|
3044
|
-
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3045
|
-
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
3046
|
-
# analyze.
|
|
3047
|
-
#
|
|
3048
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content::EventImageContent>, nil]
|
|
3049
|
-
optional :content,
|
|
3050
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserContact::Content] }
|
|
3831
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ClientInfo }
|
|
3051
3832
|
|
|
3052
3833
|
# @!attribute content_id
|
|
3053
3834
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -3069,35 +3850,33 @@ module SafetyKit
|
|
|
3069
3850
|
#
|
|
3070
3851
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
3071
3852
|
optional :metadata,
|
|
3072
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3853
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Metadata] }
|
|
3073
3854
|
|
|
3074
3855
|
# @!attribute resources_used
|
|
3075
3856
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3076
3857
|
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3077
3858
|
# caller-defined ids, or similar identifiers.
|
|
3078
3859
|
#
|
|
3079
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3860
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::UnionMember1>, nil]
|
|
3080
3861
|
optional :resources_used,
|
|
3081
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
3862
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed] }
|
|
3082
3863
|
|
|
3083
|
-
# @!method initialize(
|
|
3864
|
+
# @!method initialize(content:, event_name:, timestamp:, user_id:, client_info: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :content_uploaded)
|
|
3084
3865
|
# Some parameter documentations has been truncated, see
|
|
3085
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3866
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded}
|
|
3086
3867
|
# for more details.
|
|
3087
3868
|
#
|
|
3088
|
-
# A user
|
|
3869
|
+
# A user posts, uploads, publishes, edits, or replaces content.
|
|
3089
3870
|
#
|
|
3090
|
-
# @param
|
|
3871
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3091
3872
|
#
|
|
3092
|
-
# @param
|
|
3873
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
3093
3874
|
#
|
|
3094
3875
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
3095
3876
|
#
|
|
3096
3877
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
3097
3878
|
#
|
|
3098
|
-
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3099
|
-
#
|
|
3100
|
-
# @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,
|
|
3879
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
3101
3880
|
#
|
|
3102
3881
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
3103
3882
|
#
|
|
@@ -3105,34 +3884,19 @@ module SafetyKit
|
|
|
3105
3884
|
#
|
|
3106
3885
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3107
3886
|
#
|
|
3108
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3887
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3109
3888
|
#
|
|
3110
|
-
# @param type [Symbol, :
|
|
3111
|
-
|
|
3112
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact#client_info
|
|
3113
|
-
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
3114
|
-
# @!attribute ip
|
|
3115
|
-
# IP address observed by your backend for the client that triggered the event.
|
|
3116
|
-
#
|
|
3117
|
-
# @return [String, nil]
|
|
3118
|
-
optional :ip, String
|
|
3119
|
-
|
|
3120
|
-
# @!method initialize(ip: nil)
|
|
3121
|
-
# Client context observed by your backend for the user action that triggered the
|
|
3122
|
-
# event.
|
|
3123
|
-
#
|
|
3124
|
-
# @param ip [String] IP address observed by your backend for the client that triggered the event.
|
|
3125
|
-
end
|
|
3889
|
+
# @param type [Symbol, :content_uploaded]
|
|
3126
3890
|
|
|
3127
3891
|
# User-authored text content associated with an event.
|
|
3128
3892
|
module Content
|
|
3129
3893
|
extend SafetyKit::Internal::Type::Union
|
|
3130
3894
|
|
|
3131
3895
|
# User-authored text content associated with an event.
|
|
3132
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3896
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventTextContent }
|
|
3133
3897
|
|
|
3134
3898
|
# User-uploaded image content associated with an event.
|
|
3135
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3899
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent }
|
|
3136
3900
|
|
|
3137
3901
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
3138
3902
|
# @!attribute text
|
|
@@ -3144,9 +3908,9 @@ module SafetyKit
|
|
|
3144
3908
|
# @!attribute type
|
|
3145
3909
|
# Text content part.
|
|
3146
3910
|
#
|
|
3147
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3911
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventTextContent::Type]
|
|
3148
3912
|
required :type,
|
|
3149
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3913
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventTextContent::Type }
|
|
3150
3914
|
|
|
3151
3915
|
# @!attribute key
|
|
3152
3916
|
# Stable field key for this content part.
|
|
@@ -3159,13 +3923,13 @@ module SafetyKit
|
|
|
3159
3923
|
#
|
|
3160
3924
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
3161
3925
|
#
|
|
3162
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3926
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventTextContent::Type] Text content part.
|
|
3163
3927
|
#
|
|
3164
3928
|
# @param key [String] Stable field key for this content part.
|
|
3165
3929
|
|
|
3166
3930
|
# Text content part.
|
|
3167
3931
|
#
|
|
3168
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3932
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventTextContent#type
|
|
3169
3933
|
module Type
|
|
3170
3934
|
extend SafetyKit::Internal::Type::Enum
|
|
3171
3935
|
|
|
@@ -3180,16 +3944,16 @@ module SafetyKit
|
|
|
3180
3944
|
# @!attribute source
|
|
3181
3945
|
# Image source information.
|
|
3182
3946
|
#
|
|
3183
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3947
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Source]
|
|
3184
3948
|
required :source,
|
|
3185
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3949
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Source }
|
|
3186
3950
|
|
|
3187
3951
|
# @!attribute type
|
|
3188
3952
|
# Image content part.
|
|
3189
3953
|
#
|
|
3190
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3954
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Type]
|
|
3191
3955
|
required :type,
|
|
3192
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3956
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Type }
|
|
3193
3957
|
|
|
3194
3958
|
# @!attribute key
|
|
3195
3959
|
# Stable field key for this content part.
|
|
@@ -3200,20 +3964,20 @@ module SafetyKit
|
|
|
3200
3964
|
# @!method initialize(source:, type:, key: nil)
|
|
3201
3965
|
# User-uploaded image content associated with an event.
|
|
3202
3966
|
#
|
|
3203
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3967
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Source] Image source information.
|
|
3204
3968
|
#
|
|
3205
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3969
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Type] Image content part.
|
|
3206
3970
|
#
|
|
3207
3971
|
# @param key [String] Stable field key for this content part.
|
|
3208
3972
|
|
|
3209
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3973
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent#source
|
|
3210
3974
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3211
3975
|
# @!attribute type
|
|
3212
3976
|
# URL image source.
|
|
3213
3977
|
#
|
|
3214
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3978
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Source::Type]
|
|
3215
3979
|
required :type,
|
|
3216
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
3980
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Source::Type }
|
|
3217
3981
|
|
|
3218
3982
|
# @!attribute url
|
|
3219
3983
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -3224,13 +3988,13 @@ module SafetyKit
|
|
|
3224
3988
|
# @!method initialize(type:, url:)
|
|
3225
3989
|
# Image source information.
|
|
3226
3990
|
#
|
|
3227
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3991
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Source::Type] URL image source.
|
|
3228
3992
|
#
|
|
3229
3993
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3230
3994
|
|
|
3231
3995
|
# URL image source.
|
|
3232
3996
|
#
|
|
3233
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
3997
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent::Source#type
|
|
3234
3998
|
module Type
|
|
3235
3999
|
extend SafetyKit::Internal::Type::Enum
|
|
3236
4000
|
|
|
@@ -3243,7 +4007,7 @@ module SafetyKit
|
|
|
3243
4007
|
|
|
3244
4008
|
# Image content part.
|
|
3245
4009
|
#
|
|
3246
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4010
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent#type
|
|
3247
4011
|
module Type
|
|
3248
4012
|
extend SafetyKit::Internal::Type::Enum
|
|
3249
4013
|
|
|
@@ -3255,7 +4019,22 @@ module SafetyKit
|
|
|
3255
4019
|
end
|
|
3256
4020
|
|
|
3257
4021
|
# @!method self.variants
|
|
3258
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4022
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Content::EventImageContent)]
|
|
4023
|
+
end
|
|
4024
|
+
|
|
4025
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded#client_info
|
|
4026
|
+
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
4027
|
+
# @!attribute ip
|
|
4028
|
+
# IP address observed by your backend for the client that triggered the event.
|
|
4029
|
+
#
|
|
4030
|
+
# @return [String, nil]
|
|
4031
|
+
optional :ip, String
|
|
4032
|
+
|
|
4033
|
+
# @!method initialize(ip: nil)
|
|
4034
|
+
# Client context observed by your backend for the user action that triggered the
|
|
4035
|
+
# event.
|
|
4036
|
+
#
|
|
4037
|
+
# @param ip [String] IP address observed by your backend for the client that triggered the event.
|
|
3259
4038
|
end
|
|
3260
4039
|
|
|
3261
4040
|
module Metadata
|
|
@@ -3267,7 +4046,7 @@ module SafetyKit
|
|
|
3267
4046
|
|
|
3268
4047
|
variant SafetyKit::Internal::Type::Boolean
|
|
3269
4048
|
|
|
3270
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4049
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Metadata::UnionMember3Array }
|
|
3271
4050
|
|
|
3272
4051
|
module UnionMember3
|
|
3273
4052
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -3287,9 +4066,9 @@ module SafetyKit
|
|
|
3287
4066
|
|
|
3288
4067
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3289
4068
|
UnionMember3Array =
|
|
3290
|
-
SafetyKit::Internal::Type::ArrayOf[
|
|
3291
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
3292
|
-
|
|
4069
|
+
SafetyKit::Internal::Type::ArrayOf[
|
|
4070
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::Metadata::UnionMember3 }
|
|
4071
|
+
]
|
|
3293
4072
|
end
|
|
3294
4073
|
|
|
3295
4074
|
# Real-world, account, social, or caller-defined resource used during the event.
|
|
@@ -3297,10 +4076,10 @@ module SafetyKit
|
|
|
3297
4076
|
extend SafetyKit::Internal::Type::Union
|
|
3298
4077
|
|
|
3299
4078
|
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3300
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4079
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::EntityIDResource }
|
|
3301
4080
|
|
|
3302
4081
|
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
3303
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4082
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::UnionMember1 }
|
|
3304
4083
|
|
|
3305
4084
|
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
3306
4085
|
# @!attribute namespace
|
|
@@ -3313,9 +4092,9 @@ module SafetyKit
|
|
|
3313
4092
|
# @!attribute type
|
|
3314
4093
|
# Caller-defined entity identifier resource.
|
|
3315
4094
|
#
|
|
3316
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4095
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::EntityIDResource::Type]
|
|
3317
4096
|
required :type,
|
|
3318
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4097
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::EntityIDResource::Type }
|
|
3319
4098
|
|
|
3320
4099
|
# @!attribute value
|
|
3321
4100
|
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
@@ -3326,7 +4105,7 @@ module SafetyKit
|
|
|
3326
4105
|
|
|
3327
4106
|
# @!method initialize(namespace:, type:, value:)
|
|
3328
4107
|
# Some parameter documentations has been truncated, see
|
|
3329
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4108
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::EntityIDResource}
|
|
3330
4109
|
# for more details.
|
|
3331
4110
|
#
|
|
3332
4111
|
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
@@ -3334,13 +4113,13 @@ module SafetyKit
|
|
|
3334
4113
|
#
|
|
3335
4114
|
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3336
4115
|
#
|
|
3337
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4116
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
3338
4117
|
#
|
|
3339
4118
|
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
3340
4119
|
|
|
3341
4120
|
# Caller-defined entity identifier resource.
|
|
3342
4121
|
#
|
|
3343
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4122
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::EntityIDResource#type
|
|
3344
4123
|
module Type
|
|
3345
4124
|
extend SafetyKit::Internal::Type::Enum
|
|
3346
4125
|
|
|
@@ -3369,7 +4148,7 @@ module SafetyKit
|
|
|
3369
4148
|
|
|
3370
4149
|
# @!method initialize(type:, value:)
|
|
3371
4150
|
# Some parameter documentations has been truncated, see
|
|
3372
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4151
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::UnionMember1}
|
|
3373
4152
|
# for more details.
|
|
3374
4153
|
#
|
|
3375
4154
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -3381,26 +4160,32 @@ module SafetyKit
|
|
|
3381
4160
|
end
|
|
3382
4161
|
|
|
3383
4162
|
# @!method self.variants
|
|
3384
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4163
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded::ResourcesUsed::UnionMember1)]
|
|
3385
4164
|
end
|
|
3386
4165
|
end
|
|
3387
4166
|
|
|
3388
|
-
class
|
|
4167
|
+
class ProductChanged < SafetyKit::Internal::Type::BaseModel
|
|
3389
4168
|
# @!attribute content
|
|
3390
4169
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3391
4170
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
3392
4171
|
# analyze.
|
|
3393
4172
|
#
|
|
3394
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4173
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent>]
|
|
3395
4174
|
required :content,
|
|
3396
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4175
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content] }
|
|
3397
4176
|
|
|
3398
4177
|
# @!attribute event_name
|
|
3399
|
-
#
|
|
3400
|
-
# values in typed fields, content, resources_used, or metadata.
|
|
4178
|
+
# Product action that triggered this event.
|
|
3401
4179
|
#
|
|
3402
|
-
# @return [
|
|
3403
|
-
required :event_name,
|
|
4180
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::EventName]
|
|
4181
|
+
required :event_name,
|
|
4182
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::EventName }
|
|
4183
|
+
|
|
4184
|
+
# @!attribute product
|
|
4185
|
+
# Commerce details for the product involved in this event.
|
|
4186
|
+
#
|
|
4187
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product]
|
|
4188
|
+
required :product, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product }
|
|
3404
4189
|
|
|
3405
4190
|
# @!attribute timestamp
|
|
3406
4191
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
@@ -3410,8 +4195,8 @@ module SafetyKit
|
|
|
3410
4195
|
|
|
3411
4196
|
# @!attribute type
|
|
3412
4197
|
#
|
|
3413
|
-
# @return [Symbol, :
|
|
3414
|
-
required :type, const: :
|
|
4198
|
+
# @return [Symbol, :product_changed]
|
|
4199
|
+
required :type, const: :product_changed
|
|
3415
4200
|
|
|
3416
4201
|
# @!attribute user_id
|
|
3417
4202
|
# Your stable canonical identifier for the user or account.
|
|
@@ -3423,9 +4208,9 @@ module SafetyKit
|
|
|
3423
4208
|
# Client context observed by your backend for the user action that triggered the
|
|
3424
4209
|
# event.
|
|
3425
4210
|
#
|
|
3426
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4211
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ClientInfo, nil]
|
|
3427
4212
|
optional :client_info,
|
|
3428
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4213
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ClientInfo }
|
|
3429
4214
|
|
|
3430
4215
|
# @!attribute content_id
|
|
3431
4216
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -3447,33 +4232,35 @@ module SafetyKit
|
|
|
3447
4232
|
#
|
|
3448
4233
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
3449
4234
|
optional :metadata,
|
|
3450
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4235
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Metadata] }
|
|
3451
4236
|
|
|
3452
4237
|
# @!attribute resources_used
|
|
3453
4238
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3454
4239
|
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3455
4240
|
# caller-defined ids, or similar identifiers.
|
|
3456
4241
|
#
|
|
3457
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4242
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::UnionMember1>, nil]
|
|
3458
4243
|
optional :resources_used,
|
|
3459
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4244
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed] }
|
|
3460
4245
|
|
|
3461
|
-
# @!method initialize(content:, event_name:, timestamp:, user_id:, client_info: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :
|
|
4246
|
+
# @!method initialize(content:, event_name:, product:, timestamp:, user_id:, client_info: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :product_changed)
|
|
3462
4247
|
# Some parameter documentations has been truncated, see
|
|
3463
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4248
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged}
|
|
3464
4249
|
# for more details.
|
|
3465
4250
|
#
|
|
3466
|
-
# A
|
|
4251
|
+
# A product listing is created, updated, or has a discount added.
|
|
3467
4252
|
#
|
|
3468
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4253
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3469
4254
|
#
|
|
3470
|
-
# @param event_name [
|
|
4255
|
+
# @param event_name [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::EventName] Product action that triggered this event.
|
|
4256
|
+
#
|
|
4257
|
+
# @param product [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product] Commerce details for the product involved in this event.
|
|
3471
4258
|
#
|
|
3472
4259
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
3473
4260
|
#
|
|
3474
4261
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
3475
4262
|
#
|
|
3476
|
-
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4263
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
3477
4264
|
#
|
|
3478
4265
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
3479
4266
|
#
|
|
@@ -3481,19 +4268,19 @@ module SafetyKit
|
|
|
3481
4268
|
#
|
|
3482
4269
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3483
4270
|
#
|
|
3484
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4271
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3485
4272
|
#
|
|
3486
|
-
# @param type [Symbol, :
|
|
4273
|
+
# @param type [Symbol, :product_changed]
|
|
3487
4274
|
|
|
3488
4275
|
# User-authored text content associated with an event.
|
|
3489
4276
|
module Content
|
|
3490
4277
|
extend SafetyKit::Internal::Type::Union
|
|
3491
4278
|
|
|
3492
4279
|
# User-authored text content associated with an event.
|
|
3493
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4280
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventTextContent }
|
|
3494
4281
|
|
|
3495
4282
|
# User-uploaded image content associated with an event.
|
|
3496
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4283
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent }
|
|
3497
4284
|
|
|
3498
4285
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
3499
4286
|
# @!attribute text
|
|
@@ -3505,9 +4292,9 @@ module SafetyKit
|
|
|
3505
4292
|
# @!attribute type
|
|
3506
4293
|
# Text content part.
|
|
3507
4294
|
#
|
|
3508
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4295
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventTextContent::Type]
|
|
3509
4296
|
required :type,
|
|
3510
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4297
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventTextContent::Type }
|
|
3511
4298
|
|
|
3512
4299
|
# @!attribute key
|
|
3513
4300
|
# Stable field key for this content part.
|
|
@@ -3520,13 +4307,13 @@ module SafetyKit
|
|
|
3520
4307
|
#
|
|
3521
4308
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
3522
4309
|
#
|
|
3523
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4310
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventTextContent::Type] Text content part.
|
|
3524
4311
|
#
|
|
3525
4312
|
# @param key [String] Stable field key for this content part.
|
|
3526
4313
|
|
|
3527
4314
|
# Text content part.
|
|
3528
4315
|
#
|
|
3529
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4316
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventTextContent#type
|
|
3530
4317
|
module Type
|
|
3531
4318
|
extend SafetyKit::Internal::Type::Enum
|
|
3532
4319
|
|
|
@@ -3541,16 +4328,16 @@ module SafetyKit
|
|
|
3541
4328
|
# @!attribute source
|
|
3542
4329
|
# Image source information.
|
|
3543
4330
|
#
|
|
3544
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4331
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Source]
|
|
3545
4332
|
required :source,
|
|
3546
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4333
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Source }
|
|
3547
4334
|
|
|
3548
4335
|
# @!attribute type
|
|
3549
4336
|
# Image content part.
|
|
3550
4337
|
#
|
|
3551
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4338
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Type]
|
|
3552
4339
|
required :type,
|
|
3553
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4340
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Type }
|
|
3554
4341
|
|
|
3555
4342
|
# @!attribute key
|
|
3556
4343
|
# Stable field key for this content part.
|
|
@@ -3561,20 +4348,20 @@ module SafetyKit
|
|
|
3561
4348
|
# @!method initialize(source:, type:, key: nil)
|
|
3562
4349
|
# User-uploaded image content associated with an event.
|
|
3563
4350
|
#
|
|
3564
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4351
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Source] Image source information.
|
|
3565
4352
|
#
|
|
3566
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4353
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Type] Image content part.
|
|
3567
4354
|
#
|
|
3568
4355
|
# @param key [String] Stable field key for this content part.
|
|
3569
4356
|
|
|
3570
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4357
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent#source
|
|
3571
4358
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3572
4359
|
# @!attribute type
|
|
3573
4360
|
# URL image source.
|
|
3574
4361
|
#
|
|
3575
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4362
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Source::Type]
|
|
3576
4363
|
required :type,
|
|
3577
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4364
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Source::Type }
|
|
3578
4365
|
|
|
3579
4366
|
# @!attribute url
|
|
3580
4367
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -3585,13 +4372,13 @@ module SafetyKit
|
|
|
3585
4372
|
# @!method initialize(type:, url:)
|
|
3586
4373
|
# Image source information.
|
|
3587
4374
|
#
|
|
3588
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4375
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Source::Type] URL image source.
|
|
3589
4376
|
#
|
|
3590
4377
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3591
4378
|
|
|
3592
4379
|
# URL image source.
|
|
3593
4380
|
#
|
|
3594
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4381
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent::Source#type
|
|
3595
4382
|
module Type
|
|
3596
4383
|
extend SafetyKit::Internal::Type::Enum
|
|
3597
4384
|
|
|
@@ -3604,7 +4391,7 @@ module SafetyKit
|
|
|
3604
4391
|
|
|
3605
4392
|
# Image content part.
|
|
3606
4393
|
#
|
|
3607
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4394
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent#type
|
|
3608
4395
|
module Type
|
|
3609
4396
|
extend SafetyKit::Internal::Type::Enum
|
|
3610
4397
|
|
|
@@ -3616,10 +4403,122 @@ module SafetyKit
|
|
|
3616
4403
|
end
|
|
3617
4404
|
|
|
3618
4405
|
# @!method self.variants
|
|
3619
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4406
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Content::EventImageContent)]
|
|
4407
|
+
end
|
|
4408
|
+
|
|
4409
|
+
# Product action that triggered this event.
|
|
4410
|
+
#
|
|
4411
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged#event_name
|
|
4412
|
+
module EventName
|
|
4413
|
+
extend SafetyKit::Internal::Type::Enum
|
|
4414
|
+
|
|
4415
|
+
PRODUCT_CREATED = :product_created
|
|
4416
|
+
PRODUCT_UPDATED = :product_updated
|
|
4417
|
+
|
|
4418
|
+
# @!method self.values
|
|
4419
|
+
# @return [Array<Symbol>]
|
|
4420
|
+
end
|
|
4421
|
+
|
|
4422
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged#product
|
|
4423
|
+
class Product < SafetyKit::Internal::Type::BaseModel
|
|
4424
|
+
# @!attribute price
|
|
4425
|
+
# Current listed price of the product.
|
|
4426
|
+
#
|
|
4427
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product::Price]
|
|
4428
|
+
required :price,
|
|
4429
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product::Price }
|
|
4430
|
+
|
|
4431
|
+
# @!attribute discounted_price
|
|
4432
|
+
# Discounted price of the product, when a discount applies.
|
|
4433
|
+
#
|
|
4434
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product::DiscountedPrice, nil]
|
|
4435
|
+
optional :discounted_price,
|
|
4436
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product::DiscountedPrice }
|
|
4437
|
+
|
|
4438
|
+
# @!attribute shipping_info
|
|
4439
|
+
# Shipping details for the product.
|
|
4440
|
+
#
|
|
4441
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product::ShippingInfo, nil]
|
|
4442
|
+
optional :shipping_info,
|
|
4443
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product::ShippingInfo }
|
|
4444
|
+
|
|
4445
|
+
# @!method initialize(price:, discounted_price: nil, shipping_info: nil)
|
|
4446
|
+
# Commerce details for the product involved in this event.
|
|
4447
|
+
#
|
|
4448
|
+
# @param price [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product::Price] Current listed price of the product.
|
|
4449
|
+
#
|
|
4450
|
+
# @param discounted_price [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product::DiscountedPrice] Discounted price of the product, when a discount applies.
|
|
4451
|
+
#
|
|
4452
|
+
# @param shipping_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product::ShippingInfo] Shipping details for the product.
|
|
4453
|
+
|
|
4454
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product#price
|
|
4455
|
+
class Price < SafetyKit::Internal::Type::BaseModel
|
|
4456
|
+
# @!attribute amount
|
|
4457
|
+
# Price amount as a decimal string.
|
|
4458
|
+
#
|
|
4459
|
+
# @return [String]
|
|
4460
|
+
required :amount, String
|
|
4461
|
+
|
|
4462
|
+
# @!attribute currency
|
|
4463
|
+
# ISO 4217 currency code.
|
|
4464
|
+
#
|
|
4465
|
+
# @return [String]
|
|
4466
|
+
required :currency, String
|
|
4467
|
+
|
|
4468
|
+
# @!method initialize(amount:, currency:)
|
|
4469
|
+
# Current listed price of the product.
|
|
4470
|
+
#
|
|
4471
|
+
# @param amount [String] Price amount as a decimal string.
|
|
4472
|
+
#
|
|
4473
|
+
# @param currency [String] ISO 4217 currency code.
|
|
4474
|
+
end
|
|
4475
|
+
|
|
4476
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product#discounted_price
|
|
4477
|
+
class DiscountedPrice < SafetyKit::Internal::Type::BaseModel
|
|
4478
|
+
# @!attribute amount
|
|
4479
|
+
# Price amount as a decimal string.
|
|
4480
|
+
#
|
|
4481
|
+
# @return [String]
|
|
4482
|
+
required :amount, String
|
|
4483
|
+
|
|
4484
|
+
# @!attribute currency
|
|
4485
|
+
# ISO 4217 currency code.
|
|
4486
|
+
#
|
|
4487
|
+
# @return [String]
|
|
4488
|
+
required :currency, String
|
|
4489
|
+
|
|
4490
|
+
# @!method initialize(amount:, currency:)
|
|
4491
|
+
# Discounted price of the product, when a discount applies.
|
|
4492
|
+
#
|
|
4493
|
+
# @param amount [String] Price amount as a decimal string.
|
|
4494
|
+
#
|
|
4495
|
+
# @param currency [String] ISO 4217 currency code.
|
|
4496
|
+
end
|
|
4497
|
+
|
|
4498
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Product#shipping_info
|
|
4499
|
+
class ShippingInfo < SafetyKit::Internal::Type::BaseModel
|
|
4500
|
+
# @!attribute ships_from
|
|
4501
|
+
# Location the product ships from.
|
|
4502
|
+
#
|
|
4503
|
+
# @return [String]
|
|
4504
|
+
required :ships_from, String
|
|
4505
|
+
|
|
4506
|
+
# @!attribute ships_to
|
|
4507
|
+
# Locations the product ships to.
|
|
4508
|
+
#
|
|
4509
|
+
# @return [Array<String>]
|
|
4510
|
+
required :ships_to, SafetyKit::Internal::Type::ArrayOf[String]
|
|
4511
|
+
|
|
4512
|
+
# @!method initialize(ships_from:, ships_to:)
|
|
4513
|
+
# Shipping details for the product.
|
|
4514
|
+
#
|
|
4515
|
+
# @param ships_from [String] Location the product ships from.
|
|
4516
|
+
#
|
|
4517
|
+
# @param ships_to [Array<String>] Locations the product ships to.
|
|
4518
|
+
end
|
|
3620
4519
|
end
|
|
3621
4520
|
|
|
3622
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4521
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged#client_info
|
|
3623
4522
|
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
3624
4523
|
# @!attribute ip
|
|
3625
4524
|
# IP address observed by your backend for the client that triggered the event.
|
|
@@ -3643,7 +4542,7 @@ module SafetyKit
|
|
|
3643
4542
|
|
|
3644
4543
|
variant SafetyKit::Internal::Type::Boolean
|
|
3645
4544
|
|
|
3646
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4545
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Metadata::UnionMember3Array }
|
|
3647
4546
|
|
|
3648
4547
|
module UnionMember3
|
|
3649
4548
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -3664,7 +4563,7 @@ module SafetyKit
|
|
|
3664
4563
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
3665
4564
|
UnionMember3Array =
|
|
3666
4565
|
SafetyKit::Internal::Type::ArrayOf[
|
|
3667
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4566
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::Metadata::UnionMember3 }
|
|
3668
4567
|
]
|
|
3669
4568
|
end
|
|
3670
4569
|
|
|
@@ -3673,10 +4572,10 @@ module SafetyKit
|
|
|
3673
4572
|
extend SafetyKit::Internal::Type::Union
|
|
3674
4573
|
|
|
3675
4574
|
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
3676
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4575
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::EntityIDResource }
|
|
3677
4576
|
|
|
3678
4577
|
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
3679
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4578
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::UnionMember1 }
|
|
3680
4579
|
|
|
3681
4580
|
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
3682
4581
|
# @!attribute namespace
|
|
@@ -3689,9 +4588,9 @@ module SafetyKit
|
|
|
3689
4588
|
# @!attribute type
|
|
3690
4589
|
# Caller-defined entity identifier resource.
|
|
3691
4590
|
#
|
|
3692
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4591
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::EntityIDResource::Type]
|
|
3693
4592
|
required :type,
|
|
3694
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4593
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::EntityIDResource::Type }
|
|
3695
4594
|
|
|
3696
4595
|
# @!attribute value
|
|
3697
4596
|
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
@@ -3702,7 +4601,7 @@ module SafetyKit
|
|
|
3702
4601
|
|
|
3703
4602
|
# @!method initialize(namespace:, type:, value:)
|
|
3704
4603
|
# Some parameter documentations has been truncated, see
|
|
3705
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4604
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::EntityIDResource}
|
|
3706
4605
|
# for more details.
|
|
3707
4606
|
#
|
|
3708
4607
|
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
@@ -3710,13 +4609,13 @@ module SafetyKit
|
|
|
3710
4609
|
#
|
|
3711
4610
|
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
3712
4611
|
#
|
|
3713
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4612
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
3714
4613
|
#
|
|
3715
4614
|
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
3716
4615
|
|
|
3717
4616
|
# Caller-defined entity identifier resource.
|
|
3718
4617
|
#
|
|
3719
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4618
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::EntityIDResource#type
|
|
3720
4619
|
module Type
|
|
3721
4620
|
extend SafetyKit::Internal::Type::Enum
|
|
3722
4621
|
|
|
@@ -3745,7 +4644,7 @@ module SafetyKit
|
|
|
3745
4644
|
|
|
3746
4645
|
# @!method initialize(type:, value:)
|
|
3747
4646
|
# Some parameter documentations has been truncated, see
|
|
3748
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4647
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::UnionMember1}
|
|
3749
4648
|
# for more details.
|
|
3750
4649
|
#
|
|
3751
4650
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -3757,32 +4656,17 @@ module SafetyKit
|
|
|
3757
4656
|
end
|
|
3758
4657
|
|
|
3759
4658
|
# @!method self.variants
|
|
3760
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4659
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged::ResourcesUsed::UnionMember1)]
|
|
3761
4660
|
end
|
|
3762
|
-
end
|
|
3763
|
-
|
|
3764
|
-
class ProductChanged < SafetyKit::Internal::Type::BaseModel
|
|
3765
|
-
# @!attribute content
|
|
3766
|
-
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3767
|
-
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
3768
|
-
# analyze.
|
|
3769
|
-
#
|
|
3770
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content::EventImageContent>]
|
|
3771
|
-
required :content,
|
|
3772
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Content] }
|
|
4661
|
+
end
|
|
3773
4662
|
|
|
4663
|
+
class CreateAccount < SafetyKit::Internal::Type::BaseModel
|
|
3774
4664
|
# @!attribute event_name
|
|
3775
|
-
#
|
|
3776
|
-
#
|
|
3777
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::EventName]
|
|
3778
|
-
required :event_name,
|
|
3779
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::EventName }
|
|
3780
|
-
|
|
3781
|
-
# @!attribute product
|
|
3782
|
-
# Commerce details for the product involved in this event.
|
|
4665
|
+
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
4666
|
+
# values in typed fields, content, resources_used, or metadata.
|
|
3783
4667
|
#
|
|
3784
|
-
# @return [
|
|
3785
|
-
required :
|
|
4668
|
+
# @return [String]
|
|
4669
|
+
required :event_name, String
|
|
3786
4670
|
|
|
3787
4671
|
# @!attribute timestamp
|
|
3788
4672
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
@@ -3792,8 +4676,8 @@ module SafetyKit
|
|
|
3792
4676
|
|
|
3793
4677
|
# @!attribute type
|
|
3794
4678
|
#
|
|
3795
|
-
# @return [Symbol, :
|
|
3796
|
-
required :type, const: :
|
|
4679
|
+
# @return [Symbol, :create_account]
|
|
4680
|
+
required :type, const: :create_account
|
|
3797
4681
|
|
|
3798
4682
|
# @!attribute user_id
|
|
3799
4683
|
# Your stable canonical identifier for the user or account.
|
|
@@ -3805,9 +4689,18 @@ module SafetyKit
|
|
|
3805
4689
|
# Client context observed by your backend for the user action that triggered the
|
|
3806
4690
|
# event.
|
|
3807
4691
|
#
|
|
3808
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4692
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ClientInfo, nil]
|
|
3809
4693
|
optional :client_info,
|
|
3810
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4694
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ClientInfo }
|
|
4695
|
+
|
|
4696
|
+
# @!attribute content
|
|
4697
|
+
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
4698
|
+
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
4699
|
+
# analyze.
|
|
4700
|
+
#
|
|
4701
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent>, nil]
|
|
4702
|
+
optional :content,
|
|
4703
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content] }
|
|
3811
4704
|
|
|
3812
4705
|
# @!attribute content_id
|
|
3813
4706
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -3829,35 +4722,33 @@ module SafetyKit
|
|
|
3829
4722
|
#
|
|
3830
4723
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
3831
4724
|
optional :metadata,
|
|
3832
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4725
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Metadata] }
|
|
3833
4726
|
|
|
3834
4727
|
# @!attribute resources_used
|
|
3835
4728
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
3836
4729
|
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
3837
4730
|
# caller-defined ids, or similar identifiers.
|
|
3838
4731
|
#
|
|
3839
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4732
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::UnionMember1>, nil]
|
|
3840
4733
|
optional :resources_used,
|
|
3841
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
4734
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed] }
|
|
3842
4735
|
|
|
3843
|
-
# @!method initialize(
|
|
4736
|
+
# @!method initialize(event_name:, timestamp:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :create_account)
|
|
3844
4737
|
# Some parameter documentations has been truncated, see
|
|
3845
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4738
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount}
|
|
3846
4739
|
# for more details.
|
|
3847
4740
|
#
|
|
3848
|
-
# A
|
|
3849
|
-
#
|
|
3850
|
-
# @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,
|
|
3851
|
-
#
|
|
3852
|
-
# @param event_name [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::EventName] Product action that triggered this event.
|
|
4741
|
+
# A user or account is created.
|
|
3853
4742
|
#
|
|
3854
|
-
# @param
|
|
4743
|
+
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
3855
4744
|
#
|
|
3856
4745
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
3857
4746
|
#
|
|
3858
4747
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
3859
4748
|
#
|
|
3860
|
-
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4749
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
4750
|
+
#
|
|
4751
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
3861
4752
|
#
|
|
3862
4753
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
3863
4754
|
#
|
|
@@ -3865,19 +4756,34 @@ module SafetyKit
|
|
|
3865
4756
|
#
|
|
3866
4757
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
3867
4758
|
#
|
|
3868
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4759
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
3869
4760
|
#
|
|
3870
|
-
# @param type [Symbol, :
|
|
4761
|
+
# @param type [Symbol, :create_account]
|
|
4762
|
+
|
|
4763
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount#client_info
|
|
4764
|
+
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
4765
|
+
# @!attribute ip
|
|
4766
|
+
# IP address observed by your backend for the client that triggered the event.
|
|
4767
|
+
#
|
|
4768
|
+
# @return [String, nil]
|
|
4769
|
+
optional :ip, String
|
|
4770
|
+
|
|
4771
|
+
# @!method initialize(ip: nil)
|
|
4772
|
+
# Client context observed by your backend for the user action that triggered the
|
|
4773
|
+
# event.
|
|
4774
|
+
#
|
|
4775
|
+
# @param ip [String] IP address observed by your backend for the client that triggered the event.
|
|
4776
|
+
end
|
|
3871
4777
|
|
|
3872
4778
|
# User-authored text content associated with an event.
|
|
3873
4779
|
module Content
|
|
3874
4780
|
extend SafetyKit::Internal::Type::Union
|
|
3875
4781
|
|
|
3876
4782
|
# User-authored text content associated with an event.
|
|
3877
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4783
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventTextContent }
|
|
3878
4784
|
|
|
3879
4785
|
# User-uploaded image content associated with an event.
|
|
3880
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4786
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent }
|
|
3881
4787
|
|
|
3882
4788
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
3883
4789
|
# @!attribute text
|
|
@@ -3889,9 +4795,9 @@ module SafetyKit
|
|
|
3889
4795
|
# @!attribute type
|
|
3890
4796
|
# Text content part.
|
|
3891
4797
|
#
|
|
3892
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4798
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventTextContent::Type]
|
|
3893
4799
|
required :type,
|
|
3894
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4800
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventTextContent::Type }
|
|
3895
4801
|
|
|
3896
4802
|
# @!attribute key
|
|
3897
4803
|
# Stable field key for this content part.
|
|
@@ -3904,13 +4810,13 @@ module SafetyKit
|
|
|
3904
4810
|
#
|
|
3905
4811
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
3906
4812
|
#
|
|
3907
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4813
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventTextContent::Type] Text content part.
|
|
3908
4814
|
#
|
|
3909
4815
|
# @param key [String] Stable field key for this content part.
|
|
3910
4816
|
|
|
3911
4817
|
# Text content part.
|
|
3912
4818
|
#
|
|
3913
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4819
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventTextContent#type
|
|
3914
4820
|
module Type
|
|
3915
4821
|
extend SafetyKit::Internal::Type::Enum
|
|
3916
4822
|
|
|
@@ -3925,16 +4831,16 @@ module SafetyKit
|
|
|
3925
4831
|
# @!attribute source
|
|
3926
4832
|
# Image source information.
|
|
3927
4833
|
#
|
|
3928
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4834
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Source]
|
|
3929
4835
|
required :source,
|
|
3930
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4836
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Source }
|
|
3931
4837
|
|
|
3932
4838
|
# @!attribute type
|
|
3933
4839
|
# Image content part.
|
|
3934
4840
|
#
|
|
3935
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4841
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Type]
|
|
3936
4842
|
required :type,
|
|
3937
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4843
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Type }
|
|
3938
4844
|
|
|
3939
4845
|
# @!attribute key
|
|
3940
4846
|
# Stable field key for this content part.
|
|
@@ -3945,20 +4851,20 @@ module SafetyKit
|
|
|
3945
4851
|
# @!method initialize(source:, type:, key: nil)
|
|
3946
4852
|
# User-uploaded image content associated with an event.
|
|
3947
4853
|
#
|
|
3948
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4854
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Source] Image source information.
|
|
3949
4855
|
#
|
|
3950
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4856
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Type] Image content part.
|
|
3951
4857
|
#
|
|
3952
4858
|
# @param key [String] Stable field key for this content part.
|
|
3953
4859
|
|
|
3954
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4860
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent#source
|
|
3955
4861
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
3956
4862
|
# @!attribute type
|
|
3957
4863
|
# URL image source.
|
|
3958
4864
|
#
|
|
3959
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4865
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Source::Type]
|
|
3960
4866
|
required :type,
|
|
3961
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4867
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Source::Type }
|
|
3962
4868
|
|
|
3963
4869
|
# @!attribute url
|
|
3964
4870
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -3969,13 +4875,13 @@ module SafetyKit
|
|
|
3969
4875
|
# @!method initialize(type:, url:)
|
|
3970
4876
|
# Image source information.
|
|
3971
4877
|
#
|
|
3972
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4878
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
3973
4879
|
#
|
|
3974
4880
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
3975
4881
|
|
|
3976
4882
|
# URL image source.
|
|
3977
4883
|
#
|
|
3978
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4884
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent::Source#type
|
|
3979
4885
|
module Type
|
|
3980
4886
|
extend SafetyKit::Internal::Type::Enum
|
|
3981
4887
|
|
|
@@ -3988,7 +4894,7 @@ module SafetyKit
|
|
|
3988
4894
|
|
|
3989
4895
|
# Image content part.
|
|
3990
4896
|
#
|
|
3991
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4897
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent#type
|
|
3992
4898
|
module Type
|
|
3993
4899
|
extend SafetyKit::Internal::Type::Enum
|
|
3994
4900
|
|
|
@@ -4000,134 +4906,7 @@ module SafetyKit
|
|
|
4000
4906
|
end
|
|
4001
4907
|
|
|
4002
4908
|
# @!method self.variants
|
|
4003
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4004
|
-
end
|
|
4005
|
-
|
|
4006
|
-
# Product action that triggered this event.
|
|
4007
|
-
#
|
|
4008
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged#event_name
|
|
4009
|
-
module EventName
|
|
4010
|
-
extend SafetyKit::Internal::Type::Enum
|
|
4011
|
-
|
|
4012
|
-
PRODUCT_CREATED = :product_created
|
|
4013
|
-
PRODUCT_UPDATED = :product_updated
|
|
4014
|
-
|
|
4015
|
-
# @!method self.values
|
|
4016
|
-
# @return [Array<Symbol>]
|
|
4017
|
-
end
|
|
4018
|
-
|
|
4019
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged#product
|
|
4020
|
-
class Product < SafetyKit::Internal::Type::BaseModel
|
|
4021
|
-
# @!attribute price
|
|
4022
|
-
# Current listed price of the product.
|
|
4023
|
-
#
|
|
4024
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::Price]
|
|
4025
|
-
required :price,
|
|
4026
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::Price }
|
|
4027
|
-
|
|
4028
|
-
# @!attribute discounted_price
|
|
4029
|
-
# Discounted price of the product, when a discount applies.
|
|
4030
|
-
#
|
|
4031
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::DiscountedPrice, nil]
|
|
4032
|
-
optional :discounted_price,
|
|
4033
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::DiscountedPrice }
|
|
4034
|
-
|
|
4035
|
-
# @!attribute shipping_info
|
|
4036
|
-
# Shipping details for the product.
|
|
4037
|
-
#
|
|
4038
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::ShippingInfo, nil]
|
|
4039
|
-
optional :shipping_info,
|
|
4040
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::ShippingInfo }
|
|
4041
|
-
|
|
4042
|
-
# @!method initialize(price:, discounted_price: nil, shipping_info: nil)
|
|
4043
|
-
# Commerce details for the product involved in this event.
|
|
4044
|
-
#
|
|
4045
|
-
# @param price [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::Price] Current listed price of the product.
|
|
4046
|
-
#
|
|
4047
|
-
# @param discounted_price [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::DiscountedPrice] Discounted price of the product, when a discount applies.
|
|
4048
|
-
#
|
|
4049
|
-
# @param shipping_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product::ShippingInfo] Shipping details for the product.
|
|
4050
|
-
|
|
4051
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product#price
|
|
4052
|
-
class Price < SafetyKit::Internal::Type::BaseModel
|
|
4053
|
-
# @!attribute amount
|
|
4054
|
-
# Price amount as a decimal string.
|
|
4055
|
-
#
|
|
4056
|
-
# @return [String]
|
|
4057
|
-
required :amount, String
|
|
4058
|
-
|
|
4059
|
-
# @!attribute currency
|
|
4060
|
-
# ISO 4217 currency code.
|
|
4061
|
-
#
|
|
4062
|
-
# @return [String]
|
|
4063
|
-
required :currency, String
|
|
4064
|
-
|
|
4065
|
-
# @!method initialize(amount:, currency:)
|
|
4066
|
-
# Current listed price of the product.
|
|
4067
|
-
#
|
|
4068
|
-
# @param amount [String] Price amount as a decimal string.
|
|
4069
|
-
#
|
|
4070
|
-
# @param currency [String] ISO 4217 currency code.
|
|
4071
|
-
end
|
|
4072
|
-
|
|
4073
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product#discounted_price
|
|
4074
|
-
class DiscountedPrice < SafetyKit::Internal::Type::BaseModel
|
|
4075
|
-
# @!attribute amount
|
|
4076
|
-
# Price amount as a decimal string.
|
|
4077
|
-
#
|
|
4078
|
-
# @return [String]
|
|
4079
|
-
required :amount, String
|
|
4080
|
-
|
|
4081
|
-
# @!attribute currency
|
|
4082
|
-
# ISO 4217 currency code.
|
|
4083
|
-
#
|
|
4084
|
-
# @return [String]
|
|
4085
|
-
required :currency, String
|
|
4086
|
-
|
|
4087
|
-
# @!method initialize(amount:, currency:)
|
|
4088
|
-
# Discounted price of the product, when a discount applies.
|
|
4089
|
-
#
|
|
4090
|
-
# @param amount [String] Price amount as a decimal string.
|
|
4091
|
-
#
|
|
4092
|
-
# @param currency [String] ISO 4217 currency code.
|
|
4093
|
-
end
|
|
4094
|
-
|
|
4095
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged::Product#shipping_info
|
|
4096
|
-
class ShippingInfo < SafetyKit::Internal::Type::BaseModel
|
|
4097
|
-
# @!attribute ships_from
|
|
4098
|
-
# Location the product ships from.
|
|
4099
|
-
#
|
|
4100
|
-
# @return [String]
|
|
4101
|
-
required :ships_from, String
|
|
4102
|
-
|
|
4103
|
-
# @!attribute ships_to
|
|
4104
|
-
# Locations the product ships to.
|
|
4105
|
-
#
|
|
4106
|
-
# @return [Array<String>]
|
|
4107
|
-
required :ships_to, SafetyKit::Internal::Type::ArrayOf[String]
|
|
4108
|
-
|
|
4109
|
-
# @!method initialize(ships_from:, ships_to:)
|
|
4110
|
-
# Shipping details for the product.
|
|
4111
|
-
#
|
|
4112
|
-
# @param ships_from [String] Location the product ships from.
|
|
4113
|
-
#
|
|
4114
|
-
# @param ships_to [Array<String>] Locations the product ships to.
|
|
4115
|
-
end
|
|
4116
|
-
end
|
|
4117
|
-
|
|
4118
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged#client_info
|
|
4119
|
-
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
4120
|
-
# @!attribute ip
|
|
4121
|
-
# IP address observed by your backend for the client that triggered the event.
|
|
4122
|
-
#
|
|
4123
|
-
# @return [String, nil]
|
|
4124
|
-
optional :ip, String
|
|
4125
|
-
|
|
4126
|
-
# @!method initialize(ip: nil)
|
|
4127
|
-
# Client context observed by your backend for the user action that triggered the
|
|
4128
|
-
# event.
|
|
4129
|
-
#
|
|
4130
|
-
# @param ip [String] IP address observed by your backend for the client that triggered the event.
|
|
4909
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Content::EventImageContent)]
|
|
4131
4910
|
end
|
|
4132
4911
|
|
|
4133
4912
|
module Metadata
|
|
@@ -4139,7 +4918,7 @@ module SafetyKit
|
|
|
4139
4918
|
|
|
4140
4919
|
variant SafetyKit::Internal::Type::Boolean
|
|
4141
4920
|
|
|
4142
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4921
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Metadata::UnionMember3Array }
|
|
4143
4922
|
|
|
4144
4923
|
module UnionMember3
|
|
4145
4924
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -4160,7 +4939,7 @@ module SafetyKit
|
|
|
4160
4939
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
4161
4940
|
UnionMember3Array =
|
|
4162
4941
|
SafetyKit::Internal::Type::ArrayOf[
|
|
4163
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4942
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::Metadata::UnionMember3 }
|
|
4164
4943
|
]
|
|
4165
4944
|
end
|
|
4166
4945
|
|
|
@@ -4169,10 +4948,10 @@ module SafetyKit
|
|
|
4169
4948
|
extend SafetyKit::Internal::Type::Union
|
|
4170
4949
|
|
|
4171
4950
|
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
4172
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4951
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::EntityIDResource }
|
|
4173
4952
|
|
|
4174
4953
|
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
4175
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4954
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::UnionMember1 }
|
|
4176
4955
|
|
|
4177
4956
|
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
4178
4957
|
# @!attribute namespace
|
|
@@ -4185,9 +4964,9 @@ module SafetyKit
|
|
|
4185
4964
|
# @!attribute type
|
|
4186
4965
|
# Caller-defined entity identifier resource.
|
|
4187
4966
|
#
|
|
4188
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4967
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::EntityIDResource::Type]
|
|
4189
4968
|
required :type,
|
|
4190
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
4969
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::EntityIDResource::Type }
|
|
4191
4970
|
|
|
4192
4971
|
# @!attribute value
|
|
4193
4972
|
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
@@ -4198,7 +4977,7 @@ module SafetyKit
|
|
|
4198
4977
|
|
|
4199
4978
|
# @!method initialize(namespace:, type:, value:)
|
|
4200
4979
|
# Some parameter documentations has been truncated, see
|
|
4201
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4980
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::EntityIDResource}
|
|
4202
4981
|
# for more details.
|
|
4203
4982
|
#
|
|
4204
4983
|
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
@@ -4206,13 +4985,13 @@ module SafetyKit
|
|
|
4206
4985
|
#
|
|
4207
4986
|
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
4208
4987
|
#
|
|
4209
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4988
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
4210
4989
|
#
|
|
4211
4990
|
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
4212
4991
|
|
|
4213
4992
|
# Caller-defined entity identifier resource.
|
|
4214
4993
|
#
|
|
4215
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4994
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::EntityIDResource#type
|
|
4216
4995
|
module Type
|
|
4217
4996
|
extend SafetyKit::Internal::Type::Enum
|
|
4218
4997
|
|
|
@@ -4241,7 +5020,7 @@ module SafetyKit
|
|
|
4241
5020
|
|
|
4242
5021
|
# @!method initialize(type:, value:)
|
|
4243
5022
|
# Some parameter documentations has been truncated, see
|
|
4244
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5023
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::UnionMember1}
|
|
4245
5024
|
# for more details.
|
|
4246
5025
|
#
|
|
4247
5026
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -4253,11 +5032,11 @@ module SafetyKit
|
|
|
4253
5032
|
end
|
|
4254
5033
|
|
|
4255
5034
|
# @!method self.variants
|
|
4256
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5035
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount::ResourcesUsed::UnionMember1)]
|
|
4257
5036
|
end
|
|
4258
5037
|
end
|
|
4259
5038
|
|
|
4260
|
-
class
|
|
5039
|
+
class UpdateAccount < SafetyKit::Internal::Type::BaseModel
|
|
4261
5040
|
# @!attribute event_name
|
|
4262
5041
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
4263
5042
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -4273,8 +5052,8 @@ module SafetyKit
|
|
|
4273
5052
|
|
|
4274
5053
|
# @!attribute type
|
|
4275
5054
|
#
|
|
4276
|
-
# @return [Symbol, :
|
|
4277
|
-
required :type, const: :
|
|
5055
|
+
# @return [Symbol, :update_account]
|
|
5056
|
+
required :type, const: :update_account
|
|
4278
5057
|
|
|
4279
5058
|
# @!attribute user_id
|
|
4280
5059
|
# Your stable canonical identifier for the user or account.
|
|
@@ -4286,18 +5065,18 @@ module SafetyKit
|
|
|
4286
5065
|
# Client context observed by your backend for the user action that triggered the
|
|
4287
5066
|
# event.
|
|
4288
5067
|
#
|
|
4289
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5068
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ClientInfo, nil]
|
|
4290
5069
|
optional :client_info,
|
|
4291
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5070
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ClientInfo }
|
|
4292
5071
|
|
|
4293
5072
|
# @!attribute content
|
|
4294
5073
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
4295
5074
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
4296
5075
|
# analyze.
|
|
4297
5076
|
#
|
|
4298
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5077
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent>, nil]
|
|
4299
5078
|
optional :content,
|
|
4300
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
5079
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content] }
|
|
4301
5080
|
|
|
4302
5081
|
# @!attribute content_id
|
|
4303
5082
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -4319,23 +5098,24 @@ module SafetyKit
|
|
|
4319
5098
|
#
|
|
4320
5099
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
4321
5100
|
optional :metadata,
|
|
4322
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
5101
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Metadata] }
|
|
4323
5102
|
|
|
4324
5103
|
# @!attribute resources_used
|
|
4325
5104
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
4326
5105
|
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
4327
5106
|
# caller-defined ids, or similar identifiers.
|
|
4328
5107
|
#
|
|
4329
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5108
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::UnionMember1>, nil]
|
|
4330
5109
|
optional :resources_used,
|
|
4331
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
5110
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed] }
|
|
4332
5111
|
|
|
4333
|
-
# @!method initialize(event_name:, timestamp:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :
|
|
5112
|
+
# @!method initialize(event_name:, timestamp:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :update_account)
|
|
4334
5113
|
# Some parameter documentations has been truncated, see
|
|
4335
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5114
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount}
|
|
4336
5115
|
# for more details.
|
|
4337
5116
|
#
|
|
4338
|
-
# A user or account
|
|
5117
|
+
# A user or account profile, contact detail, payment detail, or public bio
|
|
5118
|
+
# changes.
|
|
4339
5119
|
#
|
|
4340
5120
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
4341
5121
|
#
|
|
@@ -4343,9 +5123,9 @@ module SafetyKit
|
|
|
4343
5123
|
#
|
|
4344
5124
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
4345
5125
|
#
|
|
4346
|
-
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5126
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
4347
5127
|
#
|
|
4348
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5128
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
4349
5129
|
#
|
|
4350
5130
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
4351
5131
|
#
|
|
@@ -4353,11 +5133,11 @@ module SafetyKit
|
|
|
4353
5133
|
#
|
|
4354
5134
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
4355
5135
|
#
|
|
4356
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5136
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
4357
5137
|
#
|
|
4358
|
-
# @param type [Symbol, :
|
|
5138
|
+
# @param type [Symbol, :update_account]
|
|
4359
5139
|
|
|
4360
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5140
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount#client_info
|
|
4361
5141
|
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
4362
5142
|
# @!attribute ip
|
|
4363
5143
|
# IP address observed by your backend for the client that triggered the event.
|
|
@@ -4377,10 +5157,10 @@ module SafetyKit
|
|
|
4377
5157
|
extend SafetyKit::Internal::Type::Union
|
|
4378
5158
|
|
|
4379
5159
|
# User-authored text content associated with an event.
|
|
4380
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5160
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventTextContent }
|
|
4381
5161
|
|
|
4382
5162
|
# User-uploaded image content associated with an event.
|
|
4383
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5163
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent }
|
|
4384
5164
|
|
|
4385
5165
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
4386
5166
|
# @!attribute text
|
|
@@ -4392,9 +5172,9 @@ module SafetyKit
|
|
|
4392
5172
|
# @!attribute type
|
|
4393
5173
|
# Text content part.
|
|
4394
5174
|
#
|
|
4395
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5175
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventTextContent::Type]
|
|
4396
5176
|
required :type,
|
|
4397
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5177
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventTextContent::Type }
|
|
4398
5178
|
|
|
4399
5179
|
# @!attribute key
|
|
4400
5180
|
# Stable field key for this content part.
|
|
@@ -4407,13 +5187,13 @@ module SafetyKit
|
|
|
4407
5187
|
#
|
|
4408
5188
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
4409
5189
|
#
|
|
4410
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5190
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventTextContent::Type] Text content part.
|
|
4411
5191
|
#
|
|
4412
5192
|
# @param key [String] Stable field key for this content part.
|
|
4413
5193
|
|
|
4414
5194
|
# Text content part.
|
|
4415
5195
|
#
|
|
4416
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5196
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventTextContent#type
|
|
4417
5197
|
module Type
|
|
4418
5198
|
extend SafetyKit::Internal::Type::Enum
|
|
4419
5199
|
|
|
@@ -4428,16 +5208,16 @@ module SafetyKit
|
|
|
4428
5208
|
# @!attribute source
|
|
4429
5209
|
# Image source information.
|
|
4430
5210
|
#
|
|
4431
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5211
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Source]
|
|
4432
5212
|
required :source,
|
|
4433
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5213
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Source }
|
|
4434
5214
|
|
|
4435
5215
|
# @!attribute type
|
|
4436
5216
|
# Image content part.
|
|
4437
5217
|
#
|
|
4438
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5218
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Type]
|
|
4439
5219
|
required :type,
|
|
4440
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5220
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Type }
|
|
4441
5221
|
|
|
4442
5222
|
# @!attribute key
|
|
4443
5223
|
# Stable field key for this content part.
|
|
@@ -4448,20 +5228,20 @@ module SafetyKit
|
|
|
4448
5228
|
# @!method initialize(source:, type:, key: nil)
|
|
4449
5229
|
# User-uploaded image content associated with an event.
|
|
4450
5230
|
#
|
|
4451
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5231
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Source] Image source information.
|
|
4452
5232
|
#
|
|
4453
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5233
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Type] Image content part.
|
|
4454
5234
|
#
|
|
4455
5235
|
# @param key [String] Stable field key for this content part.
|
|
4456
5236
|
|
|
4457
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5237
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent#source
|
|
4458
5238
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
4459
5239
|
# @!attribute type
|
|
4460
5240
|
# URL image source.
|
|
4461
5241
|
#
|
|
4462
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5242
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Source::Type]
|
|
4463
5243
|
required :type,
|
|
4464
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5244
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Source::Type }
|
|
4465
5245
|
|
|
4466
5246
|
# @!attribute url
|
|
4467
5247
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -4472,13 +5252,13 @@ module SafetyKit
|
|
|
4472
5252
|
# @!method initialize(type:, url:)
|
|
4473
5253
|
# Image source information.
|
|
4474
5254
|
#
|
|
4475
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5255
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Source::Type] URL image source.
|
|
4476
5256
|
#
|
|
4477
5257
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
4478
5258
|
|
|
4479
5259
|
# URL image source.
|
|
4480
5260
|
#
|
|
4481
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5261
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent::Source#type
|
|
4482
5262
|
module Type
|
|
4483
5263
|
extend SafetyKit::Internal::Type::Enum
|
|
4484
5264
|
|
|
@@ -4491,7 +5271,7 @@ module SafetyKit
|
|
|
4491
5271
|
|
|
4492
5272
|
# Image content part.
|
|
4493
5273
|
#
|
|
4494
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5274
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent#type
|
|
4495
5275
|
module Type
|
|
4496
5276
|
extend SafetyKit::Internal::Type::Enum
|
|
4497
5277
|
|
|
@@ -4503,7 +5283,7 @@ module SafetyKit
|
|
|
4503
5283
|
end
|
|
4504
5284
|
|
|
4505
5285
|
# @!method self.variants
|
|
4506
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5286
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Content::EventImageContent)]
|
|
4507
5287
|
end
|
|
4508
5288
|
|
|
4509
5289
|
module Metadata
|
|
@@ -4515,7 +5295,7 @@ module SafetyKit
|
|
|
4515
5295
|
|
|
4516
5296
|
variant SafetyKit::Internal::Type::Boolean
|
|
4517
5297
|
|
|
4518
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5298
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Metadata::UnionMember3Array }
|
|
4519
5299
|
|
|
4520
5300
|
module UnionMember3
|
|
4521
5301
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -4536,7 +5316,7 @@ module SafetyKit
|
|
|
4536
5316
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
4537
5317
|
UnionMember3Array =
|
|
4538
5318
|
SafetyKit::Internal::Type::ArrayOf[
|
|
4539
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5319
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::Metadata::UnionMember3 }
|
|
4540
5320
|
]
|
|
4541
5321
|
end
|
|
4542
5322
|
|
|
@@ -4545,10 +5325,10 @@ module SafetyKit
|
|
|
4545
5325
|
extend SafetyKit::Internal::Type::Union
|
|
4546
5326
|
|
|
4547
5327
|
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
4548
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5328
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::EntityIDResource }
|
|
4549
5329
|
|
|
4550
5330
|
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
4551
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5331
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::UnionMember1 }
|
|
4552
5332
|
|
|
4553
5333
|
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
4554
5334
|
# @!attribute namespace
|
|
@@ -4561,9 +5341,9 @@ module SafetyKit
|
|
|
4561
5341
|
# @!attribute type
|
|
4562
5342
|
# Caller-defined entity identifier resource.
|
|
4563
5343
|
#
|
|
4564
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5344
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::EntityIDResource::Type]
|
|
4565
5345
|
required :type,
|
|
4566
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5346
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::EntityIDResource::Type }
|
|
4567
5347
|
|
|
4568
5348
|
# @!attribute value
|
|
4569
5349
|
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
@@ -4574,7 +5354,7 @@ module SafetyKit
|
|
|
4574
5354
|
|
|
4575
5355
|
# @!method initialize(namespace:, type:, value:)
|
|
4576
5356
|
# Some parameter documentations has been truncated, see
|
|
4577
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5357
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::EntityIDResource}
|
|
4578
5358
|
# for more details.
|
|
4579
5359
|
#
|
|
4580
5360
|
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
@@ -4582,13 +5362,13 @@ module SafetyKit
|
|
|
4582
5362
|
#
|
|
4583
5363
|
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
4584
5364
|
#
|
|
4585
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5365
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
4586
5366
|
#
|
|
4587
5367
|
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
4588
5368
|
|
|
4589
5369
|
# Caller-defined entity identifier resource.
|
|
4590
5370
|
#
|
|
4591
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5371
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::EntityIDResource#type
|
|
4592
5372
|
module Type
|
|
4593
5373
|
extend SafetyKit::Internal::Type::Enum
|
|
4594
5374
|
|
|
@@ -4617,7 +5397,7 @@ module SafetyKit
|
|
|
4617
5397
|
|
|
4618
5398
|
# @!method initialize(type:, value:)
|
|
4619
5399
|
# Some parameter documentations has been truncated, see
|
|
4620
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5400
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::UnionMember1}
|
|
4621
5401
|
# for more details.
|
|
4622
5402
|
#
|
|
4623
5403
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -4629,11 +5409,11 @@ module SafetyKit
|
|
|
4629
5409
|
end
|
|
4630
5410
|
|
|
4631
5411
|
# @!method self.variants
|
|
4632
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5412
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount::ResourcesUsed::UnionMember1)]
|
|
4633
5413
|
end
|
|
4634
5414
|
end
|
|
4635
5415
|
|
|
4636
|
-
class
|
|
5416
|
+
class UserReport < SafetyKit::Internal::Type::BaseModel
|
|
4637
5417
|
# @!attribute event_name
|
|
4638
5418
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
4639
5419
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -4641,6 +5421,12 @@ module SafetyKit
|
|
|
4641
5421
|
# @return [String]
|
|
4642
5422
|
required :event_name, String
|
|
4643
5423
|
|
|
5424
|
+
# @!attribute labels
|
|
5425
|
+
# One or more label categories supplied with the report or moderation decision.
|
|
5426
|
+
#
|
|
5427
|
+
# @return [Array<String>]
|
|
5428
|
+
required :labels, SafetyKit::Internal::Type::ArrayOf[String]
|
|
5429
|
+
|
|
4644
5430
|
# @!attribute timestamp
|
|
4645
5431
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
4646
5432
|
#
|
|
@@ -4649,8 +5435,8 @@ module SafetyKit
|
|
|
4649
5435
|
|
|
4650
5436
|
# @!attribute type
|
|
4651
5437
|
#
|
|
4652
|
-
# @return [Symbol, :
|
|
4653
|
-
required :type, const: :
|
|
5438
|
+
# @return [Symbol, :user_report]
|
|
5439
|
+
required :type, const: :user_report
|
|
4654
5440
|
|
|
4655
5441
|
# @!attribute user_id
|
|
4656
5442
|
# Your stable canonical identifier for the user or account.
|
|
@@ -4662,18 +5448,18 @@ module SafetyKit
|
|
|
4662
5448
|
# Client context observed by your backend for the user action that triggered the
|
|
4663
5449
|
# event.
|
|
4664
5450
|
#
|
|
4665
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5451
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ClientInfo, nil]
|
|
4666
5452
|
optional :client_info,
|
|
4667
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5453
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::ClientInfo }
|
|
4668
5454
|
|
|
4669
5455
|
# @!attribute content
|
|
4670
5456
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
4671
5457
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
4672
5458
|
# analyze.
|
|
4673
5459
|
#
|
|
4674
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5460
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent>, nil]
|
|
4675
5461
|
optional :content,
|
|
4676
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
5462
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content] }
|
|
4677
5463
|
|
|
4678
5464
|
# @!attribute content_id
|
|
4679
5465
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -4695,34 +5481,50 @@ module SafetyKit
|
|
|
4695
5481
|
#
|
|
4696
5482
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
4697
5483
|
optional :metadata,
|
|
4698
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
5484
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::Metadata] }
|
|
4699
5485
|
|
|
4700
5486
|
# @!attribute resources_used
|
|
4701
5487
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
4702
5488
|
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
4703
5489
|
# caller-defined ids, or similar identifiers.
|
|
4704
5490
|
#
|
|
4705
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5491
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::UnionMember1>, nil]
|
|
4706
5492
|
optional :resources_used,
|
|
4707
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
5493
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed] }
|
|
4708
5494
|
|
|
4709
|
-
# @!
|
|
5495
|
+
# @!attribute target_content_id
|
|
5496
|
+
# Your stable identifier for the content being reported.
|
|
5497
|
+
#
|
|
5498
|
+
# @return [String, nil]
|
|
5499
|
+
optional :target_content_id, String
|
|
5500
|
+
|
|
5501
|
+
# @!attribute target_user_id
|
|
5502
|
+
# Your stable canonical identifier for the user being reported.
|
|
5503
|
+
#
|
|
5504
|
+
# @return [String, nil]
|
|
5505
|
+
optional :target_user_id, String
|
|
5506
|
+
|
|
5507
|
+
# @!method initialize(event_name:, labels:, timestamp:, user_id:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil, type: :user_report)
|
|
4710
5508
|
# Some parameter documentations has been truncated, see
|
|
4711
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
4712
|
-
#
|
|
5509
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport} for
|
|
5510
|
+
# more details.
|
|
4713
5511
|
#
|
|
4714
|
-
# A user
|
|
4715
|
-
#
|
|
5512
|
+
# A user-submitted report. Use user_id for the reporter. Include target_user_id
|
|
5513
|
+
# when a user is reported, target_content_id when content is reported, and both
|
|
5514
|
+
# when the report is about content associated with a user. Use content and
|
|
5515
|
+
# content_id for the report itself.
|
|
4716
5516
|
#
|
|
4717
5517
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
4718
5518
|
#
|
|
5519
|
+
# @param labels [Array<String>] One or more label categories supplied with the report or moderation decision.
|
|
5520
|
+
#
|
|
4719
5521
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
4720
5522
|
#
|
|
4721
5523
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
4722
5524
|
#
|
|
4723
|
-
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5525
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
4724
5526
|
#
|
|
4725
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5527
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
4726
5528
|
#
|
|
4727
5529
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
4728
5530
|
#
|
|
@@ -4730,11 +5532,15 @@ module SafetyKit
|
|
|
4730
5532
|
#
|
|
4731
5533
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
4732
5534
|
#
|
|
4733
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5535
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
4734
5536
|
#
|
|
4735
|
-
# @param
|
|
5537
|
+
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
5538
|
+
#
|
|
5539
|
+
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
5540
|
+
#
|
|
5541
|
+
# @param type [Symbol, :user_report]
|
|
4736
5542
|
|
|
4737
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5543
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport#client_info
|
|
4738
5544
|
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
4739
5545
|
# @!attribute ip
|
|
4740
5546
|
# IP address observed by your backend for the client that triggered the event.
|
|
@@ -4754,10 +5560,10 @@ module SafetyKit
|
|
|
4754
5560
|
extend SafetyKit::Internal::Type::Union
|
|
4755
5561
|
|
|
4756
5562
|
# User-authored text content associated with an event.
|
|
4757
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5563
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventTextContent }
|
|
4758
5564
|
|
|
4759
5565
|
# User-uploaded image content associated with an event.
|
|
4760
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5566
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent }
|
|
4761
5567
|
|
|
4762
5568
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
4763
5569
|
# @!attribute text
|
|
@@ -4769,9 +5575,9 @@ module SafetyKit
|
|
|
4769
5575
|
# @!attribute type
|
|
4770
5576
|
# Text content part.
|
|
4771
5577
|
#
|
|
4772
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5578
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventTextContent::Type]
|
|
4773
5579
|
required :type,
|
|
4774
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5580
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventTextContent::Type }
|
|
4775
5581
|
|
|
4776
5582
|
# @!attribute key
|
|
4777
5583
|
# Stable field key for this content part.
|
|
@@ -4784,13 +5590,13 @@ module SafetyKit
|
|
|
4784
5590
|
#
|
|
4785
5591
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
4786
5592
|
#
|
|
4787
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5593
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventTextContent::Type] Text content part.
|
|
4788
5594
|
#
|
|
4789
5595
|
# @param key [String] Stable field key for this content part.
|
|
4790
5596
|
|
|
4791
5597
|
# Text content part.
|
|
4792
5598
|
#
|
|
4793
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5599
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventTextContent#type
|
|
4794
5600
|
module Type
|
|
4795
5601
|
extend SafetyKit::Internal::Type::Enum
|
|
4796
5602
|
|
|
@@ -4805,16 +5611,16 @@ module SafetyKit
|
|
|
4805
5611
|
# @!attribute source
|
|
4806
5612
|
# Image source information.
|
|
4807
5613
|
#
|
|
4808
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5614
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Source]
|
|
4809
5615
|
required :source,
|
|
4810
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5616
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Source }
|
|
4811
5617
|
|
|
4812
5618
|
# @!attribute type
|
|
4813
5619
|
# Image content part.
|
|
4814
5620
|
#
|
|
4815
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5621
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Type]
|
|
4816
5622
|
required :type,
|
|
4817
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5623
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Type }
|
|
4818
5624
|
|
|
4819
5625
|
# @!attribute key
|
|
4820
5626
|
# Stable field key for this content part.
|
|
@@ -4825,20 +5631,20 @@ module SafetyKit
|
|
|
4825
5631
|
# @!method initialize(source:, type:, key: nil)
|
|
4826
5632
|
# User-uploaded image content associated with an event.
|
|
4827
5633
|
#
|
|
4828
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5634
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Source] Image source information.
|
|
4829
5635
|
#
|
|
4830
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5636
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Type] Image content part.
|
|
4831
5637
|
#
|
|
4832
5638
|
# @param key [String] Stable field key for this content part.
|
|
4833
5639
|
|
|
4834
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5640
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent#source
|
|
4835
5641
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
4836
5642
|
# @!attribute type
|
|
4837
5643
|
# URL image source.
|
|
4838
5644
|
#
|
|
4839
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5645
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Source::Type]
|
|
4840
5646
|
required :type,
|
|
4841
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5647
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Source::Type }
|
|
4842
5648
|
|
|
4843
5649
|
# @!attribute url
|
|
4844
5650
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -4849,13 +5655,13 @@ module SafetyKit
|
|
|
4849
5655
|
# @!method initialize(type:, url:)
|
|
4850
5656
|
# Image source information.
|
|
4851
5657
|
#
|
|
4852
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5658
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Source::Type] URL image source.
|
|
4853
5659
|
#
|
|
4854
5660
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
4855
5661
|
|
|
4856
5662
|
# URL image source.
|
|
4857
5663
|
#
|
|
4858
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5664
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent::Source#type
|
|
4859
5665
|
module Type
|
|
4860
5666
|
extend SafetyKit::Internal::Type::Enum
|
|
4861
5667
|
|
|
@@ -4868,7 +5674,7 @@ module SafetyKit
|
|
|
4868
5674
|
|
|
4869
5675
|
# Image content part.
|
|
4870
5676
|
#
|
|
4871
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5677
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent#type
|
|
4872
5678
|
module Type
|
|
4873
5679
|
extend SafetyKit::Internal::Type::Enum
|
|
4874
5680
|
|
|
@@ -4880,7 +5686,7 @@ module SafetyKit
|
|
|
4880
5686
|
end
|
|
4881
5687
|
|
|
4882
5688
|
# @!method self.variants
|
|
4883
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5689
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Content::EventImageContent)]
|
|
4884
5690
|
end
|
|
4885
5691
|
|
|
4886
5692
|
module Metadata
|
|
@@ -4892,7 +5698,7 @@ module SafetyKit
|
|
|
4892
5698
|
|
|
4893
5699
|
variant SafetyKit::Internal::Type::Boolean
|
|
4894
5700
|
|
|
4895
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5701
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::Metadata::UnionMember3Array }
|
|
4896
5702
|
|
|
4897
5703
|
module UnionMember3
|
|
4898
5704
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -4912,9 +5718,9 @@ module SafetyKit
|
|
|
4912
5718
|
|
|
4913
5719
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
4914
5720
|
UnionMember3Array =
|
|
4915
|
-
SafetyKit::Internal::Type::ArrayOf[
|
|
4916
|
-
|
|
4917
|
-
]
|
|
5721
|
+
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
5722
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::Metadata::UnionMember3
|
|
5723
|
+
}]
|
|
4918
5724
|
end
|
|
4919
5725
|
|
|
4920
5726
|
# Real-world, account, social, or caller-defined resource used during the event.
|
|
@@ -4922,10 +5728,10 @@ module SafetyKit
|
|
|
4922
5728
|
extend SafetyKit::Internal::Type::Union
|
|
4923
5729
|
|
|
4924
5730
|
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
4925
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5731
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::EntityIDResource }
|
|
4926
5732
|
|
|
4927
5733
|
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
4928
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5734
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::UnionMember1 }
|
|
4929
5735
|
|
|
4930
5736
|
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
4931
5737
|
# @!attribute namespace
|
|
@@ -4938,9 +5744,9 @@ module SafetyKit
|
|
|
4938
5744
|
# @!attribute type
|
|
4939
5745
|
# Caller-defined entity identifier resource.
|
|
4940
5746
|
#
|
|
4941
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5747
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::EntityIDResource::Type]
|
|
4942
5748
|
required :type,
|
|
4943
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5749
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::EntityIDResource::Type }
|
|
4944
5750
|
|
|
4945
5751
|
# @!attribute value
|
|
4946
5752
|
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
@@ -4951,7 +5757,7 @@ module SafetyKit
|
|
|
4951
5757
|
|
|
4952
5758
|
# @!method initialize(namespace:, type:, value:)
|
|
4953
5759
|
# Some parameter documentations has been truncated, see
|
|
4954
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5760
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::EntityIDResource}
|
|
4955
5761
|
# for more details.
|
|
4956
5762
|
#
|
|
4957
5763
|
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
@@ -4959,13 +5765,13 @@ module SafetyKit
|
|
|
4959
5765
|
#
|
|
4960
5766
|
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
4961
5767
|
#
|
|
4962
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5768
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
4963
5769
|
#
|
|
4964
5770
|
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
4965
5771
|
|
|
4966
5772
|
# Caller-defined entity identifier resource.
|
|
4967
5773
|
#
|
|
4968
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5774
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::EntityIDResource#type
|
|
4969
5775
|
module Type
|
|
4970
5776
|
extend SafetyKit::Internal::Type::Enum
|
|
4971
5777
|
|
|
@@ -4994,7 +5800,7 @@ module SafetyKit
|
|
|
4994
5800
|
|
|
4995
5801
|
# @!method initialize(type:, value:)
|
|
4996
5802
|
# Some parameter documentations has been truncated, see
|
|
4997
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5803
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::UnionMember1}
|
|
4998
5804
|
# for more details.
|
|
4999
5805
|
#
|
|
5000
5806
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -5006,11 +5812,11 @@ module SafetyKit
|
|
|
5006
5812
|
end
|
|
5007
5813
|
|
|
5008
5814
|
# @!method self.variants
|
|
5009
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5815
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport::ResourcesUsed::UnionMember1)]
|
|
5010
5816
|
end
|
|
5011
5817
|
end
|
|
5012
5818
|
|
|
5013
|
-
class
|
|
5819
|
+
class Appeal < SafetyKit::Internal::Type::BaseModel
|
|
5014
5820
|
# @!attribute event_name
|
|
5015
5821
|
# Stable, low-cardinality product action name. Use snake_case and put dynamic
|
|
5016
5822
|
# values in typed fields, content, resources_used, or metadata.
|
|
@@ -5018,12 +5824,6 @@ module SafetyKit
|
|
|
5018
5824
|
# @return [String]
|
|
5019
5825
|
required :event_name, String
|
|
5020
5826
|
|
|
5021
|
-
# @!attribute labels
|
|
5022
|
-
# One or more label categories supplied with the report or moderation decision.
|
|
5023
|
-
#
|
|
5024
|
-
# @return [Array<String>]
|
|
5025
|
-
required :labels, SafetyKit::Internal::Type::ArrayOf[String]
|
|
5026
|
-
|
|
5027
5827
|
# @!attribute timestamp
|
|
5028
5828
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
5029
5829
|
#
|
|
@@ -5032,8 +5832,8 @@ module SafetyKit
|
|
|
5032
5832
|
|
|
5033
5833
|
# @!attribute type
|
|
5034
5834
|
#
|
|
5035
|
-
# @return [Symbol, :
|
|
5036
|
-
required :type, const: :
|
|
5835
|
+
# @return [Symbol, :appeal]
|
|
5836
|
+
required :type, const: :appeal
|
|
5037
5837
|
|
|
5038
5838
|
# @!attribute user_id
|
|
5039
5839
|
# Your stable canonical identifier for the user or account.
|
|
@@ -5041,22 +5841,29 @@ module SafetyKit
|
|
|
5041
5841
|
# @return [String]
|
|
5042
5842
|
required :user_id, String
|
|
5043
5843
|
|
|
5844
|
+
# @!attribute appealed_decision_id
|
|
5845
|
+
# Your stable identifier for the moderation decision or enforcement action being
|
|
5846
|
+
# appealed, such as the content_id of a moderation_decision event you previously
|
|
5847
|
+
# sent.
|
|
5848
|
+
#
|
|
5849
|
+
# @return [String, nil]
|
|
5850
|
+
optional :appealed_decision_id, String
|
|
5851
|
+
|
|
5044
5852
|
# @!attribute client_info
|
|
5045
5853
|
# Client context observed by your backend for the user action that triggered the
|
|
5046
5854
|
# event.
|
|
5047
5855
|
#
|
|
5048
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5049
|
-
optional :client_info,
|
|
5050
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember7::UserReport::ClientInfo }
|
|
5856
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ClientInfo, nil]
|
|
5857
|
+
optional :client_info, -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::ClientInfo }
|
|
5051
5858
|
|
|
5052
5859
|
# @!attribute content
|
|
5053
5860
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
5054
5861
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
5055
5862
|
# analyze.
|
|
5056
5863
|
#
|
|
5057
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5864
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent>, nil]
|
|
5058
5865
|
optional :content,
|
|
5059
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
5866
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content] }
|
|
5060
5867
|
|
|
5061
5868
|
# @!attribute content_id
|
|
5062
5869
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -5078,50 +5885,37 @@ module SafetyKit
|
|
|
5078
5885
|
#
|
|
5079
5886
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
5080
5887
|
optional :metadata,
|
|
5081
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
5888
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::Metadata] }
|
|
5082
5889
|
|
|
5083
5890
|
# @!attribute resources_used
|
|
5084
5891
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
5085
5892
|
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
5086
5893
|
# caller-defined ids, or similar identifiers.
|
|
5087
5894
|
#
|
|
5088
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5895
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::UnionMember1>, nil]
|
|
5089
5896
|
optional :resources_used,
|
|
5090
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
5091
|
-
|
|
5092
|
-
# @!attribute target_content_id
|
|
5093
|
-
# Your stable identifier for the content being reported.
|
|
5094
|
-
#
|
|
5095
|
-
# @return [String, nil]
|
|
5096
|
-
optional :target_content_id, String
|
|
5097
|
-
|
|
5098
|
-
# @!attribute target_user_id
|
|
5099
|
-
# Your stable canonical identifier for the user being reported.
|
|
5100
|
-
#
|
|
5101
|
-
# @return [String, nil]
|
|
5102
|
-
optional :target_user_id, String
|
|
5897
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed] }
|
|
5103
5898
|
|
|
5104
|
-
# @!method initialize(event_name:,
|
|
5899
|
+
# @!method initialize(event_name:, timestamp:, user_id:, appealed_decision_id: nil, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, type: :appeal)
|
|
5105
5900
|
# Some parameter documentations has been truncated, see
|
|
5106
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5901
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal} for
|
|
5107
5902
|
# more details.
|
|
5108
5903
|
#
|
|
5109
|
-
# A user
|
|
5110
|
-
#
|
|
5111
|
-
#
|
|
5112
|
-
# content_id for the report itself.
|
|
5904
|
+
# A user appeals a moderation action taken against them. Use user_id for the
|
|
5905
|
+
# appealing user, appealed_decision_id to reference the decision being appealed,
|
|
5906
|
+
# and content and content_id for the appeal itself.
|
|
5113
5907
|
#
|
|
5114
5908
|
# @param event_name [String] Stable, low-cardinality product action name. Use snake_case and put dynamic valu
|
|
5115
5909
|
#
|
|
5116
|
-
# @param labels [Array<String>] One or more label categories supplied with the report or moderation decision.
|
|
5117
|
-
#
|
|
5118
5910
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
5119
5911
|
#
|
|
5120
5912
|
# @param user_id [String] Your stable canonical identifier for the user or account.
|
|
5121
5913
|
#
|
|
5122
|
-
# @param
|
|
5914
|
+
# @param appealed_decision_id [String] Your stable identifier for the moderation decision or enforcement action being a
|
|
5123
5915
|
#
|
|
5124
|
-
# @param
|
|
5916
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
5917
|
+
#
|
|
5918
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
5125
5919
|
#
|
|
5126
5920
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
5127
5921
|
#
|
|
@@ -5129,15 +5923,11 @@ module SafetyKit
|
|
|
5129
5923
|
#
|
|
5130
5924
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
5131
5925
|
#
|
|
5132
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5133
|
-
#
|
|
5134
|
-
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
5135
|
-
#
|
|
5136
|
-
# @param target_user_id [String] Your stable canonical identifier for the user being reported.
|
|
5926
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
5137
5927
|
#
|
|
5138
|
-
# @param type [Symbol, :
|
|
5928
|
+
# @param type [Symbol, :appeal]
|
|
5139
5929
|
|
|
5140
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5930
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal#client_info
|
|
5141
5931
|
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
5142
5932
|
# @!attribute ip
|
|
5143
5933
|
# IP address observed by your backend for the client that triggered the event.
|
|
@@ -5157,10 +5947,10 @@ module SafetyKit
|
|
|
5157
5947
|
extend SafetyKit::Internal::Type::Union
|
|
5158
5948
|
|
|
5159
5949
|
# User-authored text content associated with an event.
|
|
5160
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5950
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventTextContent }
|
|
5161
5951
|
|
|
5162
5952
|
# User-uploaded image content associated with an event.
|
|
5163
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5953
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent }
|
|
5164
5954
|
|
|
5165
5955
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
5166
5956
|
# @!attribute text
|
|
@@ -5172,9 +5962,9 @@ module SafetyKit
|
|
|
5172
5962
|
# @!attribute type
|
|
5173
5963
|
# Text content part.
|
|
5174
5964
|
#
|
|
5175
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5965
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventTextContent::Type]
|
|
5176
5966
|
required :type,
|
|
5177
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
5967
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventTextContent::Type }
|
|
5178
5968
|
|
|
5179
5969
|
# @!attribute key
|
|
5180
5970
|
# Stable field key for this content part.
|
|
@@ -5187,13 +5977,13 @@ module SafetyKit
|
|
|
5187
5977
|
#
|
|
5188
5978
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
5189
5979
|
#
|
|
5190
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5980
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventTextContent::Type] Text content part.
|
|
5191
5981
|
#
|
|
5192
5982
|
# @param key [String] Stable field key for this content part.
|
|
5193
5983
|
|
|
5194
5984
|
# Text content part.
|
|
5195
5985
|
#
|
|
5196
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
5986
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventTextContent#type
|
|
5197
5987
|
module Type
|
|
5198
5988
|
extend SafetyKit::Internal::Type::Enum
|
|
5199
5989
|
|
|
@@ -5208,16 +5998,16 @@ module SafetyKit
|
|
|
5208
5998
|
# @!attribute source
|
|
5209
5999
|
# Image source information.
|
|
5210
6000
|
#
|
|
5211
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6001
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Source]
|
|
5212
6002
|
required :source,
|
|
5213
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6003
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Source }
|
|
5214
6004
|
|
|
5215
6005
|
# @!attribute type
|
|
5216
6006
|
# Image content part.
|
|
5217
6007
|
#
|
|
5218
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6008
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Type]
|
|
5219
6009
|
required :type,
|
|
5220
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6010
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Type }
|
|
5221
6011
|
|
|
5222
6012
|
# @!attribute key
|
|
5223
6013
|
# Stable field key for this content part.
|
|
@@ -5228,20 +6018,20 @@ module SafetyKit
|
|
|
5228
6018
|
# @!method initialize(source:, type:, key: nil)
|
|
5229
6019
|
# User-uploaded image content associated with an event.
|
|
5230
6020
|
#
|
|
5231
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6021
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Source] Image source information.
|
|
5232
6022
|
#
|
|
5233
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6023
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Type] Image content part.
|
|
5234
6024
|
#
|
|
5235
6025
|
# @param key [String] Stable field key for this content part.
|
|
5236
6026
|
|
|
5237
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6027
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent#source
|
|
5238
6028
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
5239
6029
|
# @!attribute type
|
|
5240
6030
|
# URL image source.
|
|
5241
6031
|
#
|
|
5242
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6032
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Source::Type]
|
|
5243
6033
|
required :type,
|
|
5244
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6034
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Source::Type }
|
|
5245
6035
|
|
|
5246
6036
|
# @!attribute url
|
|
5247
6037
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -5252,13 +6042,13 @@ module SafetyKit
|
|
|
5252
6042
|
# @!method initialize(type:, url:)
|
|
5253
6043
|
# Image source information.
|
|
5254
6044
|
#
|
|
5255
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6045
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Source::Type] URL image source.
|
|
5256
6046
|
#
|
|
5257
6047
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
5258
6048
|
|
|
5259
6049
|
# URL image source.
|
|
5260
6050
|
#
|
|
5261
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6051
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent::Source#type
|
|
5262
6052
|
module Type
|
|
5263
6053
|
extend SafetyKit::Internal::Type::Enum
|
|
5264
6054
|
|
|
@@ -5271,7 +6061,7 @@ module SafetyKit
|
|
|
5271
6061
|
|
|
5272
6062
|
# Image content part.
|
|
5273
6063
|
#
|
|
5274
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6064
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent#type
|
|
5275
6065
|
module Type
|
|
5276
6066
|
extend SafetyKit::Internal::Type::Enum
|
|
5277
6067
|
|
|
@@ -5283,7 +6073,7 @@ module SafetyKit
|
|
|
5283
6073
|
end
|
|
5284
6074
|
|
|
5285
6075
|
# @!method self.variants
|
|
5286
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6076
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Content::EventImageContent)]
|
|
5287
6077
|
end
|
|
5288
6078
|
|
|
5289
6079
|
module Metadata
|
|
@@ -5295,7 +6085,7 @@ module SafetyKit
|
|
|
5295
6085
|
|
|
5296
6086
|
variant SafetyKit::Internal::Type::Boolean
|
|
5297
6087
|
|
|
5298
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6088
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::Metadata::UnionMember3Array }
|
|
5299
6089
|
|
|
5300
6090
|
module UnionMember3
|
|
5301
6091
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -5316,7 +6106,7 @@ module SafetyKit
|
|
|
5316
6106
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
5317
6107
|
UnionMember3Array =
|
|
5318
6108
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
5319
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
6109
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::Metadata::UnionMember3
|
|
5320
6110
|
}]
|
|
5321
6111
|
end
|
|
5322
6112
|
|
|
@@ -5325,10 +6115,10 @@ module SafetyKit
|
|
|
5325
6115
|
extend SafetyKit::Internal::Type::Union
|
|
5326
6116
|
|
|
5327
6117
|
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
5328
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6118
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::EntityIDResource }
|
|
5329
6119
|
|
|
5330
6120
|
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
5331
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6121
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::UnionMember1 }
|
|
5332
6122
|
|
|
5333
6123
|
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
5334
6124
|
# @!attribute namespace
|
|
@@ -5341,9 +6131,9 @@ module SafetyKit
|
|
|
5341
6131
|
# @!attribute type
|
|
5342
6132
|
# Caller-defined entity identifier resource.
|
|
5343
6133
|
#
|
|
5344
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6134
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::EntityIDResource::Type]
|
|
5345
6135
|
required :type,
|
|
5346
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6136
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::EntityIDResource::Type }
|
|
5347
6137
|
|
|
5348
6138
|
# @!attribute value
|
|
5349
6139
|
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
@@ -5354,7 +6144,7 @@ module SafetyKit
|
|
|
5354
6144
|
|
|
5355
6145
|
# @!method initialize(namespace:, type:, value:)
|
|
5356
6146
|
# Some parameter documentations has been truncated, see
|
|
5357
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6147
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::EntityIDResource}
|
|
5358
6148
|
# for more details.
|
|
5359
6149
|
#
|
|
5360
6150
|
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
@@ -5362,13 +6152,13 @@ module SafetyKit
|
|
|
5362
6152
|
#
|
|
5363
6153
|
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
5364
6154
|
#
|
|
5365
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6155
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
5366
6156
|
#
|
|
5367
6157
|
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
5368
6158
|
|
|
5369
6159
|
# Caller-defined entity identifier resource.
|
|
5370
6160
|
#
|
|
5371
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6161
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::EntityIDResource#type
|
|
5372
6162
|
module Type
|
|
5373
6163
|
extend SafetyKit::Internal::Type::Enum
|
|
5374
6164
|
|
|
@@ -5397,7 +6187,7 @@ module SafetyKit
|
|
|
5397
6187
|
|
|
5398
6188
|
# @!method initialize(type:, value:)
|
|
5399
6189
|
# Some parameter documentations has been truncated, see
|
|
5400
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6190
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::UnionMember1}
|
|
5401
6191
|
# for more details.
|
|
5402
6192
|
#
|
|
5403
6193
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -5409,7 +6199,7 @@ module SafetyKit
|
|
|
5409
6199
|
end
|
|
5410
6200
|
|
|
5411
6201
|
# @!method self.variants
|
|
5412
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6202
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal::ResourcesUsed::UnionMember1)]
|
|
5413
6203
|
end
|
|
5414
6204
|
end
|
|
5415
6205
|
|
|
@@ -5442,9 +6232,9 @@ module SafetyKit
|
|
|
5442
6232
|
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
5443
6233
|
# review or moderation provider).
|
|
5444
6234
|
#
|
|
5445
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6235
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::SourceType]
|
|
5446
6236
|
required :source_type,
|
|
5447
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6237
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::SourceType }
|
|
5448
6238
|
|
|
5449
6239
|
# @!attribute timestamp
|
|
5450
6240
|
# The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
@@ -5461,18 +6251,18 @@ module SafetyKit
|
|
|
5461
6251
|
# Client context observed by your backend for the user action that triggered the
|
|
5462
6252
|
# event.
|
|
5463
6253
|
#
|
|
5464
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6254
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ClientInfo, nil]
|
|
5465
6255
|
optional :client_info,
|
|
5466
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6256
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ClientInfo }
|
|
5467
6257
|
|
|
5468
6258
|
# @!attribute content
|
|
5469
6259
|
# User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
5470
6260
|
# listing text, image URLs, and similar content SafetyKit should compare or
|
|
5471
6261
|
# analyze.
|
|
5472
6262
|
#
|
|
5473
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6263
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent>, nil]
|
|
5474
6264
|
optional :content,
|
|
5475
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
6265
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content] }
|
|
5476
6266
|
|
|
5477
6267
|
# @!attribute content_id
|
|
5478
6268
|
# Your stable identifier for the content involved in this event, such as a
|
|
@@ -5494,16 +6284,16 @@ module SafetyKit
|
|
|
5494
6284
|
#
|
|
5495
6285
|
# @return [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil]
|
|
5496
6286
|
optional :metadata,
|
|
5497
|
-
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
6287
|
+
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Metadata] }
|
|
5498
6288
|
|
|
5499
6289
|
# @!attribute resources_used
|
|
5500
6290
|
# Reusable resources observed during the event. Use this for emails, phone
|
|
5501
6291
|
# numbers, names, addresses, social handles, URLs, payment identifiers,
|
|
5502
6292
|
# caller-defined ids, or similar identifiers.
|
|
5503
6293
|
#
|
|
5504
|
-
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6294
|
+
# @return [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::UnionMember1>, nil]
|
|
5505
6295
|
optional :resources_used,
|
|
5506
|
-
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::
|
|
6296
|
+
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed] }
|
|
5507
6297
|
|
|
5508
6298
|
# @!attribute target_content_id
|
|
5509
6299
|
# Your stable identifier for the content being reported.
|
|
@@ -5519,7 +6309,7 @@ module SafetyKit
|
|
|
5519
6309
|
|
|
5520
6310
|
# @!method initialize(event_name:, labels:, source_id:, source_type:, timestamp:, client_info: nil, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil, type: :moderation_decision)
|
|
5521
6311
|
# Some parameter documentations has been truncated, see
|
|
5522
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6312
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision}
|
|
5523
6313
|
# for more details.
|
|
5524
6314
|
#
|
|
5525
6315
|
# A moderation label or decision from an automated enforcement system or manual
|
|
@@ -5532,13 +6322,13 @@ module SafetyKit
|
|
|
5532
6322
|
#
|
|
5533
6323
|
# @param source_id [String] Stable identifier within source_type. Examples: moderator@example.com or 550e840
|
|
5534
6324
|
#
|
|
5535
|
-
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6325
|
+
# @param source_type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::SourceType] Coarse attribution category for the moderation decision source. Supported values
|
|
5536
6326
|
#
|
|
5537
6327
|
# @param timestamp [Time] The time the event occurred in your system, as an ISO 8601 datetime string.
|
|
5538
6328
|
#
|
|
5539
|
-
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6329
|
+
# @param client_info [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ClientInfo] Client context observed by your backend for the user action that triggered the e
|
|
5540
6330
|
#
|
|
5541
|
-
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6331
|
+
# @param content [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent>] User-authored or user-uploaded content parts. Use this for message bodies, bios,
|
|
5542
6332
|
#
|
|
5543
6333
|
# @param content_id [String] Your stable identifier for the content involved in this event, such as a message
|
|
5544
6334
|
#
|
|
@@ -5546,7 +6336,7 @@ module SafetyKit
|
|
|
5546
6336
|
#
|
|
5547
6337
|
# @param metadata [Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}] Non-PII product context for filtering, segmentation, and debugging. Values may b
|
|
5548
6338
|
#
|
|
5549
|
-
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6339
|
+
# @param resources_used [Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::UnionMember1>] Reusable resources observed during the event. Use this for emails, phone numbers
|
|
5550
6340
|
#
|
|
5551
6341
|
# @param target_content_id [String] Your stable identifier for the content being reported.
|
|
5552
6342
|
#
|
|
@@ -5560,7 +6350,7 @@ module SafetyKit
|
|
|
5560
6350
|
# automated model, rules engine, or enforcement workflow), or vendor (an external
|
|
5561
6351
|
# review or moderation provider).
|
|
5562
6352
|
#
|
|
5563
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6353
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision#source_type
|
|
5564
6354
|
module SourceType
|
|
5565
6355
|
extend SafetyKit::Internal::Type::Enum
|
|
5566
6356
|
|
|
@@ -5573,7 +6363,7 @@ module SafetyKit
|
|
|
5573
6363
|
# @return [Array<Symbol>]
|
|
5574
6364
|
end
|
|
5575
6365
|
|
|
5576
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6366
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision#client_info
|
|
5577
6367
|
class ClientInfo < SafetyKit::Internal::Type::BaseModel
|
|
5578
6368
|
# @!attribute ip
|
|
5579
6369
|
# IP address observed by your backend for the client that triggered the event.
|
|
@@ -5593,10 +6383,10 @@ module SafetyKit
|
|
|
5593
6383
|
extend SafetyKit::Internal::Type::Union
|
|
5594
6384
|
|
|
5595
6385
|
# User-authored text content associated with an event.
|
|
5596
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6386
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventTextContent }
|
|
5597
6387
|
|
|
5598
6388
|
# User-uploaded image content associated with an event.
|
|
5599
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6389
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent }
|
|
5600
6390
|
|
|
5601
6391
|
class EventTextContent < SafetyKit::Internal::Type::BaseModel
|
|
5602
6392
|
# @!attribute text
|
|
@@ -5608,9 +6398,9 @@ module SafetyKit
|
|
|
5608
6398
|
# @!attribute type
|
|
5609
6399
|
# Text content part.
|
|
5610
6400
|
#
|
|
5611
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6401
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventTextContent::Type]
|
|
5612
6402
|
required :type,
|
|
5613
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6403
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventTextContent::Type }
|
|
5614
6404
|
|
|
5615
6405
|
# @!attribute key
|
|
5616
6406
|
# Stable field key for this content part.
|
|
@@ -5623,13 +6413,13 @@ module SafetyKit
|
|
|
5623
6413
|
#
|
|
5624
6414
|
# @param text [String] User-authored text SafetyKit should compare or analyze.
|
|
5625
6415
|
#
|
|
5626
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6416
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventTextContent::Type] Text content part.
|
|
5627
6417
|
#
|
|
5628
6418
|
# @param key [String] Stable field key for this content part.
|
|
5629
6419
|
|
|
5630
6420
|
# Text content part.
|
|
5631
6421
|
#
|
|
5632
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6422
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventTextContent#type
|
|
5633
6423
|
module Type
|
|
5634
6424
|
extend SafetyKit::Internal::Type::Enum
|
|
5635
6425
|
|
|
@@ -5644,16 +6434,16 @@ module SafetyKit
|
|
|
5644
6434
|
# @!attribute source
|
|
5645
6435
|
# Image source information.
|
|
5646
6436
|
#
|
|
5647
|
-
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6437
|
+
# @return [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Source]
|
|
5648
6438
|
required :source,
|
|
5649
|
-
-> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6439
|
+
-> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Source }
|
|
5650
6440
|
|
|
5651
6441
|
# @!attribute type
|
|
5652
6442
|
# Image content part.
|
|
5653
6443
|
#
|
|
5654
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6444
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Type]
|
|
5655
6445
|
required :type,
|
|
5656
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6446
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Type }
|
|
5657
6447
|
|
|
5658
6448
|
# @!attribute key
|
|
5659
6449
|
# Stable field key for this content part.
|
|
@@ -5664,20 +6454,20 @@ module SafetyKit
|
|
|
5664
6454
|
# @!method initialize(source:, type:, key: nil)
|
|
5665
6455
|
# User-uploaded image content associated with an event.
|
|
5666
6456
|
#
|
|
5667
|
-
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6457
|
+
# @param source [SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Source] Image source information.
|
|
5668
6458
|
#
|
|
5669
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6459
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Type] Image content part.
|
|
5670
6460
|
#
|
|
5671
6461
|
# @param key [String] Stable field key for this content part.
|
|
5672
6462
|
|
|
5673
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6463
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent#source
|
|
5674
6464
|
class Source < SafetyKit::Internal::Type::BaseModel
|
|
5675
6465
|
# @!attribute type
|
|
5676
6466
|
# URL image source.
|
|
5677
6467
|
#
|
|
5678
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6468
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Source::Type]
|
|
5679
6469
|
required :type,
|
|
5680
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6470
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Source::Type }
|
|
5681
6471
|
|
|
5682
6472
|
# @!attribute url
|
|
5683
6473
|
# URL of the image SafetyKit should compare or analyze.
|
|
@@ -5688,13 +6478,13 @@ module SafetyKit
|
|
|
5688
6478
|
# @!method initialize(type:, url:)
|
|
5689
6479
|
# Image source information.
|
|
5690
6480
|
#
|
|
5691
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6481
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Source::Type] URL image source.
|
|
5692
6482
|
#
|
|
5693
6483
|
# @param url [String] URL of the image SafetyKit should compare or analyze.
|
|
5694
6484
|
|
|
5695
6485
|
# URL image source.
|
|
5696
6486
|
#
|
|
5697
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6487
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent::Source#type
|
|
5698
6488
|
module Type
|
|
5699
6489
|
extend SafetyKit::Internal::Type::Enum
|
|
5700
6490
|
|
|
@@ -5707,7 +6497,7 @@ module SafetyKit
|
|
|
5707
6497
|
|
|
5708
6498
|
# Image content part.
|
|
5709
6499
|
#
|
|
5710
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6500
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent#type
|
|
5711
6501
|
module Type
|
|
5712
6502
|
extend SafetyKit::Internal::Type::Enum
|
|
5713
6503
|
|
|
@@ -5719,7 +6509,7 @@ module SafetyKit
|
|
|
5719
6509
|
end
|
|
5720
6510
|
|
|
5721
6511
|
# @!method self.variants
|
|
5722
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6512
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Content::EventImageContent)]
|
|
5723
6513
|
end
|
|
5724
6514
|
|
|
5725
6515
|
module Metadata
|
|
@@ -5731,7 +6521,7 @@ module SafetyKit
|
|
|
5731
6521
|
|
|
5732
6522
|
variant SafetyKit::Internal::Type::Boolean
|
|
5733
6523
|
|
|
5734
|
-
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6524
|
+
variant -> { SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Metadata::UnionMember3Array }
|
|
5735
6525
|
|
|
5736
6526
|
module UnionMember3
|
|
5737
6527
|
extend SafetyKit::Internal::Type::Union
|
|
@@ -5752,7 +6542,7 @@ module SafetyKit
|
|
|
5752
6542
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
5753
6543
|
UnionMember3Array =
|
|
5754
6544
|
SafetyKit::Internal::Type::ArrayOf[
|
|
5755
|
-
union: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6545
|
+
union: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::Metadata::UnionMember3 }
|
|
5756
6546
|
]
|
|
5757
6547
|
end
|
|
5758
6548
|
|
|
@@ -5761,10 +6551,10 @@ module SafetyKit
|
|
|
5761
6551
|
extend SafetyKit::Internal::Type::Union
|
|
5762
6552
|
|
|
5763
6553
|
# Caller-defined stable entity identifier resource. This is equivalent to an id resource value of urlEncode(namespace) + '/' + urlEncode(value).
|
|
5764
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6554
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::EntityIDResource }
|
|
5765
6555
|
|
|
5766
6556
|
# Real-world or account resource used during the event, such as an email, phone number, address, URL, social handle, or payment identifier.
|
|
5767
|
-
variant -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6557
|
+
variant -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::UnionMember1 }
|
|
5768
6558
|
|
|
5769
6559
|
class EntityIDResource < SafetyKit::Internal::Type::BaseModel
|
|
5770
6560
|
# @!attribute namespace
|
|
@@ -5777,9 +6567,9 @@ module SafetyKit
|
|
|
5777
6567
|
# @!attribute type
|
|
5778
6568
|
# Caller-defined entity identifier resource.
|
|
5779
6569
|
#
|
|
5780
|
-
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6570
|
+
# @return [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::EntityIDResource::Type]
|
|
5781
6571
|
required :type,
|
|
5782
|
-
enum: -> { SafetyKit::Beta::EventCreateParams::Body::
|
|
6572
|
+
enum: -> { SafetyKit::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::EntityIDResource::Type }
|
|
5783
6573
|
|
|
5784
6574
|
# @!attribute value
|
|
5785
6575
|
# Identifier value within namespace. SafetyKit stores a normalized hash of the
|
|
@@ -5790,7 +6580,7 @@ module SafetyKit
|
|
|
5790
6580
|
|
|
5791
6581
|
# @!method initialize(namespace:, type:, value:)
|
|
5792
6582
|
# Some parameter documentations has been truncated, see
|
|
5793
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6583
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::EntityIDResource}
|
|
5794
6584
|
# for more details.
|
|
5795
6585
|
#
|
|
5796
6586
|
# Caller-defined stable entity identifier resource. This is equivalent to an id
|
|
@@ -5798,13 +6588,13 @@ module SafetyKit
|
|
|
5798
6588
|
#
|
|
5799
6589
|
# @param namespace [String] Caller-defined namespace for the identifier. SafetyKit stores this with value as
|
|
5800
6590
|
#
|
|
5801
|
-
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6591
|
+
# @param type [Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::EntityIDResource::Type] Caller-defined entity identifier resource.
|
|
5802
6592
|
#
|
|
5803
6593
|
# @param value [String] Identifier value within namespace. SafetyKit stores a normalized hash of the enc
|
|
5804
6594
|
|
|
5805
6595
|
# Caller-defined entity identifier resource.
|
|
5806
6596
|
#
|
|
5807
|
-
# @see SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6597
|
+
# @see SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::EntityIDResource#type
|
|
5808
6598
|
module Type
|
|
5809
6599
|
extend SafetyKit::Internal::Type::Enum
|
|
5810
6600
|
|
|
@@ -5833,7 +6623,7 @@ module SafetyKit
|
|
|
5833
6623
|
|
|
5834
6624
|
# @!method initialize(type:, value:)
|
|
5835
6625
|
# Some parameter documentations has been truncated, see
|
|
5836
|
-
# {SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6626
|
+
# {SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::UnionMember1}
|
|
5837
6627
|
# for more details.
|
|
5838
6628
|
#
|
|
5839
6629
|
# Real-world or account resource used during the event, such as an email, phone
|
|
@@ -5845,21 +6635,21 @@ module SafetyKit
|
|
|
5845
6635
|
end
|
|
5846
6636
|
|
|
5847
6637
|
# @!method self.variants
|
|
5848
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6638
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::EntityIDResource, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision::ResourcesUsed::UnionMember1)]
|
|
5849
6639
|
end
|
|
5850
6640
|
end
|
|
5851
6641
|
|
|
5852
6642
|
# @!method self.variants
|
|
5853
|
-
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::
|
|
6643
|
+
# @return [Array(SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision)]
|
|
5854
6644
|
end
|
|
5855
6645
|
|
|
5856
6646
|
# @!method self.variants
|
|
5857
|
-
# @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::
|
|
6647
|
+
# @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::AppealEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision>)]
|
|
5858
6648
|
|
|
5859
6649
|
# @type [SafetyKit::Internal::Type::Converter]
|
|
5860
|
-
|
|
6650
|
+
UnionMember8Array =
|
|
5861
6651
|
SafetyKit::Internal::Type::ArrayOf[union: -> {
|
|
5862
|
-
SafetyKit::Beta::EventCreateParams::Body::
|
|
6652
|
+
SafetyKit::Beta::EventCreateParams::Body::UnionMember8
|
|
5863
6653
|
}]
|
|
5864
6654
|
end
|
|
5865
6655
|
end
|