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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Label

Defined in:

lib/safety_kit/models/beta/event_create_params.rb

Instance Attribute Summary

• #label ⇒ String

  Stable snake_case report label category.

Instance Method Summary

• #initialize(event_name:, labels:, timestamp:, type:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil) ⇒ Object constructor

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

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:, labels:, timestamp:, type:, user_id:, content: nil, content_id: nil, metadata: nil, resources_used: nil, target_content_id: nil, target_user_id: nil) ⇒ Object

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

A user-submitted report. Use user_id for the reporter, content and content_id for the report itself, and target_user_id or target_content_id for what was reported.

Parameters:

• event_name (String) —

  Stable, low-cardinality product action name. Use snake_case and put dynamic valu

• labels (Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Label>) —

  One or more label categories supplied with the report.

• timestamp (Time) —

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

• type (Symbol, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Type)
• user_id (String) —

  Your stable canonical identifier for the user or account.

• content (Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventTextContent, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::Content::EventImageContent>) (defaults to: nil) —

  User-authored or user-uploaded content parts. Use this for message bodies, bios,

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

  Your stable identifier for the content involved in this event, such as a message

• metadata (Hash{Symbol=>String, Float, Boolean, Array<String, Float, Boolean>}) (defaults to: nil) —

  Non-PII product context for filtering, segmentation, and debugging. Values may b

• resources_used (Array<SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest::ResourcesUsed>) (defaults to: nil) —

  Reusable resources observed during the event. Use this for emails, phone numbers

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

  Your stable identifier for the user-owned content that is the target of a report

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

  Your stable canonical identifier for the user being reported.

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

class Label < SafetyKit::Internal::Type::BaseModel
  # @!attribute label
  #   Stable snake_case report label category.
  #
  #   @return [String]
  required :label, String

  # @!method initialize(label:)
  #   Label category supplied with a user report.
  #
  #   @param label [String] Stable snake_case report label category.
end

Instance Attribute Details

#label ⇒ String

Stable snake_case report label category.

Returns:

• (String)

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

required :label, String