Class: Believe::Models::QuoteCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Believe::Models::QuoteCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/believe/models/quote_create_params.rb

Overview

See Also:

• Resources::Quotes#create

Instance Attribute Summary

• #character_id ⇒ String

  ID of the character who said it.

• #context ⇒ String

  Context in which the quote was said.

• #episode_id ⇒ String^?

  Episode where the quote appears.

• #is_funny ⇒ Boolean^?

  Whether this quote is humorous.

• #is_inspirational ⇒ Boolean^?

  Whether this quote is inspirational.

• #moment_type ⇒ Symbol, ::Believe::Models::QuoteMoment

  Type of moment when the quote was said.

• #popularity_score ⇒ Float^?

  Popularity/virality score (0-100).

• #secondary_themes ⇒ Array<Symbol, ::Believe::Models::QuoteTheme>^?

  Additional themes.

• #text ⇒ String

  The quote text.

• #theme ⇒ Symbol, ::Believe::Models::QuoteTheme

  Primary theme of the quote.

• #times_shared ⇒ Integer^?

  Number of times shared on social media.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(character_id:, context:, moment_type:, text:, theme:, episode_id: nil, is_funny: nil, is_inspirational: nil, popularity_score: nil, secondary_themes: nil, times_shared: nil, request_options: {}) ⇒ Object constructor

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, 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(character_id:, context:, moment_type:, text:, theme:, episode_id: nil, is_funny: nil, is_inspirational: nil, popularity_score: nil, secondary_themes: nil, times_shared: nil, request_options: {}) ⇒ Object

Parameters:

• character_id (String) —

  ID of the character who said it

• context (String) —

  Context in which the quote was said

• moment_type (Symbol, ::Believe::Models::QuoteMoment) —

  Type of moment when the quote was said

• text (String) —

  The quote text

• theme (Symbol, ::Believe::Models::QuoteTheme) —

  Primary theme of the quote

• episode_id (String, nil) (defaults to: nil) —

  Episode where the quote appears

• is_funny (Boolean) (defaults to: nil) —

  Whether this quote is humorous

• is_inspirational (Boolean) (defaults to: nil) —

  Whether this quote is inspirational

• popularity_score (Float, nil) (defaults to: nil) —

  Popularity/virality score (0-100)

• secondary_themes (Array<Symbol, ::Believe::Models::QuoteTheme>) (defaults to: nil) —

  Additional themes

• times_shared (Integer, nil) (defaults to: nil) —

  Number of times shared on social media

• request_options (::Believe::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/believe/models/quote_create_params.rb', line 76

Instance Attribute Details

#character_id ⇒ String

ID of the character who said it

Returns:

• (String)

# File 'lib/believe/models/quote_create_params.rb', line 14

required :character_id, String

#context ⇒ String

Context in which the quote was said

Returns:

• (String)

# File 'lib/believe/models/quote_create_params.rb', line 20

required :context, String

#episode_id ⇒ String^?

Episode where the quote appears

Returns:

• (String, nil)

# File 'lib/believe/models/quote_create_params.rb', line 44

optional :episode_id, String, nil?: true

#is_funny ⇒ Boolean^?

Whether this quote is humorous

Returns:

• (Boolean, nil)

# File 'lib/believe/models/quote_create_params.rb', line 50

optional :is_funny, ::Believe::Internal::Type::Boolean

#is_inspirational ⇒ Boolean^?

Whether this quote is inspirational

Returns:

• (Boolean, nil)

# File 'lib/believe/models/quote_create_params.rb', line 56

optional :is_inspirational, ::Believe::Internal::Type::Boolean

#moment_type ⇒ Symbol, ::Believe::Models::QuoteMoment

Type of moment when the quote was said

Returns:

• (Symbol, ::Believe::Models::QuoteMoment)

# File 'lib/believe/models/quote_create_params.rb', line 26

required :moment_type, enum: -> { ::Believe::QuoteMoment }

#popularity_score ⇒ Float^?

Popularity/virality score (0-100)

Returns:

• (Float, nil)

# File 'lib/believe/models/quote_create_params.rb', line 62

optional :popularity_score, Float, nil?: true

#secondary_themes ⇒ Array<Symbol, ::Believe::Models::QuoteTheme>^?

Additional themes

Returns:

• (Array<Symbol, ::Believe::Models::QuoteTheme>, nil)

# File 'lib/believe/models/quote_create_params.rb', line 68

optional :secondary_themes, -> { ::Believe::Internal::Type::ArrayOf[enum: ::Believe::QuoteTheme] }

#text ⇒ String

The quote text

Returns:

• (String)

# File 'lib/believe/models/quote_create_params.rb', line 32

required :text, String

#theme ⇒ Symbol, ::Believe::Models::QuoteTheme

Primary theme of the quote

Returns:

• (Symbol, ::Believe::Models::QuoteTheme)

# File 'lib/believe/models/quote_create_params.rb', line 38

required :theme, enum: -> { ::Believe::QuoteTheme }

#times_shared ⇒ Integer^?

Number of times shared on social media

Returns:

• (Integer, nil)

# File 'lib/believe/models/quote_create_params.rb', line 74

optional :times_shared, Integer, nil?: true