catalog_playlists.go

package applemusic

import (
	"context"
	"fmt"
)

// PlaylistType represents the type of playlist.
type PlaylistType string

const (
	// PlaylistTypeUserShared is a playlist created and shared by an Apple Music user.
	PlaylistTypeUserShared = PlaylistType("user-shared")

	// PlaylistTypeEditorial is a playlist created by an Apple Music curator.
	PlaylistTypeEditorial = PlaylistType("editorial")

	// PlaylistTypeExternal is a playlist created by an non-Apple curator or brand.
	PlaylistTypeExternal = PlaylistType("external")

	// PlaylistTypePersonalMix is a personalized playlist for an Apple Music user.
	PlaylistTypePersonalMix = PlaylistType("personal-mix")
)

// PlaylistAttributes represents the attributes of the resource.
type PlaylistAttributes struct {
	Artwork          *Artwork        `json:"artwork,omitempty"`
	CuratorName      string          `json:"curatorName,omitempty"`
	Description      *EditorialNotes `json:"description,omitempty"`
	LastModifiedDate string          `json:"lastModifiedDate"`
	Name             string          `json:"name"`
	PlaylistType     PlaylistType    `json:"playlistType"`
	PlayParams       *PlayParameters `json:"playParams,omitempty"`
	URL              string          `json:"url"`
}

// PlaylistRelationships represents a to-one or to-many relationship from one resource object to others.
type PlaylistRelationships struct {
	Curator Curators `json:"curator"` // Default inclusion: Identifiers only
	Tracks  Tracks   `json:"tracks"`  // The songs and music videos included in the playlist. Default inclusion: Objects
}

// Playlist represents a playlist.
type Playlist struct {
	Id            string                `json:"id"`
	Type          string                `json:"type"`
	Href          string                `json:"href"`
	Attributes    PlaylistAttributes    `json:"attributes"`
	Relationships PlaylistRelationships `json:"relationships,omitempty"`
}

// Playlists represents a list of playlists.
type Playlists struct {
	Data []Playlist `json:"data"`
	Href string     `json:"href,omitempty"`
	Next string     `json:"next,omitempty"`
}

func (s *CatalogService) getPlaylists(ctx context.Context, u string) (*Playlists, *Response, error) {
	req, err := s.client.NewRequest("GET", u, nil)
	if err != nil {
		return nil, nil, err
	}

	playlists := &Playlists{}
	resp, err := s.client.Do(ctx, req, playlists)
	if err != nil {
		return nil, resp, err
	}

	return playlists, resp, nil
}

// GetPlaylist fetches a playlist using its identifier.
func (s *CatalogService) GetPlaylist(ctx context.Context, storefront, id string, opt *Options) (*Playlists, *Response, error) {
	u := fmt.Sprintf("v1/catalog/%s/playlists/%s", storefront, id)
	u, err := addOptions(u, opt)
	if err != nil {
		return nil, nil, err
	}

	return s.getPlaylists(ctx, u)
}

// GetPlaylistsByIds fetches one or more playlists using their identifiers.
func (s *CatalogService) GetPlaylistsByIds(ctx context.Context, storefront string, ids []string, opt *Options) (*Playlists, *Response, error) {
	u := fmt.Sprintf("v1/catalog/%s/playlists", storefront)
	u, err := addOptions(u, makeIdsOptions(ids, opt))
	if err != nil {
		return nil, nil, err
	}

	return s.getPlaylists(ctx, u)
}