godfist

v0.5.0

godfist v0.5.0 Godfist.League

Module to interact with the League endpoint.

Link to this section Summary

Functions

challenger(region, rank_queue)

Get challenger tier League mapped to queues

league_by_id(region, league_id)

Get League with given ID, including inactive entries

master(region, rank_queue)

Get master tier League mapped to queues

positions(region, sumid)

Get League positions in all queues for a given Summoner ID

Link to this section Functions

Link to this function challenger(region, rank_queue) 
challenger(atom, atom) :: {:ok, map} | {:error, String.t}

Get challenger tier League mapped to queues.

Queues are: flex_sr, flex_tt, solo_5

Example 

iex> Godfist.League.challenger(:na, :solo_5)

iex> Godfist.League.challenger(:oce, :flex_tt)
Link to this function league_by_id(region, league_id)

Get League with given ID, including inactive entries.

Example 

iex> Godfist.League.league_by_id(:lan, "9150f9f0-cf08-11e6-8809-d4ae52a70a5a")
Link to this function master(region, rank_queue) 
master(atom, atom) :: {:ok, map} | {:error, String.t}

Get master tier League mapped to queues.

See challenger/2 for a list of queues.

Example 

iex> Godfist.League.master(:eune, :flex_sr)
Link to this function positions(region, sumid) 
positions(atom, integer) :: {:ok, map} | {:error, String.t}

Get League positions in all queues for a given Summoner ID.

Example 

iex> Godfist.League.positions(:lan, 24244)