| bookshelf_profiles_formatsA | bookshelf profiles formats operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_create_customfilter(body={}) — Create customfilter. WRITE: this modifies your Bookshelf instance. bookshelf_create_customformat(body={}) — Create customformat. WRITE: this modifies your Bookshelf instance. bookshelf_create_delayprofile(body={}) — Create delayprofile. WRITE: this modifies your Bookshelf instance. bookshelf_create_metadataprofile(body={}) — Create metadataprofile. WRITE: this modifies your Bookshelf instance. bookshelf_create_qualityprofile(body={}) — Create qualityprofile. WRITE: this modifies your Bookshelf instance. bookshelf_create_releaseprofile(body={}) — Create releaseprofile. WRITE: this modifies your Bookshelf instance. bookshelf_delete_customfilter(id) — Delete customfilter. DESTRUCTIVE: this deletes data. bookshelf_delete_customformat(id) — Delete customformat. DESTRUCTIVE: this deletes data. bookshelf_delete_delayprofile(id) — Delete delayprofile. DESTRUCTIVE: this deletes data. bookshelf_delete_metadataprofile(id) — Delete metadataprofile. DESTRUCTIVE: this deletes data. bookshelf_delete_qualityprofile(id) — Delete qualityprofile. DESTRUCTIVE: this deletes data. bookshelf_delete_releaseprofile(id) — Delete releaseprofile. DESTRUCTIVE: this deletes data. bookshelf_get_customfilter(id) — Fetch a single customfilter by id. bookshelf_get_customformat(id) — Fetch a single customformat by id. bookshelf_get_customformat_schema() — List customformat schema. bookshelf_get_delayprofile(id) — Fetch a single delayprofile by id. bookshelf_get_language(id) — Fetch a single language by id. bookshelf_get_metadataprofile(id) — Fetch a single metadataprofile by id. bookshelf_get_metadataprofile_schema() — List metadataprofile schema. bookshelf_get_qualitydefinition(id) — Fetch a single qualitydefinition by id. bookshelf_get_qualityprofile(id) — Fetch a single qualityprofile by id. bookshelf_get_qualityprofile_schema() — List qualityprofile schema. bookshelf_get_releaseprofile(id) — Fetch a single releaseprofile by id. bookshelf_list_customfilter() — List customfilter. bookshelf_list_customformat() — List customformat. bookshelf_list_delayprofile() — List delayprofile. bookshelf_list_language() — List language. bookshelf_list_metadataprofile() — List metadataprofile. bookshelf_list_qualitydefinition() — List qualitydefinition. bookshelf_list_qualityprofile() — List qualityprofile. bookshelf_list_releaseprofile() — List releaseprofile. bookshelf_reorder_delayprofile(id, after_id=None) — Update delayprofile reorder. Query params: afterId. WRITE: this modifies your Bookshelf instance. bookshelf_update_customfilter(id, body={}) — Update customfilter. WRITE: this modifies your Bookshelf instance. bookshelf_update_customformat(id, body={}) — Update customformat. WRITE: this modifies your Bookshelf instance. bookshelf_update_delayprofile(id, body={}) — Update delayprofile. WRITE: this modifies your Bookshelf instance. bookshelf_update_metadataprofile(id, body={}) — Update metadataprofile. WRITE: this modifies your Bookshelf instance. bookshelf_update_quality_definitions(body=[]) — Update qualitydefinition update. WRITE: this modifies your Bookshelf instance. bookshelf_update_qualitydefinition(id, body={}) — Update qualitydefinition. WRITE: this modifies your Bookshelf instance. bookshelf_update_qualityprofile(id, body={}) — Update qualityprofile. WRITE: this modifies your Bookshelf instance. bookshelf_update_releaseprofile(id, body={}) — Update releaseprofile. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_media_libraryA | bookshelf media library operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_add_books_to_shelf(body={}) — Add the given books to a Goodreads/Hardcover shelf. Body is a BookshelfResource with bookshelfId and bookIds. bookshelf_bulk_delete_author(body={}) — Bulk delete author editor. DESTRUCTIVE: this deletes data. bookshelf_bulk_delete_book(body={}) — Bulk delete book editor. DESTRUCTIVE: this deletes data. bookshelf_bulk_delete_bookfile(body={}) — Bulk delete bookfile bulk. DESTRUCTIVE: this deletes data. bookshelf_bulk_update_author(body={}) — Bulk update author editor. WRITE: this modifies your Bookshelf instance. bookshelf_bulk_update_book(body={}) — Bulk update book editor. WRITE: this modifies your Bookshelf instance. bookshelf_bulk_update_bookfile(body={}) — Bulk update bookfile editor. WRITE: this modifies your Bookshelf instance. bookshelf_commit_manual_import(body=[]) — Commit manual imports for the given files. Body is a list of ManualImportUpdateResource. WRITE: this modifies your Bookshelf instance. bookshelf_create_author(body={}) — Create author. WRITE: this modifies your Bookshelf instance. bookshelf_create_book(body={}) — Create book. WRITE: this modifies your Bookshelf instance. bookshelf_delete_author(id, delete_files=False, add_import_list_exclusion=False) — Delete author. Query params: deleteFiles, addImportListExclusion. DESTRUCTIVE: this deletes data. bookshelf_delete_book(id, delete_files=False, add_import_list_exclusion=False) — Delete book. Query params: deleteFiles, addImportListExclusion. DESTRUCTIVE: this deletes data. bookshelf_delete_bookfile(id) — Delete bookfile. DESTRUCTIVE: this deletes data. bookshelf_get_author(id) — Fetch a single author by id. bookshelf_get_book(id) — Fetch a single book by id. bookshelf_get_book_overview(id) — Fetch a single book overview by id. bookshelf_get_bookfile(id) — Fetch a single bookfile by id. bookshelf_get_parse(title=None) — Parse a file or release title and show how Bookshelf interprets it. bookshelf_get_rename(author_id=None, book_id=None) — List proposed renames for an author or book (files that would be renamed on the next rename task). bookshelf_get_retag(author_id=None, book_id=None) — List proposed file retags for an author or book. bookshelf_list_author() — List author. bookshelf_list_book(author_id=None, book_ids=None, title_slug=None, include_all_author_books=False) — List book. Query params: authorId, bookIds, titleSlug, includeAllAuthorBooks. bookshelf_list_bookfile(author_id=None, book_file_ids=None, book_id=None, unmapped=None) — List bookfile. Query params: authorId, bookFileIds, bookId, unmapped. bookshelf_list_edition(book_id=None) — List edition. Query params: bookId. bookshelf_list_manualimport(folder=None, download_id=None, author_id=None, filter_existing_files=True, replace_existing_files=True) — List manualimport. Query params: folder, downloadId, authorId, filterExistingFiles, replaceExistingFiles. bookshelf_list_series(author_id=None) — List series. Query params: authorId. bookshelf_lookup_author(term=None) — Search the metadata provider for authors by term. bookshelf_lookup_book(term=None) — Search the metadata provider for books by term. bookshelf_search(term=None) — Search for new books/authors on the metadata provider by term and return the matches to add. bookshelf_update_author(id, move_files=False, body={}) — Update author. Query params: moveFiles. WRITE: this modifies your Bookshelf instance. bookshelf_update_book(id, body={}) — Update book. WRITE: this modifies your Bookshelf instance. bookshelf_update_bookfile(id, body={}) — Update bookfile. WRITE: this modifies your Bookshelf instance. bookshelf_update_books_monitored(body={}) — Set the monitored state of books in bulk. Body is a BooksMonitoredResource with bookIds and monitored.
|
| bookshelf_configD | bookshelf config operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_get_config_development() — List config development. bookshelf_get_config_development_by_id(id) — Fetch a single config development by id. bookshelf_get_config_downloadclient() — List config downloadclient. bookshelf_get_config_downloadclient_by_id(id) — Fetch a single config downloadclient by id. bookshelf_get_config_host() — List config host. bookshelf_get_config_host_by_id(id) — Fetch a single config host by id. bookshelf_get_config_indexer() — List config indexer. bookshelf_get_config_indexer_by_id(id) — Fetch a single config indexer by id. bookshelf_get_config_mediamanagement() — List config mediamanagement. bookshelf_get_config_mediamanagement_by_id(id) — Fetch a single config mediamanagement by id. bookshelf_get_config_metadataprovider() — List config metadataprovider. bookshelf_get_config_metadataprovider_by_id(id) — Fetch a single config metadataprovider by id. bookshelf_get_config_naming() — List config naming. bookshelf_get_config_naming_by_id(id) — Fetch a single config naming by id. bookshelf_get_config_naming_examples(rename_books=None, replace_illegal_characters=None, colon_replacement_format=None, standard_book_format=None, author_folder_format=None, include_author_name=None, include_book_title=None, include_quality=None, replace_spaces=None, separator=None, number_style=None, id=None, resource_name=None) — List config naming examples. Query params: renameBooks, replaceIllegalCharacters, colonReplacementFormat, standardBookFormat, authorFolderFormat, includeAuthorName, includeBookTitle, includeQuality, replaceSpaces, separator, numberStyle, id, resourceName. bookshelf_get_config_ui() — List config ui. bookshelf_get_config_ui_by_id(id) — Fetch a single config ui by id. bookshelf_get_localization() — List localization. bookshelf_list_update() — List update. bookshelf_update_config_development(id, body={}) — Update config development. WRITE: this modifies your Bookshelf instance. bookshelf_update_config_downloadclient(id, body={}) — Update config downloadclient. WRITE: this modifies your Bookshelf instance. bookshelf_update_config_host(id, body={}) — Update config host. WRITE: this modifies your Bookshelf instance. bookshelf_update_config_indexer(id, body={}) — Update config indexer. WRITE: this modifies your Bookshelf instance. bookshelf_update_config_mediamanagement(id, body={}) — Update config mediamanagement. WRITE: this modifies your Bookshelf instance. bookshelf_update_config_metadataprovider(id, body={}) — Update config metadataprovider. WRITE: this modifies your Bookshelf instance. bookshelf_update_config_naming(id, body={}) — Update config naming. WRITE: this modifies your Bookshelf instance. bookshelf_update_config_ui(id, body={}) — Update config ui. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_system_commandsC | bookshelf system commands operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_delete_command(id) — Delete command. DESTRUCTIVE: this deletes data. bookshelf_delete_system_backup(id) — Delete system backup. DESTRUCTIVE: this deletes data. bookshelf_get_command(id) — Fetch a single command by id. bookshelf_get_health() — List health. bookshelf_get_system_routes() — List system routes. bookshelf_get_system_routes_duplicate() — List system routes duplicate. bookshelf_get_system_status() — Get system status: app name, version, OS, build, and runtime. bookshelf_get_system_task() — List system task. bookshelf_get_system_task_by_id(id) — Fetch a single system task by id. bookshelf_list_command() — List command. bookshelf_list_log(page=1, page_size=10, sort_key=None, sort_direction=None, level=None) — List log. Query params: page, pageSize, sortKey, sortDirection, level. bookshelf_list_log_file() — List log file. bookshelf_list_log_file_update() — List log file update. bookshelf_list_system_backup() — List system backup. bookshelf_ping() — List ping. bookshelf_restart() — Restart the Bookshelf service. bookshelf_restore_backup(id) — Create system backup restore. WRITE: this modifies your Bookshelf instance. bookshelf_restore_backup_upload() — Create system backup restore upload. WRITE: this modifies your Bookshelf instance. bookshelf_run_command(body={}) — Run a Bookshelf command (body is a CommandResource with a name, e.g. RefreshAuthor, AuthorSearch, BookSearch, DownloadedBooksScan, RenamedBookFiles, RescanFolders, MetadataRefresh). WRITE: this modifies your Bookshelf instance. bookshelf_shutdown() — Shut down the Bookshelf service.
|
| bookshelf_notifications_metadataB | bookshelf notifications metadata operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_action_metadata(name, body={}) — Create metadata action. WRITE: this modifies your Bookshelf instance. bookshelf_action_notification(name, body={}) — Create notification action. WRITE: this modifies your Bookshelf instance. bookshelf_create_metadata(force_save=False, body={}) — Create metadata. Query params: forceSave. WRITE: this modifies your Bookshelf instance. bookshelf_create_notification(force_save=False, body={}) — Create notification. Query params: forceSave. WRITE: this modifies your Bookshelf instance. bookshelf_delete_metadata(id) — Delete metadata. DESTRUCTIVE: this deletes data. bookshelf_delete_notification(id) — Delete notification. DESTRUCTIVE: this deletes data. bookshelf_get_metadata(id) — Fetch a single metadata by id. bookshelf_get_metadata_schema() — List metadata schema. bookshelf_get_notification(id) — Fetch a single notification by id. bookshelf_get_notification_schema() — List notification schema. bookshelf_list_metadata() — List metadata. bookshelf_list_notification() — List notification. bookshelf_test_all_metadata() — Create metadata testall. WRITE: this modifies your Bookshelf instance. bookshelf_test_all_notification() — Create notification testall. WRITE: this modifies your Bookshelf instance. bookshelf_test_metadata(force_test=False, body={}) — Create metadata test. Query params: forceTest. WRITE: this modifies your Bookshelf instance. bookshelf_test_notification(force_test=False, body={}) — Create notification test. Query params: forceTest. WRITE: this modifies your Bookshelf instance. bookshelf_update_metadata(id, force_save=False, body={}) — Update metadata. Query params: forceSave. WRITE: this modifies your Bookshelf instance. bookshelf_update_notification(id, force_save=False, body={}) — Update notification. Query params: forceSave. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_download_clientsB | bookshelf download clients operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_action_downloadclient(name, body={}) — Create downloadclient action. WRITE: this modifies your Bookshelf instance. bookshelf_bulk_delete_downloadclient(body={}) — Bulk delete downloadclient bulk. DESTRUCTIVE: this deletes data. bookshelf_bulk_update_downloadclient(body={}) — Bulk update downloadclient bulk. WRITE: this modifies your Bookshelf instance. bookshelf_create_downloadclient(force_save=False, body={}) — Create downloadclient. Query params: forceSave. WRITE: this modifies your Bookshelf instance. bookshelf_create_remotepathmapping(body={}) — Create remotepathmapping. WRITE: this modifies your Bookshelf instance. bookshelf_delete_downloadclient(id) — Delete downloadclient. DESTRUCTIVE: this deletes data. bookshelf_delete_remotepathmapping(id) — Delete remotepathmapping. DESTRUCTIVE: this deletes data. bookshelf_get_downloadclient(id) — Fetch a single downloadclient by id. bookshelf_get_downloadclient_schema() — List downloadclient schema. bookshelf_get_remotepathmapping(id) — Fetch a single remotepathmapping by id. bookshelf_list_downloadclient() — List downloadclient. bookshelf_list_remotepathmapping() — List remotepathmapping. bookshelf_test_all_downloadclient() — Create downloadclient testall. WRITE: this modifies your Bookshelf instance. bookshelf_test_downloadclient(force_test=False, body={}) — Create downloadclient test. Query params: forceTest. WRITE: this modifies your Bookshelf instance. bookshelf_update_downloadclient(id, force_save=False, body={}) — Update downloadclient. Query params: forceSave. WRITE: this modifies your Bookshelf instance. bookshelf_update_remotepathmapping(id, body={}) — Update remotepathmapping. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_import_listsA | bookshelf import lists operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_action_importlist(name, body={}) — Create importlist action. WRITE: this modifies your Bookshelf instance. bookshelf_bulk_delete_importlist(body={}) — Bulk delete importlist bulk. DESTRUCTIVE: this deletes data. bookshelf_bulk_update_importlist(body={}) — Bulk update importlist bulk. WRITE: this modifies your Bookshelf instance. bookshelf_create_importlist(force_save=False, body={}) — Create importlist. Query params: forceSave. WRITE: this modifies your Bookshelf instance. bookshelf_create_importlistexclusion(body={}) — Create importlistexclusion. WRITE: this modifies your Bookshelf instance. bookshelf_delete_importlist(id) — Delete importlist. DESTRUCTIVE: this deletes data. bookshelf_delete_importlistexclusion(id) — Delete importlistexclusion. DESTRUCTIVE: this deletes data. bookshelf_get_importlist(id) — Fetch a single importlist by id. bookshelf_get_importlist_schema() — List importlist schema. bookshelf_get_importlistexclusion(id) — Fetch a single importlistexclusion by id. bookshelf_list_importlist() — List importlist. bookshelf_list_importlistexclusion() — List importlistexclusion. bookshelf_test_all_importlist() — Create importlist testall. WRITE: this modifies your Bookshelf instance. bookshelf_test_importlist(force_test=False, body={}) — Create importlist test. Query params: forceTest. WRITE: this modifies your Bookshelf instance. bookshelf_update_importlist(id, force_save=False, body={}) — Update importlist. Query params: forceSave. WRITE: this modifies your Bookshelf instance. bookshelf_update_importlistexclusion(id, body={}) — Update importlistexclusion. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_indexersB | bookshelf indexers operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_action_indexer(name, body={}) — Create indexer action. WRITE: this modifies your Bookshelf instance. bookshelf_bulk_delete_indexer(body={}) — Bulk delete indexer bulk. DESTRUCTIVE: this deletes data. bookshelf_bulk_update_indexer(body={}) — Bulk update indexer bulk. WRITE: this modifies your Bookshelf instance. bookshelf_create_indexer(force_save=False, body={}) — Create indexer. Query params: forceSave. WRITE: this modifies your Bookshelf instance. bookshelf_delete_indexer(id) — Delete indexer. DESTRUCTIVE: this deletes data. bookshelf_get_indexer(id) — Fetch a single indexer by id. bookshelf_get_indexer_schema() — List indexer schema. bookshelf_list_indexer() — List indexer. bookshelf_test_all_indexer() — Create indexer testall. WRITE: this modifies your Bookshelf instance. bookshelf_test_indexer(force_test=False, body={}) — Create indexer test. Query params: forceTest. WRITE: this modifies your Bookshelf instance. bookshelf_update_indexer(id, force_save=False, body={}) — Update indexer. Query params: forceSave. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_storageC | bookshelf storage operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_create_rootfolder(body={}) — Create rootfolder. WRITE: this modifies your Bookshelf instance. bookshelf_delete_rootfolder(id) — Delete rootfolder. DESTRUCTIVE: this deletes data. bookshelf_get_diskspace() — List diskspace. bookshelf_get_rootfolder(id) — Fetch a single rootfolder by id. bookshelf_list_filesystem(path=None, include_files=False, allow_folders_without_trailing_slashes=False) — List filesystem. Query params: path, includeFiles, allowFoldersWithoutTrailingSlashes. bookshelf_list_filesystem_mediafiles(path=None) — List filesystem mediafiles. Query params: path. bookshelf_list_filesystem_type(path=None) — List filesystem type. Query params: path. bookshelf_list_rootfolder() — List rootfolder. bookshelf_update_rootfolder(id, body={}) — Update rootfolder. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_history_blocklistA | bookshelf history blocklist operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_bulk_delete_blocklist(body={}) — Bulk delete blocklist bulk. DESTRUCTIVE: this deletes data. bookshelf_delete_blocklist(id) — Delete blocklist. DESTRUCTIVE: this deletes data. bookshelf_list_blocklist(page=1, page_size=10, sort_key=None, sort_direction=None) — List blocklist. Query params: page, pageSize, sortKey, sortDirection. bookshelf_list_history(page=1, page_size=10, sort_key=None, sort_direction=None, include_author=None, include_book=None, event_type=None, book_id=None, download_id=None) — List history. Query params: page, pageSize, sortKey, sortDirection, includeAuthor, includeBook, eventType, bookId, downloadId. bookshelf_list_history_author(author_id=None, book_id=None, event_type=None, include_author=False, include_book=False) — List history author. Query params: authorId, bookId, eventType, includeAuthor, includeBook. bookshelf_list_history_since(date=None, event_type=None, include_author=False, include_book=False) — List history since. Query params: date, eventType, includeAuthor, includeBook. bookshelf_mark_history_failed(id) — Mark a history event as failed and trigger a re-search. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_queueA | bookshelf queue operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_bulk_delete_queue(remove_from_client=True, blocklist=False, skip_redownload=False, change_category=False, body={}) — Bulk delete queue bulk. Query params: removeFromClient, blocklist, skipRedownload, changeCategory. DESTRUCTIVE: this deletes data. bookshelf_delete_queue(id, remove_from_client=True, blocklist=False, skip_redownload=False, change_category=False) — Delete queue. Query params: removeFromClient, blocklist, skipRedownload, changeCategory. DESTRUCTIVE: this deletes data. bookshelf_get_queue_details(author_id=None, book_ids=None, include_author=False, include_book=True) — List detailed queue items for an author or books. bookshelf_get_queue_status() — Get queue statistics: total/full count and warnings. bookshelf_grab_queue_bulk(body={}) — Grab multiple queue items now. Body is a QueueBulkResource with ids. bookshelf_grab_queue_item(id) — Grab a single queue item now. bookshelf_list_queue(page=1, page_size=10, sort_key=None, sort_direction=None, include_unknown_author_items=False, include_author=False, include_book=False) — List queue. Query params: page, pageSize, sortKey, sortDirection, includeUnknownAuthorItems, includeAuthor, includeBook.
|
| bookshelf_tagsB | bookshelf tags operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_create_tag(body={}) — Create tag. WRITE: this modifies your Bookshelf instance. bookshelf_delete_tag(id) — Delete tag. DESTRUCTIVE: this deletes data. bookshelf_get_tag(id) — Fetch a single tag by id. bookshelf_get_tag_detail(id) — Fetch a single tag detail by id. bookshelf_list_tag() — List tag. bookshelf_list_tag_detail() — List tag detail. bookshelf_update_tag(id, body={}) — Update tag. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_wantedA | bookshelf wanted operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_get_wanted_cutoff(id) — Fetch a single wanted cutoff by id. bookshelf_get_wanted_missing(id) — Fetch a single wanted missing by id. bookshelf_list_wanted_cutoff(page=1, page_size=10, sort_key=None, sort_direction=None, include_author=False, monitored=True) — List wanted cutoff. Query params: page, pageSize, sortKey, sortDirection, includeAuthor, monitored. bookshelf_list_wanted_missing(page=1, page_size=10, sort_key=None, sort_direction=None, include_author=False, monitored=True) — List wanted missing. Query params: page, pageSize, sortKey, sortDirection, includeAuthor, monitored.
|
| bookshelf_release_searchC | bookshelf release search operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_get_indexerflag() — List indexerflag. bookshelf_list_release(book_id=None, author_id=None) — List release. Query params: bookId, authorId. bookshelf_push_release(body={}) — Push a release to Bookshelf (e.g. from an external downloader); body is a ReleaseResource with title and downloadUrl. bookshelf_search_releases(body={}) — Trigger a release search for a book and grab the given release. WRITE: this modifies your Bookshelf instance.
|
| bookshelf_calendarB | bookshelf calendar operations on Bookshelf. Pass operation and an arguments dict matching that operation's parameters. bookshelf_get_calendar(id) — Fetch a single calendar by id. bookshelf_list_calendar(start=None, end=None, unmonitored=False, include_author=False) — List calendar. Query params: start, end, unmonitored, includeAuthor.
|
