go-twitch/api/teams/get_teams.go

92 lines
2.5 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

package teams
import (
"context"
"encoding/json"
"net/http"
"net/url"
"time"
"github.com/google/go-querystring/query"
)
type GetTeamsParams struct {
// The name of the team to get. This parameter and the id parameter are mutually exclusive; you must specify the teams name or ID but not both.
Name *string `url:"name,omitempty"`
// The ID of the team to get. This parameter and the name parameter are mutually exclusive; you must specify the teams name or ID but not both.
ID *string `url:"id,omitempty"`
}
type GetTeamsResponse struct {
// A list that contains the single team that you requested.
Teams []Team `json:"teams"`
}
type Team struct {
// The list of team members.
Users []struct {
// An ID that identifies the team member.
UserID string `json:"user_id"`
// The team members login name.
UserLogin string `json:"user_login"`
// The team members display name.
UserName string `json:"user_name"`
} `json:"users"`
// A URL to the teams background image.
BackgroundImageURL string `json:"background_image_url"`
// A URL to the teams banner.
Banner string `json:"banner"`
// The UTC date and time (in RFC3339 format) of when the team was created.
CreatedAt time.Time `json:"created_at"`
// The UTC date and time (in RFC3339 format) of the last time the team was updated.
UpdatedAt time.Time `json:"updated_at"`
// The teams description. The description may contain formatting such as Markdown, HTML, newline (\n) characters, etc.
Info string `json:"info"`
// A URL to a thumbnail image of the teams logo.
ThumbnailURL string `json:"thumbnail_url"`
// The teams name.
TeamName string `json:"team_name"`
// The teams display name.
TeamDisplayName string `json:"team_display_name"`
// An ID that identifies the team.
ID string `json:"id"`
}
// Gets information about the specified Twitch team. Read More
//
// Requires an app access token or user access token.
func (c *Teams) GetTeams(ctx context.Context, params *GetTeamsParams) (*GetTeamsResponse, error) {
v, _ := query.Values(params)
endpoint := c.baseUrl.ResolveReference(&url.URL{Path: "teams", RawQuery: v.Encode()})
req, err := http.NewRequestWithContext(ctx, http.MethodGet, endpoint.String(), nil)
if err != nil {
return nil, err
}
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
var data GetTeamsResponse
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return nil, err
}
return &data, nil
}