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

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

Overview

See Also:

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 244

Instance Attribute Details

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

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

Returns:



153
154
155
 
# File 'lib/moderation_api/models/webhook_event.rb', line 153

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

#company ⇒ String?

The author’s company or organization

Returns:

  • (String, nil) 


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

optional :company, String, nil?: true

#email ⇒ String?

Author email address

Returns:

  • (String, nil) 


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

optional :email, String, nil?: true

#external_id ⇒ String?

The author’s ID from your system

Returns:

  • (String, nil) 


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

optional :external_id, String, nil?: true

#external_link ⇒ String?

URL of the author’s external profile

Returns:

  • (String, nil) 


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

optional :external_link, String, nil?: true

#first_seen ⇒ Float

Timestamp when author first appeared

Returns:

  • (Float) 


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

required :first_seen, Float

#id ⇒ String

Author ID in Moderation API

Returns:

  • (String) 


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

required :id, String

#last_incident ⇒ Float?

Timestamp of last incident

Returns:

  • (Float, nil) 


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

optional :last_incident, Float, nil?: true

#last_seen ⇒ Float

Timestamp of last activity

Returns:

  • (Float) 


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

required :last_seen, Float

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

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

Returns:



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

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

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

Returns:



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

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

#name ⇒ String?

Author name or identifier

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

#profile_picture ⇒ String?

URL of the author’s profile picture

Returns:

  • (String, nil) 


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

optional :profile_picture, String, nil?: true

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

Risk assessment details, if available.

Returns:



185
186
187
188
189
 
# File 'lib/moderation_api/models/webhook_event.rb', line 185

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

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

Current author status

Returns:



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

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

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

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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