Readarr

pyarr.models.readarr.ReadarrCommands

Readarr commands.

Note

The parameters are supplied as **kwargs within the post_command method.

ApplicationUpdateCheck:

Checks for Application updates

AuthorSearch:

Search for specific author by ID

Args:

authorId (int): ID for Author

BookSearch:

Search for specific Book by ID

Args:

bookId (int): ID for Book

RefreshAuthor:

Refresh all Authors, or by specific ID

Args:

authorId (int, optional): ID for Author

RefreshBook:

Refresh all Books, or by specific ID

Args:

bookId (int, optional): ID for Book

RenameAuthor:

Rename all Authors, or by list of Ids

Args:

authorIds (list[int], optional): IDs for Authors

RenameFiles:

Rename all files, or by specific ID

Args:

authorId (int, optional): ID for Author files (str): ID of files

RescanFolders:

Rescans folders

RssSync:

Synchronise RSS Feeds

Backup:

Backup of the Database

MissingBookSearch:

Searches for any missing books

alias of Literal[‘ApplicationUpdateCheck’, ‘AuthorSearch’, ‘BookSearch’, ‘RefreshAuthor’, ‘RefreshBook’, ‘RenameAuthor’, ‘RenameFiles’, ‘RescanFolders’, ‘RssSync’, ‘Backup’, ‘MissingBookSearch’]

pyarr.models.readarr.ReadarrSortKeys

Readarr sort keys.

alias of Literal[‘authorId’, ‘Books.Id’, ‘books.releaseDate’, ‘downloadClient’, ‘id’, ‘indexer’, ‘message’, ‘path’, ‘progress’, ‘protocol’, ‘quality’, ‘ratings’, ‘size’, ‘sourcetitle’, ‘status’, ‘timeleft’, ‘title’]

pyarr.models.readarr.ReadarrSearchType

Readarr search types.

alias of Literal[‘asin’, ‘edition’, ‘isbn’, ‘author’, ‘work’]

pyarr.models.readarr.ReadarrAuthorMonitor

Readarr author monitor options.

alias of Literal[‘all’, ‘future’, ‘missing’, ‘existing’, ‘first’, ‘latest’, ‘none’]