Module: NBA::TeamAndPlayersVsPlayers

Defined in:
lib/nba/team_and_players_vs_players.rb

Overview

Provides methods to retrieve team and players vs players statistics

API:

  • public

Constant Summary collapse

PLAYERS_VS_PLAYERS =

Result set name for players vs players

Returns:

  • the result set name

API:

  • public

"PlayersVsPlayers".freeze
TEAM_PLAYERS_VS_PLAYERS_OFF =

Result set name for team players vs players off court

Returns:

  • the result set name

API:

  • public

"TeamPlayersVsPlayersOff".freeze
TEAM_PLAYERS_VS_PLAYERS_ON =

Result set name for team players vs players on court

Returns:

  • the result set name

API:

  • public

"TeamPlayersVsPlayersOn".freeze
TEAM_VS_PLAYERS =

Result set name for team vs players

Returns:

  • the result set name

API:

  • public

"TeamVsPlayers".freeze

Class Method Summary collapse

Class Method Details

.players_vs_players(team:, vs_team:, players:, vs_players:, season: Utils.current_season, season_type: "Regular Season", per_mode: "PerGame", client: CLIENT) ⇒ Collection

Retrieves players vs players comparison statistics

Examples:

stats = NBA::TeamAndPlayersVsPlayers.players_vs_players(
  team: 1610612744, vs_team: 1610612747, players: [201939], vs_players: [2544]
)
stats.first.pts #=> 26.4

Parameters:

  • the team ID or Team object

  • the vs team ID or Team object

  • array of player IDs or Player objects

  • array of vs player IDs or Player objects

  • (defaults to: Utils.current_season)

    the season year

  • (defaults to: "Regular Season")

    the season type

  • (defaults to: "PerGame")

    the per mode

  • (defaults to: CLIENT)

    the API client to use

Returns:

  • a collection of player vs player statistics

API:

  • public



45
46
47
48
49
 
# File 'lib/nba/team_and_players_vs_players.rb', line 45

def self.players_vs_players(team:, vs_team:, players:, vs_players:, season: Utils.current_season,
  season_type: "Regular Season", per_mode: "PerGame", client: CLIENT)
  opts = {season: season, season_type: season_type, per_mode: per_mode, result_set: PLAYERS_VS_PLAYERS}
  fetch_stats(team, vs_team, players, vs_players, opts, client: client)
end

.team_players_vs_players_off(team:, vs_team:, players:, vs_players:, season: Utils.current_season, season_type: "Regular Season", per_mode: "PerGame", client: CLIENT) ⇒ Collection

Retrieves team players vs players off court statistics

Examples:

stats = NBA::TeamAndPlayersVsPlayers.team_players_vs_players_off(
  team: 1610612744, vs_team: 1610612747, players: [201939], vs_players: [2544]
)
stats.first.pts #=> 22.1

Parameters:

  • the team ID or Team object

  • the vs team ID or Team object

  • array of player IDs or Player objects

  • array of vs player IDs or Player objects

  • (defaults to: Utils.current_season)

    the season year

  • (defaults to: "Regular Season")

    the season type

  • (defaults to: "PerGame")

    the per mode

  • (defaults to: CLIENT)

    the API client to use

Returns:

  • a collection of team player statistics

API:

  • public



68
69
70
71
72
 
# File 'lib/nba/team_and_players_vs_players.rb', line 68

def self.team_players_vs_players_off(team:, vs_team:, players:, vs_players:, season: Utils.current_season,
  season_type: "Regular Season", per_mode: "PerGame", client: CLIENT)
  opts = {season: season, season_type: season_type, per_mode: per_mode, result_set: TEAM_PLAYERS_VS_PLAYERS_OFF}
  fetch_stats(team, vs_team, players, vs_players, opts, client: client)
end

.team_players_vs_players_on(team:, vs_team:, players:, vs_players:, season: Utils.current_season, season_type: "Regular Season", per_mode: "PerGame", client: CLIENT) ⇒ Collection

Retrieves team players vs players on court statistics

Examples:

stats = NBA::TeamAndPlayersVsPlayers.team_players_vs_players_on(
  team: 1610612744, vs_team: 1610612747, players: [201939], vs_players: [2544]
)
stats.first.pts #=> 28.3

Parameters:

  • the team ID or Team object

  • the vs team ID or Team object

  • array of player IDs or Player objects

  • array of vs player IDs or Player objects

  • (defaults to: Utils.current_season)

    the season year

  • (defaults to: "Regular Season")

    the season type

  • (defaults to: "PerGame")

    the per mode

  • (defaults to: CLIENT)

    the API client to use

Returns:

  • a collection of team player statistics

API:

  • public



91
92
93
94
95
 
# File 'lib/nba/team_and_players_vs_players.rb', line 91

def self.team_players_vs_players_on(team:, vs_team:, players:, vs_players:, season: Utils.current_season,
  season_type: "Regular Season", per_mode: "PerGame", client: CLIENT)
  opts = {season: season, season_type: season_type, per_mode: per_mode, result_set: TEAM_PLAYERS_VS_PLAYERS_ON}
  fetch_stats(team, vs_team, players, vs_players, opts, client: client)
end

.team_vs_players(team:, vs_team:, players:, vs_players:, season: Utils.current_season, season_type: "Regular Season", per_mode: "PerGame", client: CLIENT) ⇒ Collection

Retrieves team vs players statistics

Examples:

stats = NBA::TeamAndPlayersVsPlayers.team_vs_players(
  team: 1610612744, vs_team: 1610612747, players: [201939], vs_players: [2544]
)
stats.first.pts #=> 112.4

Parameters:

  • the team ID or Team object

  • the vs team ID or Team object

  • array of player IDs or Player objects

  • array of vs player IDs or Player objects

  • (defaults to: Utils.current_season)

    the season year

  • (defaults to: "Regular Season")

    the season type

  • (defaults to: "PerGame")

    the per mode

  • (defaults to: CLIENT)

    the API client to use

Returns:

  • a collection of team statistics

API:

  • public



114
115
116
117
118
 
# File 'lib/nba/team_and_players_vs_players.rb', line 114

def self.team_vs_players(team:, vs_team:, players:, vs_players:, season: Utils.current_season,
  season_type: "Regular Season", per_mode: "PerGame", client: CLIENT)
  opts = {season: season, season_type: season_type, per_mode: per_mode, result_set: TEAM_VS_PLAYERS}
  fetch_stats(team, vs_team, players, vs_players, opts, client: client)
end