Safe Haskell	None
Language	Haskell2010

Utils.Spoty.Types

Description

Object declarations and lenses. Should not be imported by user code. Please view the official documentation.

Note that the distinction between full and simple objects is implemented as an optional Maybe field with details.

Synopsis

Documentation

type URL = Text Source

type SpotID = Text Source

type SpotURI = Text Source

require :: FromJSON a => Text -> HashMap Text Value -> Parser (Maybe a) Source

Require that a field is present before parsing the corresponding value.

parseStrMap :: MonadPlus m => HashMap k Value -> (k -> Text -> a) -> m [a] Source

Parse a map of key-value entries, wrapped in the given constructor.

data ExternalID Source

Constructors

ExternalID
Fields _idType :: Text _idIdentifier :: Text

class HasType c e | c -> e where Source

Methods

type :: Lens' c e Source

Instances

HasType ExternalID Text
HasType ExternalURL Text
HasType Album Text

class HasIdentifier c e | c -> e where Source

Methods

identifier :: Lens' c e Source

Instances

HasIdentifier ExternalID Text

_idTypeLens :: Lens' ExternalID Text Source

_idIdentifierLens :: Lens' ExternalID Text Source

data ExternalURL Source

Constructors

ExternalURL
Fields _urlType :: Text _url :: URL

_urlTypeLens :: Lens' ExternalURL Text Source

data Image Source

Constructors

Image
Fields _imageHeight :: Maybe Int _imagePath :: URL _imageWidth :: Maybe Int

Instances

Eq Image
Ord Image
Show Image
FromJSON Image
HasPath Image URL
HasWidth Image (Maybe Int)
HasHeight Image (Maybe Int)
HasImages ArtistDetails [Image]
HasImages Album [Image]

class HasHeight c e | c -> e where Source

Methods

height :: Lens' c e Source

Instances

HasHeight Image (Maybe Int)

class HasPath c e | c -> e where Source

Methods

path :: Lens' c e Source

Instances

HasPath Image URL

class HasWidth c e | c -> e where Source

Methods

width :: Lens' c e Source

Instances

HasWidth Image (Maybe Int)

_imageWidthLens :: Lens' Image (Maybe Int) Source

_imagePathLens :: Lens' Image URL Source

_imageHeightLens :: Lens' Image (Maybe Int) Source

data Paging a Source

Constructors

Paging
Fields _pagingHref :: Text _pagingItems :: [a] _pagingLimit :: Int _pagingNext :: Maybe URL _pagingOffset :: Int _pagingPrevious :: Maybe URL _pagingTotal :: Int

Instances

HasTracks AlbumDetails (Paging Track)
Eq a => Eq (Paging a)
Ord a => Ord (Paging a)
Show a => Show (Paging a)
FromJSON a => FromJSON (Paging a)
HasTotal (Paging a) Int
HasOffset (Paging a) Int
HasLimit (Paging a) Int
HasHref (Paging a) Text
HasPrevious (Paging a) (Maybe URL)
HasNext (Paging a) (Maybe URL)
HasItems (Paging a) [a]

class HasHref c e | c -> e where Source

Methods

href :: Lens' c e Source

Instances

HasHref User URL
HasHref Artist URL
HasHref Track URL
HasHref Album Text
HasHref (Paging a) Text

class HasItems c e | c -> e where Source

Methods

items :: Lens' c e Source

Instances

HasItems (Paging a) [a]

class HasLimit c e | c -> e where Source

Methods

limit :: Lens' c e Source

Instances

HasLimit (Paging a) Int

class HasNext c e | c -> e where Source

Methods

next :: Lens' c e Source

Instances

HasNext (Paging a) (Maybe URL)

class HasOffset c e | c -> e where Source

Methods

offset :: Lens' c e Source

Instances

HasOffset (Paging a) Int

class HasPrevious c e | c -> e where Source

Methods

previous :: Lens' c e Source

Instances

HasPrevious (Paging a) (Maybe URL)

class HasTotal c e | c -> e where Source

Methods

total :: Lens' c e Source

Instances

HasTotal (Paging a) Int

_pagingTotalLens :: forall a. Lens' (Paging a) Int Source

_pagingPreviousLens :: forall a. Lens' (Paging a) (Maybe URL) Source

_pagingOffsetLens :: forall a. Lens' (Paging a) Int Source

_pagingNextLens :: forall a. Lens' (Paging a) (Maybe URL) Source

_pagingLimitLens :: forall a. Lens' (Paging a) Int Source

_pagingItemsLens :: forall a a. Lens (Paging a) (Paging a) [a] [a] Source

_pagingHrefLens :: forall a. Lens' (Paging a) Text Source

data User Source

Constructors

User
Fields _userExternalUrls :: [ExternalURL] _userHref :: URL _userSpotifyID :: SpotID _userSpotifyURI :: SpotURI

Instances

Eq User
Ord User
Show User
FromJSON User
HasHref User URL
HasSpotifyURI User SpotURI
HasSpotifyID User SpotID
HasExternalUrls User [ExternalURL]

class HasExternalUrls c e | c -> e where Source

Methods

externalUrls :: Lens' c e Source

Instances

HasExternalUrls User [ExternalURL]
HasExternalUrls Artist [ExternalURL]
HasExternalUrls Track [ExternalURL]

class HasSpotifyID c e | c -> e where Source

Methods

spotifyID :: Lens' c e Source

Instances

HasSpotifyID User SpotID
HasSpotifyID Artist SpotID
HasSpotifyID Track SpotID
HasSpotifyID Album SpotID

class HasSpotifyURI c e | c -> e where Source

Methods

spotifyURI :: Lens' c e Source

Instances

HasSpotifyURI User SpotURI
HasSpotifyURI Artist SpotURI
HasSpotifyURI Track SpotURI
HasSpotifyURI Album SpotURI

_userSpotifyURILens :: Lens' User SpotURI Source

_userSpotifyIDLens :: Lens' User SpotID Source

_userHrefLens :: Lens' User URL Source

_userExternalUrlsLens :: Lens' User [ExternalURL] Source

data ArtistDetails Source

Constructors

ArtistDetails
Fields _artistGenres :: [Text] _artistImages :: [Image] _artistPopularity :: Int

class HasGenres c e | c -> e where Source

Methods

genres :: Lens' c e Source

Instances

HasGenres ArtistDetails [Text]
HasGenres AlbumDetails [Text]

class HasImages c e | c -> e where Source

Methods

images :: Lens' c e Source

Instances

HasImages ArtistDetails [Image]
HasImages Album [Image]

class HasPopularity c e | c -> e where Source

Methods

popularity :: Lens' c e Source

Instances

HasPopularity ArtistDetails Int
HasPopularity TrackDetails Int
HasPopularity AlbumDetails Int

_artistImagesLens :: Lens' ArtistDetails [Image] Source

_artistGenresLens :: Lens' ArtistDetails [Text] Source

data Artist Source

Constructors

Artist
Fields _artistExternalUrls :: [ExternalURL] _artistHref :: URL _artistSpotifyID :: SpotID _artistName :: Text _artistSpotifyURI :: SpotURI _artistDetails :: Maybe ArtistDetails

class HasName c e | c -> e where Source

Methods

name :: Lens' c e Source

Instances

HasName Artist Text
HasName Track Text
HasName Album Text

class HasDetails c e | c -> e where Source

Methods

details :: Lens' c e Source

Instances

HasDetails Artist (Maybe ArtistDetails)
HasDetails Track (Maybe TrackDetails)
HasDetails Album (Maybe AlbumDetails)

_artistSpotifyURILens :: Lens' Artist SpotURI Source

_artistSpotifyIDLens :: Lens' Artist SpotID Source

_artistNameLens :: Lens' Artist Text Source

_artistHrefLens :: Lens' Artist URL Source

_artistExternalUrlsLens :: Lens' Artist [ExternalURL] Source

_artistDetailsLens :: Lens' Artist (Maybe ArtistDetails) Source

data TrackDetails Source

Constructors

TrackDetails
Fields _trackAvailableMarkets :: [Text] _trackExternalIDs :: [ExternalID] _trackPopularity :: Int

class HasAvailableMarkets c e | c -> e where Source

Methods

availableMarkets :: Lens' c e Source

Instances

HasAvailableMarkets TrackDetails [Text]
HasAvailableMarkets Album [Text]

class HasExternalIDs c e | c -> e where Source

Methods

externalIDs :: Lens' c e Source

Instances

HasExternalIDs TrackDetails [ExternalID]
HasExternalIDs AlbumDetails [ExternalID]

_trackExternalIDsLens :: Lens' TrackDetails [ExternalID] Source

_trackAvailableMarketsLens :: Lens' TrackDetails [Text] Source

data Track Source

Constructors

Track
Fields _trackArtists :: [Artist] _trackDiscNumber :: Int _trackDurationMs :: Int _trackExplicit :: Bool _trackExternalUrls :: [ExternalURL] _trackHref :: URL _trackSpotifyID :: SpotID _trackName :: Text _trackPreviewURL :: URL _trackNumber :: Int _trackSpotifyURI :: SpotURI _trackDetails :: Maybe TrackDetails

class HasArtists c e | c -> e where Source

Methods

artists :: Lens' c e Source

Instances

HasArtists Track [Artist]
HasArtists AlbumDetails [Artist]

class HasDiscNumber c e | c -> e where Source

Methods

discNumber :: Lens' c e Source

Instances

HasDiscNumber Track Int

class HasDurationMs c e | c -> e where Source

Methods

durationMs :: Lens' c e Source

Instances

HasDurationMs Track Int

class HasExplicit c e | c -> e where Source

Methods

explicit :: Lens' c e Source

Instances

HasExplicit Track Bool

class HasPreviewURL c e | c -> e where Source

Methods

previewURL :: Lens' c e Source

Instances

HasPreviewURL Track URL

class HasNumber c e | c -> e where Source

Methods

number :: Lens' c e Source

Instances

HasNumber Track Int

_trackSpotifyURILens :: Lens' Track SpotURI Source

_trackSpotifyIDLens :: Lens' Track SpotID Source

_trackPreviewURLLens :: Lens' Track URL Source

_trackNumberLens :: Lens' Track Int Source

_trackNameLens :: Lens' Track Text Source

_trackHrefLens :: Lens' Track URL Source

_trackExternalUrlsLens :: Lens' Track [ExternalURL] Source

_trackExplicitLens :: Lens' Track Bool Source

_trackDurationMsLens :: Lens' Track Int Source

_trackDiscNumberLens :: Lens' Track Int Source

_trackDetailsLens :: Lens' Track (Maybe TrackDetails) Source

_trackArtistsLens :: Lens' Track [Artist] Source

data AlbumDetails Source

Constructors

AlbumDetails
Fields _albumArtists :: [Artist] _albumExternalIDs :: [ExternalID] _albumGenres :: [Text] _albumPopularity :: Int _albumReleaseDate :: Text _albumReleaseDatePrecision :: Text _albumTracks :: Paging Track

class HasReleaseDate c e | c -> e where Source

Methods

releaseDate :: Lens' c e Source

Instances

HasReleaseDate AlbumDetails Text

class HasReleaseDatePrecision c e | c -> e where Source

Methods

releaseDatePrecision :: Lens' c e Source

Instances

HasReleaseDatePrecision AlbumDetails Text

class HasTracks c e | c -> e where Source

Methods

tracks :: Lens' c e Source

Instances

HasTracks AlbumDetails (Paging Track)

_albumTracksLens :: Lens' AlbumDetails (Paging Track) Source

_albumReleaseDatePrecisionLens :: Lens' AlbumDetails Text Source

_albumReleaseDateLens :: Lens' AlbumDetails Text Source

_albumGenresLens :: Lens' AlbumDetails [Text] Source

_albumExternalIDsLens :: Lens' AlbumDetails [ExternalID] Source

_albumArtistsLens :: Lens' AlbumDetails [Artist] Source

data Album Source

Constructors

Album
Fields _albumType :: Text _albumAvailableMarkets :: [Text] _albumExternalURLs :: [ExternalURL] _albumHref :: Text _albumSpotifyID :: SpotID _albumImages :: [Image] _albumName :: Text _albumSpotifyURI :: SpotURI _albumDetails :: Maybe AlbumDetails

class HasExternalURLs c e | c -> e where Source

Methods

externalURLs :: Lens' c e Source

Instances

HasExternalURLs Album [ExternalURL]

_albumTypeLens :: Lens' Album Text Source

_albumSpotifyURILens :: Lens' Album SpotURI Source

_albumSpotifyIDLens :: Lens' Album SpotID Source

_albumNameLens :: Lens' Album Text Source

_albumImagesLens :: Lens' Album [Image] Source

_albumHrefLens :: Lens' Album Text Source

_albumExternalURLsLens :: Lens' Album [ExternalURL] Source

_albumDetailsLens :: Lens' Album (Maybe AlbumDetails) Source

_albumAvailableMarketsLens :: Lens' Album [Text] Source

Eq ExternalID
Ord ExternalID
Show ExternalID
HasIdentifier ExternalID Text
HasType ExternalID Text
HasExternalIDs TrackDetails [ExternalID]
HasExternalIDs AlbumDetails [ExternalID]
FromJSON [ExternalID]

Eq ExternalURL
Ord ExternalURL
Show ExternalURL
HasType ExternalURL Text
HasExternalUrls User [ExternalURL]
HasExternalUrls Artist [ExternalURL]
HasExternalUrls Track [ExternalURL]
HasExternalURLs Album [ExternalURL]
FromJSON [ExternalURL]

Eq ArtistDetails
Ord ArtistDetails
Show ArtistDetails
FromJSON ArtistDetails
HasPopularity ArtistDetails Int
HasImages ArtistDetails [Image]
HasGenres ArtistDetails [Text]
HasDetails Artist (Maybe ArtistDetails)

Eq Artist
Ord Artist
Show Artist
FromJSON Artist
HasHref Artist URL
HasSpotifyURI Artist SpotURI
HasSpotifyID Artist SpotID
HasName Artist Text
HasExternalUrls Artist [ExternalURL]
HasDetails Artist (Maybe ArtistDetails)
HasArtists Track [Artist]
HasArtists AlbumDetails [Artist]

Eq TrackDetails
Ord TrackDetails
Show TrackDetails
FromJSON TrackDetails
HasPopularity TrackDetails Int
HasDetails Track (Maybe TrackDetails)
HasExternalIDs TrackDetails [ExternalID]
HasAvailableMarkets TrackDetails [Text]

Eq Track
Ord Track
Show Track
FromJSON Track
HasHref Track URL
HasSpotifyURI Track SpotURI
HasSpotifyID Track SpotID
HasName Track Text
HasNumber Track Int
HasPreviewURL Track URL
HasExplicit Track Bool
HasDurationMs Track Int
HasDiscNumber Track Int
HasExternalUrls Track [ExternalURL]
HasDetails Track (Maybe TrackDetails)
HasArtists Track [Artist]
HasTracks AlbumDetails (Paging Track)

Eq AlbumDetails
Ord AlbumDetails
Show AlbumDetails
FromJSON AlbumDetails
HasPopularity AlbumDetails Int
HasReleaseDatePrecision AlbumDetails Text
HasReleaseDate AlbumDetails Text
HasGenres AlbumDetails [Text]
HasDetails Album (Maybe AlbumDetails)
HasExternalIDs AlbumDetails [ExternalID]
HasArtists AlbumDetails [Artist]
HasTracks AlbumDetails (Paging Track)

Eq Album
Ord Album
Show Album
FromJSON Album
HasType Album Text
HasHref Album Text
HasSpotifyURI Album SpotURI
HasSpotifyID Album SpotID
HasName Album Text
HasImages Album [Image]
HasDetails Album (Maybe AlbumDetails)
HasAvailableMarkets Album [Text]
HasExternalURLs Album [ExternalURL]