Class: ModerationAPI::Models::AuthorUpdateResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModerationAPI::Models::AuthorUpdateResponse

Defined in:

lib/moderation_api/models/author_update_response.rb

Overview

See Also:

• Resources::Authors#update

Defined Under Namespace

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

Instance Attribute Summary

• #block ⇒ ModerationAPI::Models::AuthorUpdateResponse::Block^?

  Block or suspension details, if applicable.

• #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::AuthorUpdateResponse::Metadata

  Additional metadata provided by your system.

• #metrics ⇒ ModerationAPI::Models::AuthorUpdateResponse::Metrics
• #name ⇒ String^?

  Author name or identifier.

• #profile_picture ⇒ String^?

  URL of the author’s profile picture.

• #risk_evaluation ⇒ ModerationAPI::Models::AuthorUpdateResponse::RiskEvaluation^?

  Risk assessment details, if available.

• #status ⇒ Symbol, ModerationAPI::Models::AuthorUpdateResponse::Status

  Current author status.

• #trust_level ⇒ ModerationAPI::Models::AuthorUpdateResponse::TrustLevel

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(risk_level: nil) ⇒ Object constructor

  Risk assessment details, if available.

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/author_update_response.rb', line 96

Instance Attribute Details

#block ⇒ ModerationAPI::Models::AuthorUpdateResponse::Block^?

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

Returns:

• (ModerationAPI::Models::AuthorUpdateResponse::Block, nil)

# File 'lib/moderation_api/models/author_update_response.rb', line 17

required :block, -> { ModerationAPI::Models::AuthorUpdateResponse::Block }, nil?: true

#email ⇒ String^?

Author email address

Returns:

• (String, nil)

# File 'lib/moderation_api/models/author_update_response.rb', line 64

optional :email, String, nil?: true

#external_id ⇒ String^?

The author’s ID from your system

Returns:

• (String, nil)

# File 'lib/moderation_api/models/author_update_response.rb', line 70

optional :external_id, String, nil?: true

#external_link ⇒ String^?

URL of the author’s external profile

Returns:

• (String, nil)

# File 'lib/moderation_api/models/author_update_response.rb', line 76

optional :external_link, String, nil?: true

#first_seen ⇒ Float

Timestamp when author first appeared

Returns:

• (Float)

# File 'lib/moderation_api/models/author_update_response.rb', line 23

required :first_seen, Float

#id ⇒ String

Author ID in Moderation API

Returns:

• (String)

# File 'lib/moderation_api/models/author_update_response.rb', line 11

required :id, String

#last_incident ⇒ Float^?

Timestamp of last incident

Returns:

• (Float, nil)

# File 'lib/moderation_api/models/author_update_response.rb', line 82

optional :last_incident, Float, nil?: true

#last_seen ⇒ Float

Timestamp of last activity

Returns:

• (Float)

# File 'lib/moderation_api/models/author_update_response.rb', line 29

required :last_seen, Float

#metadata ⇒ ModerationAPI::Models::AuthorUpdateResponse::Metadata

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

Returns:

• (ModerationAPI::Models::AuthorUpdateResponse::Metadata)

# File 'lib/moderation_api/models/author_update_response.rb', line 36

required :metadata, -> { ModerationAPI::Models::AuthorUpdateResponse::Metadata }

#metrics ⇒ ModerationAPI::Models::AuthorUpdateResponse::Metrics

Returns:

• (ModerationAPI::Models::AuthorUpdateResponse::Metrics)

# File 'lib/moderation_api/models/author_update_response.rb', line 41

required :metrics, -> { ModerationAPI::Models::AuthorUpdateResponse::Metrics }

#name ⇒ String^?

Author name or identifier

Returns:

• (String, nil)

# File 'lib/moderation_api/models/author_update_response.rb', line 88

optional :name, String, nil?: true

#profile_picture ⇒ String^?

URL of the author’s profile picture

Returns:

• (String, nil)

# File 'lib/moderation_api/models/author_update_response.rb', line 94

optional :profile_picture, String, nil?: true

#risk_evaluation ⇒ ModerationAPI::Models::AuthorUpdateResponse::RiskEvaluation^?

Risk assessment details, if available.

Returns:

• (ModerationAPI::Models::AuthorUpdateResponse::RiskEvaluation, nil)

# File 'lib/moderation_api/models/author_update_response.rb', line 47

required :risk_evaluation, -> { ModerationAPI::Models::AuthorUpdateResponse::RiskEvaluation }, nil?: true

#status ⇒ Symbol, ModerationAPI::Models::AuthorUpdateResponse::Status

Current author status

Returns:

• (Symbol, ModerationAPI::Models::AuthorUpdateResponse::Status)

# File 'lib/moderation_api/models/author_update_response.rb', line 53

required :status, enum: -> { ModerationAPI::Models::AuthorUpdateResponse::Status }

#trust_level ⇒ ModerationAPI::Models::AuthorUpdateResponse::TrustLevel

Returns:

• (ModerationAPI::Models::AuthorUpdateResponse::TrustLevel)

# File 'lib/moderation_api/models/author_update_response.rb', line 58

required :trust_level, -> { ModerationAPI::Models::AuthorUpdateResponse::TrustLevel }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/moderation_api/models/author_update_response.rb', line 247