Class: ModerationAPI::Models::AuthorRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/moderation_api/models/author_retrieve_response.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/author_retrieve_response.rb', line 98

Instance Attribute Details

#block ⇒ ModerationAPI::Models::AuthorRetrieveResponse::Block?

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

Returns:



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

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

#email ⇒ String?

Author email address

Returns:

  • (String, nil) 


66
 
# File 'lib/moderation_api/models/author_retrieve_response.rb', line 66

optional :email, String, nil?: true

#external_id ⇒ String?

The author’s ID from your system

Returns:

  • (String, nil) 


72
 
# File 'lib/moderation_api/models/author_retrieve_response.rb', line 72

optional :external_id, String, nil?: true

#external_link ⇒ String?

URL of the author’s external profile

Returns:

  • (String, nil) 


78
 
# File 'lib/moderation_api/models/author_retrieve_response.rb', line 78

optional :external_link, String, nil?: true

#first_seen ⇒ Float

Timestamp when author first appeared

Returns:

  • (Float) 


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

required :first_seen, Float

#id ⇒ String

Author ID in Moderation API

Returns:

  • (String) 


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

required :id, String

#last_incident ⇒ Float?

Timestamp of last incident

Returns:

  • (Float, nil) 


84
 
# File 'lib/moderation_api/models/author_retrieve_response.rb', line 84

optional :last_incident, Float, nil?: true

#last_seen ⇒ Float

Timestamp of last activity

Returns:

  • (Float) 


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

required :last_seen, Float

#metadata ⇒ ModerationAPI::Models::AuthorRetrieveResponse::Metadata

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

Returns:



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

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

#metrics ⇒ ModerationAPI::Models::AuthorRetrieveResponse::Metrics

Returns:



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

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

#name ⇒ String?

Author name or identifier

Returns:

  • (String, nil) 


90
 
# File 'lib/moderation_api/models/author_retrieve_response.rb', line 90

optional :name, String, nil?: true

#profile_picture ⇒ String?

URL of the author’s profile picture

Returns:

  • (String, nil) 


96
 
# File 'lib/moderation_api/models/author_retrieve_response.rb', line 96

optional :profile_picture, String, nil?: true

#risk_evaluation ⇒ ModerationAPI::Models::AuthorRetrieveResponse::RiskEvaluation?

Risk assessment details, if available.

Returns:



47
48
49
 
# File 'lib/moderation_api/models/author_retrieve_response.rb', line 47

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

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

Current author status

Returns:



55
 
# File 'lib/moderation_api/models/author_retrieve_response.rb', line 55

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

#trust_level ⇒ ModerationAPI::Models::AuthorRetrieveResponse::TrustLevel

Returns:



60
 
# File 'lib/moderation_api/models/author_retrieve_response.rb', line 60

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/moderation_api/models/author_retrieve_response.rb', line 249