model

Documentation

Index

• type Album
• type Artist
• type Author
• type Book
• type Config
  • func NewConfig() *Config
• type Episode
• type EpisodeFile
• type History
• type Indexer
• type IndexerStatResponse
• type IndexerStats
• type Missing
• type Movie
• type Queue
• type QueueRecords
• type RootFolder
• type Seasons
• type Series
• type SongFile
• type SystemHealth
• type SystemStatus
• type UserAgentStats

Types

type Album

type Album []struct {
	Id        int      `json:"id"`
	Monitored bool     `json:"monitored"`
	Genres    []string `json:"genres"`
	Duration  int      `json:"duration"`
}

Album - Stores struct of JSON response

type Artist

type Artist []struct {
	Id         int    `json:"id"`
	Status     string `json:"status"`
	Ended      bool   `json:"ended"`
	Monitored  bool   `json:"monitored"`
	Statistics struct {
		AlbumCount      int   `json:"albumCount"`
		TrackFileCount  int   `json:"trackFileCount"`
		TrackCount      int   `json:"trackCount"`
		TotalTrackCount int   `json:"totalTrackCount"`
		SizeOnDisk      int64 `json:"sizeOnDisk"`
	} `json:"statistics"`
	Genres           []string `json:"genres"`
	QualityProfileID int      `json:"qualityProfileId"`
}

Artist - Stores struct of JSON response

type Author

type Author []struct {
	Id         int    `json:"id"`
	AuthorName string `json:"authorName"`
	Monitored  bool   `json:"monitored"`
	Statistics struct {
		BookCount      int     `json:"bookCount"`
		BookFileCount  int     `json:"bookFileCount"`
		TotalBookCount int     `json:"totalBookCount"`
		SizeOnDisk     int64   `json:"sizeOnDisk"`
		PercentOfBooks float32 `json:"percentOfBooks"`
	} `json:"statistics"`
}

type Book

type Book []struct {
	Monitored  bool `json:"monitored"`
	Grabbed    bool `json:"grabbed"`
	Statistics struct {
		BookFileCount int `json:"bookFileCount"`
	} `json:"statistics"`
}

type Config

type Config struct {
	XMLName    xml.Name `xml:"Config"`
	ApiKey     string   `xml:"ApiKey"`
	Port       string   `xml:"Port"`
	UrlBase    string   `xml:"UrlBase"`
	ApiVersion string   `xml:"ApiVersion"`
}

func NewConfig

func NewConfig() *Config

type Episode

type Episode []struct {
	Size      int    `json:"episodeFileId"`
	Title     string `json:"title"`
	HasFile   bool   `json:"hasFile"`
	Monitored bool   `json:"monitored"`
}

Episode - Stores struct of JSON response https://github.com/Sonarr/Sonarr/wiki/Episode

type EpisodeFile

type EpisodeFile []struct {
	Size    int64 `json:"size"`
	Quality struct {
		Quality struct {
			ID         int    `json:"id"`
			Name       string `json:"name"`
			Source     string `json:"source"`
			Resolution int    `json:"resolution"`
		} `json:"quality"`
	} `json:"quality"`
}

EpisodeFile - Stores struct of JSON response https://github.com/Sonarr/Sonarr/wiki/EpisodeFile

type History

type History struct {
	TotalRecords int `json:"totalRecords"`
}

History - Stores struct of JSON response

type Indexer

type Indexer []struct {
	Name     string `json:"name"`
	SortName string `json:"sortName"`
	Enabled  bool   `json:"enable"`
	Fields   []struct {
		Name string `json:"name"`
		// Value has multiple types, depending on the field, so it
		// must be typecast at the call site.
		Value interface{} `json:"value"`
	} `json:"fields"`
}

type IndexerStatResponse

type IndexerStatResponse struct {
	Indexers   []IndexerStats   `json:"indexers"`
	UserAgents []UserAgentStats `json:"userAgents"`
}

type IndexerStats

type IndexerStats struct {
	Name                      string `json:"indexerName"`
	AverageResponseTime       int    `json:"averageResponseTime"`
	NumberOfQueries           int    `json:"numberOfQueries"`
	NumberOfGrabs             int    `json:"numberOfGrabs"`
	NumberOfRssQueries        int    `json:"numberOfRssQueries"`
	NumberOfAuthQueries       int    `json:"numberOfAuthQueries"`
	NumberOfFailedQueries     int    `json:"numberOfFailedQueries"`
	NumberOfFailedGrabs       int    `json:"numberOfFailedGrabs"`
	NumberOfFailedRssQueries  int    `json:"numberOfFailedRssQueries"`
	NumberOfFailedAuthQueries int    `json:"numberOfFailedAuthQueries"`
}

type Missing

type Missing struct {
	TotalRecords int `json:"totalRecords"`
}

Missing - Stores struct of JSON response https://github.com/Sonarr/Sonarr/wiki/Wanted-Missing

type Movie

type Movie []struct {
	Status    string `json:"status"`
	HasFile   bool   `json:"hasFile"`
	Available bool   `json:"isAvailable"`
	Monitored bool   `json:"monitored"`
	MovieFile struct {
		Size    int64 `json:"size"`
		Quality struct {
			Quality struct {
				Name string `json:"name"`
			} `json:"quality"`
		} `json:"quality"`
	} `json:"movieFile"`
	QualityProfileID int `json:"qualityProfileId"`
}

Movie - Stores struct of JSON response

type Queue

type Queue struct {
	Page          int            `json:"page"`
	PageSize      int            `json:"pageSize"`
	SortKey       string         `json:"sortKey"`
	SortDirection string         `json:"sortDirection"`
	TotalRecords  int            `json:"totalRecords"`
	Records       []QueueRecords `json:"records"`
}

Queue - Stores struct of JSON response

type QueueRecords

type QueueRecords struct {
	Size                  float64 `json:"size"`
	Title                 string  `json:"title"`
	Status                string  `json:"status"`
	TrackedDownloadStatus string  `json:"trackedDownloadStatus"`
	TrackedDownloadState  string  `json:"trackedDownloadState"`
	StatusMessages        []struct {
		Title    string   `json:"title"`
		Messages []string `json:"messages"`
	} `json:"statusMessages"`
	ErrorMessage string `json:"errorMessage"`
}

QueueRecords - Stores struct of JSON response

type RootFolder

type RootFolder []struct {
	Path      string `json:"path"`
	FreeSpace int64  `json:"freeSpace"`
}

RootFolder - Stores struct of JSON response

type Seasons

type Seasons struct {
	Monitored         bool `json:"monitored"`
	EpisodeFileCount  int  `json:"episodeFileCount"`
	EpisodeCount      int  `json:"episodeCount"`
	TotalEpisodeCount int  `json:"totalEpisodeCount"`
	Statistics        struct {
		EpisodeFileCount  int     `json:"episodeFileCount"`
		EpisodeCount      int     `json:"episodeCount"`
		TotalEpisodeCount int     `json:"totalEpisodeCount"`
		SizeOnDisk        int64   `json:"sizeOnDisk"`
		PercentOfEpisodes float32 `json:"percentOfEpisodes"`
	} `json:"statistics"`
}

Seasons - Stores struct of JSON response https://github.com/Sonarr/Sonarr/wiki/Seasons

type Series

type Series []struct {
	Id         int       `json:"id"`
	Monitored  bool      `json:"monitored"`
	Seasons    []Seasons `json:"seasons"`
	Statistics struct {
		SeasonCount       int     `json:"seasonCount"`
		EpisodeFileCount  int     `json:"episodeFileCount"`
		EpisodeCount      int     `json:"episodeCount"`
		TotalEpisodeCount int     `json:"totalEpisodeCount"`
		SizeOnDisk        int64   `json:"sizeOnDisk"`
		PercentOfEpisodes float32 `json:"percentOfEpisodes"`
	} `json:"statistics"`
}

Series - Stores struct of JSON response https://github.com/Sonarr/Sonarr/wiki/Series

type SongFile

type SongFile []struct {
	Size    int64 `json:"size"`
	Quality struct {
		Quality struct {
			ID   int    `json:"id"`
			Name string `json:"name"`
		} `json:"quality"`
	} `json:"quality"`
}

SongFile - Stores struct of JSON response

type SystemHealth

type SystemHealth []struct {
	Source  string `json:"source"`
	Type    string `json:"type"`
	Message string `json:"message"`
	WikiURL string `json:"wikiUrl"`
}

SystemHealth - Stores struct of JSON response

type SystemStatus

type SystemStatus struct {
	Version string `json:"version"`
	AppData string `json:"appData"`
	Branch  string `json:"branch"`
}

SystemStatus - Stores struct of JSON response

type UserAgentStats

type UserAgentStats struct {
	UserAgent       string `json:"userAgent"`
	NumberOfQueries int    `json:"numberOfQueries"`
	NumberOfGrabs   int    `json:"numberOfGrabs"`
}