readarr.BookApi

All URIs are relative to http://localhost:8787

Method	HTTP request	Description
create_book	POST /api/v1/book
delete_book	DELETE /api/v1/book/{id}
get_book_by_id	GET /api/v1/book/{id}
get_book_overview	GET /api/v1/book/{id}/overview
list_book	GET /api/v1/book
put_book_monitor	PUT /api/v1/book/monitor
update_book	PUT /api/v1/book/{id}

create_book

BookResource create_book(book_resource=book_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.models.book_resource import BookResource
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.BookApi(api_client)
    book_resource = readarr.BookResource() # BookResource |  (optional)

    try:
        api_response = api_instance.create_book(book_resource=book_resource)
        print("The response of BookApi->create_book:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BookApi->create_book: %s\n" % e)

Parameters

Name	Type	Description	Notes
book_resource	BookResource		[optional]

Return type

BookResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_book

delete_book(id, delete_files=delete_files, add_import_list_exclusion=add_import_list_exclusion)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.BookApi(api_client)
    id = 56 # int | 
    delete_files = False # bool |  (optional) (default to False)
    add_import_list_exclusion = False # bool |  (optional) (default to False)

    try:
        api_instance.delete_book(id, delete_files=delete_files, add_import_list_exclusion=add_import_list_exclusion)
    except Exception as e:
        print("Exception when calling BookApi->delete_book: %s\n" % e)

Parameters

Name	Type	Notes
id	int
delete_files	bool	[optional] [default to False]
add_import_list_exclusion	bool	[optional] [default to False]

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_book_by_id

BookResource get_book_by_id(id)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.models.book_resource import BookResource
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.BookApi(api_client)
    id = 56 # int | 

    try:
        api_response = api_instance.get_book_by_id(id)
        print("The response of BookApi->get_book_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BookApi->get_book_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

BookResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_book_overview

get_book_overview(id)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.BookApi(api_client)
    id = 56 # int | 

    try:
        api_instance.get_book_overview(id)
    except Exception as e:
        print("Exception when calling BookApi->get_book_overview: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_book

List[BookResource] list_book(author_id=author_id, book_ids=book_ids, title_slug=title_slug, include_all_author_books=include_all_author_books)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.models.book_resource import BookResource
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.BookApi(api_client)
    author_id = 56 # int |  (optional)
    book_ids = [56] # List[int] |  (optional)
    title_slug = 'title_slug_example' # str |  (optional)
    include_all_author_books = False # bool |  (optional) (default to False)

    try:
        api_response = api_instance.list_book(author_id=author_id, book_ids=book_ids, title_slug=title_slug, include_all_author_books=include_all_author_books)
        print("The response of BookApi->list_book:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BookApi->list_book: %s\n" % e)

Parameters

Name	Type	Notes
author_id	int	[optional]
book_ids	List[int]	[optional]
title_slug	str	[optional]
include_all_author_books	bool	[optional] [default to False]

Return type

List[BookResource]

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_book_monitor

put_book_monitor(books_monitored_resource=books_monitored_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.models.books_monitored_resource import BooksMonitoredResource
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.BookApi(api_client)
    books_monitored_resource = readarr.BooksMonitoredResource() # BooksMonitoredResource |  (optional)

    try:
        api_instance.put_book_monitor(books_monitored_resource=books_monitored_resource)
    except Exception as e:
        print("Exception when calling BookApi->put_book_monitor: %s\n" % e)

Parameters

Name	Type	Description	Notes
books_monitored_resource	BooksMonitoredResource		[optional]

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_book

BookResource update_book(id, book_resource=book_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import readarr
from readarr.models.book_resource import BookResource
from readarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8787
# See configuration.py for a list of all supported configuration parameters.
configuration = readarr.Configuration(
    host = "http://localhost:8787"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'

# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Enter a context with an instance of the API client
with readarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = readarr.BookApi(api_client)
    id = 'id_example' # str | 
    book_resource = readarr.BookResource() # BookResource |  (optional)

    try:
        api_response = api_instance.update_book(id, book_resource=book_resource)
        print("The response of BookApi->update_book:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BookApi->update_book: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
book_resource	BookResource		[optional]

Return type

BookResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

BookApi.md

Latest commit

History

BookApi.md

File metadata and controls

readarr.BookApi

create_book

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_book

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_book_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_book_overview

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_book

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_book_monitor

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_book

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details