diff --git a/client.go b/client.go index f689d06..c801491 100644 --- a/client.go +++ b/client.go @@ -16,38 +16,16 @@ Provides a high-level client to talk to the API that football-data.org offers. To create an instance please use NewClient(h). */ type Client interface { - // Fixture prepares a request to fetch the fixtures of a soccer season. Fixture(id uint64) FixtureRequest - - // Fixtures prepares a request to fetch the fixtures of a soccer season. Fixtures() FixturesRequest - - // FixturesOfSoccerSeason prepares a request to fetch the fixtures of a soccer season. + SoccerSeason(id uint64) SoccerSeasonRequest FixturesOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonFixturesRequest - - // FixturesOfTeam prepares a request to fetch the fixtures of a soccer season. + LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest + TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest + SoccerSeasons() SoccerSeasonsRequest + Team(id uint64) TeamRequest FixturesOfTeam(id uint64) TeamFixturesRequest - // LeagueTableOfSoccerSeason prepares a new request to fetch the league table of a given soccer season. - LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest - - // PlayersOfTeam prepares a request to fetch a team's players. - PlayersOfTeam(id uint64) TeamPlayersRequest - - // SoccerSeason prepares a request to fetch the complete list of soccer seasons. - SoccerSeason(id uint64) SoccerSeasonRequest - - // SoccerSeasons prepares a request to fetch the complete list of soccer seasons. - SoccerSeasons() SoccerSeasonsRequest - - // Team prepares a request to fetch a team's information. - Team(id uint64) TeamRequest - - // TeamsOfSoccerSeason prepares a new request to fetch the league table of a given soccer season. - TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest - - // SetToken sets the authentication token. - // Calling this method is *optional*. SetToken(authToken string) } @@ -70,6 +48,8 @@ func NewClient(h *http.Client) Client { return &client{httpClient: h} } +// SetToken sets the authentication token. +// Calling this method is *optional*. func (c *client) SetToken(authToken string) { c.AuthToken = authToken } diff --git a/req_fixture.go b/req_fixture.go index 34c1e66..3c43651 100644 --- a/req_fixture.go +++ b/req_fixture.go @@ -21,6 +21,7 @@ func (r FixtureRequest) Do() (s Fixture, err error) { return } +// Fixture prepares a request to fetch the fixtures of a soccer season. func (c *client) Fixture(id uint64) FixtureRequest { return FixtureRequest{c.req("fixture/%d", id)} } diff --git a/req_fixtures.go b/req_fixtures.go index de2426c..e0f0c6e 100644 --- a/req_fixtures.go +++ b/req_fixtures.go @@ -30,6 +30,7 @@ func (r FixturesRequest) Do() (s FixturesResponse, err error) { return } +// Fixtures prepares a request to fetch the fixtures of a soccer season. func (c *client) Fixtures() FixturesRequest { return FixturesRequest{c.req("fixtures")} } diff --git a/req_soccerseason.go b/req_soccerseason.go index 2675d3a..fccaad9 100644 --- a/req_soccerseason.go +++ b/req_soccerseason.go @@ -13,6 +13,7 @@ func (r SoccerSeasonRequest) Do() (s SoccerSeason, err error) { return } +// SoccerSeason prepares a request to fetch the complete list of soccer seasons. func (c *client) SoccerSeason(id uint64) SoccerSeasonRequest { return SoccerSeasonRequest{c.req("soccerseasons/%d", id)} } diff --git a/req_soccerseason_fixtures.go b/req_soccerseason_fixtures.go index 90b67a7..c026a1d 100644 --- a/req_soccerseason_fixtures.go +++ b/req_soccerseason_fixtures.go @@ -30,6 +30,7 @@ func (r SoccerSeasonFixturesRequest) Do() (s FixtureList, err error) { return } +// FixturesOfSoccerSeason prepares a request to fetch the fixtures of a soccer season. func (c *client) FixturesOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonFixturesRequest { return SoccerSeasonFixturesRequest{c.req("soccerseasons/%d/fixtures", soccerSeasonId)} } diff --git a/req_soccerseason_leaguetable.go b/req_soccerseason_leaguetable.go index 60ca8c4..737653b 100644 --- a/req_soccerseason_leaguetable.go +++ b/req_soccerseason_leaguetable.go @@ -21,6 +21,7 @@ func (r SoccerSeasonLeagueTableRequest) Do() (s SoccerSeason, err error) { return } +// LeagueTableOfSoccerSeason prepares a new request to fetch the league table of a given soccer season. func (c *client) LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest { return SoccerSeasonLeagueTableRequest{c.req("soccerseasons/%d/leagueTable", soccerSeasonId)} } diff --git a/req_soccerseason_teams.go b/req_soccerseason_teams.go index d821173..e60a479 100644 --- a/req_soccerseason_teams.go +++ b/req_soccerseason_teams.go @@ -13,6 +13,7 @@ func (r SoccerSeasonTeamsRequest) Do() (s TeamList, err error) { return } +// TeamsOfSoccerSeason prepares a new request to fetch the league table of a given soccer season. func (c *client) TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest { return SoccerSeasonTeamsRequest{c.req("soccerseasons/%d/leagueTable", soccerSeasonId)} } diff --git a/req_soccerseasons.go b/req_soccerseasons.go index 79cef56..6b1408e 100644 --- a/req_soccerseasons.go +++ b/req_soccerseasons.go @@ -21,6 +21,7 @@ func (r SoccerSeasonsRequest) Do() (s SoccerSeasonList, err error) { return } +// SoccerSeasons prepares a request to fetch the complete list of soccer seasons. func (c *client) SoccerSeasons() SoccerSeasonsRequest { return SoccerSeasonsRequest{c.req("soccerseasons")} } diff --git a/req_team.go b/req_team.go index 67c06fd..c961502 100644 --- a/req_team.go +++ b/req_team.go @@ -20,6 +20,7 @@ func (r TeamRequest) Do() (s Team, err error) { return } +// Team prepares a request to fetch a team's information. func (c *client) Team(id uint64) TeamRequest { return TeamRequest{c.req("teams/%d", id), id} } diff --git a/req_team_fixtures.go b/req_team_fixtures.go index 575f02a..d63e03e 100644 --- a/req_team_fixtures.go +++ b/req_team_fixtures.go @@ -36,6 +36,7 @@ func (r TeamFixturesRequest) Do() (s FixturesResponse, err error) { return } +// FixturesOfTeam prepares a request to fetch the fixtures of a soccer season. func (c *client) FixturesOfTeam(id uint64) TeamFixturesRequest { return TeamFixturesRequest{c.req("teams/%d/fixtures", id)} } diff --git a/req_team_players.go b/req_team_players.go index 4f8656b..099de3b 100644 --- a/req_team_players.go +++ b/req_team_players.go @@ -13,6 +13,7 @@ func (r TeamPlayersRequest) Do() (s PlayerList, err error) { return } +// PlayersOfTeam prepares a request to fetch a team's players. func (c *client) PlayersOfTeam(id uint64) TeamPlayersRequest { return TeamPlayersRequest{c.req("teams/%d/players", id)} }