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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author

Defined in:

lib/moderation_api/models/webhook_event.rb,
sig/moderation_api/models/webhook_event.rbs

Overview

See Also:

• ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object#author

Defined Under Namespace

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

Instance Attribute Summary

• #block ⇒ ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::Block^?

  Block or suspension details, if applicable.

• #company ⇒ String^?

  The author's company or organization.

• #email ⇒ String^?

  Author email address.

• #external_id ⇒ String^?

  The author's ID from your system.

• #external_link ⇒ String^?

  URL of the author's external profile.

• #first_seen ⇒ Float

  Timestamp when author first appeared.

• #id ⇒ String

  Author ID in Moderation API.

• #last_incident ⇒ Float^?

  Timestamp of last incident.

• #last_seen ⇒ Float

  Timestamp of last activity.

• #metadata ⇒ ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::Metadata

  Additional metadata provided by your system.

• #metrics ⇒ ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::Metrics
• #name ⇒ String^?

  Author name or identifier.

• #profile_picture ⇒ String^?

  URL of the author's profile picture.

• #risk_evaluation ⇒ ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::RiskEvaluation^?

  Risk assessment details, if available.

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

  Current author status.

• #trust_level ⇒ ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::TrustLevel

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(risk_level: nil) ⇒ Object constructor

  Risk assessment details, if available.

• #to_hash ⇒ {

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 2147

Instance Attribute Details

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

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

Parameters:

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

Returns:

• (ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::Block, nil)

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

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

#company ⇒ String^?

The author's company or organization

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :company, String, nil?: true

#email ⇒ String^?

Author email address

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :email, String, nil?: true

#external_id ⇒ String^?

The author's ID from your system

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :external_id, String, nil?: true

#external_link ⇒ String^?

URL of the author's external profile

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :external_link, String, nil?: true

#first_seen ⇒ Float

Timestamp when author first appeared

Parameters:

• value (Float)

Returns:

• (Float)

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

required :first_seen, Float

#id ⇒ String

Author ID in Moderation API

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#last_incident ⇒ Float^?

Timestamp of last incident

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

optional :last_incident, Float, nil?: true

#last_seen ⇒ Float

Timestamp of last activity

Parameters:

• value (Float)

Returns:

• (Float)

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

required :last_seen, Float

#metadata ⇒ ModerationAPI::Models::WebhookEvent::AuthorAction::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::AuthorAction::Data::Object::Author::Metadata)

Returns:

• (ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::Metadata)

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

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

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

Parameters:

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

Returns:

• (ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::Metrics)

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

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

#name ⇒ String^?

Author name or identifier

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :name, String, nil?: true

#profile_picture ⇒ String^?

URL of the author's profile picture

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :profile_picture, String, nil?: true

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

Risk assessment details, if available.

Parameters:

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

Returns:

• (ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::RiskEvaluation, nil)

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

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

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

Current author status

Parameters:

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

Returns:

• (Symbol, ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::Status)

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

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

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

Parameters:

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

Returns:

• (ModerationAPI::Models::WebhookEvent::AuthorAction::Data::Object::Author::TrustLevel)

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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {