Class: SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest

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

Defined Under Namespace

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

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(ip: nil) ⇒ Object

Client context observed by your backend for the user action that triggered the event.

Parameters:

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

    IP address observed by your backend for the client that triggered the event.




# File 'lib/safety_kit/models/async_create_async_params.rb', line 134

Instance Attribute Details

#client_info ⇒ SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest::ClientInfo?

Client context observed by your backend for the user action that triggered the event.

Returns:



92
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 92

optional :client_info, -> { SafetyKit::AsyncCreateAsyncParams::Body::UserContactEventRequest::ClientInfo }

#content ⇒ Array<SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest::Content::EventTextContent, SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest::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:



100
101
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 100

optional :content,
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::AsyncCreateAsyncParams::Body::UserContactEventRequest::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) 


108
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 108

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) 


61
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 61

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) 


115
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 115

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) 


122
123
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 122

optional :metadata,
-> { SafetyKit::Internal::Type::HashOf[union: SafetyKit::AsyncCreateAsyncParams::Body::UserContactEventRequest::Metadata] }

#resources_used ⇒ Array<SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest::ResourcesUsed::EntityIDResource, SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest::ResourcesUsed::UnionMember1>?

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

Returns:



131
132
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 131

optional :resources_used,
-> { SafetyKit::Internal::Type::ArrayOf[union: SafetyKit::AsyncCreateAsyncParams::Body::UserContactEventRequest::ResourcesUsed] }

#target_user_id ⇒ String

Your stable canonical identifier for the other user in a user-to-user interaction.

Returns:

  • (String) 


68
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 68

required :target_user_id, String

#timestamp ⇒ Time

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

Returns:

  • (Time) 


74
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 74

required :timestamp, Time

#type ⇒ Symbol, SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest::Type

Returns:



79
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 79

required :type, enum: -> { SafetyKit::AsyncCreateAsyncParams::Body::UserContactEventRequest::Type }

#user_id ⇒ String

Your stable canonical identifier for the user or account.

Returns:

  • (String) 


85
 
# File 'lib/safety_kit/models/async_create_async_params.rb', line 85

required :user_id, String