Class: Believe::Models::EpisodeListParams

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

Overview

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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_focus: nil, limit: nil, season: nil, skip: nil, request_options: {}) ⇒ Object

Parameters:

  • character_focus (String, nil) (defaults to: nil)

    Filter by character focus (character ID)

  • limit (Integer) (defaults to: nil)

    Maximum number of items to return (max: 100)

  • season (Integer, nil) (defaults to: nil)

    Filter by season

  • skip (Integer) (defaults to: nil)

    Number of items to skip (offset)

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


# File 'lib/believe/models/episode_list_params.rb', line 34

Instance Attribute Details

#character_focusString?

Filter by character focus (character ID)

Returns:

  • (String, nil)


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

optional :character_focus, String, nil?: true

#limitInteger?

Maximum number of items to return (max: 100)

Returns:

  • (Integer, nil)


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

optional :limit, Integer

#seasonInteger?

Filter by season

Returns:

  • (Integer, nil)


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

optional :season, Integer, nil?: true

#skipInteger?

Number of items to skip (offset)

Returns:

  • (Integer, nil)


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

optional :skip, Integer