Class: SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest

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: 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(event_name:, timestamp:, type:, user_id:, content: nil, content_id: nil, idempotency_key: nil, metadata: nil, resources_used: nil) ⇒ Object

Some parameter documentations has been truncated, see SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest for more details.

A user or account profile, contact detail, payment detail, or public bio changes.

Parameters:




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

Instance Attribute Details

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

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

Returns:



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

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

#content_id ⇒ String?

Your stable identifier for the content involved in this event, such as a message, listing, page, post, profile, or uploaded media item.

Returns:

  • (String, nil) 


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

optional :content_id, String

#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) 


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

required :event_name, String

#idempotency_key ⇒ String?

Optional caller-provided key used to make retries of this individual event idempotent. Reuse the same key only for retries of the same logical event.

Returns:

  • (String, nil) 


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

optional :idempotency_key, 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) 


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

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

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

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

Returns:



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

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

#timestamp ⇒ Time

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

Returns:

  • (Time) 


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

required :timestamp, Time

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

Returns:



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

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

#user_id ⇒ String

Your stable canonical identifier for the user or account.

Returns:

  • (String) 


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

required :user_id, String