Class: SportsOddsAPI::Models::PlayerGetParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/sports_odds_api/models/player_get_params.rb,
sig/sports_odds_api/models/player_get_params.rbs

Overview

See Also:

  • SportsOddsAPI::Resources::Players#get

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::SportsOddsAPI

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(cursor: nil, event_id: nil, limit: nil, player_id: nil, team_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see SportsOddsAPI::Models::PlayerGetParams for more details.

Parameters:

  • cursor (String) (defaults to: nil)

    The cursor for the request. Used to get the next group of Players. This should b

  • event_id (String) (defaults to: nil)

    EventID to get Players data for

  • limit (Float) (defaults to: nil)

    The maximum number of Players to return

  • player_id (String) (defaults to: nil)

    PlayerID to get data for

  • team_id (String) (defaults to: nil)

    TeamID to get Players data for

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


# File 'lib/sports_odds_api/models/player_get_params.rb', line 41

Instance Attribute Details

#cursorString?

The cursor for the request. Used to get the next group of Players. This should be the nextCursor from the prior response.

Parameters:

  • (String)

Returns:

  • (String, nil)


15
# File 'lib/sports_odds_api/models/player_get_params.rb', line 15

optional :cursor, String

#event_idString?

EventID to get Players data for

Parameters:

  • (String)

Returns:

  • (String, nil)


21
# File 'lib/sports_odds_api/models/player_get_params.rb', line 21

optional :event_id, String

#limitFloat?

The maximum number of Players to return

Parameters:

  • (Float)

Returns:

  • (Float, nil)


27
# File 'lib/sports_odds_api/models/player_get_params.rb', line 27

optional :limit, Float

#player_idString?

PlayerID to get data for

Parameters:

  • (String)

Returns:

  • (String, nil)


33
# File 'lib/sports_odds_api/models/player_get_params.rb', line 33

optional :player_id, String

#team_idString?

TeamID to get Players data for

Parameters:

  • (String)

Returns:

  • (String, nil)


39
# File 'lib/sports_odds_api/models/player_get_params.rb', line 39

optional :team_id, String

Instance Method Details

#to_hash{

Returns:

  • ({)


46
# File 'sig/sports_odds_api/models/player_get_params.rbs', line 46

def to_hash: -> {