Skip to content

HistoryApi.md

Latest commit

 

History

History
366 lines (258 loc) · 12.8 KB

HistoryApi.md

File metadata and controls

366 lines (258 loc) · 12.8 KB
Raw

readarr.HistoryApi

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

Method HTTP request Description
create_history_failed_by_id POST /api/v1/history/failed/{id}
get_history GET /api/v1/history
list_history_author GET /api/v1/history/author
list_history_since GET /api/v1/history/since

create_history_failed_by_id

create_history_failed_by_id(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.HistoryApi(api_client)
    id = 56 # int | 

    try:
        api_instance.create_history_failed_by_id(id)
    except Exception as e:
        print("Exception when calling HistoryApi->create_history_failed_by_id: %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]

get_history

HistoryResourcePagingResource get_history(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction, include_author=include_author, include_book=include_book, event_type=event_type, book_id=book_id, download_id=download_id)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import readarr
from readarr.models.history_resource_paging_resource import HistoryResourcePagingResource
from readarr.models.sort_direction import SortDirection
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.HistoryApi(api_client)
    page = 1 # int |  (optional) (default to 1)
    page_size = 10 # int |  (optional) (default to 10)
    sort_key = 'sort_key_example' # str |  (optional)
    sort_direction = readarr.SortDirection() # SortDirection |  (optional)
    include_author = True # bool |  (optional)
    include_book = True # bool |  (optional)
    event_type = [56] # List[int] |  (optional)
    book_id = 56 # int |  (optional)
    download_id = 'download_id_example' # str |  (optional)

    try:
        api_response = api_instance.get_history(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction, include_author=include_author, include_book=include_book, event_type=event_type, book_id=book_id, download_id=download_id)
        print("The response of HistoryApi->get_history:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HistoryApi->get_history: %s\n" % e)

Parameters

Name Type Description Notes
page int [optional] [default to 1]
page_size int [optional] [default to 10]
sort_key str [optional]
sort_direction SortDirection [optional]
include_author bool [optional]
include_book bool [optional]
event_type List[int] [optional]
book_id int [optional]
download_id str [optional]

Return type

HistoryResourcePagingResource

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]

list_history_author

List[HistoryResource] list_history_author(author_id=author_id, book_id=book_id, event_type=event_type, include_author=include_author, include_book=include_book)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import readarr
from readarr.models.entity_history_event_type import EntityHistoryEventType
from readarr.models.history_resource import HistoryResource
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.HistoryApi(api_client)
    author_id = 56 # int |  (optional)
    book_id = 56 # int |  (optional)
    event_type = readarr.EntityHistoryEventType() # EntityHistoryEventType |  (optional)
    include_author = False # bool |  (optional) (default to False)
    include_book = False # bool |  (optional) (default to False)

    try:
        api_response = api_instance.list_history_author(author_id=author_id, book_id=book_id, event_type=event_type, include_author=include_author, include_book=include_book)
        print("The response of HistoryApi->list_history_author:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HistoryApi->list_history_author: %s\n" % e)

Parameters

Name Type Description Notes
author_id int [optional]
book_id int [optional]
event_type EntityHistoryEventType [optional]
include_author bool [optional] [default to False]
include_book bool [optional] [default to False]

Return type

List[HistoryResource]

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]

list_history_since

List[HistoryResource] list_history_since(var_date=var_date, event_type=event_type, include_author=include_author, include_book=include_book)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import readarr
from readarr.models.entity_history_event_type import EntityHistoryEventType
from readarr.models.history_resource import HistoryResource
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.HistoryApi(api_client)
    var_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    event_type = readarr.EntityHistoryEventType() # EntityHistoryEventType |  (optional)
    include_author = False # bool |  (optional) (default to False)
    include_book = False # bool |  (optional) (default to False)

    try:
        api_response = api_instance.list_history_since(var_date=var_date, event_type=event_type, include_author=include_author, include_book=include_book)
        print("The response of HistoryApi->list_history_since:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HistoryApi->list_history_since: %s\n" % e)

Parameters

Name Type Description Notes
var_date datetime [optional]
event_type EntityHistoryEventType [optional]
include_author bool [optional] [default to False]
include_book bool [optional] [default to False]

Return type

List[HistoryResource]

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]