Module: SleeperFF::Client::Leagues

Included in:
SleeperFF::Client
Defined in:
lib/sleeper_ff/client/leagues.rb

Instance Method Summary collapse

Instance Method Details

#league(league_id) ⇒ Sawyer::Resource

Get a specific league

Parameters:

  • league_id (String)

    League ID

Returns:

  • (Sawyer::Resource)

    League information



19
20
21
# File 'lib/sleeper_ff/client/leagues.rb', line 19

def league(league_id)
  get "league/#{league_id}"
end

#league_rosters(league_id) ⇒ Array<Sawyer::Resource>

Get all rosters in a league

Parameters:

  • league_id (String)

    League ID

Returns:

  • (Array<Sawyer::Resource>)

    Array of roster information



27
28
29
# File 'lib/sleeper_ff/client/leagues.rb', line 27

def league_rosters(league_id)
  get "league/#{league_id}/rosters"
end

#league_users(league_id) ⇒ Array<Sawyer::Resource>

Get all users in a league

Parameters:

  • league_id (String)

    League ID

Returns:

  • (Array<Sawyer::Resource>)

    Array of user information



35
36
37
# File 'lib/sleeper_ff/client/leagues.rb', line 35

def league_users(league_id)
  get "league/#{league_id}/users"
end

#user_leagues(username, season) ⇒ Array<Sawyer::Resource>

Get all leagues for a user in a season

Parameters:

  • username (String)

    Username of the Sleeper user

  • season (Integer)

    NFL season year (e.g., 2023)

Returns:

  • (Array<Sawyer::Resource>)

    Array of league information



11
12
13
# File 'lib/sleeper_ff/client/leagues.rb', line 11

def user_leagues(username, season)
  get "user/#{username}/leagues/nfl/#{season}"
end