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

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

Defined Under Namespace

Modules: Status Classes: Block, Metadata, Metrics, RiskEvaluation, TrustLevel

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

Risk assessment details, if available.

Parameters:

  • risk_level (Float, nil) (defaults to: nil) —

    Calculated risk level based on more than 10 behavioral signals.




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

Instance Attribute Details

#block ⇒ ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Author::Block?

Block or suspension details, if applicable. Null if the author is enabled.

Parameters:

  • value (ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::Block, nil)

Returns:



3529
3530
3531
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3529

required :block,
-> { ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::Block },
nil?: true

#company ⇒ String?

The author's company or organization

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :company, String, nil?: true

#email ⇒ String?

Author email address

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :email, String, nil?: true

#external_id ⇒ String?

The author's ID from your system

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :external_id, String, nil?: true

#external_link ⇒ String?

URL of the author's external profile

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :external_link, String, nil?: true

#first_seen ⇒ Float

Timestamp when author first appeared

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :first_seen, Float

#id ⇒ String

Author ID in Moderation API

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#last_incident ⇒ Float?

Timestamp of last incident

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


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

optional :last_incident, Float, nil?: true

#last_seen ⇒ Float

Timestamp of last activity

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :last_seen, Float

#metadata ⇒ ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Author::Metadata

Additional metadata provided by your system. We recommend including any relevant information that may assist in the moderation process.

Parameters:

  • value (ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::Metadata)

Returns:



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

required :metadata, -> { ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::Metadata }

#metrics ⇒ ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Author::Metrics

Parameters:

  • value (ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::Metrics)

Returns:



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

required :metrics, -> { ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::Metrics }

#name ⇒ String?

Author name or identifier

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

#profile_picture ⇒ String?

URL of the author's profile picture

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :profile_picture, String, nil?: true

#risk_evaluation ⇒ ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Author::RiskEvaluation?

Risk assessment details, if available.

Parameters:

  • value (ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::RiskEvaluation, nil)

Returns:



3561
3562
3563
3564
3565
 
# File 'lib/moderation_api/models/webhook_event.rb', line 3561

required :risk_evaluation,
-> {
  ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::RiskEvaluation
},
nil?: true

#status ⇒ Symbol, ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Author::Status

Current author status

Parameters:

  • value (ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Author::status)

Returns:



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

required :status, enum: -> { ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::Status }

#trust_level ⇒ ModerationAPI::Models::WebhookEvent::QueueItemAction::Data::Object::Author::TrustLevel

Parameters:

  • value (ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::TrustLevel)

Returns:



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

required :trust_level,
-> { ModerationAPI::WebhookEvent::QueueItemAction::Data::Object::Author::TrustLevel }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {