Class: Believe::Models::QuoteListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/believe/models/quote_list_params.rb

Overview

See Also:

• Resources::Quotes#list

Instance Attribute Summary

• #character_id ⇒ String^?

  Filter by character.

• #funny ⇒ Boolean^?

  Filter funny quotes.

• #inspirational ⇒ Boolean^?

  Filter inspirational quotes.

• #limit ⇒ Integer^?

  Maximum number of items to return (max: 100).

• #moment_type ⇒ Symbol, ...

  Filter by moment type.

• #skip ⇒ Integer^?

  Number of items to skip (offset).

• #theme ⇒ Symbol, ...

  Filter by theme.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(character_id: nil, funny: nil, inspirational: nil, limit: nil, moment_type: nil, skip: nil, theme: 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: nil, funny: nil, inspirational: nil, limit: nil, moment_type: nil, skip: nil, theme: nil, request_options: {}) ⇒ Object

Parameters:

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

  Filter by character

• funny (Boolean, nil) (defaults to: nil) —

  Filter funny quotes

• inspirational (Boolean, nil) (defaults to: nil) —

  Filter inspirational quotes

• limit (Integer) (defaults to: nil) —

  Maximum number of items to return (max: 100)

• moment_type (Symbol, ::Believe::Models::QuoteMoment, nil) (defaults to: nil) —

  Filter by moment type

• skip (Integer) (defaults to: nil) —

  Number of items to skip (offset)

• theme (Symbol, ::Believe::Models::QuoteTheme, nil) (defaults to: nil) —

  Filter by theme

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

# File 'lib/believe/models/quote_list_params.rb', line 52

Instance Attribute Details

#character_id ⇒ String^?

Filter by character

Returns:

• (String, nil)

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

optional :character_id, String, nil?: true

#funny ⇒ Boolean^?

Filter funny quotes

Returns:

• (Boolean, nil)

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

optional :funny, ::Believe::Internal::Type::Boolean, nil?: true

#inspirational ⇒ Boolean^?

Filter inspirational quotes

Returns:

• (Boolean, nil)

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

optional :inspirational, ::Believe::Internal::Type::Boolean, nil?: true

#limit ⇒ Integer^?

Maximum number of items to return (max: 100)

Returns:

• (Integer, nil)

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

optional :limit, Integer

#moment_type ⇒ Symbol, ...

Filter by moment type

Returns:

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

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

optional :moment_type, enum: -> { ::Believe::QuoteMoment }, nil?: true

#skip ⇒ Integer^?

Number of items to skip (offset)

Returns:

• (Integer, nil)

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

optional :skip, Integer

#theme ⇒ Symbol, ...

Filter by theme

Returns:

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

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

optional :theme, enum: -> { ::Believe::QuoteTheme }, nil?: true