readarr

package
v0.0.0-...-f30bd74 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2024 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	FilterAll starr.Filtering = iota
	FilterGrabbed

	FilterBookFileImported
	FilterDownloadFailed
	FilterDeleted
	FilterRenamed
	FilterImportFailed
	FilterDownloadImported
	FilterRetagged
	FilterIgnored
)

Filter values are integers. Given names for ease of discovery. https://github.com/Readarr/Readarr/blob/de72cfcaaa22495c7ce9fcb596a93beff6efb3d6/src/NzbDrone.Core/History/EntityHistory.cs#L31-L43

View Source 
const APIver = "v1"

APIver is the Readarr API version supported by this library.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddAuthorOptions 

type AddAuthorOptions struct {
	SearchForMissingBooks bool    `json:"searchForMissingBooks"`
	Monitored             bool    `json:"monitored"`
	Monitor               string  `json:"monitor"`
	BooksToMonitor        []int64 `json:"booksToMonitor"`
}

AddAuthorOptions is part of AddBookAuthor.

type AddBookAuthor 

type AddBookAuthor struct {
	Monitored         bool              `json:"monitored"`         // true?
	QualityProfileID  int64             `json:"qualityProfileId"`  // required
	MetadataProfileID int64             `json:"metadataProfileId"` // required
	ForeignAuthorID   string            `json:"foreignAuthorId"`   // required
	RootFolderPath    string            `json:"rootFolderPath"`    // required
	Tags              []int             `json:"tags"`
	AddOptions        *AddAuthorOptions `json:"addOptions"`
}

AddBookAuthor is part of AddBookInput.

type AddBookEdition 

type AddBookEdition struct {
	Title            string         `json:"title"`            // Edition Title
	TitleSlug        string         `json:"titleSlug"`        // Slugs are dumb
	Images           []*starr.Image `json:"images"`           // this is dumb too
	ForeignEditionID string         `json:"foreignEditionId"` // GRID ID
	Monitored        bool           `json:"monitored"`        // true
	ManualAdd        bool           `json:"manualAdd"`        // true
}

AddBookEdition is part of AddBookInput.

type AddBookInput 

type AddBookInput struct {
	Monitored     bool              `json:"monitored"`
	Tags          []int             `json:"tags"`
	AddOptions    *AddBookOptions   `json:"addOptions"`    // Contains Search.
	Author        *AddBookAuthor    `json:"author"`        // Contains Author ID
	Editions      []*AddBookEdition `json:"editions"`      // contains GRID Edition ID
	ForeignBookID string            `json:"foreignBookId"` // GRID Book ID.
}

AddBookInput is the input to add a book.

type AddBookOptions 

type AddBookOptions struct {
	AddType          string `json:"addType,omitempty"`
	SearchForNewBook bool   `json:"searchForNewBook"`
}

AddBookOptions is part of AddBookInput.

type AudioCountry 

type AudioCountry struct {
	TwoLetterCode string `json:"twoLetterCode"`
	Name          string `json:"name"`
}

AudioCountry is part of AudioTags.

type AudioMediaInfo 

type AudioMediaInfo struct {
	AudioFormat     string `json:"audioFormat"`
	AudioBitrate    int    `json:"audioBitrate"`
	AudioChannels   int    `json:"audioChannels"`
	AudioBits       int    `json:"audioBits"`
	AudioSampleRate int    `json:"audioSampleRate"`
}

AudioMediaInfo is part of AudioTags.

type AudioTags 

type AudioTags struct {
	Title          string          `json:"title"`
	CleanTitle     string          `json:"cleanTitle"`
	Authors        []string        `json:"authors"`
	AuthorTitle    string          `json:"authorTitle"`
	BookTitle      string          `json:"bookTitle"`
	SeriesTitle    string          `json:"seriesTitle"`
	SeriesIndex    string          `json:"seriesIndex"`
	ISBN           string          `json:"isbn"`
	ASIN           string          `json:"asin"`
	GoodreadsID    string          `json:"goodreadsId"`
	AuthorMBID     string          `json:"authorMBId"`
	BookMBID       string          `json:"bookMBId"`
	ReleaseMBID    string          `json:"releaseMBId"`
	RecordingMBID  string          `json:"recordingMBId"`
	TrackMBID      string          `json:"trackMBId"`
	DiscNumber     int             `json:"discNumber"`
	DiscCount      int             `json:"discCount"`
	Country        *AudioCountry   `json:"country"`
	Year           int             `json:"year"`
	Publisher      string          `json:"publisher"`
	Label          string          `json:"label"`
	Source         string          `json:"source"`
	CatalogNumber  string          `json:"catalogNumber"`
	Disambiguation string          `json:"disambiguation"`
	Duration       *starr.TimeSpan `json:"duration"`
	Quality        *starr.Quality  `json:"quality"`
	MediaInfo      *AudioMediaInfo `json:"mediaInfo"`
	TrackNumbers   []int           `json:"trackNumbers"`
	Language       string          `json:"language"`
	ReleaseGroup   string          `json:"releaseGroup"`
	ReleaseHash    string          `json:"releaseHash"`
}

AudioTags are part of a bookfile.

type Author 

type Author struct {
	ID                  int64          `json:"id"`
	Status              string         `json:"status,omitempty"`
	AuthorName          string         `json:"authorName,omitempty"`
	ForeignAuthorID     string         `json:"foreignAuthorId,omitempty"`
	TitleSlug           string         `json:"titleSlug,omitempty"`
	Overview            string         `json:"overview,omitempty"`
	Links               []*starr.Link  `json:"links,omitempty"`
	Images              []*starr.Image `json:"images,omitempty"`
	Path                string         `json:"path,omitempty"`
	QualityProfileID    int            `json:"qualityProfileId,omitempty"`
	MetadataProfileID   int            `json:"metadataProfileId,omitempty"`
	Genres              []string       `json:"genres,omitempty"`
	CleanName           string         `json:"cleanName,omitempty"`
	SortName            string         `json:"sortName,omitempty"`
	Tags                []int          `json:"tags,omitempty"`
	Added               time.Time      `json:"added,omitempty"`
	Ratings             *starr.Ratings `json:"ratings,omitempty"`
	Statistics          *Statistics    `json:"statistics,omitempty"`
	LastBook            *AuthorBook    `json:"lastBook,omitempty"`
	NextBook            *AuthorBook    `json:"nextBook,omitempty"`
	Ended               bool           `json:"ended,omitempty"`
	Monitored           bool           `json:"monitored"`
	AuthorMetadataID    int64          `json:"authorMetadataId"`
	AuthorNameLastFirst string         `json:"authorNameLastFirst"`
	MonitorNewItems     string         `json:"monitorNewItems"`
	SortNameLastFirst   string         `json:"sortNameLastFirst"`
}

Author is the /api/v1/author endpoint.

type AuthorBook 

type AuthorBook struct {
	ID               int64           `json:"id"`
	AuthorMetadataID int             `json:"authorMetadataId"`
	ForeignBookID    string          `json:"foreignBookId"`
	TitleSlug        string          `json:"titleSlug"`
	Title            string          `json:"title"`
	ReleaseDate      time.Time       `json:"releaseDate"`
	Links            []*starr.Link   `json:"links"`
	Genres           []string        `json:"genres"`
	Ratings          *starr.Ratings  `json:"ratings"`
	CleanTitle       string          `json:"cleanTitle"`
	Monitored        bool            `json:"monitored"`
	AnyEditionOk     bool            `json:"anyEditionOk"`
	LastInfoSync     time.Time       `json:"lastInfoSync"`
	Added            time.Time       `json:"added"`
	AddOptions       *AddBookOptions `json:"addOptions"`
	AuthorMetadata   *starr.IsLoaded `json:"authorMetadata"`
	Author           *starr.IsLoaded `json:"author"`
	Editions         *starr.IsLoaded `json:"editions"`
	BookFiles        *starr.IsLoaded `json:"bookFiles"`
	SeriesLinks      *starr.IsLoaded `json:"seriesLinks"`
}

AuthorBook is part of an Author, and is very different from a normal Book type.

type BlockList 

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

BlockList represents the /api/v1/blocklist endpoint.

type BlockListRecord 

type BlockListRecord struct {
	Author        *Author        `json:"author"`
	Quality       *starr.Quality `json:"quality"`
	CustomFormats []interface{}  `json:"customFormats"`
	BookIDs       []int64        `json:"bookIds"`
	ID            int64          `json:"id"`
	AuthorID      int64          `json:"authorId"`
	Date          time.Time      `json:"date"`
	SourceTitle   string         `json:"sourceTitle"`
	Protocol      starr.Protocol `json:"protocol"`
	Indexer       string         `json:"indexer"`
	Message       string         `json:"message"`
}

BlockListRecord represents a single block list item.

type Book 

type Book struct {
	Added          time.Time      `json:"added"`
	AnyEditionOk   bool           `json:"anyEditionOk"`
	AuthorID       int64          `json:"authorId"`
	AuthorTitle    string         `json:"authorTitle"`
	Disambiguation string         `json:"disambiguation,omitempty"`
	Editions       []*Edition     `json:"editions"`
	ForeignBookID  string         `json:"foreignBookId"`
	Genres         []string       `json:"genres"`
	ID             int64          `json:"id"`
	Images         []*starr.Image `json:"images"`
	Links          []*starr.Link  `json:"links"`
	Monitored      bool           `json:"monitored"`
	Grabbed        bool           `json:"grabbed"`
	Overview       string         `json:"overview"`
	PageCount      int            `json:"pageCount"`
	Ratings        *starr.Ratings `json:"ratings"`
	ReleaseDate    time.Time      `json:"releaseDate"`
	RemoteCover    string         `json:"remoteCover,omitempty"`
	SeriesTitle    string         `json:"seriesTitle"`
	Statistics     *Statistics    `json:"statistics,omitempty"`
	Title          string         `json:"title"`
	TitleSlug      string         `json:"titleSlug"`
	Author         *Author        `json:"author"`
}

Book is the /api/v1/book endpoint among others, and gets used across this package.

type BookFile 

type BookFile struct {
	AuthorID            int64          `json:"authorId"`
	BookID              int64          `json:"bookId"`
	Path                string         `json:"path"`
	Size                int            `json:"size,omitempty"`
	DateAdded           time.Time      `json:"dateAdded,omitempty"`
	Quality             *starr.Quality `json:"quality"`
	QualityWeight       int            `json:"qualityWeight,omitempty"`
	QualityCutoffNotMet bool           `json:"qualityCutoffNotMet"`
	ID                  int64          `json:"id"`
	AudioTags           *AudioTags     `json:"audioTags,omitempty"`
}

BookFile represents the data from the bookfile endpoint.

type CRF 

type CRF int

CRF is ColonReplacementFormat, for naming config. 

const (
	ColonDelete CRF = iota
	ColonReplaceWithDash
	ColonReplaceWithSpaceDash
	ColonReplaceWithSpaceDashSpace
	ColonSmartReplace
)

These are all of the possible Colon Replacement Formats (for naming config) in Readarr.

type Calendar 

type Calendar struct {
	Start         time.Time
	End           time.Time
	Unmonitored   bool
	IncludeAuthor bool
}

Calendar defines the filters for fetching calendar items.

type CommandRequest 

type CommandRequest struct {
	Name    string  `json:"name"`
	BookIDs []int64 `json:"bookIds,omitempty"`
	BookID  int64   `json:"bookId,omitempty"`
}

CommandRequest goes into the /api/v1/command endpoint. This was created from the search command and may not support other commands yet.

type CommandResponse 

type CommandResponse struct {
	ID                  int64                  `json:"id"`
	Name                string                 `json:"name"`
	CommandName         string                 `json:"commandName"`
	Message             string                 `json:"message,omitempty"`
	Priority            string                 `json:"priority"`
	Status              string                 `json:"status"`
	Queued              time.Time              `json:"queued"`
	Started             time.Time              `json:"started,omitempty"`
	Ended               time.Time              `json:"ended,omitempty"`
	StateChangeTime     time.Time              `json:"stateChangeTime,omitempty"`
	LastExecutionTime   time.Time              `json:"lastExecutionTime,omitempty"`
	Duration            string                 `json:"duration,omitempty"`
	Trigger             string                 `json:"trigger"`
	SendUpdatesToClient bool                   `json:"sendUpdatesToClient"`
	UpdateScheduledTask bool                   `json:"updateScheduledTask"`
	Body                map[string]interface{} `json:"body"`
}

CommandResponse comes from the /api/v1/command endpoint.

type DownloadClientConfig 

type DownloadClientConfig struct {
	EnableCompletedDownloadHandling bool   `json:"enableCompletedDownloadHandling"`
	AutoRedownloadFailed            bool   `json:"autoRedownloadFailed"`
	ID                              int64  `json:"id"`
	DownloadClientWorkingFolders    string `json:"downloadClientWorkingFolders"`
	RemoveCompletedDownloads        bool   `json:"removeCompletedDownloads"`
	RemoveFailedDownloads           bool   `json:"removeFailedDownloads"`
}

DownloadClientConfig is the /api/v1/config/downloadClientConfig endpoint.

type DownloadClientInput 

type DownloadClientInput struct {
	Enable             bool                `json:"enable"`
	Priority           int                 `json:"priority"`
	ID                 int64               `json:"id,omitempty"`
	ConfigContract     string              `json:"configContract"`
	Implementation     string              `json:"implementation"`
	ImplementationName string              `json:"implementationName"`
	Name               string              `json:"name"`
	Protocol           starr.Protocol      `json:"protocol"`
	Tags               []int               `json:"tags"`
	Fields             []*starr.FieldInput `json:"fields"`
}

DownloadClientInput is the input for a new or updated download client.

type DownloadClientOutput 

type DownloadClientOutput struct {
	Enable             bool                 `json:"enable"`
	Priority           int                  `json:"priority"`
	ID                 int64                `json:"id,omitempty"`
	ConfigContract     string               `json:"configContract"`
	Implementation     string               `json:"implementation"`
	ImplementationName string               `json:"implementationName"`
	InfoLink           string               `json:"infoLink"`
	Name               string               `json:"name"`
	Protocol           starr.Protocol       `json:"protocol"`
	Tags               []int                `json:"tags"`
	Fields             []*starr.FieldOutput `json:"fields"`
}

DownloadClientOutput is the output from the download client methods.

type Edition 

type Edition struct {
	ID               int64          `json:"id"`
	BookID           int64          `json:"bookId"`
	ForeignEditionID string         `json:"foreignEditionId"`
	TitleSlug        string         `json:"titleSlug"`
	Isbn13           string         `json:"isbn13"`
	Asin             string         `json:"asin"`
	Title            string         `json:"title"`
	Overview         string         `json:"overview"`
	Format           string         `json:"format"`
	Publisher        string         `json:"publisher"`
	PageCount        int            `json:"pageCount"`
	ReleaseDate      time.Time      `json:"releaseDate"`
	Images           []*starr.Image `json:"images"`
	Links            []*starr.Link  `json:"links"`
	Ratings          *starr.Ratings `json:"ratings"`
	Monitored        bool           `json:"monitored"`
	ManualAdd        bool           `json:"manualAdd"`
	IsEbook          bool           `json:"isEbook"`
}

Edition is more Book meta data.

type Exclusion 

type Exclusion struct {
	ForeignID  string `json:"foreignId"`
	AuthorName string `json:"authorName"`
	ID         int64  `json:"id,omitempty"`
}

Exclusion is a Readarr excluded item.

type History 

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

History is the /api/v1/history endpoint.

type HistoryRecord 

type HistoryRecord struct {
	ID                  int64          `json:"id"`
	BookID              int64          `json:"bookId"`
	AuthorID            int64          `json:"authorId"`
	SourceTitle         string         `json:"sourceTitle"`
	Quality             *starr.Quality `json:"quality"`
	QualityCutoffNotMet bool           `json:"qualityCutoffNotMet"`
	Date                time.Time      `json:"date"`
	DownloadID          string         `json:"downloadId"`
	EventType           string         `json:"eventType"`
	Data                struct {
		Age             string         `json:"age"`
		AgeHours        string         `json:"ageHours"`
		AgeMinutes      string         `json:"ageMinutes"`
		DownloadClient  string         `json:"downloadClient"`
		DownloadForced  string         `json:"downloadForced"`
		DownloadURL     string         `json:"downloadUrl"`
		DroppedPath     string         `json:"droppedPath"`
		GUID            string         `json:"guid"`
		ImportedPath    string         `json:"importedPath"`
		Indexer         string         `json:"indexer"`
		Message         string         `json:"message"`
		NzbInfoURL      string         `json:"nzbInfoUrl"`
		Protocol        starr.Protocol `json:"protocol"`
		PublishedDate   time.Time      `json:"publishedDate"`
		Reason          string         `json:"reason"`
		ReleaseGroup    string         `json:"releaseGroup"`
		Size            string         `json:"size"`
		StatusMessages  string         `json:"statusMessages"`
		TorrentInfoHash string         `json:"torrentInfoHash"`
	} `json:"data"`
}

HistoryRecord is part of the history. Not all items have all Data members. Check EventType for events you need.

type ImportListInput 

type ImportListInput struct {
	EnableAutomaticAdd    bool                `json:"enableAutomaticAdd"`
	ShouldMonitorExisting bool                `json:"shouldMonitorExisting"`
	ShouldSearch          bool                `json:"shouldSearch"`
	ListOrder             int                 `json:"listOrder"`
	ID                    int64               `json:"id,omitempty"` // for update not add.
	MetadataProfileID     int64               `json:"metadataProfileId,omitempty"`
	QualityProfileID      int64               `json:"qualityProfileId,omitempty"`
	ListType              string              `json:"listType,omitempty"`
	ConfigContract        string              `json:"configContract,omitempty"`
	Implementation        string              `json:"implementation,omitempty"`
	Name                  string              `json:"name,omitempty"`
	RootFolderPath        string              `json:"rootFolderPath,omitempty"`
	ShouldMonitor         string              `json:"shouldMonitor,omitempty"`
	MonitorNewItems       string              `json:"monitorNewItems,omitempty"`
	Tags                  []int               `json:"tags,omitempty"`
	Fields                []*starr.FieldInput `json:"fields,omitempty"`
}

ImportListInput is the input for a new or updated import list.

type ImportListOutput 

type ImportListOutput struct {
	EnableAutomaticAdd    bool                 `json:"enableAutomaticAdd"`
	ShouldMonitorExisting bool                 `json:"shouldMonitorExisting"`
	ShouldSearch          bool                 `json:"shouldSearch"`
	ID                    int64                `json:"id"`
	ListOrder             int64                `json:"listOrder"`
	MetadataProfileID     int64                `json:"metadataProfileId"`
	QualityProfileID      int64                `json:"qualityProfileId"`
	ConfigContract        string               `json:"configContract"`
	Implementation        string               `json:"implementation"`
	ImplementationName    string               `json:"implementationName"`
	InfoLink              string               `json:"infoLink"`
	ListType              string               `json:"listType"`
	MonitorNewItems       string               `json:"monitorNewItems"`
	Name                  string               `json:"name"`
	RootFolderPath        string               `json:"rootFolderPath"`
	ShouldMonitor         string               `json:"shouldMonitor"`
	Tags                  []int                `json:"tags"`
	Fields                []*starr.FieldOutput `json:"fields"`
}

ImportListOutput is the output from the import list methods.

type IndexerConfig 

type IndexerConfig struct {
	ID              int64 `json:"id"`
	MaximumSize     int64 `json:"maximumSize"`
	MinimumAge      int64 `json:"minimumAge"`
	Retention       int64 `json:"retention"`
	RssSyncInterval int64 `json:"rssSyncInterval"`
}

IndexerConfig represents the /config/indexer endpoint.

type IndexerInput 

type IndexerInput struct {
	EnableAutomaticSearch   bool                `json:"enableAutomaticSearch"`
	EnableInteractiveSearch bool                `json:"enableInteractiveSearch"`
	EnableRss               bool                `json:"enableRss"`
	Priority                int64               `json:"priority"`
	ID                      int64               `json:"id,omitempty"`
	ConfigContract          string              `json:"configContract"`
	Implementation          string              `json:"implementation"`
	Name                    string              `json:"name"`
	Protocol                starr.Protocol      `json:"protocol"`
	Tags                    []int               `json:"tags"`
	Fields                  []*starr.FieldInput `json:"fields"`
}

IndexerInput is the input for a new or updated indexer.

type IndexerOutput 

type IndexerOutput struct {
	EnableAutomaticSearch   bool                 `json:"enableAutomaticSearch"`
	EnableInteractiveSearch bool                 `json:"enableInteractiveSearch"`
	EnableRss               bool                 `json:"enableRss"`
	SupportsRss             bool                 `json:"supportsRss"`
	SupportsSearch          bool                 `json:"supportsSearch"`
	Priority                int64                `json:"priority"`
	ID                      int64                `json:"id,omitempty"`
	ConfigContract          string               `json:"configContract"`
	Implementation          string               `json:"implementation"`
	ImplementationName      string               `json:"implementationName"`
	InfoLink                string               `json:"infoLink"`
	Name                    string               `json:"name"`
	Protocol                starr.Protocol       `json:"protocol"`
	Tags                    []int                `json:"tags"`
	Fields                  []*starr.FieldOutput `json:"fields"`
}

IndexerOutput is the output from the indexer methods.

type ManualImportInput 

type ManualImportInput struct {
	ID                      int64          `json:"id"`
	Path                    string         `json:"path"`
	Name                    string         `json:"name"`
	AuthorID                int64          `json:"authorID"`
	BookID                  int64          `json:"bookID"`
	ForeignEditionID        int64          `json:"foreignEditionId"`
	Quality                 *starr.Quality `json:"quality"`
	ReleaseGroup            string         `json:"releaseGroup"`
	DownloadID              string         `json:"downloadId"`
	AdditionalFile          bool           `json:"additionalFile"`
	ReplaceExistingFiles    bool           `json:"replaceExistingFiles"`
	DisableReleaseSwitching bool           `json:"disableReleaseSwitching"`
	Rejections              []*Rejection   `json:"rejections"`
}

ManualImportInput is the input data for a manual import request using a POST request.

type ManualImportOutput 

type ManualImportOutput struct {
	ID                      int64          `json:"id"`
	Path                    string         `json:"path"`
	Name                    string         `json:"name"`
	Size                    int            `json:"size"`
	Author                  *Author        `json:"author"`
	Book                    *Book          `json:"book"`
	ForeignEditionID        int64          `json:"foreignEditionId"`
	Quality                 *starr.Quality `json:"quality"`
	ReleaseGroup            string         `json:"releaseGroup"`
	QualityWeight           int64          `json:"qualityWeight"`
	DownloadID              string         `json:"downloadId"`
	AudioTags               *AudioTags     `json:"audioTags"`
	AdditionalFile          bool           `json:"additionalFile"`
	ReplaceExistingFiles    bool           `json:"replaceExistingFiles"`
	DisableReleaseSwitching bool           `json:"disableReleaseSwitching"`
	Rejections              []*Rejection   `json:"rejections"`
}

ManualImportOutput is the output data for a manual import request.

type ManualImportParams 

type ManualImportParams struct {
	Folder               string
	DownloadID           string
	AuthorID             int64
	ReplaceExistingFiles bool
	FilterExistingFiles  bool
}

ManualImportParams provides the input parameters for the GET /manualimport API.

type MediaManagement 

type MediaManagement struct {
	SkipFreeSpaceCheckWhenImporting        bool   `json:"skipFreeSpaceCheckWhenImporting"`
	AutoUnmonitorPreviouslyDownloadedBooks bool   `json:"autoUnmonitorPreviouslyDownloadedBooks"`
	SetPermissionsLinux                    bool   `json:"setPermissionsLinux"`
	CreateEmptyAuthorFolders               bool   `json:"createEmptyAuthorFolders"`
	DeleteEmptyFolders                     bool   `json:"deleteEmptyFolders"`
	WatchLibraryForChanges                 bool   `json:"watchLibraryForChanges"`
	CopyUsingHardlinks                     bool   `json:"copyUsingHardlinks"`
	ImportExtraFiles                       bool   `json:"importExtraFiles"`
	MinimumFreeSpaceWhenImporting          int64  `json:"minimumFreeSpaceWhenImporting"`
	ID                                     int64  `json:"id"` // always 1
	RecycleBinCleanupDays                  int64  `json:"recycleBinCleanupDays"`
	RecycleBin                             string `json:"recycleBin"`
	DownloadPropersAndRepacks              string `json:"downloadPropersAndRepacks"`
	FileDate                               string `json:"fileDate"`
	RescanAfterRefresh                     string `json:"rescanAfterRefresh"`
	AllowFingerprinting                    string `json:"allowFingerprinting"`
	ChmodFolder                            string `json:"chmodFolder"`
	ChownGroup                             string `json:"chownGroup"`
	ExtraFileExtensions                    string `json:"extraFileExtensions"`
}

MediaManagement represents the /config/mediaManagement endpoint.

type MetadataProfile 

type MetadataProfile struct {
	ID                  int64   `json:"id"`
	Name                string  `json:"name"`
	MinPopularity       float64 `json:"minPopularity"`
	SkipMissingDate     bool    `json:"skipMissingDate"`
	SkipMissingIsbn     bool    `json:"skipMissingIsbn"`
	SkipPartsAndSets    bool    `json:"skipPartsAndSets"`
	SkipSeriesSecondary bool    `json:"skipSeriesSecondary"`
	AllowedLanguages    string  `json:"allowedLanguages,omitempty"`
}

MetadataProfile is the /api/v1/metadataProfile endpoint.

type Naming 

type Naming struct {
	RenameBooks              bool   `json:"renameBooks"`
	ReplaceIllegalCharacters bool   `json:"replaceIllegalCharacters"`
	IncludeAuthorName        bool   `json:"includeAuthorName"`
	IncludeBookTitle         bool   `json:"includeBookTitle"`
	IncludeQuality           bool   `json:"includeQuality"`
	ReplaceSpaces            bool   `json:"replaceSpaces"`
	ColonReplacementFormat   CRF    `json:"colonReplacementFormat"`
	ID                       int64  `json:"id"`
	StandardBookFormat       string `json:"standardBookFormat"`
	AuthorFolderFormat       string `json:"authorFolderFormat"`
}

Naming represents the config/naming endpoint in Readarr.

type NotificationInput 

type NotificationInput struct {
	OnGrab                     bool                `json:"onGrab,omitempty"`
	OnReleaseImport            bool                `json:"onReleaseImport,omitempty"`
	OnUpgrade                  bool                `json:"onUpgrade,omitempty"`
	OnRename                   bool                `json:"onRename,omitempty"`
	OnAuthorDelete             bool                `json:"onAuthorDelete,omitempty"`
	OnBookDelete               bool                `json:"onBookDelete,omitempty"`
	OnBookFileDelete           bool                `json:"onBookFileDelete,omitempty"`
	OnBookFileDeleteForUpgrade bool                `json:"onBookFileDeleteForUpgrade,omitempty"`
	OnHealthIssue              bool                `json:"onHealthIssue,omitempty"`
	OnDownloadFailure          bool                `json:"onDownloadFailure,omitempty"`
	OnImportFailure            bool                `json:"onImportFailure,omitempty"`
	OnBookRetag                bool                `json:"onBookRetag,omitempty"`
	OnApplicationUpdate        bool                `json:"onApplicationUpdate,omitempty"`
	IncludeHealthWarnings      bool                `json:"includeHealthWarnings,omitempty"`
	ID                         int64               `json:"id,omitempty"`
	Name                       string              `json:"name"`
	Implementation             string              `json:"implementation"`
	ConfigContract             string              `json:"configContract"`
	Tags                       []int               `json:"tags,omitempty"`
	Fields                     []*starr.FieldInput `json:"fields"`
}

NotificationInput is the input for a new or updated notification.

type NotificationOutput 

type NotificationOutput struct {
	OnGrab                             bool                 `json:"onGrab,omitempty"`
	OnReleaseImport                    bool                 `json:"onReleaseImport,omitempty"`
	OnUpgrade                          bool                 `json:"onUpgrade,omitempty"`
	OnRename                           bool                 `json:"onRename,omitempty"`
	OnAuthorDelete                     bool                 `json:"onAuthorDelete,omitempty"`
	OnBookDelete                       bool                 `json:"onBookDelete,omitempty"`
	OnBookFileDelete                   bool                 `json:"onBookFileDelete,omitempty"`
	OnBookFileDeleteForUpgrade         bool                 `json:"onBookFileDeleteForUpgrade,omitempty"`
	OnHealthIssue                      bool                 `json:"onHealthIssue,omitempty"`
	OnDownloadFailure                  bool                 `json:"onDownloadFailure,omitempty"`
	OnImportFailure                    bool                 `json:"onImportFailure,omitempty"`
	OnBookRetag                        bool                 `json:"onBookRetag,omitempty"`
	OnApplicationUpdate                bool                 `json:"onApplicationUpdate,omitempty"`
	SupportsOnGrab                     bool                 `json:"supportsOnGrab"`
	SupportsOnReleaseImport            bool                 `json:"supportsOnReleaseImport"`
	SupportsOnUpgrade                  bool                 `json:"supportsOnUpgrade"`
	SupportsOnRename                   bool                 `json:"supportsOnRename"`
	SupportsOnAuthorDelete             bool                 `json:"supportsOnAuthorDelete"`
	SupportsOnBookDelete               bool                 `json:"supportsOnBookDelete"`
	SupportsOnBookFileDelete           bool                 `json:"supportsOnBookFileDelete"`
	SupportsOnBookFileDeleteForUpgrade bool                 `json:"supportsOnBookFileDeleteForUpgrade"`
	SupportsOnApplicationUpdate        bool                 `json:"supportsOnApplicationUpdate"`
	SupportsOnDownloadFailure          bool                 `json:"supportsOnDownloadFailure"`
	SupportsOnImportFailure            bool                 `json:"supportsOnImportFailure"`
	SupportsOnBookRetag                bool                 `json:"supportsOnBookRetag"`
	SupportsOnHealthIssue              bool                 `json:"supportsOnHealthIssue"`
	IncludeHealthWarnings              bool                 `json:"includeHealthWarnings"`
	ID                                 int64                `json:"id"`
	Name                               string               `json:"name"`
	ImplementationName                 string               `json:"implementationName"`
	Implementation                     string               `json:"implementation"`
	ConfigContract                     string               `json:"configContract"`
	InfoLink                           string               `json:"infoLink"`
	Tags                               []int                `json:"tags"`
	Fields                             []*starr.FieldOutput `json:"fields"`
}

NotificationOutput is the output from the notification methods.

type QualityProfile 

type QualityProfile struct {
	ID                    int64               `json:"id"`
	Name                  string              `json:"name"`
	UpgradeAllowed        bool                `json:"upgradeAllowed"`
	Cutoff                int64               `json:"cutoff"`
	Qualities             []*starr.Quality    `json:"items"`
	MinFormatScore        int64               `json:"minFormatScore"`
	MinUpgradeFormatScore int64               `json:"minUpgradeFormatScore"`
	CutoffFormatScore     int64               `json:"cutoffFormatScore"`
	FormatItems           []*starr.FormatItem `json:"formatItems"`
}

QualityProfile is the /api/v1/qualityprofile endpoint.

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       []*QueueRecord `json:"records"`
}

Queue is the /api/v1/queue endpoint.

type QueueRecord 

type QueueRecord struct {
	HasPostImportCategory   bool                   `json:"downloadClientHasPostImportCategory"`
	AuthorID                int64                  `json:"authorId"`
	BookID                  int64                  `json:"bookId"`
	Quality                 *starr.Quality         `json:"quality"`
	Size                    float64                `json:"size"`
	Title                   string                 `json:"title"`
	Sizeleft                float64                `json:"sizeleft"`
	Timeleft                string                 `json:"timeleft"`
	EstimatedCompletionTime time.Time              `json:"estimatedCompletionTime"`
	Status                  string                 `json:"status"`
	TrackedDownloadStatus   string                 `json:"trackedDownloadStatus,omitempty"`
	TrackedDownloadState    string                 `json:"trackedDownloadState,omitempty"`
	StatusMessages          []*starr.StatusMessage `json:"statusMessages,omitempty"`
	DownloadID              string                 `json:"downloadId,omitempty"`
	Protocol                starr.Protocol         `json:"protocol"`
	DownloadClient          string                 `json:"downloadClient,omitempty"`
	Indexer                 string                 `json:"indexer"`
	OutputPath              string                 `json:"outputPath,omitempty"`
	DownloadForced          bool                   `json:"downloadForced"`
	ID                      int64                  `json:"id"`
	ErrorMessage            string                 `json:"errorMessage"`
}

QueueRecord is a book from the queue API path.

type Readarr 

type Readarr struct {
	starr.APIer
}

Readarr contains all the methods to interact with a Readarr server.

func New 

func New(config *starr.Config) *Readarr

New returns a Readarr object used to interact with the Readarr API.

func (*Readarr) AddBook 

func (r *Readarr) AddBook(book *AddBookInput) (*Book, error)

AddBook adds a new book to the library.

func (*Readarr) AddBookContext 

func (r *Readarr) AddBookContext(ctx context.Context, book *AddBookInput) (*Book, error)

AddBookContext adds a new book to the library.

func (*Readarr) AddDownloadClient 

func (r *Readarr) AddDownloadClient(downloadclient *DownloadClientInput) (*DownloadClientOutput, error)

AddDownloadClient creates a download client without testing it.

func (*Readarr) AddDownloadClientContext 

func (r *Readarr) AddDownloadClientContext(ctx context.Context,
	client *DownloadClientInput,
) (*DownloadClientOutput, error)

AddDownloadClientContext creates a download client without testing it.

func (*Readarr) AddExclusion 

func (r *Readarr) AddExclusion(exclusion *Exclusion) (*Exclusion, error)

AddExclusion adds one exclusion to Readarr.

func (*Readarr) AddExclusionContext 

func (r *Readarr) AddExclusionContext(ctx context.Context, exclusion *Exclusion) (*Exclusion, error)

AddExclusionContext adds one exclusion to Readarr.

func (*Readarr) AddImportList 

func (r *Readarr) AddImportList(importList *ImportListInput) (*ImportListOutput, error)

AddImportList creates an import list without testing it.

func (*Readarr) AddImportListContext 

func (r *Readarr) AddImportListContext(ctx context.Context, importList *ImportListInput) (*ImportListOutput, error)

AddImportListContext creates an import list without testing it.

func (*Readarr) AddIndexer 

func (r *Readarr) AddIndexer(indexer *IndexerInput) (*IndexerOutput, error)

AddIndexer creates an indexer without testing it.

func (*Readarr) AddIndexerContext 

func (r *Readarr) AddIndexerContext(ctx context.Context, indexer *IndexerInput) (*IndexerOutput, error)

AddIndexerContext creates an indexer without testing it.

func (*Readarr) AddNotification 

func (r *Readarr) AddNotification(notification *NotificationInput) (*NotificationOutput, error)

AddNotification creates a notification.

func (*Readarr) AddNotificationContext 

func (r *Readarr) AddNotificationContext(ctx context.Context, client *NotificationInput) (*NotificationOutput, error)

AddNotificationContext creates a notification.

func (*Readarr) AddQualityProfile 

func (r *Readarr) AddQualityProfile(profile *QualityProfile) (int64, error)

AddQualityProfile updates a quality profile in place.

func (*Readarr) AddQualityProfileContext 

func (r *Readarr) AddQualityProfileContext(ctx context.Context, profile *QualityProfile) (int64, error)

AddQualityProfileContext updates a quality profile in place.

func (*Readarr) AddRemotePathMapping 

func (r *Readarr) AddRemotePathMapping(mapping *starr.RemotePathMapping) (*starr.RemotePathMapping, error)

AddRemotePathMapping creates a remote path mapping.

func (*Readarr) AddRemotePathMappingContext 

func (r *Readarr) AddRemotePathMappingContext(ctx context.Context,
	mapping *starr.RemotePathMapping,
) (*starr.RemotePathMapping, error)

AddRemotePathMappingContext creates a remote path mapping.

func (*Readarr) AddTag 

func (r *Readarr) AddTag(tag *starr.Tag) (*starr.Tag, error)

AddTag creates a tag.

func (*Readarr) AddTagContext 

func (r *Readarr) AddTagContext(ctx context.Context, tag *starr.Tag) (*starr.Tag, error)

AddTagContext creates a tag.

func (*Readarr) DeleteAuthor 

func (r *Readarr) DeleteAuthor(authorID int64, deleteFiles, addImportExclusion bool) error

DeleteAuthor removes an Author from the database. Setting deleteFiles true will delete all content for the Author.

func (*Readarr) DeleteAuthorContext 

func (r *Readarr) DeleteAuthorContext(ctx context.Context, authorID int64, deleteFiles, addImportExclusion bool) error

DeleteAuthorContext removes na Author from the database. Setting deleteFiles true will delete all content for the Author.

func (*Readarr) DeleteBlockList 

func (r *Readarr) DeleteBlockList(listID int64) error

DeleteBlockList removes a single block list item.

func (*Readarr) DeleteBlockListContext 

func (r *Readarr) DeleteBlockListContext(ctx context.Context, listID int64) error

DeleteBlockListContext removes a single block list item with a context.

func (*Readarr) DeleteBlockLists 

func (r *Readarr) DeleteBlockLists(ids []int64) error

DeleteBlockLists removes multiple block list items.

func (*Readarr) DeleteBlockListsContext 

func (r *Readarr) DeleteBlockListsContext(ctx context.Context, ids []int64) error

DeleteBlockListsContext removes multiple block list items with a context.

func (*Readarr) DeleteBook 

func (r *Readarr) DeleteBook(bookID int64, deleteFiles, addImportExclusion bool) error

DeleteBook removes a Book from the database. Setting deleteFiles true will delete all content for the Book.

func (*Readarr) DeleteBookContext 

func (r *Readarr) DeleteBookContext(ctx context.Context, bookID int64, deleteFiles, addImportExclusion bool) error

DeleteBookContext removes a Book from the database. Setting deleteFiles true will delete all content for the Book.

func (*Readarr) DeleteBookFile 

func (r *Readarr) DeleteBookFile(bookFileID int64) error

DeleteBookFile deletes a book file.

func (*Readarr) DeleteBookFileContext 

func (r *Readarr) DeleteBookFileContext(ctx context.Context, bookFileID int64) error

DeleteBookFileContext deletes a book file.

func (*Readarr) DeleteBookFiles 

func (r *Readarr) DeleteBookFiles(bookFileIDs []int64) error

DeleteBookFiles bulk deletes book files by their IDs.

func (*Readarr) DeleteBookFilesContext 

func (r *Readarr) DeleteBookFilesContext(ctx context.Context, bookFileIDs []int64) error

DeleteBookFilesContext bulk deletes book files by their IDs.

func (*Readarr) DeleteDownloadClient 

func (r *Readarr) DeleteDownloadClient(downloadclientID int64) error

DeleteDownloadClient removes a single download client.

func (*Readarr) DeleteDownloadClientContext 

func (r *Readarr) DeleteDownloadClientContext(ctx context.Context, downloadclientID int64) error

DeleteDownloadClientContext removes a single download client.

func (*Readarr) DeleteExclusions 

func (r *Readarr) DeleteExclusions(ids []int64) error

DeleteExclusions removes exclusions from Readarr.

func (*Readarr) DeleteExclusionsContext 

func (r *Readarr) DeleteExclusionsContext(ctx context.Context, ids []int64) error

DeleteExclusionsContext removes exclusions from Readarr.

func (*Readarr) DeleteImportList 

func (r *Readarr) DeleteImportList(importListID int64) error

DeleteImportList removes a single import list.

func (*Readarr) DeleteImportListContext 

func (r *Readarr) DeleteImportListContext(ctx context.Context, importListID int64) error

DeleteImportListContext removes a single import list.

func (*Readarr) DeleteIndexer 

func (r *Readarr) DeleteIndexer(indexerID int64) error

DeleteIndexer removes a single indexer.

func (*Readarr) DeleteIndexerContext 

func (r *Readarr) DeleteIndexerContext(ctx context.Context, indexerID int64) error

DeleteIndexerContext removes a single indexer.

func (*Readarr) DeleteNotification 

func (r *Readarr) DeleteNotification(notificationID int64) error

DeleteNotification removes a single notification.

func (*Readarr) DeleteNotificationContext 

func (r *Readarr) DeleteNotificationContext(ctx context.Context, notificationID int64) error

func (*Readarr) DeleteQualityProfile 

func (r *Readarr) DeleteQualityProfile(profileID int64) error

DeleteQualityProfile deletes a quality profile.

func (*Readarr) DeleteQualityProfileContext 

func (r *Readarr) DeleteQualityProfileContext(ctx context.Context, profileID int64) error

DeleteQualityProfileContext deletes a quality profile.

func (*Readarr) DeleteQueue 

func (r *Readarr) DeleteQueue(queueID int64, opts *starr.QueueDeleteOpts) error

DeleteQueue deletes an item from the Activity Queue.

func (*Readarr) DeleteQueueContext 

func (r *Readarr) DeleteQueueContext(ctx context.Context, queueID int64, opts *starr.QueueDeleteOpts) error

DeleteQueueContext deletes an item from the Activity Queue.

func (*Readarr) DeleteRemotePathMapping 

func (r *Readarr) DeleteRemotePathMapping(mappingID int64) error

DeleteRemotePathMapping removes a single remote path mapping.

func (*Readarr) DeleteRemotePathMappingContext 

func (r *Readarr) DeleteRemotePathMappingContext(ctx context.Context, mappingID int64) error

DeleteRemotePathMappingContext removes a single remote path mapping.

func (*Readarr) DeleteTag 

func (r *Readarr) DeleteTag(tagID int) error

DeleteTag removes a single tag.

func (*Readarr) DeleteTagContext 

func (r *Readarr) DeleteTagContext(ctx context.Context, tagID int) error

DeleteTagContext removes a single tag.

func (*Readarr) Fail 

func (r *Readarr) Fail(historyID int64) error

Fail marks the given history item as failed by id.

func (*Readarr) FailContext 

func (r *Readarr) FailContext(ctx context.Context, historyID int64) error

FailContext marks the given history item as failed by id.

func (*Readarr) GetAuthorByID 

func (r *Readarr) GetAuthorByID(authorID int64) (*Author, error)

GetAuthorByID returns an author.

func (*Readarr) GetAuthorByIDContext 

func (r *Readarr) GetAuthorByIDContext(ctx context.Context, authorID int64) (*Author, error)

GetAuthorByIDContext returns an author.

func (*Readarr) GetBackupFiles 

func (r *Readarr) GetBackupFiles() ([]*starr.BackupFile, error)

GetBackupFiles returns all available Readarr backup files. Use Get() to download a file using BackupFile.Path.

func (*Readarr) GetBackupFilesContext 

func (r *Readarr) GetBackupFilesContext(ctx context.Context) ([]*starr.BackupFile, error)

GetBackupFilesContext returns all available Readarr backup files. Use Get() to download a file using BackupFile.Path.

func (*Readarr) GetBlockList 

func (r *Readarr) GetBlockList(count int) (*BlockList, error)

GetBlockList returns the count of block list items requested. If you need control over the page, use GetBlockListPage().

func (*Readarr) GetBlockListContext 

func (r *Readarr) GetBlockListContext(ctx context.Context, records int) (*BlockList, error)

GetBlockListContext returns block list items.

func (*Readarr) GetBlockListPage 

func (r *Readarr) GetBlockListPage(params *starr.PageReq) (*BlockList, error)

GetBlockListPage returns block list items based on filters.

func (*Readarr) GetBlockListPageContext 

func (r *Readarr) GetBlockListPageContext(ctx context.Context, params *starr.PageReq) (*BlockList, error)

GetBlockListPageContext returns block list items based on filters.

func (*Readarr) GetBook 

func (r *Readarr) GetBook(gridID string) ([]*Book, error)

GetBook returns books. All books are returned if gridID is empty.

func (*Readarr) GetBookByID 

func (r *Readarr) GetBookByID(bookID int64) (*Book, error)

GetBookByID returns a book.

func (*Readarr) GetBookByIDContext 

func (r *Readarr) GetBookByIDContext(ctx context.Context, bookID int64) (*Book, error)

GetBookByIDContext returns a book.

func (*Readarr) GetBookContext 

func (r *Readarr) GetBookContext(ctx context.Context, gridID string) ([]*Book, error)

GetBookContext returns books. All books are returned if gridID is empty.

func (*Readarr) GetBookFiles 

func (r *Readarr) GetBookFiles(bookFileIDs []int64) ([]*BookFile, error)

GetBookFiles returns the requested book files by ID.

func (*Readarr) GetBookFilesContext 

func (r *Readarr) GetBookFilesContext(ctx context.Context, bookFileIDs []int64) ([]*BookFile, error)

GetBookFilesContext returns the requested book files by their IDs.

func (*Readarr) GetBookFilesForAuthor 

func (r *Readarr) GetBookFilesForAuthor(authorID int64) ([]*BookFile, error)

GetBookFilesForAuthor returns the book files for an author.

func (*Readarr) GetBookFilesForAuthorContext 

func (r *Readarr) GetBookFilesForAuthorContext(ctx context.Context, authorID int64) ([]*BookFile, error)

GetBookFilesForAuthorContext returns the book files for an author.

func (*Readarr) GetBookFilesForBook 

func (r *Readarr) GetBookFilesForBook(bookID ...int64) ([]*BookFile, error)

GetBookFilesForBook returns the book files for a book or books.

func (*Readarr) GetBookFilesForBookContext 

func (r *Readarr) GetBookFilesForBookContext(ctx context.Context, bookID ...int64) ([]*BookFile, error)

GetBookFilesForBookContext returns the book files for a book or books.

func (*Readarr) GetCalendar 

func (r *Readarr) GetCalendar(filter Calendar) ([]*Book, error)

GetCalendar returns calendars based on filters.

func (*Readarr) GetCalendarContext 

func (r *Readarr) GetCalendarContext(ctx context.Context, filter Calendar) ([]*Book, error)

GetCalendarContext returns calendars based on filters.

func (*Readarr) GetCalendarID 

func (r *Readarr) GetCalendarID(calendarID int64) (*Book, error)

GetCalendarID returns a single calendar by ID.

func (*Readarr) GetCalendarIDContext 

func (r *Readarr) GetCalendarIDContext(ctx context.Context, calendarID int64) (*Book, error)

GetCalendarIDContext returns a single calendar by ID.

func (*Readarr) GetCommands 

func (r *Readarr) GetCommands() ([]*CommandResponse, error)

GetCommands returns all available Readarr commands. These can be used with SendCommand.

func (*Readarr) GetCommandsContext 

func (r *Readarr) GetCommandsContext(ctx context.Context) ([]*CommandResponse, error)

GetCommandsContext returns all available Readarr commands. These can be used with SendCommand.

func (*Readarr) GetDownloadClient 

func (r *Readarr) GetDownloadClient(downloadclientID int64) (*DownloadClientOutput, error)

GetDownloadClient returns a single download client.

func (*Readarr) GetDownloadClientConfig 

func (r *Readarr) GetDownloadClientConfig() (*DownloadClientConfig, error)

GetDownloadClientConfig returns the download client config.

func (*Readarr) GetDownloadClientConfigContext 

func (r *Readarr) GetDownloadClientConfigContext(ctx context.Context) (*DownloadClientConfig, error)

GetDownloadClientConfig returns the download client config.

func (*Readarr) GetDownloadClientContext 

func (r *Readarr) GetDownloadClientContext(ctx context.Context, downloadclientID int64) (*DownloadClientOutput, error)

GetDownloadClientContext returns a single download client.

func (*Readarr) GetDownloadClients 

func (r *Readarr) GetDownloadClients() ([]*DownloadClientOutput, error)

GetDownloadClients returns all configured download clients.

func (*Readarr) GetDownloadClientsContext 

func (r *Readarr) GetDownloadClientsContext(ctx context.Context) ([]*DownloadClientOutput, error)

GetDownloadClientsContext returns all configured download clients.

func (*Readarr) GetExclusions 

func (r *Readarr) GetExclusions() ([]*Exclusion, error)

GetExclusions returns all configured exclusions from Readarr.

func (*Readarr) GetExclusionsContext 

func (r *Readarr) GetExclusionsContext(ctx context.Context) ([]*Exclusion, error)

GetExclusionsContext returns all configured exclusions from Readarr.

func (*Readarr) GetHistory 

func (r *Readarr) GetHistory(records, perPage int) (*History, error)

GetHistory returns the Readarr History (grabs/failures/completed). If you need control over the page, use readarr.GetHistoryPage(). This function simply returns the number of history records desired, up to the number of records present in the application. It grabs records in (paginated) batches of perPage, and concatenates them into one list. Passing zero for records will return all of them.

func (*Readarr) GetHistoryContext 

func (r *Readarr) GetHistoryContext(ctx context.Context, records, perPage int) (*History, error)

GetHistoryContext returns the Readarr History (grabs/failures/completed). If you need control over the page, use readarr.GetHistoryPageContext().

func (*Readarr) GetHistoryPage 

func (r *Readarr) GetHistoryPage(params *starr.PageReq) (*History, error)

GetHistoryPage returns a single page from the Readarr History (grabs/failures/completed). The page size and number is configurable with the input request parameters.

func (*Readarr) GetHistoryPageContext 

func (r *Readarr) GetHistoryPageContext(ctx context.Context, params *starr.PageReq) (*History, error)

GetHistoryPageContext returns a single page from the Readarr History (grabs/failures/completed). The page size and number is configurable with the input request parameters.

func (*Readarr) GetImportList 

func (r *Readarr) GetImportList(importListID int64) (*ImportListOutput, error)

GetImportList returns a single import list.

func (*Readarr) GetImportListContext 

func (r *Readarr) GetImportListContext(ctx context.Context, importListID int64) (*ImportListOutput, error)

GetIndGetImportListContextexer returns a single import list.

func (*Readarr) GetImportLists 

func (r *Readarr) GetImportLists() ([]*ImportListOutput, error)

GetImportLists returns all configured import lists.

func (*Readarr) GetImportListsContext 

func (r *Readarr) GetImportListsContext(ctx context.Context) ([]*ImportListOutput, error)

GetImportListsContext returns all configured import lists.

func (*Readarr) GetIndexer 

func (r *Readarr) GetIndexer(indexerID int64) (*IndexerOutput, error)

GetIndexer returns a single indexer.

func (*Readarr) GetIndexerConfig 

func (r *Readarr) GetIndexerConfig() (*IndexerConfig, error)

GetIndexerConfig returns an Indexer Config.

func (*Readarr) GetIndexerConfigContext 

func (r *Readarr) GetIndexerConfigContext(ctx context.Context) (*IndexerConfig, error)

GetIndexerConfigContext returns the indexer Config.

func (*Readarr) GetIndexerContext 

func (r *Readarr) GetIndexerContext(ctx context.Context, indexerID int64) (*IndexerOutput, error)

GetIndGetIndexerContextexer returns a single indexer.

func (*Readarr) GetIndexers 

func (r *Readarr) GetIndexers() ([]*IndexerOutput, error)

GetIndexers returns all configured indexers.

func (*Readarr) GetIndexersContext 

func (r *Readarr) GetIndexersContext(ctx context.Context) ([]*IndexerOutput, error)

GetIndexersContext returns all configured indexers.

func (*Readarr) GetMediaManagement 

func (r *Readarr) GetMediaManagement() (*MediaManagement, error)

GetMediaManagement returns the media management.

func (*Readarr) GetMediaManagementContext 

func (r *Readarr) GetMediaManagementContext(ctx context.Context) (*MediaManagement, error)

GetMediaManagement returns the media management.

func (*Readarr) GetMetadataProfiles 

func (r *Readarr) GetMetadataProfiles() ([]*MetadataProfile, error)

GetMetadataProfiles returns the metadata profiles.

func (*Readarr) GetMetadataProfilesContext 

func (r *Readarr) GetMetadataProfilesContext(ctx context.Context) ([]*MetadataProfile, error)

GetMetadataProfilesContext returns the metadata profiles.

func (*Readarr) GetNaming 

func (r *Readarr) GetNaming() (*Naming, error)

GetNaming returns the file naming rules.

func (*Readarr) GetNamingContext 

func (r *Readarr) GetNamingContext(ctx context.Context) (*Naming, error)

GetNamingContext returns the file naming rules.

func (*Readarr) GetNotification 

func (r *Readarr) GetNotification(notificationID int) (*NotificationOutput, error)

GetNotification returns a single notification.

func (*Readarr) GetNotificationContext 

func (r *Readarr) GetNotificationContext(ctx context.Context, notificationID int) (*NotificationOutput, error)

GetNotificationContext returns a single notification.

func (*Readarr) GetNotifications 

func (r *Readarr) GetNotifications() ([]*NotificationOutput, error)

GetNotifications returns all configured notifications.

func (*Readarr) GetNotificationsContext 

func (r *Readarr) GetNotificationsContext(ctx context.Context) ([]*NotificationOutput, error)

GetNotificationsContext returns all configured notifications.

func (*Readarr) GetQualityProfiles 

func (r *Readarr) GetQualityProfiles() ([]*QualityProfile, error)

GetQualityProfiles returns the quality profiles.

func (*Readarr) GetQualityProfilesContext 

func (r *Readarr) GetQualityProfilesContext(ctx context.Context) ([]*QualityProfile, error)

GetQualityProfilesContext returns the quality profiles.

func (*Readarr) GetQueue 

func (r *Readarr) GetQueue(records, perPage int) (*Queue, error)

GetQueue returns a single page from the Readarr Queue (processing, but not yet imported). If you need control over the page, use readarr.GetQueuePage(). This function simply returns the number of queue records desired, up to the number of records present in the application. It grabs records in (paginated) batches of perPage, and concatenates them into one list. Passing zero for records will return all of them.

func (*Readarr) GetQueueContext 

func (r *Readarr) GetQueueContext(ctx context.Context, records, perPage int) (*Queue, error)

GetQueueContext returns a single page from the Readarr Queue (processing, but not yet imported). If you need control over the page, use readarr.GetQueuePageContext().

func (*Readarr) GetQueuePage 

func (r *Readarr) GetQueuePage(params *starr.PageReq) (*Queue, error)

GetQueuePage returns a single page from the Readarr Queue. The page size and number is configurable with the input request parameters.

func (*Readarr) GetQueuePageContext 

func (r *Readarr) GetQueuePageContext(ctx context.Context, params *starr.PageReq) (*Queue, error)

GetQueuePageContext returns a single page from the Readarr Queue. The page size and number is configurable with the input request parameters.

func (*Readarr) GetRemotePathMapping 

func (r *Readarr) GetRemotePathMapping(mappingID int64) (*starr.RemotePathMapping, error)

GetRemotePathMapping returns a single remote path mapping.

func (*Readarr) GetRemotePathMappingContext 

func (r *Readarr) GetRemotePathMappingContext(ctx context.Context, mappingID int64) (*starr.RemotePathMapping, error)

GetRemotePathMappingContext returns a single remote path mapping.

func (*Readarr) GetRemotePathMappings 

func (r *Readarr) GetRemotePathMappings() ([]*starr.RemotePathMapping, error)

GetRemotePathMappings returns all configured remote path mappings.

func (*Readarr) GetRemotePathMappingsContext 

func (r *Readarr) GetRemotePathMappingsContext(ctx context.Context) ([]*starr.RemotePathMapping, error)

GetRemotePathMappingsContext returns all configured remote path mappings.

func (*Readarr) GetRootFolders 

func (r *Readarr) GetRootFolders() ([]*RootFolder, error)

GetRootFolders returns all configured root folders.

func (*Readarr) GetRootFoldersContext 

func (r *Readarr) GetRootFoldersContext(ctx context.Context) ([]*RootFolder, error)

GetRootFoldersContext returns all configured root folders.

func (*Readarr) GetSystemStatus 

func (r *Readarr) GetSystemStatus() (*SystemStatus, error)

GetSystemStatus returns system status.

func (*Readarr) GetSystemStatusContext 

func (r *Readarr) GetSystemStatusContext(ctx context.Context) (*SystemStatus, error)

GetSystemStatusContext returns system status.

func (*Readarr) GetTag 

func (r *Readarr) GetTag(tagID int) (*starr.Tag, error)

GetTag returns a single tag.

func (*Readarr) GetTagContext 

func (r *Readarr) GetTagContext(ctx context.Context, tagID int) (*starr.Tag, error)

GetTagContext returns a single tag.

func (*Readarr) GetTags 

func (r *Readarr) GetTags() ([]*starr.Tag, error)

GetTags returns all configured tags.

func (*Readarr) GetTagsContext 

func (r *Readarr) GetTagsContext(ctx context.Context) ([]*starr.Tag, error)

GetTagsContext returns all configured tags.

func (*Readarr) Lookup 

func (r *Readarr) Lookup(term string) ([]*Book, error)

Lookup will search for books matching the specified search term.

func (*Readarr) LookupContext 

func (r *Readarr) LookupContext(ctx context.Context, term string) ([]*Book, error)

LookupContext will search for books matching the specified search term.

func (*Readarr) ManualImport 

func (r *Readarr) ManualImport(params *ManualImportParams) (*ManualImportOutput, error)

ManualImport initiates a manual import (GET).

func (*Readarr) ManualImportContext 

func (r *Readarr) ManualImportContext(ctx context.Context, params *ManualImportParams) (*ManualImportOutput, error)

ManualImportContext initiates a manual import (GET).

func (*Readarr) ManualImportReprocess 

func (r *Readarr) ManualImportReprocess(manualimport *ManualImportInput) error

ManualImportReprocess reprocesses a manual import (POST).

func (*Readarr) ManualImportReprocessContext 

func (r *Readarr) ManualImportReprocessContext(ctx context.Context, manualimport *ManualImportInput) error

ManualImportReprocessContext reprocesses a manual import (POST).

func (*Readarr) Ping 

func (r *Readarr) Ping() error

Ping returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.

func (*Readarr) PingContext 

func (r *Readarr) PingContext(ctx context.Context) error

PingContext returns an error if the starr instance does not respond with a 200 to an HTTP /ping request.

func (*Readarr) QueueGrab 

func (r *Readarr) QueueGrab(ids ...int64) error

QueueGrab tells the app to grab an item that's in queue. Most often used on items with a delay set from a delay profile.

func (*Readarr) QueueGrabContext 

func (r *Readarr) QueueGrabContext(ctx context.Context, ids ...int64) error

QueueGrabContext tells the app to grab an item that's in queue, probably set to a delay. Most often used on items with a delay set from a delay profile.

func (*Readarr) SendCommand 

func (r *Readarr) SendCommand(cmd *CommandRequest) (*CommandResponse, error)

SendCommand sends a command to Readarr.

func (*Readarr) SendCommandContext 

func (r *Readarr) SendCommandContext(ctx context.Context, cmd *CommandRequest) (*CommandResponse, error)

SendCommandContext sends a command to Readarr.

func (*Readarr) TestDownloadClient 

func (r *Readarr) TestDownloadClient(client *DownloadClientInput) error

TestDownloadClient tests a download client.

func (*Readarr) TestDownloadClientContext 

func (r *Readarr) TestDownloadClientContext(ctx context.Context, client *DownloadClientInput) error

TestDownloadClientContext tests a download client.

func (*Readarr) TestImportList 

func (r *Readarr) TestImportList(list *ImportListInput) error

TestImportList tests an import list.

func (*Readarr) TestImportListContextt 

func (r *Readarr) TestImportListContextt(ctx context.Context, list *ImportListInput) error

TestImportListContextt tests an import list.

func (*Readarr) TestIndexer 

func (r *Readarr) TestIndexer(indexer *IndexerInput) error

TestIndexer tests an indexer.

func (*Readarr) TestIndexerContext 

func (r *Readarr) TestIndexerContext(ctx context.Context, indexer *IndexerInput) error

TestIndexerContext tests an indexer.

func (*Readarr) UpdateAuthor 

func (r *Readarr) UpdateAuthor(author *Author, moveFiles bool) (*Author, error)

UpdateAuthor updates an author in place.

func (*Readarr) UpdateAuthorContext 

func (r *Readarr) UpdateAuthorContext(ctx context.Context, author *Author, moveFiles bool) (*Author, error)

UpdateAuthorContext updates an author in place.

func (*Readarr) UpdateBook 

func (r *Readarr) UpdateBook(bookID int64, book *Book, moveFiles bool) error

UpdateBook updates a book in place.

func (*Readarr) UpdateBookContext 

func (r *Readarr) UpdateBookContext(ctx context.Context, bookID int64, book *Book, moveFiles bool) error

UpdateBookContext updates a book in place.

func (*Readarr) UpdateBookFile 

func (r *Readarr) UpdateBookFile(bookFile *BookFile) (*BookFile, error)

UpdateBookFile updates a book file.

func (*Readarr) UpdateBookFileContext 

func (r *Readarr) UpdateBookFileContext(ctx context.Context, bookFile *BookFile) (*BookFile, error)

UpdateBookFileContext updates a book file.

func (*Readarr) UpdateDownloadClient 

func (r *Readarr) UpdateDownloadClient(downloadclient *DownloadClientInput, force bool) (*DownloadClientOutput, error)

UpdateDownloadClient updates the download client.

func (*Readarr) UpdateDownloadClientConfig 

func (r *Readarr) UpdateDownloadClientConfig(downloadConfig *DownloadClientConfig) (*DownloadClientConfig, error)

UpdateDownloadClientConfig update the single download client config.

func (*Readarr) UpdateDownloadClientConfigContext 

func (r *Readarr) UpdateDownloadClientConfigContext(ctx context.Context,
	config *DownloadClientConfig,
) (*DownloadClientConfig, error)

UpdateDownloadClientConfig update the single download client config.

func (*Readarr) UpdateDownloadClientContext 

func (r *Readarr) UpdateDownloadClientContext(ctx context.Context,
	client *DownloadClientInput,
	force bool,
) (*DownloadClientOutput, error)

UpdateDownloadClientContext updates the download client.

func (*Readarr) UpdateExclusion 

func (r *Readarr) UpdateExclusion(exclusion *Exclusion) (*Exclusion, error)

UpdateExclusion changes an exclusions in Readarr.

func (*Readarr) UpdateExclusionContext 

func (r *Readarr) UpdateExclusionContext(ctx context.Context, exclusion *Exclusion) (*Exclusion, error)

UpdateExclusionContext changes an exclusions in Readarr.

func (*Readarr) UpdateImportList 

func (r *Readarr) UpdateImportList(importList *ImportListInput, force bool) (*ImportListOutput, error)

UpdateImportList updates the import list.

func (*Readarr) UpdateImportListContext 

func (r *Readarr) UpdateImportListContext(
	ctx context.Context,
	importList *ImportListInput,
	force bool,
) (*ImportListOutput, error)

UpdateImportListContext updates the import list.

func (*Readarr) UpdateIndexer 

func (r *Readarr) UpdateIndexer(indexer *IndexerInput, force bool) (*IndexerOutput, error)

UpdateIndexer updates the indexer.

func (*Readarr) UpdateIndexerConfig 

func (r *Readarr) UpdateIndexerConfig(indexerConfig *IndexerConfig) (*IndexerConfig, error)

UpdateIndexerConfig update the single indexerConfig.

func (*Readarr) UpdateIndexerConfigContext 

func (r *Readarr) UpdateIndexerConfigContext(ctx context.Context, config *IndexerConfig) (*IndexerConfig, error)

UpdateIndexerConfigContext update the single indexerConfig.

func (*Readarr) UpdateIndexerContext 

func (r *Readarr) UpdateIndexerContext(ctx context.Context, indexer *IndexerInput, force bool) (*IndexerOutput, error)

UpdateIndexerContext updates the indexer.

func (*Readarr) UpdateMediaManagement 

func (r *Readarr) UpdateMediaManagement(mMgt *MediaManagement) (*MediaManagement, error)

UpdateMediaManagement updates the media management.

func (*Readarr) UpdateMediaManagementContext 

func (r *Readarr) UpdateMediaManagementContext(ctx context.Context, mMgt *MediaManagement) (*MediaManagement, error)

UpdateMediaManagementContext updates the media management.

func (*Readarr) UpdateNaming 

func (r *Readarr) UpdateNaming(naming *Naming) (*Naming, error)

UpdateNaming updates the file naming rules.

func (*Readarr) UpdateNamingContext 

func (r *Readarr) UpdateNamingContext(ctx context.Context, naming *Naming) (*Naming, error)

UpdateNamingContext updates the file naming rules.

func (*Readarr) UpdateNotification 

func (r *Readarr) UpdateNotification(notification *NotificationInput) (*NotificationOutput, error)

UpdateNotification updates the notification.

func (*Readarr) UpdateNotificationContext 

func (r *Readarr) UpdateNotificationContext(ctx context.Context,
	client *NotificationInput,
) (*NotificationOutput, error)

UpdateNotificationContext updates the notification.

func (*Readarr) UpdateQualityProfile 

func (r *Readarr) UpdateQualityProfile(profile *QualityProfile) (*QualityProfile, error)

UpdateQualityProfile updates a quality profile in place.

func (*Readarr) UpdateQualityProfileContext 

func (r *Readarr) UpdateQualityProfileContext(ctx context.Context, profile *QualityProfile) (*QualityProfile, error)

UpdateQualityProfileContext updates a quality profile in place.

func (*Readarr) UpdateRemotePathMapping 

func (r *Readarr) UpdateRemotePathMapping(mapping *starr.RemotePathMapping) (*starr.RemotePathMapping, error)

UpdateRemotePathMapping updates the remote path mapping.

func (*Readarr) UpdateRemotePathMappingContext 

func (r *Readarr) UpdateRemotePathMappingContext(ctx context.Context,
	mapping *starr.RemotePathMapping,
) (*starr.RemotePathMapping, error)

UpdateRemotePathMappingContext updates the remote path mapping.

func (*Readarr) UpdateTag 

func (r *Readarr) UpdateTag(tag *starr.Tag) (*starr.Tag, error)

UpdateTag updates a tag.

func (*Readarr) UpdateTagContext 

func (r *Readarr) UpdateTagContext(ctx context.Context, tag *starr.Tag) (*starr.Tag, error)

UpdateTagContext updates a tag.

type Rejection 

type Rejection struct {
	Reason string `json:"reason"`
	// permanent or temporary
	Type string `json:"type"`
}

Rejection is part of the manual import payload.

type RootFolder 

type RootFolder struct {
	ID                       int64  `json:"id"`
	Name                     string `json:"name"`
	Path                     string `json:"path"`
	DefaultMetadataProfileID int64  `json:"defaultMetadataProfileId"`
	DefaultQualityProfileID  int64  `json:"defaultQualityProfileId"`
	DefaultMonitorOption     string `json:"defaultMonitorOption"`
	DefaultTags              []int  `json:"defaultTags"`
	Port                     int    `json:"port"`
	OutputProfile            string `json:"outputProfile"`
	UseSsl                   bool   `json:"useSsl"`
	Accessible               bool   `json:"accessible"`
	IsCalibreLibrary         bool   `json:"isCalibreLibrary"`
	FreeSpace                int64  `json:"freeSpace"`
	TotalSpace               int64  `json:"totalSpace"`
}

RootFolder is the /api/v1/rootfolder endpoint.

type Statistics 

type Statistics struct {
	BookCount          int     `json:"bookCount"`
	BookFileCount      int     `json:"bookFileCount"`
	TotalBookCount     int     `json:"totalBookCount"`
	SizeOnDisk         int     `json:"sizeOnDisk"`
	PercentOfBooks     float64 `json:"percentOfBooks"`
	AvailableBookCount int     `json:"availableBookCount"`
}

Statistics for a Book, or maybe an author.

type SystemStatus 

type SystemStatus struct {
	AppData                string    `json:"appData"`
	AppName                string    `json:"appName"`
	Authentication         string    `json:"authentication"`
	Branch                 string    `json:"branch"`
	BuildTime              time.Time `json:"buildTime"`
	DatabaseType           string    `json:"databaseType"`
	DatabaseVersion        string    `json:"databaseVersion"`
	InstanceName           string    `json:"instanceName"`
	IsAdmin                bool      `json:"isAdmin"`
	IsDebug                bool      `json:"isDebug"`
	IsDocker               bool      `json:"isDocker"`
	IsLinux                bool      `json:"isLinux"`
	IsMono                 bool      `json:"isMono"`
	IsNetCore              bool      `json:"isNetCore"`
	IsOsx                  bool      `json:"isOsx"`
	IsProduction           bool      `json:"isProduction"`
	IsUserInteractive      bool      `json:"isUserInteractive"`
	IsWindows              bool      `json:"isWindows"`
	MigrationVersion       int64     `json:"migrationVersion"`
	Mode                   string    `json:"mode"`
	OsName                 string    `json:"osName"`
	OsVersion              string    `json:"osVersion"`
	PackageAuthor          string    `json:"packageAuthor"`
	PackageUpdateMechanism string    `json:"packageUpdateMechanism"`
	PackageVersion         string    `json:"packageVersion"`
	RuntimeName            string    `json:"runtimeName"`
	RuntimeVersion         string    `json:"runtimeVersion"`
	StartTime              time.Time `json:"startTime"`
	StartupPath            string    `json:"startupPath"`
	URLBase                string    `json:"urlBase"`
	Version                string    `json:"version"`
}

SystemStatus is the /api/v1/system/status endpoint.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.