Strava

v1.0.0

Strava v1.0.0 Strava.RunningRaces View Source

API calls for all endpoints tagged RunningRaces.

Link to this section Summary

Functions

get_running_race_by_id(client, id, opts \\ [])

Get Running Race Returns a running race for a given identifier

get_running_races(client, opts \\ [])

List Running Races Returns a list running races based on a set of search criteria

Link to this section Functions

Link to this function

get_running_race_by_id(client, id, opts \\ []) View Source 
get_running_race_by_id(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, Strava.RunningRace.t()} | {:error, Tesla.Env.t()}

Get Running Race Returns a running race for a given identifier.

Parameters

  • client (Strava.Client): Client to make authenticated requests
  • id (integer()): The identifier of the running race.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %Strava.RunningRace{}} on success {:error, info} on failure

Link to this function

get_running_races(client, opts \\ []) View Source 
get_running_races(Tesla.Env.client(), keyword()) ::
  {:ok, [Strava.RunningRace.t()]} | {:error, Tesla.Env.t()}

List Running Races Returns a list running races based on a set of search criteria.

Parameters

  • client (Strava.Client): Client to make authenticated requests

  • opts (KeywordList): [optional] Optional parameters

    • :year (integer()): Filters the list by a given year.

Returns

{:ok, [%RunningRace{}, ...]} on success {:error, info} on failure