Strava

v1.0.0

Strava v1.0.0 Strava.Clubs View Source

API calls for all endpoints tagged Clubs.

Link to this section Summary

Functions

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

List Club Activities Retrieve recent activities from members of a specific club. The authenticated athlete must belong to the requested club in order to hit this endpoint. Pagination is supported. Athlete profile visibility is respected for all activities

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

List Club Administrators. Returns a list of the administrators of a given club

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

Get Club Returns a given club using its identifier

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

List Club Members Returns a list of the athletes who are members of a given club

get_logged_in_athlete_clubs(client, opts \\ [])

List Athlete Clubs Returns a list of the clubs whose membership includes the authenticated athlete

Link to this section Functions

Link to this function

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

List Club Activities Retrieve recent activities from members of a specific club. The authenticated athlete must belong to the requested club in order to hit this endpoint. Pagination is supported. Athlete profile visibility is respected for all activities.

Parameters

  • client (Strava.Client): Client to make authenticated requests
  • id (integer()): The identifier of the club.

  • opts (KeywordList): [optional] Optional parameters

    • :page (integer()): Page number.
    • :per_page (integer()): Number of items per page. Defaults to 30.

Returns

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

Link to this function

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

List Club Administrators. Returns a list of the administrators of a given club.

Parameters

  • client (Strava.Client): Client to make authenticated requests
  • id (integer()): The identifier of the club.

  • opts (KeywordList): [optional] Optional parameters

    • :page (integer()): Page number.
    • :per_page (integer()): Number of items per page. Defaults to 30.

Returns

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

Link to this function

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

Get Club Returns a given club using its identifier.

Parameters

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

Returns

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

Link to this function

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

List Club Members Returns a list of the athletes who are members of a given club.

Parameters

  • client (Strava.Client): Client to make authenticated requests
  • id (integer()): The identifier of the club.

  • opts (KeywordList): [optional] Optional parameters

    • :page (integer()): Page number.
    • :per_page (integer()): Number of items per page. Defaults to 30.

Returns

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

Link to this function

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

List Athlete Clubs Returns a list of the clubs whose membership includes the authenticated athlete.

Parameters

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

  • opts (KeywordList): [optional] Optional parameters

    • :page (integer()): Page number.
    • :per_page (integer()): Number of items per page. Defaults to 30.

Returns

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