Class: Believe::Models::CharacterListParams

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

Overview

See Also:

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(limit: nil, min_optimism: nil, role: nil, skip: nil, team_id: nil, request_options: {}) ⇒ Object

Parameters:

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

    Maximum number of items to return (max: 100)

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

    Minimum optimism score

  • role (Symbol, ::Believe::Models::CharacterRole, nil) (defaults to: nil) —

    Filter by role

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

    Number of items to skip (offset)

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

    Filter by team ID

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



# File 'lib/believe/models/character_list_params.rb', line 40

Instance Attribute Details

#limit ⇒ Integer?

Maximum number of items to return (max: 100)

Returns:

  • (Integer, nil) 


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

optional :limit, Integer

#min_optimism ⇒ Integer?

Minimum optimism score

Returns:

  • (Integer, nil) 


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

optional :min_optimism, Integer, nil?: true

#role ⇒ Symbol, ...

Filter by role

Returns:



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

optional :role, enum: -> { ::Believe::CharacterRole }, nil?: true

#skip ⇒ Integer?

Number of items to skip (offset)

Returns:

  • (Integer, nil) 


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

optional :skip, Integer

#team_id ⇒ String?

Filter by team ID

Returns:

  • (String, nil) 


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

optional :team_id, String, nil?: true