Class: ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moderation_api/models/webhook_event.rb,
sig/moderation_api/models/webhook_event.rbs

Overview

See Also:

  • ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object#item

Defined Under Namespace

Modules: Content, MetaType Classes: ClientAction, Label

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(brand:, method_:) ⇒ Object

Parameters:

  • brand (String)
  • method_ (String) 



# File 'lib/moderation_api/models/webhook_event.rb', line 3899

Instance Attribute Details

#author_id ⇒ String?

External author ID (the customer's identifier, not Moderation API's internal id)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


3815
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3815

required :author_id, String, nil?: true

#channel_key ⇒ String?

The channel the content was submitted to, identified by your customer-defined channel key.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


3822
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3822

required :channel_key, String, nil?: true

#client_action ⇒ ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction?

A recommendation from your own client-side flagging.

Parameters:

  • value (ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction, nil)

Returns:



3828
3829
3830
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3828

required :client_action,
-> { ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Item::ClientAction },
nil?: true

#content ⇒ ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::Content::Text, ...

The original content payload

Parameters:

  • value (ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::content)

Returns:



3836
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3836

required :content, union: -> { ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Item::Content }

#conversation_id ⇒ String?

Conversation grouping ID, if any

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


3842
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3842

required :conversation_id, String, nil?: true

#flagged ⇒ Boolean?

Whether the content was flagged by moderation

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


3848
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3848

required :flagged, ModerationAPI::Internal::Type::Boolean, nil?: true

#flagged_fields ⇒ Array<String>

For object content, the field keys (e.g. "bio") that triggered a flag. Empty when no fields were flagged or the content is not an object.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


3855
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3855

required :flagged_fields, ModerationAPI::Internal::Type::ArrayOf[String]

#id ⇒ String

Content ID from your system

Parameters:

  • value (String)

Returns:

  • (String) 


3809
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3809

required :id, String

#labels ⇒ Array<ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::Label>?

Moderation labels applied to the content

Parameters:

  • value (::Array[ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Item::Label], nil)

Returns:



3861
3862
3863
3864
3865
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3861

required :labels,
-> {
  ModerationAPI::Internal::Type::ArrayOf[ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Item::Label]
},
nil?: true

#language ⇒ String?

Detected ISO language code, if available

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


3871
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3871

required :language, String, nil?: true

#meta_type ⇒ Symbol, ...

High-level content type (e.g. message, post, comment). Defaults to the channel's configured content type but can be overridden per request via the moderation API type field.

Parameters:

  • value (ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Item::meta_type, nil)

Returns:



3879
3880
3881
3882
3883
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3879

required :meta_type,
enum: -> {
  ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Item::MetaType
},
nil?: true

#metadata ⇒ Hash{Symbol=>Object}?

Arbitrary key/value metadata. Top-level keys are strings.

Parameters:

  • value (::Hash[Symbol, top], nil)

Returns:



3889
3890
3891
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3889

required :metadata,
ModerationAPI::Internal::Type::HashOf[ModerationAPI::Internal::Type::Unknown],
nil?: true

#timestamp ⇒ Time

ISO 8601 timestamp of when the content was submitted

Parameters:

  • value (Time)

Returns:

  • (Time) 


3897
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3897

required :timestamp, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


2949
 
# File 'sig/moderation_api/models/webhook_event.rbs', line 2949

def to_hash: -> {