lidarr

Documentation

Index

• type AddArtistOptions
• type AddArtistRequest
• type Artist
  • func (m Artist) String() string
• type ArtistImage
• type Client
  • func NewClient(c Config) (*Client, error)
  • func (c *Client) AddArtist(m Artist, metadataProfile int, qualityProfile int, path string) (artist Artist, err error)
  • func (c *Client) GetFolders() ([]Folder, error)
  • func (c *Client) GetProfile(endpoint string) ([]Profile, error)
  • func (c *Client) SearchArtists(term string) ([]Artist, error)
• type Config
• type Folder
• type Profile

Types

type AddArtistOptions

type AddArtistOptions struct {
	SearchForMissingAlbums bool `json:"searchForMissingAlbums"`
}

type AddArtistRequest

type AddArtistRequest struct {
	ArtistName        string           `json:"artistName"`
	CleanName         string           `json:"cleanName"`
	Images            []ArtistImage    `json:"images"`
	QualityProfileID  int              `json:"qualityProfileId"`
	MetadataProfileID int              `json:"metadataProfileId"`
	ForeignArtistID   string           `json:"foreignArtistId"`
	RootFolderPath    string           `json:"rootFolderPath"`
	Monitored         bool             `json:"monitored"`
	AddOptions        AddArtistOptions `json:"addOptions"`
}

type Artist

type Artist struct {
	ArtistName      string        `json:"artistName"`
	CleanName       string        `json:"cleanName"`
	Disambiguation  string        `json:"disambiguation"`
	ForeignArtistID string        `json:"foreignArtistId"`
	Images          []ArtistImage `json:"images"`
}

func (Artist) String

func (m Artist) String() string

type ArtistImage

type ArtistImage struct {
	CoverType string `json:"coverType"`
	URL       string `json:"url"`
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(c Config) (*Client, error)

func (*Client) AddArtist

func (c *Client) AddArtist(m Artist, metadataProfile int, qualityProfile int, path string) (artist Artist, err error)

func (*Client) GetFolders

func (c *Client) GetFolders() ([]Folder, error)

func (*Client) GetProfile

func (c *Client) GetProfile(endpoint string) ([]Profile, error)

func (*Client) SearchArtists

func (c *Client) SearchArtists(term string) ([]Artist, error)

type Config

type Config struct {
	Hostname   string `json:"hostname"`
	APIKey     string `json:"apiKey"`
	Port       int    `json:"port"`
	URLBase    string `json:"urlBase"`
	SSL        bool   `json:"ssl"`
	Username   string `json:"username"`
	Password   string `json:"password"`
	MaxResults int    `json:"maxResults"`
}

type Folder

type Folder struct {
	Path      string `json:"path"`
	FreeSpace int64  `json:"freeSpace"`
	ID        int    `json:"id"`
}

type Profile

type Profile struct {
	Name string `json:"name"`
	ID   int    `json:"id"`
}