Class: SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/safety_kit/models/beta/event_create_params.rb

Defined Under Namespace

Modules: Content, Metadata, Type Classes: Properties, ResourcesUsed

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(account_state: nil, account_types: nil, country: nil, email_verified: nil) ⇒ Object

Stable, typed account-level facts SafetyKit can use in rules and aggregate analysis.

Parameters:

  • account_state (String) (defaults to: nil) —

    Current account lifecycle or moderation state.

  • account_types (Array<String>) (defaults to: nil) —

    Stable account categories in your product.

  • country (String) (defaults to: nil) —

    Country associated with the account.

  • email_verified (Boolean) (defaults to: nil) —

    Whether the account’s email address has been verified.




# File 'lib/safety_kit/models/beta/event_create_params.rb', line 673

Instance Attribute Details

#content ⇒ Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content::EventImageContent>?

User-authored or user-uploaded content parts. Use this for message bodies, bios, listing text, image URLs, and similar content SafetyKit should compare or analyze.

Returns:



645
646
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 645

optional :content,
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Content] }

#event_name ⇒ String

Stable, low-cardinality product action name. Use snake_case and put dynamic values in typed fields, content, resources_used, or metadata.

Returns:

  • (String) 


620
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 620

required :event_name, String

#metadata ⇒ Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}?

Non-PII product context for filtering, segmentation, and debugging. Values may be strings, numbers, booleans, or arrays of those scalar values.

Returns:

  • (Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}, nil) 


653
654
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 653

optional :metadata,
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Metadata] }

#properties ⇒ SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Properties?

Stable, typed account-level facts SafetyKit can use in rules and aggregate analysis.

Returns:



661
662
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 661

optional :properties,
-> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Properties }

#resources_used ⇒ Array<SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed>?

Reusable resources observed during the event. Use this for emails, phone numbers, names, addresses, social handles, URLs, payment identifiers, or similar identifiers.

Returns:



670
671
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 670

optional :resources_used,
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::ResourcesUsed] }

#timestamp ⇒ Time

The time the event occurred in your system, as an ISO 8601 datetime string.

Returns:

  • (Time) 


626
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 626

required :timestamp, Time

#type ⇒ Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type

Returns:



631
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 631

required :type, enum: -> { SafetyKit::Beta::EventCreateParams::Body::CreateAccountEventRequest::Type }

#user_id ⇒ String

Your stable canonical identifier for the user or account.

Returns:

  • (String) 


637
 
# File 'lib/safety_kit/models/beta/event_create_params.rb', line 637

required :user_id, String