Class: ModerationAPI::Models::AuthorCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/moderation_api/models/author_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Metadata

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from ModerationAPI::Internal::Type::BaseModel

Instance Attribute Details

#email ⇒ String?

Author email address

Returns:

  • (String, nil) 


20
 
# File 'lib/moderation_api/models/author_create_params.rb', line 20

optional :email, String, nil?: true

#external_id ⇒ String

External ID of the user, typically the ID of the author in your database.

Returns:

  • (String) 


14
 
# File 'lib/moderation_api/models/author_create_params.rb', line 14

required :external_id, String

#external_link ⇒ String?

URL of the author’s external profile

Returns:

  • (String, nil) 


26
 
# File 'lib/moderation_api/models/author_create_params.rb', line 26

optional :external_link, String, nil?: true

#first_seen ⇒ Float?

Timestamp when author first appeared

Returns:

  • (Float, nil) 


32
 
# File 'lib/moderation_api/models/author_create_params.rb', line 32

optional :first_seen, Float

#last_seen ⇒ Float?

Timestamp of last activity

Returns:

  • (Float, nil) 


38
 
# File 'lib/moderation_api/models/author_create_params.rb', line 38

optional :last_seen, Float

#manual_trust_level ⇒ Float?

Returns:

  • (Float, nil) 


43
 
# File 'lib/moderation_api/models/author_create_params.rb', line 43

optional :manual_trust_level, Float, nil?: true

#metadata ⇒ ModerationAPI::Models::AuthorCreateParams::Metadata?

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

Returns:



50
 
# File 'lib/moderation_api/models/author_create_params.rb', line 50

optional :metadata, -> { ModerationAPI::AuthorCreateParams::Metadata }

#name ⇒ String?

Author name or identifier

Returns:

  • (String, nil) 


56
 
# File 'lib/moderation_api/models/author_create_params.rb', line 56

optional :name, String, nil?: true

#profile_picture ⇒ String?

URL of the author’s profile picture

Returns:

  • (String, nil) 


62
 
# File 'lib/moderation_api/models/author_create_params.rb', line 62

optional :profile_picture, String, nil?: true