readarr

package

Go to main page

Versions in this module

v1

v1.0.0

Aug 29, 2023

Changes in this version

type AddBookAuthor

+ Tags []int

+ type AudioCountry struct

+ Name string

+ TwoLetterCode string

+ type AudioMediaInfo struct

+ AudioBitrate int

+ AudioBits int

+ AudioChannels int

+ AudioFormat string

+ AudioSampleRate int

+ type AudioTags struct

+ ASIN string

+ AuthorMBID string

+ AuthorTitle string

+ Authors []string

+ BookMBID string

+ BookTitle string

+ CatalogNumber string

+ CleanTitle string

+ Country *AudioCountry

+ Disambiguation string

+ DiscCount int

+ DiscNumber int

+ Duration *starr.TimeSpan

+ GoodreadsID string

+ ISBN string

+ Label string

+ Language string

+ MediaInfo *AudioMediaInfo

+ Publisher string

+ Quality *starr.Quality

+ RecordingMBID string

+ ReleaseGroup string

+ ReleaseHash string

+ ReleaseMBID string

+ SeriesIndex string

+ SeriesTitle string

+ Source string

+ Title string

+ TrackMBID string

+ TrackNumbers []int

+ Year int

type Author

+ AuthorMetadataID int64

+ AuthorNameLastFirst string

+ MonitorNewItems string

+ SortNameLastFirst string

+ type BlockList struct

+ Page int

+ PageSize int

+ Records []*BlockListRecord

+ SortDirection string

+ SortKey string

+ TotalRecords int

+ type BlockListRecord struct

+ Author *Author

+ AuthorID int64

+ BookIDs []int64

+ CustomFormats []interface{}

+ Date time.Time

+ ID int64

+ Indexer string

+ Message string

+ Protocol string

+ Quality *starr.Quality

+ SourceTitle string

type Book

+ Added time.Time

+ AuthorTitle string

+ Grabbed bool

+ RemoteCover string

+ type BookFile struct

+ AudioTags *AudioTags

+ AuthorID int64

+ BookID int64

+ DateAdded time.Time

+ ID int64

+ Path string

+ Quality *starr.Quality

+ QualityCutoffNotMet bool

+ QualityWeight int

+ Size int

+ type Calendar struct

+ End time.Time

+ IncludeAuthor bool

+ Start time.Time

+ Unmonitored bool

+ type DownloadClientConfig struct

+ AutoRedownloadFailed bool

+ DownloadClientWorkingFolders string

+ EnableCompletedDownloadHandling bool

+ ID int64

+ RemoveCompletedDownloads bool

+ RemoveFailedDownloads bool

+ type DownloadClientInput struct

+ ConfigContract string

+ Enable bool

+ Fields []*starr.FieldInput

+ ID int64

+ Implementation string

+ ImplementationName string

+ Name string

+ Priority int

+ Protocol string

+ Tags []int

+ type DownloadClientOutput struct

+ ConfigContract string

+ Enable bool

+ Fields []*starr.FieldOutput

+ ID int64

+ Implementation string

+ ImplementationName string

+ InfoLink string

+ Name string

+ Priority int

+ Protocol string

+ Tags []int

+ type Exclusion struct

+ AuthorName string

+ ForeignID string

+ ID int64

+ type ImportListInput struct

+ ConfigContract string

+ EnableAutomaticAdd bool

+ Fields []*starr.FieldInput

+ ID int64

+ Implementation string

+ ListOrder int

+ ListType string

+ MetadataProfileID int64

+ MonitorNewItems string

+ Name string

+ QualityProfileID int64

+ RootFolderPath string

+ ShouldMonitor string

+ ShouldMonitorExisting bool

+ ShouldSearch bool

+ Tags []int

+ type ImportListOutput struct

+ ConfigContract string

+ EnableAutomaticAdd bool

+ Fields []*starr.FieldOutput

+ ID int64

+ Implementation string

+ ImplementationName string

+ InfoLink string

+ ListOrder int64

+ ListType string

+ MetadataProfileID int64

+ MonitorNewItems string

+ Name string

+ QualityProfileID int64

+ RootFolderPath string

+ ShouldMonitor string

+ ShouldMonitorExisting bool

+ ShouldSearch bool

+ Tags []int

+ type IndexerConfig struct

+ ID int64

+ MaximumSize int64

+ MinimumAge int64

+ Retention int64

+ RssSyncInterval int64

+ type IndexerInput struct

+ ConfigContract string

+ EnableAutomaticSearch bool

+ EnableInteractiveSearch bool

+ EnableRss bool

+ Fields []*starr.FieldInput

+ ID int64

+ Implementation string

+ Name string

+ Priority int64

+ Protocol string

+ Tags []int

+ type IndexerOutput struct

+ ConfigContract string

+ EnableAutomaticSearch bool

+ EnableInteractiveSearch bool

+ EnableRss bool

+ Fields []*starr.FieldOutput

+ ID int64

+ Implementation string

+ ImplementationName string

+ InfoLink string

+ Name string

+ Priority int64

+ Protocol string

+ SupportsRss bool

+ SupportsSearch bool

+ Tags []int

+ type ManualImportInput struct

+ AdditionalFile bool

+ AuthorID int64

+ BookID int64

+ DisableReleaseSwitching bool

+ DownloadID string

+ ForeignEditionID int64

+ ID int64

+ Name string

+ Path string

+ Quality *starr.Quality

+ Rejections []*Rejection

+ ReleaseGroup string

+ ReplaceExistingFiles bool

+ type ManualImportOutput struct

+ AdditionalFile bool

+ AudioTags *AudioTags

+ Author *Author

+ Book *Book

+ DisableReleaseSwitching bool

+ DownloadID string

+ ForeignEditionID int64

+ ID int64

+ Name string

+ Path string

+ Quality *starr.Quality

+ QualityWeight int64

+ Rejections []*Rejection

+ ReleaseGroup string

+ ReplaceExistingFiles bool

+ Size int

+ type ManualImportParams struct

+ AuthorID int64

+ DownloadID string

+ FilterExistingFiles bool

+ Folder string

+ ReplaceExistingFiles bool

+ type NotificationInput struct

+ ConfigContract string

+ Fields []*starr.FieldInput

+ ID int64

+ Implementation string

+ IncludeHealthWarnings bool

+ Name string

+ OnApplicationUpdate bool

+ OnAuthorDelete bool

+ OnBookDelete bool

+ OnBookFileDelete bool

+ OnBookFileDeleteForUpgrade bool

+ OnBookRetag bool

+ OnDownloadFailure bool

+ OnGrab bool

+ OnHealthIssue bool

+ OnImportFailure bool

+ OnReleaseImport bool

+ OnRename bool

+ OnUpgrade bool

+ Tags []int

+ type NotificationOutput struct

+ ConfigContract string

+ Fields []*starr.FieldOutput

+ ID int64

+ Implementation string

+ ImplementationName string

+ IncludeHealthWarnings bool

+ InfoLink string

+ Name string

+ OnApplicationUpdate bool

+ OnAuthorDelete bool

+ OnBookDelete bool

+ OnBookFileDelete bool

+ OnBookFileDeleteForUpgrade bool

+ OnBookRetag bool

+ OnDownloadFailure bool

+ OnGrab bool

+ OnHealthIssue bool

+ OnImportFailure bool

+ OnReleaseImport bool

+ OnRename bool

+ OnUpgrade bool

+ SupportsOnApplicationUpdate bool

+ SupportsOnAuthorDelete bool

+ SupportsOnBookDelete bool

+ SupportsOnBookFileDelete bool

+ SupportsOnBookFileDeleteForUpgrade bool

+ SupportsOnBookRetag bool

+ SupportsOnDownloadFailure bool

+ SupportsOnGrab bool

+ SupportsOnHealthIssue bool

+ SupportsOnImportFailure bool

+ SupportsOnReleaseImport bool

+ SupportsOnRename bool

+ SupportsOnUpgrade bool

+ Tags []int

type QualityProfile

+ CutoffFormatScore int64

+ FormatItems []*starr.FormatItem

+ MinFormatScore int64

type Readarr

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

+ type Rejection struct

+ Reason string

+ Type string

type Statistics

+ AvailableBookCount int

type SystemStatus

+ AppName string

+ DatabaseType string

+ DatabaseVersion string

+ InstanceName string

v0

v0.14.0

Feb 7, 2022

Changes in this version

+ const APIver

+ const FilterAll

+ const FilterBookFileImported

+ const FilterDeleted

+ const FilterDownloadFailed

+ const FilterDownloadImported

+ const FilterGrabbed

+ const FilterIgnored

+ const FilterImportFailed

+ const FilterRenamed

+ const FilterRetagged

type Readarr

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

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

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

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

v0.13.0

Jan 15, 2022

Changes in this version

type Readarr

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

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

+ func (r *Readarr) AddTagContext(ctx context.Context, label string) (int, error)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

+ func (r *Readarr) UpdateAuthorContext(ctx context.Context, authorID int64, author *Author) error

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

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

+ func (r *Readarr) UpdateTagContext(ctx context.Context, tagID int, label string) (int, error)

v0.12.1

Jan 2, 2022

v0.12.0

Dec 30, 2021

Changes in this version

type Readarr

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

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

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

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

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

v0.11.12

Nov 6, 2021

v0.11.11

Oct 17, 2021

v0.10.10

Oct 5, 2021

v0.10.9

Oct 4, 2021

v0.10.8

Aug 31, 2021

v0.10.7

Aug 21, 2021

v0.10.6

Jul 26, 2021

Changes in this version

+ type History struct

+ Page int

+ PageSize int

+ Records []HistoryRecord

+ SortDirection string

+ SortKey string

+ TotalRecords int

+ type HistoryRecord struct

+ AuthorID int64

+ BookID int64

+ Data struct{ ... }

+ Date time.Time

+ DownloadID string

+ EventType string

+ ID int64

+ Quality *starr.Quality

+ QualityCutoffNotMet bool

+ SourceTitle string

type Readarr

+ func (r *Readarr) GetHistory(maxRecords int) (*History, error)

v0.10.5

Jul 18, 2021

v0.10.4

Jul 18, 2021

Changes in this version

+ type QueueRecord struct

+ AuthorID int64

+ BookID int64

+ DownloadClient string

+ DownloadForced bool

+ DownloadID string

+ ErrorMessage string

+ EstimatedCompletionTime time.Time

+ ID int64

+ Indexer string

+ OutputPath string

+ Protocol string

+ Quality *starr.Quality

+ Size float64

+ Sizeleft float64

+ Status string

+ StatusMessages []*starr.StatusMessage

+ Timeleft string

+ Title string

+ TrackedDownloadState string

+ TrackedDownloadStatus string

v0.10.3

Jun 26, 2021

v0.10.2

Jun 25, 2021

v0.10.1

Jun 18, 2021

v0.10.0

Jun 5, 2021

v0.9.11

May 18, 2021

Changes in this version

type Readarr

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

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

v0.9.10

Apr 10, 2021

Changes in this version

type AddBookEdition

+ Images []*starr.Image

+ Title string

+ TitleSlug interface{}

+ type CommandRequest struct

+ BookID int64

+ BookIDs []int64

+ Name string

+ type CommandResponse struct

+ Body map[string]interface{}

+ CommandName string

+ Duration string

+ Ended time.Time

+ ID int64

+ LastExecutionTime time.Time

+ Message string

+ Name string

+ Priority string

+ Queued time.Time

+ SendUpdatesToClient bool

+ Started time.Time

+ StateChangeTime time.Time

+ Status string

+ Trigger string

+ UpdateScheduledTask bool

type Readarr

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

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

v0.9.9

Feb 7, 2021

Changes in this version

+ type AddAuthorOptions struct

+ BooksToMonitor []int64

+ Monitor string

+ Monitored bool

+ SearchForMissingBooks bool

+ type AddBookAuthor struct

+ AddOptions *AddAuthorOptions

+ ForeignAuthorID string

+ MetadataProfileID int64

+ Monitored bool

+ QualityProfileID int64

+ RootFolderPath string

+ type AddBookEdition struct

+ ForeignEditionID string

+ ManualAdd bool

+ Monitored bool

+ type AddBookInput struct

+ AddOptions *AddBookOptions

+ Author *AddBookAuthor

+ Editions []*AddBookEdition

+ ForeignBookID int64

+ Monitored bool

+ Tags []int

+ type AddBookOptions struct

+ AddType string

+ SearchForNewBook bool

+ type AddBookOutput struct

+ AnyEditionOk bool

+ Author *BookAuthor

+ AuthorID int64

+ Editions []*Edition

+ ForeignBookID string

+ Genres []interface{}

+ ID int64

+ Images []*starr.Image

+ Links []*starr.Link

+ Monitored bool

+ Overview string

+ PageCount int

+ Ratings *starr.Ratings

+ ReleaseDate time.Time

+ SeriesTitle string

+ Statistics *Statistics

+ Title string

+ TitleSlug string

+ type Author struct

+ Added time.Time

+ AuthorName string

+ CleanName string

+ Ended bool

+ ForeignAuthorID string

+ Genres []interface{}

+ ID int64

+ Images []*starr.Image

+ LastBook *AuthorBook

+ Links []*starr.Link

+ MetadataProfileID int

+ Monitored bool

+ NextBook *AuthorBook

+ Overview string

+ Path string

+ QualityProfileID int

+ Ratings *starr.Ratings

+ SortName string

+ Statistics *Statistics

+ Status string

+ Tags []int

+ TitleSlug string

+ type AuthorBook struct

+ AddOptions *AddBookOptions

+ Added time.Time

+ AnyEditionOk bool

+ Author *starr.IsLoaded

+ AuthorMetadata *starr.IsLoaded

+ AuthorMetadataID int

+ BookFiles *starr.IsLoaded

+ CleanTitle string

+ Editions *starr.IsLoaded

+ ForeignBookID string

+ Genres []interface{}

+ ID int64

+ LastInfoSync time.Time

+ Links []*starr.Link

+ Monitored bool

+ Ratings *starr.Ratings

+ ReleaseDate time.Time

+ SeriesLinks *starr.IsLoaded

+ Title string

+ TitleSlug string

+ type Book struct

+ AnyEditionOk bool

+ Author *BookAuthor

+ AuthorID int64

+ Disambiguation string

+ Editions []*Edition

+ ForeignBookID string

+ Genres []interface{}

+ ID int64

+ Images []*starr.Image

+ Links []*starr.Link

+ Monitored bool

+ Overview string

+ PageCount int

+ Ratings *starr.Ratings

+ ReleaseDate time.Time

+ SeriesTitle string

+ Statistics *Statistics

+ Title string

+ TitleSlug string

+ type BookAuthor struct

+ Added time.Time

+ AuthorName string

+ CleanName string

+ Ended bool

+ ForeignAuthorID string

+ Genres []interface{}

+ ID int64

+ Images []*starr.Image

+ Links []*starr.Link

+ MetadataProfileID int64

+ Monitored bool

+ Overview string

+ Path string

+ QualityProfileID int64

+ Ratings *starr.Ratings

+ SortName string

+ Statistics *Statistics

+ Status string

+ Tags []int

+ TitleSlug string

+ type BookRecord struct

+ AuthorID int64

+ BookID int64

+ DownloadClient string

+ DownloadForced bool

+ DownloadID string

+ EstimatedCompletionTime time.Time

+ ID int64

+ Indexer string

+ OutputPath string

+ Protocol string

+ Quality *starr.Quality

+ Size float64

+ Sizeleft float64

+ Status string

+ StatusMessages []*starr.StatusMessage

+ Timeleft string

+ Title string

+ TrackedDownloadState string

+ TrackedDownloadStatus string

+ type Edition struct

+ Asin string

+ BookID int64

+ ForeignEditionID string

+ Format string

+ ID int64

+ Images []*starr.Image

+ IsEbook bool

+ Isbn13 string

+ Links []*starr.Link

+ ManualAdd bool

+ Monitored bool

+ Overview string

+ PageCount int

+ Publisher string

+ Ratings *starr.Ratings

+ ReleaseDate time.Time

+ Title string

+ TitleSlug string

+ type MetadataProfile struct

+ AllowedLanguages string

+ ID int64

+ MinPopularity float64

+ Name string

+ SkipMissingDate bool

+ SkipMissingIsbn bool

+ SkipPartsAndSets bool

+ SkipSeriesSecondary bool

+ type QualityProfile struct

+ Cutoff int64

+ ID int64

+ Name string

+ Qualities []*starr.Quality

+ UpgradeAllowed bool

+ type Queue struct

+ Page int

+ PageSize int

+ Records []BookRecord

+ SortDirection string

+ SortKey string

+ TotalRecords int

+ type Readarr struct

+ func New(c *starr.Config) *Readarr

+ func (r *Readarr) AddBook(book *AddBookInput) (*AddBookOutput, error)

+ func (r *Readarr) AddTag(label string) (int, error)

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

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

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

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

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

+ func (r *Readarr) GetQueue(maxRecords int) (*Queue, error)

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

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

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

+ func (r *Readarr) UpdateAuthor(authorID int64, author *Author) error

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

+ func (r *Readarr) UpdateTag(tagID int, label string) (int, error)

+ type RootFolder struct

+ Accessible bool

+ DefaultMetadataProfileID int64

+ DefaultMonitorOption string

+ DefaultQualityProfileID int64

+ DefaultTags []int

+ FreeSpace int64

+ ID int64

+ IsCalibreLibrary bool

+ Name string

+ OutputProfile string

+ Path string

+ Port int

+ TotalSpace int64

+ UseSsl bool

+ type Statistics struct

+ BookCount int

+ BookFileCount int

+ PercentOfBooks float64

+ SizeOnDisk int

+ TotalBookCount int

+ type SystemStatus struct

+ AppData string

+ Authentication string

+ Branch string

+ BuildTime time.Time

+ IsAdmin bool

+ IsDebug bool

+ IsDocker bool

+ IsLinux bool

+ IsMono bool

+ IsNetCore bool

+ IsOsx bool

+ IsProduction bool

+ IsUserInteractive bool

+ IsWindows bool

+ MigrationVersion int

+ Mode string

+ OsName string

+ OsVersion string

+ PackageAuthor string

+ PackageUpdateMechanism string

+ PackageVersion string

+ RuntimeName string

+ RuntimeVersion string

+ SqliteVersion string

+ StartTime time.Time

+ StartupPath string

+ URLBase string

+ Version string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL