Class: SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest

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: Label, 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(label:) ⇒ Object

Label category supplied with a user report.

Parameters:

  • label (String) —

    Stable snake_case report label category.




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

Instance Attribute Details

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

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

Returns:



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

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


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

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) 


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

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) 


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

optional :idempotency_key, String

#labels ⇒ Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Label>

One or more label categories supplied with the report.

Returns:



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

required :labels,
-> { SafetyKit::Internal::Type::ArrayOf[SafetyKit::Beta::EventCreateParams::Body::UserReportEventRequest::Label] }

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


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

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

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

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

Returns:



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

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

#target_content_id ⇒ String?

Your stable identifier for the content being reported.

Returns:

  • (String, nil) 


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

optional :target_content_id, String

#target_user_id ⇒ String?

Your stable canonical identifier for the user being reported.

Returns:

  • (String, nil) 


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

optional :target_user_id, String

#timestamp ⇒ Time

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

Returns:

  • (Time) 


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

required :timestamp, Time

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

Returns:



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

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

#user_id ⇒ String

Your stable canonical identifier for the user or account.

Returns:

  • (String) 


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

required :user_id, String