godfist

v0.5.0

godfist v0.5.0 Godfist.Summoner

Module to interact with the Summoner endpoint.

Link to this section Summary

Functions

by_id(region, id)

Get a summoner’s data by account id

by_name(region, name)

Get a summoner’s data by account name

by_summid(region, id)

Get a summoner’s data by summoner id. Summoner id and Account id are not the same. They’re given as id and accountId respectively

get_id(region, name)

Get the account id of a player directly by name

Link to this section Functions

Link to this function by_id(region, id) 
by_id(atom, integer) :: {:ok, map} | {:error, String.t}

Get a summoner’s data by account id.

Example 

iex> Godfist.Summoner.by_id(:lan, id)
Link to this function by_name(region, name) 
by_name(atom, String.t) :: {:ok, map} | {:error, String.t}

Get a summoner’s data by account name.

Example 

iex> Godfist.Summoner.by_name(:oce, name)
Link to this function by_summid(region, id) 
by_summid(atom, integer) :: {:ok, map} | {:error, String.t}

Get a summoner’s data by summoner id. Summoner id and Account id are not the same. They’re given as id and accountId respectively.

Example 

iex> Godfist.Summoner.by_summid(:jp, summonerid)
Link to this function get_id(region, name) 
get_id(atom, String.t) :: {:ok, integer} | {:error, String.t}

Get the account id of a player directly by name.

Example 

iex> Godfist.Summoner.get_id(:jp, name)