go-twitch/api/charity/get_charity_campaign.go

72 lines
2.4 KiB
Go
Raw Normal View History

2024-02-27 22:26:57 -05:00
package charity
import (
"encoding/json"
"net/url"
"go.fifitido.net/twitch/api/types"
)
type GetCharityCampaignResponse struct {
// A list that contains the charity campaign that the broadcaster is currently running.
// The list is empty if the broadcaster is not running a charity campaign; the campaign information is not available after the campaign ends.
Data []CharityCampaign `json:"data"`
}
type CharityCampaign struct {
// An ID that identifies the charity campaign.
ID string `json:"id"`
// An ID that identifies the broadcaster thats running the campaign.
BroadcasterID string `json:"broadcaster_id"`
// The broadcasters login name.
BroadcasterLogin string `json:"broadcaster_login"`
// The broadcasters display name.
BroadcasterName string `json:"broadcaster_name"`
// The charitys name.
CharityName string `json:"charity_name"`
// A description of the charity.
CharityDescription string `json:"charity_description"`
// A URL to an image of the charitys logo. The images type is PNG and its size is 100px X 100px.
CharityLogo string `json:"charity_logo"`
// A URL to the charitys website.
CharityWebsite string `json:"charity_website"`
// The current amount of donations that the campaign has received.
CurrentAmount types.CurrencyAmount `json:"current_amount"`
// The campaigns fundraising goal. This field is null if the broadcaster has not defined a fundraising goal.
TargetAmount *types.CurrencyAmount `json:"target_amount"`
}
// Gets information about the charity campaign that a broadcaster is running.
// For example, the campaigns fundraising goal and the current amount of donations.
//
// To receive events when progress is made towards the campaigns goal or the broadcaster changes the fundraising goal,
// subscribe to the channel.charity_campaign.progress subscription type.
//
// Requires a user access token that includes the channel:read:charity scope.
func (c *Charity) GetCharityCampaign(broadcasterID string) (*GetCharityCampaignResponse, error) {
endpoint := c.baseUrl.ResolveReference(&url.URL{Path: "charity/campaigns", RawQuery: "broadcaster_id=" + broadcasterID})
resp, err := c.client.Get(endpoint.String())
if err != nil {
return nil, err
}
defer resp.Body.Close()
var data GetCharityCampaignResponse
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return nil, err
}
return &data, nil
}