Skip to content

Latest commit

 

History

History
184 lines (124 loc) · 5.73 KB

CalendarApi.md

File metadata and controls

184 lines (124 loc) · 5.73 KB
Raw

lidarr.CalendarApi

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

Method HTTP request Description
get_calendar_by_id GET /api/v1/calendar/{id}
list_calendar GET /api/v1/calendar

get_calendar_by_id

AlbumResource get_calendar_by_id(id)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import lidarr
from lidarr.models.album_resource import AlbumResource
from lidarr.rest import ApiException
from pprint import pprint

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

# 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 lidarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lidarr.CalendarApi(api_client)
    id = 56 # int | 

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

Parameters

Name Type Description Notes
id int

Return type

AlbumResource

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_calendar

List[AlbumResource] list_calendar(start=start, end=end, unmonitored=unmonitored, include_artist=include_artist, tags=tags)

Example

  • Api Key Authentication (apikey):
  • Api Key Authentication (X-Api-Key):
import lidarr
from lidarr.models.album_resource import AlbumResource
from lidarr.rest import ApiException
from pprint import pprint

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

# 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 lidarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lidarr.CalendarApi(api_client)
    start = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    end = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    unmonitored = False # bool |  (optional) (default to False)
    include_artist = False # bool |  (optional) (default to False)
    tags = '' # str |  (optional) (default to '')

    try:
        api_response = api_instance.list_calendar(start=start, end=end, unmonitored=unmonitored, include_artist=include_artist, tags=tags)
        print("The response of CalendarApi->list_calendar:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CalendarApi->list_calendar: %s\n" % e)

Parameters

Name Type Description Notes
start datetime [optional]
end datetime [optional]
unmonitored bool [optional] [default to False]
include_artist bool [optional] [default to False]
tags str [optional] [default to '']

Return type

List[AlbumResource]

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]