Strava v0.3.2 Strava.Club

Clubs represent groups of athletes on Strava.

More info: https://strava.github.io/api/v3/clubs/

Summary

Functions

Retrieve summary information about members of a specific club. Pagination is supported

Retrieve details about a specific club. The club must be public or the current athlete must be a member

Types

t()
t() :: %Strava.Club{admin: boolean, city: String.t, club_type: String.t, country: String.t, cover_photo: String.t, cover_photo_small: String.t, description: String.t, featured: boolean, following_count: integer, id: integer, member_count: integer, membership: String.t, name: String.t, owner: boolean, private: boolean, profile: String.t, profile_medium: String.t, resource_state: integer, sport_type: String.t, state: String.t, url: String.t, verified: boolean}

Functions

list_members(id, pagination, client \\ Strava.Client.new())

Retrieve summary information about members of a specific club. Pagination is supported.

Example

members = Strava.Club.list_members(1, %Strava.Pagination{per_page: 200, page: 1})
members = Strava.Club.list_members(1, %Strava.Pagination{per_page: 200, page: 1}, Strava.Client.new("<access_token>>"))

More info: http://strava.github.io/api/v3/clubs/#get-members

retrieve(id, client \\ Strava.Client.new())
retrieve(integer, Strava.Client.t) :: Strava.Club.t

Retrieve details about a specific club. The club must be public or the current athlete must be a member.

Example

club = Strava.Club.retrieve(1)
club = Strava.Club.retrieve(1, Strava.Client.new("<access_token>>"))

More info: https://strava.github.io/api/v3/clubs/#get-details

stream_members(id, client \\ Strava.Client.new())
stream_members(integer, Strava.Client.t) :: Enumerable.t